Ignite UI for Angular Tree Grid - Documentation The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding. Example:

Properties

Section titled "Properties"

actionStripComponents

Section titled "actionStripComponents" 
actionStripComponents: IgcActionStripToken[]

Accessors

Section titled "Accessors"

addRowEmptyTemplate

Section titled "addRowEmptyTemplate"

Inherited from: IgcGridBaseDirective 

get addRowEmptyTemplate(): (ctx: void) => React.ReactNode

Returns (ctx: void) => React.ReactNode

Gets/Sets a custom template for adding row UI when grid is empty.

 
set addRowEmptyTemplate(value: (ctx: void) => React.ReactNode): void

Parameters

  • value: (ctx: void) => React.ReactNode

Returns void

advancedFilteringExpressionsTree

Section titled "advancedFilteringExpressionsTree"

Inherited from: IgcGridBaseDirective 

get advancedFilteringExpressionsTree(): IgrFilteringExpressionsTree

Returns IgrFilteringExpressionsTree

Gets/Sets the advanced filtering state.

 
set advancedFilteringExpressionsTree(value: IgrFilteringExpressionsTree): void

Parameters

Returns void

allowAdvancedFiltering

Section titled "allowAdvancedFiltering"

Inherited from: IgcGridBaseDirective 

get allowAdvancedFiltering(): boolean

Returns boolean

Gets/Sets a value indicating whether the advanced filtering is enabled.

 
set allowAdvancedFiltering(value: boolean): void

Parameters

  • value: boolean

Returns void

allowFiltering

Section titled "allowFiltering"

Inherited from: IgcGridBaseDirective 

get allowFiltering(): boolean

Returns boolean

Gets/Sets if the filtering is enabled.

 
set allowFiltering(value: boolean): void

Parameters

  • value: boolean

Returns void

autoGenerate

Section titled "autoGenerate"

Inherited from: IgcGridBaseDirective 

get autoGenerate(): boolean

Returns boolean

Gets/Sets whether to auto-generate the columns.

 
set autoGenerate(value: boolean): void

Parameters

  • value: boolean

Returns void

autoGenerateExclude

Section titled "autoGenerateExclude"

Inherited from: IgcGridBaseDirective 

get autoGenerateExclude(): string[]

Returns string[]

Gets/Sets a list of property keys to be excluded from the generated column collection

 
set autoGenerateExclude(value: string[]): void

Parameters

  • value: string[]

Returns void

batchEditing

Section titled "batchEditing"

Inherited from: IgcGridBaseDirective 

get batchEditing(): boolean

Returns boolean

Gets/Sets whether the grid has batch editing enabled. When batch editing is enabled, changes are not made directly to the underlying data. Instead, they are stored as transactions, which can later be committed w/ the commit method.

 
set batchEditing(value: boolean): void

Parameters

  • value: boolean

Returns void

cascadeOnDelete

Section titled "cascadeOnDelete" 
get cascadeOnDelete(): boolean

Returns boolean

Sets whether child records should be deleted when their parent gets deleted. By default it is set to true and deletes all children along with the parent.

 
set cascadeOnDelete(value: boolean): void

Parameters

  • value: boolean

Returns void

cellMergeMode

Section titled "cellMergeMode"

Inherited from: IgcGridBaseDirective 

get cellMergeMode(): GridCellMergeMode

Returns GridCellMergeMode

Gets/Sets cell merge mode.

 
set cellMergeMode(value: GridCellMergeMode): void

Parameters

Returns void

cellSelection

Section titled "cellSelection"

Inherited from: IgcGridBaseDirective 

get cellSelection(): GridSelectionMode

Returns GridSelectionMode

Gets/Sets cell selection mode.

 
set cellSelection(value: GridSelectionMode): void

Parameters

Returns void

childDataKey

Section titled "childDataKey" 
get childDataKey(): string

Returns string

Sets the child data key of the tree grid.

 
set childDataKey(value: string): void

Parameters

  • value: string

Returns void

clipboardOptions

Section titled "clipboardOptions"

Inherited from: IgcGridBaseDirective 

get clipboardOptions(): IgrClipboardOptions

Returns IgrClipboardOptions

Controls the copy behavior of the grid.

 
set clipboardOptions(value: IgrClipboardOptions): void

Parameters

Returns void

columnList

Section titled "columnList"

Inherited from: IgcGridBaseDirective 

get columnList(): IgrColumnComponent[]

Returns IgrColumnComponent[]

columns

Section titled "columns"

Inherited from: IgcGridBaseDirective

Gets an array of columns.

 
get columns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

columnSelection

Section titled "columnSelection"

Inherited from: IgcGridBaseDirective 

get columnSelection(): GridSelectionMode

Returns GridSelectionMode

Gets/Sets column selection mode

 
set columnSelection(value: GridSelectionMode): void

Parameters

Returns void

columnWidth

Section titled "columnWidth"

Inherited from: IgcGridBaseDirective 

get columnWidth(): string

Returns string

Gets/Sets the default width of the columns.

 
set columnWidth(value: string): void

Parameters

  • value: string

Returns void

data

Section titled "data" 
get data(): any[]

Returns any[]

Gets/Sets the array of data that populates the component.

 
set data(value: any[]): void

Parameters

  • value: any[]

Returns void

dataCloneStrategy

Section titled "dataCloneStrategy"

Inherited from: IgcGridBaseDirective 

get dataCloneStrategy(): IgrDataCloneStrategy

Returns IgrDataCloneStrategy

Gets/Sets the data clone strategy of the grid when in edit mode.

 
set dataCloneStrategy(value: IgrDataCloneStrategy): void

Parameters

Returns void

dataRowList

Section titled "dataRowList"

Inherited from: IgcGridBaseDirective

A list of currently rendered grid row's.

 
get dataRowList(): IgrRowDirective[]

Returns IgrRowDirective[]

dataView

Section titled "dataView"

Inherited from: IgcGridBaseDirective

Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.

 
get dataView(): any[]

Returns any[]

defaultRowHeight

Section titled "defaultRowHeight"

Inherited from: IgcGridBaseDirective

Gets the default row height.

 
get defaultRowHeight(): number

Returns number

dragGhostCustomTemplate

Section titled "dragGhostCustomTemplate"

Inherited from: IgcGridBaseDirective 

get dragGhostCustomTemplate(): (ctx: IgrGridRowDragGhostContext) => React.ReactNode

Returns (ctx: IgrGridRowDragGhostContext) => React.ReactNode

Gets the custom template, if any, used for row drag ghost.

 
set dragGhostCustomTemplate(value: (ctx: IgrGridRowDragGhostContext) => React.ReactNode): void

Parameters

Returns void

dragIndicatorIconTemplate

Section titled "dragIndicatorIconTemplate"

Inherited from: IgcGridBaseDirective 

get dragIndicatorIconTemplate(): (ctx: IgrGridEmptyTemplateContext) => React.ReactNode

Returns (ctx: IgrGridEmptyTemplateContext) => React.ReactNode

The custom template, if any, that should be used when rendering the row drag indicator icon

 
set dragIndicatorIconTemplate(value: (ctx: IgrGridEmptyTemplateContext) => React.ReactNode): void

Parameters

Returns void

emptyFilteredGridMessage

Section titled "emptyFilteredGridMessage"

Inherited from: IgcGridBaseDirective 

get emptyFilteredGridMessage(): string

Returns string

Gets/Sets the message displayed when there are no records and the grid is filtered.

 
set emptyFilteredGridMessage(value: string): void

Parameters

  • value: string

Returns void

emptyGridMessage

Section titled "emptyGridMessage"

Inherited from: IgcGridBaseDirective 

get emptyGridMessage(): string

Returns string

Get/Sets the message displayed when there are no records.

 
set emptyGridMessage(value: string): void

Parameters

  • value: string

Returns void

emptyGridTemplate

Section titled "emptyGridTemplate"

Inherited from: IgcGridBaseDirective 

get emptyGridTemplate(): (ctx: IgrGridTemplateContext) => React.ReactNode

Returns (ctx: IgrGridTemplateContext) => React.ReactNode

Gets/Sets a custom template when empty.

 
set emptyGridTemplate(value: (ctx: IgrGridTemplateContext) => React.ReactNode): void

Parameters

Returns void

excelStyleHeaderIconTemplate

Section titled "excelStyleHeaderIconTemplate"

Inherited from: IgcGridBaseDirective 

get excelStyleHeaderIconTemplate(): (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

Returns (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

Gets the excel style header icon.

 
set excelStyleHeaderIconTemplate(value: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode): void

Parameters

Returns void

expansionDepth

Section titled "expansionDepth" 
get expansionDepth(): number

Returns number

Sets the count of levels to be expanded in the tree grid. By default it is set to Infinity which means all levels would be expanded.

 
set expansionDepth(value: number): void

Parameters

  • value: number

Returns void

expansionStates

Section titled "expansionStates"

Inherited from: IgcGridBaseDirective 

get expansionStates(): Map<any, boolean>

Returns Map<any, boolean>

Gets/Sets a list of key-value pairs [row ID, expansion state].

 
set expansionStates(value: Map<any, boolean>): void

Parameters

  • value: Map<any, boolean>

Returns void

filteredData

Section titled "filteredData"

Inherited from: IgcGridBaseDirective

Returns an array of objects containing the filtered data.

 
get filteredData(): any

Returns any

filteredSortedData

Section titled "filteredSortedData"

Inherited from: IgcGridBaseDirective

Returns an array containing the filtered sorted data.

 
get filteredSortedData(): any[]

Returns any[]

filteringExpressionsTree

Section titled "filteringExpressionsTree"

Inherited from: IgcGridBaseDirective 

get filteringExpressionsTree(): IgrFilteringExpressionsTree

Returns IgrFilteringExpressionsTree

Gets/Sets the filtering state.

 
set filteringExpressionsTree(value: IgrFilteringExpressionsTree): void

Parameters

Returns void

filteringLogic

Section titled "filteringLogic"

Inherited from: IgcGridBaseDirective 

get filteringLogic(): FilteringLogic

Returns FilteringLogic

Gets/Sets the filtering logic of the grid.

 
set filteringLogic(value: FilteringLogic): void

Parameters

Returns void

filterMode

Section titled "filterMode"

Inherited from: IgcGridBaseDirective 

get filterMode(): FilterMode

Returns FilterMode

Gets/Sets the filter mode.

 
set filterMode(value: FilterMode): void

Parameters

Returns void

filterStrategy

Section titled "filterStrategy"

Inherited from: IgcGridBaseDirective 

get filterStrategy(): IgrFilteringStrategy

Returns IgrFilteringStrategy

Gets/Sets the filtering strategy of the grid.

 
set filterStrategy(value: IgrFilteringStrategy): void

Parameters

Returns void

foreignKey

Section titled "foreignKey" 
get foreignKey(): string

Returns string

Sets the foreign key of the tree grid.

 
set foreignKey(value: string): void

Parameters

  • value: string

Returns void

hasChildrenKey

Section titled "hasChildrenKey" 
get hasChildrenKey(): string

Returns string

Sets the key indicating whether a row has children. This property is only used for load on demand scenarios.

 
set hasChildrenKey(value: string): void

Parameters

  • value: string

Returns void

headerCollapsedIndicatorTemplate

Section titled "headerCollapsedIndicatorTemplate"

Inherited from: IgcGridBaseDirective 

get headerCollapsedIndicatorTemplate(): (ctx: IgrGridTemplateContext) => React.ReactNode

Returns (ctx: IgrGridTemplateContext) => React.ReactNode

Gets the row collapse indicator template.

 
set headerCollapsedIndicatorTemplate(value: (ctx: IgrGridTemplateContext) => React.ReactNode): void

Parameters

Returns void

headerExpandedIndicatorTemplate

Section titled "headerExpandedIndicatorTemplate"

Inherited from: IgcGridBaseDirective 

get headerExpandedIndicatorTemplate(): (ctx: IgrGridTemplateContext) => React.ReactNode

Returns (ctx: IgrGridTemplateContext) => React.ReactNode

Gets the header expand indicator template.

 
set headerExpandedIndicatorTemplate(value: (ctx: IgrGridTemplateContext) => React.ReactNode): void

Parameters

Returns void

headSelectorTemplate

Section titled "headSelectorTemplate"

Inherited from: IgcGridBaseDirective 

get headSelectorTemplate(): (ctx: IgrHeadSelectorTemplateContext) => React.ReactNode

Returns (ctx: IgrHeadSelectorTemplateContext) => React.ReactNode

Gets the header row selector template.

 
set headSelectorTemplate(value: (ctx: IgrHeadSelectorTemplateContext) => React.ReactNode): void

Parameters

Returns void

height

Section titled "height"

Inherited from: IgcGridBaseDirective 

get height(): string

Returns string

Gets/Sets the height.

 
set height(value: string): void

Parameters

  • value: string

Returns void

hiddenColumnsCount

Section titled "hiddenColumnsCount"

Inherited from: IgcGridBaseDirective

Gets the number of hidden columns.

 
get hiddenColumnsCount(): number

Returns number

hideRowSelectors

Section titled "hideRowSelectors"

Inherited from: IgcGridBaseDirective 

get hideRowSelectors(): boolean

Returns boolean

Gets/Sets if the row selectors are hidden.

 
set hideRowSelectors(value: boolean): void

Parameters

  • value: boolean

Returns void

id

Section titled "id"

The id property of the Element interface represents the element's identifier, reflecting the id global attribute.

MDN Reference

 
get id(): string

Returns string

Sets the value of the id attribute. If not provided it will be automatically generated.

 
set id(value: string): void

Parameters

  • value: string

Returns void

isLoading

Section titled "isLoading"

Inherited from: IgcGridBaseDirective 

get isLoading(): boolean

Returns boolean

Gets/Sets whether the grid is going to show a loading indicator.

 
set isLoading(value: boolean): void

Parameters

  • value: boolean

Returns void

lastSearchInfo

Section titled "lastSearchInfo"

Inherited from: IgcGridBaseDirective

Represents the last search information.

 
get lastSearchInfo(): IgrSearchInfo

Returns IgrSearchInfo

loadChildrenOnDemand

Section titled "loadChildrenOnDemand" 
get loadChildrenOnDemand(): any

Returns any

Sets a callback for loading child rows on demand.

 
set loadChildrenOnDemand(value: any): void

Parameters

  • value: any

Returns void

loadingGridTemplate

Section titled "loadingGridTemplate"

Inherited from: IgcGridBaseDirective 

get loadingGridTemplate(): (ctx: IgrGridTemplateContext) => React.ReactNode

Returns (ctx: IgrGridTemplateContext) => React.ReactNode

Gets/Sets a custom template when loading.

 
set loadingGridTemplate(value: (ctx: IgrGridTemplateContext) => React.ReactNode): void

Parameters

Returns void

locale

Section titled "locale"

Inherited from: IgcGridBaseDirective 

get locale(): string

Returns string

Gets/Sets the locale.

 
set locale(value: string): void

Parameters

  • value: string

Returns void

mergeStrategy

Section titled "mergeStrategy"

Inherited from: IgcGridBaseDirective 

get mergeStrategy(): IgrGridMergeStrategy

Returns IgrGridMergeStrategy

Gets/Sets the merge strategy of the grid.

 
set mergeStrategy(value: IgrGridMergeStrategy): void

Parameters

Returns void

moving

Section titled "moving"

Inherited from: IgcGridBaseDirective 

get moving(): boolean

Returns boolean

Controls whether columns moving is enabled in the grid.

 
set moving(value: boolean): void

Parameters

  • value: boolean

Returns void

outlet

Section titled "outlet"

Inherited from: IgcGridBaseDirective

Gets/Sets the outlet used to attach the grid's overlays to.

 
set outlet(value: IgrOverlayOutletDirective): void

Parameters

Returns void

paginationComponents

Section titled "paginationComponents"

Inherited from: IgcGridBaseDirective 

get paginationComponents(): IgrPaginatorComponent[]

Returns IgrPaginatorComponent[]

pagingMode

Section titled "pagingMode"

Inherited from: IgcGridBaseDirective 

get pagingMode(): GridPagingMode

Returns GridPagingMode 

set pagingMode(value: GridPagingMode): void

Parameters

Returns void

pinnedColumns

Section titled "pinnedColumns"

Inherited from: IgcGridBaseDirective

Gets an array of the pinned columns.

 
get pinnedColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

pinnedColumnsCount

Section titled "pinnedColumnsCount"

Inherited from: IgcGridBaseDirective

Gets the number of pinned columns.

 
get pinnedColumnsCount(): number

Returns number

pinnedEndColumns

Section titled "pinnedEndColumns"

Inherited from: IgcGridBaseDirective

Gets an array of the pinned to the right columns.

 
get pinnedEndColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

pinnedRows

Section titled "pinnedRows"

Inherited from: IgcGridBaseDirective

Gets an array of the pinned rows.

 
get pinnedRows(): IgrGridRowComponent[]

Returns IgrGridRowComponent[]

pinnedStartColumns

Section titled "pinnedStartColumns"

Inherited from: IgcGridBaseDirective

Gets an array of the pinned to the left columns.

 
get pinnedStartColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

pinning

Section titled "pinning"

Inherited from: IgcGridBaseDirective 

get pinning(): IgrPinningConfig

Returns IgrPinningConfig

Gets/Sets the initial pinning configuration.

 
set pinning(value: IgrPinningConfig): void

Parameters

Returns void

primaryKey

Section titled "primaryKey"

Inherited from: IgcGridBaseDirective 

get primaryKey(): string

Returns string

Gets/Sets the primary key.

 
set primaryKey(value: string): void

Parameters

  • value: string

Returns void

processedRootRecords

Section titled "processedRootRecords" 
get processedRootRecords(): IgrTreeGridRecord[]

Returns IgrTreeGridRecord[]

Returns an array of processed (filtered and sorted) root ITreeGridRecords.

 
set processedRootRecords(value: IgrTreeGridRecord[]): void

Parameters

Returns void

resourceStrings

Section titled "resourceStrings"

Inherited from: IgcGridBaseDirective 

get resourceStrings(): IgrGridResourceStrings

Returns IgrGridResourceStrings

Gets/Sets the resource strings.

 
set resourceStrings(value: IgrGridResourceStrings): void

Parameters

Returns void

rootRecords

Section titled "rootRecords" 
get rootRecords(): IgrTreeGridRecord[]

Returns IgrTreeGridRecord[]

Returns an array of the root level ITreeGridRecords.

 
set rootRecords(value: IgrTreeGridRecord[]): void

Parameters

Returns void

rowAddTextTemplate

Section titled "rowAddTextTemplate"

Inherited from: IgcGridBaseDirective 

get rowAddTextTemplate(): (ctx: IgrGridEmptyTemplateContext) => React.ReactNode

Returns (ctx: IgrGridEmptyTemplateContext) => React.ReactNode

Gets the row add text template.

 
set rowAddTextTemplate(value: (ctx: IgrGridEmptyTemplateContext) => React.ReactNode): void

Parameters

Returns void

rowClasses

Section titled "rowClasses"

Inherited from: IgcGridBaseDirective 

get rowClasses(): any

Returns any

Sets a conditional class selector to the grid's row element. Accepts an object literal, containing key-value pairs, where the key is the name of the CSS class and the value is either a callback function that returns a boolean, or boolean, like so:

 
set rowClasses(value: any): void

Parameters

  • value: any

Returns void

rowCollapsedIndicatorTemplate

Section titled "rowCollapsedIndicatorTemplate"

Inherited from: IgcGridBaseDirective 

get rowCollapsedIndicatorTemplate(): (ctx: IgrGridRowTemplateContext) => React.ReactNode

Returns (ctx: IgrGridRowTemplateContext) => React.ReactNode

Gets the row collapse indicator template.

 
set rowCollapsedIndicatorTemplate(value: (ctx: IgrGridRowTemplateContext) => React.ReactNode): void

Parameters

Returns void

rowDraggable

Section titled "rowDraggable"

Inherited from: IgcGridBaseDirective 

get rowDraggable(): boolean

Returns boolean

Gets/Sets whether rows can be moved.

 
set rowDraggable(value: boolean): void

Parameters

  • value: boolean

Returns void

rowEditable

Section titled "rowEditable"

Inherited from: IgcGridBaseDirective 

get rowEditable(): boolean

Returns boolean

Gets/Sets whether the rows are editable.

 
set rowEditable(value: boolean): void

Parameters

  • value: boolean

Returns void

rowEditActionsTemplate

Section titled "rowEditActionsTemplate"

Inherited from: IgcGridBaseDirective 

get rowEditActionsTemplate(): (ctx: IgrGridRowEditActionsTemplateContext) => React.ReactNode

Returns (ctx: IgrGridRowEditActionsTemplateContext) => React.ReactNode

Gets the row edit actions template.

 
set rowEditActionsTemplate(value: (ctx: IgrGridRowEditActionsTemplateContext) => React.ReactNode): void

Parameters

Returns void

rowEditTextTemplate

Section titled "rowEditTextTemplate"

Inherited from: IgcGridBaseDirective 

get rowEditTextTemplate(): (ctx: IgrGridRowEditTextTemplateContext) => React.ReactNode

Returns (ctx: IgrGridRowEditTextTemplateContext) => React.ReactNode

Gets the row edit text template.

 
set rowEditTextTemplate(value: (ctx: IgrGridRowEditTextTemplateContext) => React.ReactNode): void

Parameters

Returns void

rowExpandedIndicatorTemplate

Section titled "rowExpandedIndicatorTemplate"

Inherited from: IgcGridBaseDirective 

get rowExpandedIndicatorTemplate(): (ctx: IgrGridRowTemplateContext) => React.ReactNode

Returns (ctx: IgrGridRowTemplateContext) => React.ReactNode

Gets the row expand indicator template.

 
set rowExpandedIndicatorTemplate(value: (ctx: IgrGridRowTemplateContext) => React.ReactNode): void

Parameters

Returns void

rowHeight

Section titled "rowHeight"

Inherited from: IgcGridBaseDirective 

get rowHeight(): number

Returns number

Gets/Sets the row height.

 
set rowHeight(value: number): void

Parameters

  • value: number

Returns void

rowList

Section titled "rowList"

Inherited from: IgcGridBaseDirective

A list of grid row.

 
get rowList(): IgrRowDirective[]

Returns IgrRowDirective[]

rowLoadingIndicatorTemplate

Section titled "rowLoadingIndicatorTemplate" 
get rowLoadingIndicatorTemplate(): (ctx: void) => React.ReactNode

Returns (ctx: void) => React.ReactNode

Template for the row loading indicator when load on demand is enabled.

 
set rowLoadingIndicatorTemplate(value: (ctx: void) => React.ReactNode): void

Parameters

  • value: (ctx: void) => React.ReactNode

Returns void

rowSelection

Section titled "rowSelection"

Inherited from: IgcGridBaseDirective 

get rowSelection(): GridSelectionMode

Returns GridSelectionMode

Gets/Sets row selection mode

 
set rowSelection(value: GridSelectionMode): void

Parameters

Returns void

rowSelectorTemplate

Section titled "rowSelectorTemplate"

Inherited from: IgcGridBaseDirective 

get rowSelectorTemplate(): (ctx: IgrRowSelectorTemplateContext) => React.ReactNode

Returns (ctx: IgrRowSelectorTemplateContext) => React.ReactNode

Gets the row selector template.

 
set rowSelectorTemplate(value: (ctx: IgrRowSelectorTemplateContext) => React.ReactNode): void

Parameters

Returns void

rowStyles

Section titled "rowStyles"

Inherited from: IgcGridBaseDirective 

get rowStyles(): any

Returns any

Sets conditional style properties on the grid row element. It accepts an object literal where the keys are the style properties and the value is an expression to be evaluated.

 
set rowStyles(value: any): void

Parameters

  • value: any

Returns void

selectedCells

Section titled "selectedCells"

Returns an array of the selected grid cells.

 
get selectedCells(): IgrCellType[]

Returns IgrCellType[]

selectedRows

Section titled "selectedRows"

Inherited from: IgcGridBaseDirective 

get selectedRows(): any[]

Returns any[]

Gets/Sets the current selection state.

 
set selectedRows(value: any[]): void

Parameters

  • value: any[]

Returns void

selectRowOnClick

Section titled "selectRowOnClick"

Inherited from: IgcGridBaseDirective 

get selectRowOnClick(): boolean

Returns boolean

Gets/Sets whether clicking over a row should select/deselect it

 
set selectRowOnClick(value: boolean): void

Parameters

  • value: boolean

Returns void

shouldGenerate

Section titled "shouldGenerate"

Inherited from: IgcGridBaseDirective 

get shouldGenerate(): boolean

Returns boolean

Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid

 
set shouldGenerate(value: boolean): void

Parameters

  • value: boolean

Returns void

showSummaryOnCollapse

Section titled "showSummaryOnCollapse"

Inherited from: IgcGridBaseDirective 

get showSummaryOnCollapse(): boolean

Returns boolean

Controls whether the summary row is visible when groupBy/parent row is collapsed.

 
set showSummaryOnCollapse(value: boolean): void

Parameters

  • value: boolean

Returns void

snackbarDisplayTime

Section titled "snackbarDisplayTime"

Inherited from: IgcGridBaseDirective 

get snackbarDisplayTime(): number

Returns number

Gets/Sets the display time for the row adding snackbar notification.

 
set snackbarDisplayTime(value: number): void

Parameters

  • value: number

Returns void

sortAscendingHeaderIconTemplate

Section titled "sortAscendingHeaderIconTemplate"

Inherited from: IgcGridBaseDirective 

get sortAscendingHeaderIconTemplate(): (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

Returns (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.

 
set sortAscendingHeaderIconTemplate(value: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode): void

Parameters

Returns void

sortDescendingHeaderIconTemplate

Section titled "sortDescendingHeaderIconTemplate"

Inherited from: IgcGridBaseDirective 

get sortDescendingHeaderIconTemplate(): (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

Returns (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.

 
set sortDescendingHeaderIconTemplate(value: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode): void

Parameters

Returns void

sortHeaderIconTemplate

Section titled "sortHeaderIconTemplate"

Inherited from: IgcGridBaseDirective 

get sortHeaderIconTemplate(): (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

Returns (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.

 
set sortHeaderIconTemplate(value: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode): void

Parameters

Returns void

sortingExpressions

Section titled "sortingExpressions"

Inherited from: IgcGridBaseDirective 

get sortingExpressions(): IgrSortingExpression[]

Returns IgrSortingExpression[]

Gets/Sets the sorting state.

 
set sortingExpressions(value: IgrSortingExpression[]): void

Parameters

Returns void

sortingOptions

Section titled "sortingOptions"

Inherited from: IgcGridBaseDirective 

get sortingOptions(): IgrSortingOptions

Returns IgrSortingOptions

Gets/Sets the sorting options - single or multiple sorting. Accepts an ISortingOptions object with any of the mode properties.

 
set sortingOptions(value: IgrSortingOptions): void

Parameters

Returns void

sortStrategy

Section titled "sortStrategy"

Inherited from: IgcGridBaseDirective 

get sortStrategy(): IgrGridSortingStrategy

Returns IgrGridSortingStrategy

Gets/Sets the sorting strategy of the grid.

 
set sortStrategy(value: IgrGridSortingStrategy): void

Parameters

Returns void

summaryCalculationMode

Section titled "summaryCalculationMode"

Inherited from: IgcGridBaseDirective 

get summaryCalculationMode(): GridSummaryCalculationMode

Returns GridSummaryCalculationMode

Gets/Sets the summary calculation mode.

 
set summaryCalculationMode(value: GridSummaryCalculationMode): void

Parameters

Returns void

summaryPosition

Section titled "summaryPosition"

Inherited from: IgcGridBaseDirective 

get summaryPosition(): GridSummaryPosition

Returns GridSummaryPosition

Gets/Sets the summary position.

 
set summaryPosition(value: GridSummaryPosition): void

Parameters

Returns void

summaryRowHeight

Section titled "summaryRowHeight"

Inherited from: IgcGridBaseDirective 

get summaryRowHeight(): number

Returns number

Get/Set summary row height

 
set summaryRowHeight(value: number): void

Parameters

  • value: number

Returns void

toolbar

Section titled "toolbar"

Inherited from: IgcGridBaseDirective 

get toolbar(): IgrGridToolbarComponent[]

Returns IgrGridToolbarComponent[]

totalRecords

Section titled "totalRecords"

Inherited from: IgcGridBaseDirective 

get totalRecords(): number

Returns number

Returns the total number of records.

 
set totalRecords(value: number): void

Parameters

  • value: number

Returns void

transactions

Section titled "transactions"

Inherited from: IgcGridBaseDirective

Get transactions service for the grid.

 
get transactions(): TransactionService

Returns TransactionService

unpinnedColumns

Section titled "unpinnedColumns"

Inherited from: IgcGridBaseDirective

Gets an array of unpinned columns.

 
get unpinnedColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

validationTrigger

Section titled "validationTrigger"

Inherited from: IgcGridBaseDirective 

get validationTrigger(): GridValidationTrigger

Returns GridValidationTrigger

Gets/Sets the trigger for validators used when editing the grid.

 
set validationTrigger(value: GridValidationTrigger): void

Parameters

Returns void

virtualizationState

Section titled "virtualizationState"

Inherited from: IgcGridBaseDirective

Returns the state of the grid virtualization.

 
get virtualizationState(): IgrForOfState

Returns IgrForOfState

visibleColumns

Section titled "visibleColumns"

Inherited from: IgcGridBaseDirective

Returns an array of visible columns.

 
get visibleColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

width

Section titled "width"

Inherited from: IgcGridBaseDirective 

get width(): string

Returns string

Gets/Sets the width of the grid.

 
set width(value: string): void

Parameters

  • value: string

Returns void

Methods

Section titled "Methods"

addRow

Section titled "addRow"

Creates a new tree grid row with the given data. If a parentRowID is not specified, the newly created row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches the specified parentRowID. If the parentRowID does not exist, an error would be thrown.

 
addRow(data: any, parentRowID: any): void

Parameters

  • data: any
  • parentRowID: any

Returns void

beginAddRowById

Section titled "beginAddRowById"

Inherited from: IgcGridBaseDirective

Enters add mode by spawning the UI under the specified row by rowID.

 
beginAddRowById(rowID: any, asChild: boolean): void

Parameters

  • rowID: any

    The rowID to spawn the add row UI for, or null to spawn it as the first record in the data view
  • asChild: boolean

    Whether the record should be added as a child. Only applicable to igxTreeGrid.

Returns void

beginAddRowByIndex

Section titled "beginAddRowByIndex"

Enters add mode by spawning the UI with the context of the specified row by index.

 
beginAddRowByIndex(index: number, asChild: boolean): void

Parameters

  • index: number

    The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length
  • asChild: boolean

    Whether the record should be added as a child. Only applicable to igxTreeGrid.

Returns void

clearCellSelection

Section titled "clearCellSelection"

Inherited from: IgcGridBaseDirective

Deselect selected cells.

 
clearCellSelection(): void

Returns void

clearFilter

Section titled "clearFilter"

Inherited from: IgcGridBaseDirective

If name is provided, clears the filtering state of the corresponding column.

 
clearFilter(name: string): void

Parameters

  • name: string

Returns void

clearSearch

Section titled "clearSearch"

Inherited from: IgcGridBaseDirective

Removes all the highlights in the cell.

 
clearSearch(): void

Returns void

clearSort

Section titled "clearSort"

Inherited from: IgcGridBaseDirective

If name is provided, clears the sorting state of the corresponding column.

 
clearSort(name: string): void

Parameters

  • name: string

Returns void

closeAdvancedFilteringDialog

Section titled "closeAdvancedFilteringDialog"

Inherited from: IgcGridBaseDirective

Closes the advanced filtering dialog.

 
closeAdvancedFilteringDialog(applyChanges: boolean): void

Parameters

  • applyChanges: boolean

    indicates whether the changes should be applied

Returns void

collapseAll

Section titled "collapseAll"

Collapses all rows.

 
collapseAll(): void

Returns void

collapseRow

Section titled "collapseRow"

Inherited from: IgcGridBaseDirective

Collapses the row by its id.

 
collapseRow(rowID: any): void

Parameters

  • rowID: any

    The row id - primaryKey value or the data record instance.

Returns void

deleteRow

Section titled "deleteRow"

Inherited from: IgcGridBaseDirective

Removes the grid row and the corresponding data record by primary key.

 
deleteRow(rowSelector: any): any

Parameters

  • rowSelector: any

Returns any

deselectAllColumns

Section titled "deselectAllColumns"

Inherited from: IgcGridBaseDirective

Deselects all columns

 
deselectAllColumns(): void

Returns void

deselectAllRows

Section titled "deselectAllRows"

Inherited from: IgcGridBaseDirective

Deselects all rows

 
deselectAllRows(onlyFilterData: boolean): void

Parameters

  • onlyFilterData: boolean

Returns void

deselectColumns

Section titled "deselectColumns"

Inherited from: IgcGridBaseDirective

Deselect specified columns by field.

 
deselectColumns(columns: string[] | IgrColumnComponent[]): void

Parameters

  • columns: string[] | IgrColumnComponent[]

Returns void

deselectRows

Section titled "deselectRows"

Inherited from: IgcGridBaseDirective

Deselect specified rows by ID.

 
deselectRows(rowIDs: any[]): void

Parameters

  • rowIDs: any[]

Returns void

disableSummaries

Section titled "disableSummaries"

Inherited from: IgcGridBaseDirective

Disable summaries for the specified column.

 
disableSummaries(rest: any[]): void

Parameters

  • rest: any[]

Returns void

enableSummaries

Section titled "enableSummaries"

Inherited from: IgcGridBaseDirective

Enables summaries for the specified column and applies your customSummary.

 
enableSummaries(rest: any[]): void

Parameters

  • rest: any[]

Returns void

endEdit

Section titled "endEdit"

Inherited from: IgcGridBaseDirective

Finishes the row transactions on the current row and returns whether the grid editing was canceled.

 
endEdit(commit: boolean, evt: any): boolean

Parameters

  • commit: boolean
  • evt: any

Returns boolean

expandAll

Section titled "expandAll"

Expands all rows.

 
expandAll(): void

Returns void

expandRow

Section titled "expandRow"

Inherited from: IgcGridBaseDirective

Expands the row by its id.

 
expandRow(rowID: any): void

Parameters

  • rowID: any

    The row id - primaryKey value or the data record instance.

Returns void

filter

Section titled "filter"

Inherited from: IgcGridBaseDirective

Filters a single column.

 
filter(name: string, value: any, conditionOrExpressionTree: IgrFilteringExpressionsTree | IgrFilteringOperation, ignoreCase: boolean): void

Parameters

Returns void

filterGlobal

Section titled "filterGlobal"

Inherited from: IgcGridBaseDirective

Filters all the column in the grid with the same condition.

 
filterGlobal(value: any, condition: any, ignoreCase: any): void

Parameters

  • value: any
  • condition: any
  • ignoreCase: any

Returns void

findNext

Section titled "findNext"

Inherited from: IgcGridBaseDirective

Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.

 
findNext(text: string, caseSensitive: boolean, exactMatch: boolean): number

Parameters

  • text: string

    the string to search.
  • caseSensitive: boolean

    optionally, if the search should be case sensitive (defaults to false).
  • exactMatch: boolean

    optionally, if the text should match the entire value (defaults to false).

Returns number

findPrev

Section titled "findPrev"

Inherited from: IgcGridBaseDirective

Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.

 
findPrev(text: string, caseSensitive: boolean, exactMatch: boolean): number

Parameters

  • text: string

    the string to search.
  • caseSensitive: boolean

    optionally, if the search should be case sensitive (defaults to false).
  • exactMatch: boolean

    optionally, if the text should match the entire value (defaults to false).

Returns number

getCellByColumn

Section titled "getCellByColumn"

Returns a CellType object that matches the conditions.

 
getCellByColumn(rowIndex: number, columnField: string): IgrCellType

Parameters

  • rowIndex: number
  • columnField: string

Returns IgrCellType

getCellByKey

Section titled "getCellByKey"

Returns a CellType object that matches the conditions.

 
getCellByKey(rowSelector: any, columnField: string): IgrCellType

Parameters

  • rowSelector: any

    match any rowID
  • columnField: string

Returns IgrCellType

getColumnByName

Section titled "getColumnByName"

Inherited from: IgcGridBaseDirective

Returns the column by field name.

 
getColumnByName(name: string): IgrColumnComponent

Parameters

  • name: string

Returns IgrColumnComponent

getColumnByVisibleIndex

Section titled "getColumnByVisibleIndex"

Inherited from: IgcGridBaseDirective 

getColumnByVisibleIndex(index: number): IgrColumnComponent

Parameters

  • index: number

Returns IgrColumnComponent

getDefaultExpandState

Section titled "getDefaultExpandState" 
getDefaultExpandState(record: IgrTreeGridRecord): boolean

Parameters

Returns boolean

getHeaderGroupWidth

Section titled "getHeaderGroupWidth"

Inherited from: IgcGridBaseDirective

Gets the width to be set on grid header group.

 
getHeaderGroupWidth(column: IgrColumnComponent): string

Parameters

  • column: IgrColumnComponent

Returns string

getNextCell

Section titled "getNextCell"

Inherited from: IgcGridBaseDirective

Returns ICellPosition which defines the next cell, according to the current position, that match specific criteria.

 
getNextCell(currRowIndex: number, curVisibleColIndex: number, callback: any): IgrCellPosition

Parameters

  • currRowIndex: number
  • curVisibleColIndex: number
  • callback: any

Returns IgrCellPosition

getPinnedEndWidth

Section titled "getPinnedEndWidth"

Inherited from: IgcGridBaseDirective

Gets calculated width of the pinned areas.

 
getPinnedEndWidth(takeHidden: boolean): void

Parameters

  • takeHidden: boolean

    If we should take into account the hidden columns in the pinned area.

Returns void

getPinnedStartWidth

Section titled "getPinnedStartWidth"

Inherited from: IgcGridBaseDirective

Gets calculated width of the pinned areas.

 
getPinnedStartWidth(takeHidden: boolean): void

Parameters

  • takeHidden: boolean

    If we should take into account the hidden columns in the pinned area.

Returns void

getPreviousCell

Section titled "getPreviousCell"

Inherited from: IgcGridBaseDirective

Returns ICellPosition which defines the previous cell, according to the current position, that match specific criteria.

 
getPreviousCell(currRowIndex: number, curVisibleColIndex: number, callback: any): IgrCellPosition

Parameters

  • currRowIndex: number
  • curVisibleColIndex: number
  • callback: any

Returns IgrCellPosition

getRowByIndex

Section titled "getRowByIndex"

Returns the tree grid row by index.

 
getRowByIndex(index: number): IgrRowType

Parameters

  • index: number

Returns IgrRowType

getRowByKey

Section titled "getRowByKey"

Returns the RowType object by the specified primary key.

 
getRowByKey(key: any): IgrRowType

Parameters

  • key: any

Returns IgrRowType

getRowData

Section titled "getRowData"

Inherited from: IgcGridBaseDirective

Returns the data that is contained in the row component.

 
getRowData(rowSelector: any): any

Parameters

  • rowSelector: any

    correspond to rowID

Returns any

getSelectedColumnsData

Section titled "getSelectedColumnsData"

Inherited from: IgcGridBaseDirective

Returns an array of the current columns selection in the form of [{ column.field: cell.value }, ...].

 
getSelectedColumnsData(formatters: boolean, headers: boolean): void

Parameters

  • formatters: boolean
  • headers: boolean

Returns void

getSelectedData

Section titled "getSelectedData"

Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...].

 
getSelectedData(formatters: boolean, headers: boolean): any[]

Parameters

  • formatters: boolean
  • headers: boolean

Returns any[]

getSelectedRanges

Section titled "getSelectedRanges"

Inherited from: IgcGridBaseDirective

Get the currently selected ranges in the grid.

 
getSelectedRanges(): IgrGridSelectionRange[]

Returns IgrGridSelectionRange[]

isRecordPinnedByIndex

Section titled "isRecordPinnedByIndex"

Inherited from: IgcGridBaseDirective

Returns whether the record is pinned or not.

 
isRecordPinnedByIndex(rowIndex: number): void

Parameters

  • rowIndex: number

    Index of the record in the filteredSortedData collection.

Returns void

markForCheck

Section titled "markForCheck"

Inherited from: IgcGridBaseDirective

Triggers change detection for the grid. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused:

 
markForCheck(): void

Returns void

moveColumn

Section titled "moveColumn"

Inherited from: IgcGridBaseDirective

Places a column before or after the specified target column.

 
moveColumn(column: IgrColumnComponent, target: IgrColumnComponent, pos: DropPosition): void

Parameters

  • column: IgrColumnComponent
  • target: IgrColumnComponent
  • pos: DropPosition

Returns void

Section titled "navigateTo"

Inherited from: IgcGridBaseDirective

Navigates to a position in the grid based on provided rowindex and visibleColumnIndex.

 
navigateTo(rowIndex: number, visibleColIndex: number, cb: any): void

Parameters

  • rowIndex: number
  • visibleColIndex: number
  • cb: any

Returns void

openAdvancedFilteringDialog

Section titled "openAdvancedFilteringDialog"

Inherited from: IgcGridBaseDirective

Opens the advanced filtering dialog.

 
openAdvancedFilteringDialog(overlaySettings: IgrOverlaySettings): void

Parameters

Returns void

pinColumn

Section titled "pinColumn"

Inherited from: IgcGridBaseDirective

Pins a column by field name.

 
pinColumn(columnName: string, index: number, pinningPosition: ColumnPinningPosition): boolean

Parameters

Returns boolean

pinRow

Section titled "pinRow"

Pin the row by its id.

 
pinRow(rowID: any, index: number): boolean

Parameters

  • rowID: any

    The row id - primaryKey value or the data record instance.
  • index: number

    The index at which to insert the row in the pinned collection.

Returns boolean

recalculateAutoSizes

Section titled "recalculateAutoSizes"

Inherited from: IgcGridBaseDirective

Recalculates all widths of columns that have size set to auto.

 
recalculateAutoSizes(): void

Returns void

reflow

Section titled "reflow"

Inherited from: IgcGridBaseDirective

Recalculates grid width/height dimensions.

 
reflow(): void

Returns void

refreshSearch

Section titled "refreshSearch"

Inherited from: IgcGridBaseDirective

Reapplies the existing search.

 
refreshSearch(updateActiveInfo: boolean, endEdit: boolean): number

Parameters

  • updateActiveInfo: boolean
  • endEdit: boolean

Returns number

selectAllColumns

Section titled "selectAllColumns"

Inherited from: IgcGridBaseDirective

Selects all columns

 
selectAllColumns(): void

Returns void

selectAllRows

Section titled "selectAllRows"

Inherited from: IgcGridBaseDirective

Selects all rows

 
selectAllRows(onlyFilterData: boolean): void

Parameters

  • onlyFilterData: boolean

Returns void

selectColumns

Section titled "selectColumns"

Inherited from: IgcGridBaseDirective

Select specified columns.

 
selectColumns(columns: string[] | IgrColumnComponent[], clearCurrentSelection: boolean): void

Parameters

  • columns: string[] | IgrColumnComponent[]
  • clearCurrentSelection: boolean

    if true clears the current selection

Returns void

selectedColumns

Section titled "selectedColumns"

Inherited from: IgcGridBaseDirective

Get current selected columns.

 
selectedColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

selectRange

Section titled "selectRange"

Inherited from: IgcGridBaseDirective

Select range(s) of cells between certain rows and columns of the grid.

 
selectRange(arg: IgrGridSelectionRange[]): void

Parameters

Returns void

selectRows

Section titled "selectRows"

Inherited from: IgcGridBaseDirective

Select specified rows by ID.

 
selectRows(rowIDs: any[], clearCurrentSelection: boolean): void

Parameters

  • rowIDs: any[]
  • clearCurrentSelection: boolean

    if true clears the current selection

Returns void

sort

Section titled "sort"

Inherited from: IgcGridBaseDirective

Sort a single column.

 
sort(expression: IgrSortingExpression[]): void

Parameters

Returns void

toggleColumnVisibility

Section titled "toggleColumnVisibility"

Inherited from: IgcGridBaseDirective

Toggles the specified column's visibility.

 
toggleColumnVisibility(args: IgrColumnVisibilityChangedEventArgs): void

Parameters

Returns void

toggleRow

Section titled "toggleRow"

Inherited from: IgcGridBaseDirective

Toggles the row by its id.

 
toggleRow(rowID: any): void

Parameters

  • rowID: any

    The row id - primaryKey value or the data record instance.

Returns void

unpinColumn

Section titled "unpinColumn"

Inherited from: IgcGridBaseDirective

Unpins a column by field name. Returns whether the operation is successful.

 
unpinColumn(columnName: string, index: number): boolean

Parameters

  • columnName: string
  • index: number

Returns boolean

unpinRow

Section titled "unpinRow"

Unpin the row by its id.

 
unpinRow(rowID: any): boolean

Parameters

  • rowID: any

    The row id - primaryKey value or the data record instance.

Returns boolean

updateCell

Section titled "updateCell"

Inherited from: IgcGridBaseDirective

Updates the grid row and the corresponding data record by primary key.

 
updateCell(value: any, rowSelector: any, column: string): void

Parameters

  • value: any

    the new value which is to be set.
  • rowSelector: any

    corresponds to rowID.
  • column: string

    corresponds to column field.

Returns void

updateRow

Section titled "updateRow"

Inherited from: IgcGridBaseDirective

Updates the grid row

 
updateRow(value: any, rowSelector: any): void

Parameters

  • value: any
  • rowSelector: any

    correspond to rowID

Returns void

Events

Section titled "Events"

onActiveNodeChange

Section titled "onActiveNodeChange" 
onActiveNodeChange(args: CustomEvent<IgrActiveNodeChangeEventArgs>): void

Parameters

Returns void

onAdvancedFilteringExpressionsTreeChange

Section titled "onAdvancedFilteringExpressionsTreeChange" 
onAdvancedFilteringExpressionsTreeChange(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

Returns void

onCellClick

Section titled "onCellClick" 
onCellClick(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

onCellEdit

Section titled "onCellEdit" 
onCellEdit(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onCellEditDone

Section titled "onCellEditDone" 
onCellEditDone(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onCellEditEnter

Section titled "onCellEditEnter" 
onCellEditEnter(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onCellEditExit

Section titled "onCellEditExit" 
onCellEditExit(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onChildrenResolved

Section titled "onChildrenResolved" 
onChildrenResolved(args: CustomEvent<void>): void

Parameters

Returns void

onColumnInit

Section titled "onColumnInit" 
onColumnInit(args: CustomEvent<IgrColumnComponent>): void

Parameters

Returns void

onColumnMoving

Section titled "onColumnMoving" 
onColumnMoving(args: CustomEvent<IgrColumnMovingEventArgs>): void

Parameters

Returns void

onColumnMovingEnd

Section titled "onColumnMovingEnd" 
onColumnMovingEnd(args: CustomEvent<IgrColumnMovingEndEventArgs>): void

Parameters

Returns void

onColumnMovingStart

Section titled "onColumnMovingStart" 
onColumnMovingStart(args: CustomEvent<IgrColumnMovingStartEventArgs>): void

Parameters

Returns void

onColumnPin

Section titled "onColumnPin" 
onColumnPin(args: CustomEvent<IgrPinColumnCancellableEventArgs>): void

Parameters

Returns void

onColumnPinned

Section titled "onColumnPinned" 
onColumnPinned(args: CustomEvent<IgrPinColumnEventArgs>): void

Parameters

Returns void

onColumnResized

Section titled "onColumnResized" 
onColumnResized(args: CustomEvent<IgrColumnResizeEventArgs>): void

Parameters

Returns void

onColumnsAutogenerated

Section titled "onColumnsAutogenerated" 
onColumnsAutogenerated(args: CustomEvent<IgrColumnsAutoGeneratedEventArgs>): void

Parameters

Returns void

onColumnSelectionChanging

Section titled "onColumnSelectionChanging" 
onColumnSelectionChanging(args: CustomEvent<IgrColumnSelectionEventArgs>): void

Parameters

Returns void

onColumnVisibilityChanged

Section titled "onColumnVisibilityChanged" 
onColumnVisibilityChanged(args: CustomEvent<IgrColumnVisibilityChangedEventArgs>): void

Parameters

Returns void

onColumnVisibilityChanging

Section titled "onColumnVisibilityChanging" 
onColumnVisibilityChanging(args: CustomEvent<IgrColumnVisibilityChangingEventArgs>): void

Parameters

Returns void

onContextMenu

Section titled "onContextMenu" 
onContextMenu(args: CustomEvent<IgrGridContextMenuEventArgs>): void

Parameters

Returns void

onDataChanged

Section titled "onDataChanged" 
onDataChanged(args: CustomEvent<IgrForOfDataChangeEventArgs>): void

Parameters

Returns void

onDataChanging

Section titled "onDataChanging" 
onDataChanging(args: CustomEvent<IgrForOfDataChangeEventArgs>): void

Parameters

Returns void

onDoubleClick

Section titled "onDoubleClick" 
onDoubleClick(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

onExpansionStatesChange

Section titled "onExpansionStatesChange" 
onExpansionStatesChange(args: CustomEvent<Map<any, boolean>>): void

Parameters

Returns void

onFiltering

Section titled "onFiltering" 
onFiltering(args: CustomEvent<IgrFilteringEventArgs>): void

Parameters

Returns void

onFilteringDone

Section titled "onFilteringDone" 
onFilteringDone(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

Returns void

onFilteringExpressionsTreeChange

Section titled "onFilteringExpressionsTreeChange" 
onFilteringExpressionsTreeChange(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

Returns void

onFormGroupCreated

Section titled "onFormGroupCreated" 
onFormGroupCreated(args: CustomEvent<IgrGridFormGroupCreatedEventArgs>): void

Parameters

Returns void

onGridCopy

Section titled "onGridCopy" 
onGridCopy(args: CustomEvent<IgrGridClipboardEvent>): void

Parameters

Returns void

onGridKeydown

Section titled "onGridKeydown" 
onGridKeydown(args: CustomEvent<IgrGridKeydownEventArgs>): void

Parameters

Returns void

onGridScroll

Section titled "onGridScroll" 
onGridScroll(args: CustomEvent<IgrGridScrollEventArgs>): void

Parameters

Returns void

onRangeSelected

Section titled "onRangeSelected" 
onRangeSelected(args: CustomEvent<IgrGridSelectionRange>): void

Parameters

Returns void

onRendered

Section titled "onRendered" 
onRendered(args: CustomEvent<boolean>): void

Parameters

Returns void

onRowAdd

Section titled "onRowAdd" 
onRowAdd(args: CustomEvent<IgrRowDataCancelableEventArgs>): void

Parameters

Returns void

onRowAdded

Section titled "onRowAdded" 
onRowAdded(args: CustomEvent<IgrRowDataEventArgs>): void

Parameters

Returns void

onRowClick

Section titled "onRowClick" 
onRowClick(args: CustomEvent<IgrGridRowEventArgs>): void

Parameters

Returns void

onRowDelete

Section titled "onRowDelete" 
onRowDelete(args: CustomEvent<IgrRowDataCancelableEventArgs>): void

Parameters

Returns void

onRowDeleted

Section titled "onRowDeleted" 
onRowDeleted(args: CustomEvent<IgrRowDataEventArgs>): void

Parameters

Returns void

onRowDragEnd

Section titled "onRowDragEnd" 
onRowDragEnd(args: CustomEvent<IgrRowDragEndEventArgs>): void

Parameters

Returns void

onRowDragStart

Section titled "onRowDragStart" 
onRowDragStart(args: CustomEvent<IgrRowDragStartEventArgs>): void

Parameters

Returns void

onRowEdit

Section titled "onRowEdit" 
onRowEdit(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onRowEditDone

Section titled "onRowEditDone" 
onRowEditDone(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onRowEditEnter

Section titled "onRowEditEnter" 
onRowEditEnter(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onRowEditExit

Section titled "onRowEditExit" 
onRowEditExit(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onRowPinned

Section titled "onRowPinned" 
onRowPinned(args: CustomEvent<IgrPinRowEventArgs>): void

Parameters

Returns void

onRowPinning

Section titled "onRowPinning" 
onRowPinning(args: CustomEvent<IgrPinRowEventArgs>): void

Parameters

Returns void

onRowSelectionChanging

Section titled "onRowSelectionChanging" 
onRowSelectionChanging(args: CustomEvent<IgrRowSelectionEventArgs>): void

Parameters

Returns void

onRowToggle

Section titled "onRowToggle" 
onRowToggle(args: CustomEvent<IgrRowToggleEventArgs>): void

Parameters

Returns void

onSelected

Section titled "onSelected" 
onSelected(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

onSelectedRowsChange

Section titled "onSelectedRowsChange" 
onSelectedRowsChange(args: CustomEvent<any[]>): void

Parameters

Returns void

onSorting

Section titled "onSorting" 
onSorting(args: CustomEvent<IgrSortingEventArgs>): void

Parameters

Returns void

onSortingDone

Section titled "onSortingDone" 
onSortingDone(args: CustomEvent<IgrSortingExpression[]>): void

Parameters

Returns void

onSortingExpressionsChange

Section titled "onSortingExpressionsChange" 
onSortingExpressionsChange(args: CustomEvent<IgrSortingExpression[]>): void

Parameters

Returns void

onToolbarExporting

Section titled "onToolbarExporting" 
onToolbarExporting(args: CustomEvent<IgrGridToolbarExportEventArgs>): void

Parameters

Returns void

onValidationStatusChange

Section titled "onValidationStatusChange" 
onValidationStatusChange(args: CustomEvent<IgrGridValidationStatusEventArgs>): void

Parameters

Returns void