Grid provides a way to present and manipulate tabular data.

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

data: any[]

Returns a reference to the master-detail template.

detailTemplate: (ctx: IgrGridMasterDetailContext) => React.ReactNode

Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on.

dropAreaMessage: string

Gets/Sets the template that will be rendered as a GroupBy drop area.

dropAreaTemplate: (ctx: void) => React.ReactNode

Gets the group by row selector template.

groupByRowSelectorTemplate: (ctx: IgrGroupByRowSelectorTemplateContext) => React.ReactNode

Gets/Sets a list of expansion states for group rows.

groupingExpansionState: IgrGroupByExpandState[]

Gets/Sets the group by state.

groupingExpressions: IgrGroupingExpression[]

Gets/Sets the template reference for the group row.

groupRowTemplate: (ctx: IgrGroupByRowTemplateContext) => React.ReactNode

Gets/Sets whether created groups are rendered expanded or collapsed.

groupsExpanded: boolean

Gets/Sets the grouping strategy of the grid.

groupStrategy: IgrGridGroupingStrategy

Gets/Sets whether the grouped columns should be hidden.

hideGroupedColumns: boolean

Gets/Sets the value of the id attribute.

id: string

Returns whether the GridComponent has group area.

showGroupArea: boolean

Gets/Sets the total number of records in the data source.

totalItemCount: number
addRowEmptyTemplate: (ctx: void) => React.ReactNode
advancedFilteringExpressionsTree: IgrFilteringExpressionsTree
allowAdvancedFiltering: boolean
allowFiltering: boolean
autoGenerate: boolean
autoGenerateExclude: string[]
batchEditing: boolean
cellMergeMode: GridCellMergeMode
cellSelection: GridSelectionMode
clipboardOptions: IgrClipboardOptions
columnSelection: GridSelectionMode
columnWidth: string
dataCloneStrategy: IgrDataCloneStrategy
dragGhostCustomTemplate: (ctx: IgrGridRowDragGhostContext) => React.ReactNode
dragIndicatorIconTemplate: (ctx: IgrGridEmptyTemplateContext) => React.ReactNode
emptyFilteredGridMessage: string
emptyGridMessage: string
emptyGridTemplate: (ctx: IgrGridTemplateContext) => React.ReactNode
excelStyleHeaderIconTemplate: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode
expansionStates: Map<any, boolean>
filteringExpressionsTree: IgrFilteringExpressionsTree
filteringLogic: FilteringLogic
filterMode: FilterMode
filterStrategy: IgrFilteringStrategy
headerCollapsedIndicatorTemplate: (ctx: IgrGridTemplateContext) => React.ReactNode
headerExpandedIndicatorTemplate: (ctx: IgrGridTemplateContext) => React.ReactNode
headSelectorTemplate: (ctx: IgrHeadSelectorTemplateContext) => React.ReactNode
height: string
hideRowSelectors: boolean
isLoading: boolean
loadingGridTemplate: (ctx: IgrGridTemplateContext) => React.ReactNode
locale: string
mergeStrategy: IgrGridMergeStrategy
moving: boolean
outlet: IgrOverlayOutletDirective
pagingMode: GridPagingMode
pinning: IgrPinningConfig
primaryKey: string
resourceStrings: IgrGridResourceStrings
rowAddTextTemplate: (ctx: IgrGridEmptyTemplateContext) => React.ReactNode
rowClasses: any
rowCollapsedIndicatorTemplate: (ctx: IgrGridRowTemplateContext) => React.ReactNode
rowDraggable: boolean
rowEditable: boolean
rowEditActionsTemplate: (ctx: IgrGridRowEditActionsTemplateContext) => React.ReactNode
rowEditTextTemplate: (ctx: IgrGridRowEditTextTemplateContext) => React.ReactNode
rowExpandedIndicatorTemplate: (ctx: IgrGridRowTemplateContext) => React.ReactNode
rowHeight: number
rowSelection: GridSelectionMode
rowSelectorTemplate: (ctx: IgrRowSelectorTemplateContext) => React.ReactNode
rowStyles: any
selectedRows: any[]
selectRowOnClick: boolean
shouldGenerate: boolean
showSummaryOnCollapse: boolean
snackbarDisplayTime: number
sortAscendingHeaderIconTemplate: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode
sortDescendingHeaderIconTemplate: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode
sortHeaderIconTemplate: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode
sortingExpressions: IgrSortingExpression[]
sortingOptions: IgrSortingOptions
sortStrategy: IgrGridSortingStrategy
summaryCalculationMode: GridSummaryCalculationMode
summaryPosition: GridSummaryPosition
summaryRowHeight: number
totalRecords: number
validationTrigger: GridValidationTrigger
width: string

Gets the hierarchical representation of the group by records.

get groupsRecords(): IgrGroupByRecord[]

Returns IgrGroupByRecord[]

Returns an array of the selected GridCells.

get selectedCells(): IgrCellType[]

Returns IgrCellType[]

get actionStripComponents(): IgcActionStripToken[]

Returns IgcActionStripToken[]

get columnList(): IgrColumnComponent[]

Returns IgrColumnComponent[]

Gets an array of ColumnComponents.

get columns(): IgrColumnComponent[]

Example

const colums = this.grid.columns.

Returns IgrColumnComponent[]

A list of currently rendered GridRowComponent's.

get dataRowList(): IgrRowDirective[]

Example

const dataList = this.grid.dataRowList;

Returns IgrRowDirective[]

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

get dataView(): any[]

Example

const dataView = this.grid.dataView;

Returns any[]

Gets the default row height.

get defaultRowHeight(): number

Example

const rowHeigh = this.grid.defaultRowHeight;

Returns number

Returns an array of objects containing the filtered data.

get filteredData(): any

Example

let filteredData = this.grid.filteredData;

Returns any

Returns an array containing the filtered sorted data.

get filteredSortedData(): any[]

Example

const filteredSortedData = this.grid1.filteredSortedData;

Returns any[]

Gets the number of hidden columns.

get hiddenColumnsCount(): number

Example

const hiddenCol = this.grid.hiddenColumnsCount;
``

Returns number

Represents the last search information.

get lastSearchInfo(): IgrSearchInfo

Returns IgrSearchInfo

get paginationComponents(): IgrPaginatorComponent[]

Returns IgrPaginatorComponent[]

Gets an array of the pinned ColumnComponents.

get pinnedColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedColumns.

Returns IgrColumnComponent[]

Gets the number of pinned columns.

get pinnedColumnsCount(): number

Returns number

Gets an array of the pinned to the right ColumnComponents.

get pinnedEndColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedEndColumns.

Returns IgrColumnComponent[]

Gets an array of the pinned RowComponents.

get pinnedRows(): IgrGridRowComponent[]

Example

const pinnedRow = this.grid.pinnedRows;

Returns IgrGridRowComponent[]

Gets an array of the pinned to the left ColumnComponents.

get pinnedStartColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedStartColumns.

Returns IgrColumnComponent[]

A list of GridRowComponent.

get rowList(): IgrRowDirective[]

Example

const rowList = this.grid.rowList;

Returns IgrRowDirective[]

get toolbar(): IgrGridToolbarComponent[]

Returns IgrGridToolbarComponent[]

Gets an array of unpinned ColumnComponents.

get unpinnedColumns(): IgrColumnComponent[]

Example

const unpinnedColumns = this.grid.unpinnedColumns.

Returns IgrColumnComponent[]

Returns the state of the grid virtualization.

get virtualizationState(): IgrForOfState

Example

const gridVirtState = this.grid1.virtualizationState;

Returns IgrForOfState

Returns an array of visible ColumnComponents.

get visibleColumns(): IgrColumnComponent[]

Example

const visibleColumns = this.grid.visibleColumns.

Returns IgrColumnComponent[]

Clears grouping for particular column, array of columns or all columns.

clearGrouping(name: string): void

Parameters

  • name: string

    Name of column or array of column names to be ungrouped.

Returns void

Example

this.grid.clearGrouping(); //clears all grouping
this.grid.clearGrouping("ID"); //ungroups a single column
this.grid.clearGrouping(["ID", "Column1", "Column2"]); //ungroups multiple columns

Deselect all rows within a group.

deselectRowsInGroup(groupRow: IgrGroupByRecord): void

Parameters

Returns void

Example

public groupRow: IGroupByRecord;
this.grid.deselectRowsInGroup(this.groupRow);

Expands the specified group and all of its parent groups.

fullyExpandGroup(groupRow: IgrGroupByRecord): void

Parameters

Returns void

Example

public groupRow: IGroupByRecord;
this.grid.fullyExpandGroup(this.groupRow);

Returns a CellType object that matches the conditions.

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

Parameters

  • rowIndex: number
  • columnField: string

Returns IgrCellType

Example

const myCell = this.grid1.getCellByColumn(2, "UnitPrice");

Returns a CellType object that matches the conditions.

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

Parameters

  • rowSelector: any

    match any rowID

  • columnField: string

Returns IgrCellType

Example

grid.getCellByKey(1, 'index');

Returns the GridRow by index.

getRowByIndex(index: number): IgrRowType

Parameters

  • index: number

Returns IgrRowType

Example

const myRow = grid.getRowByIndex(1);

Returns GridRow object by the specified primary key.

getRowByKey(key: any): IgrRowType

Parameters

  • key: any

Returns IgrRowType

Example

const myRow = this.grid1.getRowByKey("cell5");

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[]

Groups by a new ColumnComponent based on the provided expression, or modifies an existing one.

groupBy(expression: IgrGroupingExpression[]): void

Parameters

Returns void

Example

this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
this.grid.groupBy([
    { fieldName: name1, dir: SortingDirection.Asc, ignoreCase: false },
    { fieldName: name2, dir: SortingDirection.Desc, ignoreCase: true },
    { fieldName: name3, dir: SortingDirection.Desc, ignoreCase: false }
]);

Returns if a group is expanded or not.

isExpandedGroup(group: IgrGroupByRecord): boolean

Parameters

Returns boolean

Example

public groupRow: IGroupByRecord;
const expandedGroup = this.grid.isExpandedGroup(this.groupRow);

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

Example

this.grid.pinRow(rowID);

Select all rows within a group.

selectRowsInGroup(groupRow: IgrGroupByRecord, clearPrevSelection: boolean): void

Parameters

Returns void

Example

this.grid.selectRowsInGroup(this.groupRow, true);

Toggles the expansion state of all group rows recursively.

toggleAllGroupRows(): void

Returns void

Example

this.grid.toggleAllGroupRows;

Toggles the expansion state of a group.

toggleGroup(groupRow: IgrGroupByRecord): void

Parameters

Returns void

Example

public groupRow: IGroupByRecord;
const toggleExpGroup = this.grid.toggleGroup(this.groupRow);

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

Example

this.grid.unpinRow(rowID);

Creates a new GridRowComponent and adds the data record to the end of the data source.

addRow(data: any): void

Parameters

  • data: any

Returns void

Example

this.grid1.addRow(record);

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

Example

this.grid.beginAddRowById('ALFKI');
this.grid.beginAddRowById('ALFKI', true);
this.grid.beginAddRowById(null);

Enters add mode by spawning the UI at the specified index.

beginAddRowByIndex(index: number): void

Parameters

  • index: number

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

Returns void

Example

this.grid.beginAddRowByIndex(0);

Deselect selected cells.

clearCellSelection(): void

Returns void

Example

this.grid.clearCellSelection();

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

clearFilter(name: string): void

Parameters

  • name: string

Returns void

Example

this.grid.clearFilter();

Removes all the highlights in the cell.

clearSearch(): void

Returns void

Example

this.grid.clearSearch();

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

clearSort(name: string): void

Parameters

  • name: string

Returns void

Example

this.grid.clearSort();

Closes the advanced filtering dialog.

closeAdvancedFilteringDialog(applyChanges: boolean): void

Parameters

  • applyChanges: boolean

    indicates whether the changes should be applied

Returns void

Collapses all rows.

collapseAll(): void

Returns void

Example

this.grid.collapseAll();

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

Example

this.grid.collapseRow(rowID);

Removes the GridRowComponent and the corresponding data record by primary key.

deleteRow(rowSelector: any): any

Parameters

  • rowSelector: any

Returns any

Example

this.grid1.deleteRow(0);

Deselects all columns

deselectAllColumns(): void

Returns void

Example

this.grid.deselectAllColumns();

Deselects all rows

deselectAllRows(onlyFilterData: boolean): void

Parameters

  • onlyFilterData: boolean

Returns void

Example

this.grid.deselectAllRows();

Deselect specified columns by field.

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

Parameters

  • columns: string[] | IgrColumnComponent[]

Returns void

Example

this.grid.deselectColumns(['ID','Name']);

Deselect specified rows by ID.

deselectRows(rowIDs: any[]): void

Parameters

  • rowIDs: any[]

Returns void

Example

this.grid.deselectRows([1,2,5]);

Disable summaries for the specified column.

disableSummaries(rest: any[]): void

Parameters

  • rest: any[]

Returns void

Example

grid.disableSummaries('ProductName');

Enables summaries for the specified column and applies your customSummary.

enableSummaries(rest: any[]): void

Parameters

  • rest: any[]

Returns void

Example

grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);

Enable summaries for the listed columns.

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

Expands all rows.

expandAll(): void

Returns void

Example

this.grid.expandAll();

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

Example

this.grid.expandRow(rowID);

Filters a single ColumnComponent.

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

Parameters

Returns void

Filters all the ColumnComponent in the GridComponent with the same condition.

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

Parameters

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

Returns void

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

Example

this.grid.findNext("financial");

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

Example

this.grid.findPrev("financial");

Returns the ColumnComponent by field name.

getColumnByName(name: string): IgrColumnComponent

Parameters

  • name: string

Returns IgrColumnComponent

Example

const myCol = this.grid1.getColumnByName("ID");
getColumnByVisibleIndex(index: number): IgrColumnComponent

Parameters

  • index: number

Returns IgrColumnComponent

Gets the width to be set on GridHeaderGroupComponent.

getHeaderGroupWidth(column: IgrColumnComponent): string

Parameters

  • column: IgrColumnComponent

Returns string

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

Example

const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);

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

Example

const pinnedWidth = this.grid.getPinnedEndWidth();

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

Example

const pinnedWidth = this.grid.getPinnedStartWidth();

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

Example

const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);

Returns the data that is contained in the row component.

getRowData(rowSelector: any): any

Parameters

  • rowSelector: any

    correspond to rowID

Returns any

Example

const data = grid.getRowData(94741);

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

Get the currently selected ranges in the grid.

getSelectedRanges(): IgrGridSelectionRange[]

Returns IgrGridSelectionRange[]

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

Triggers change detection for the GridComponent. 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

Example

grid.markForCheck();

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

Example

grid.moveColumn(column, target);

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

Example

this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });

Opens the advanced filtering dialog.

openAdvancedFilteringDialog(overlaySettings: IgrOverlaySettings): void

Parameters

Returns void

Pins a column by field name.

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

Parameters

Returns boolean

Example

this.grid.pinColumn("ID");

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

recalculateAutoSizes(): void

Returns void

Example

this.grid1.recalculateAutoSizes();

Recalculates grid width/height dimensions.

reflow(): void

Returns void

Example

this.grid.reflow();

Reapplies the existing search.

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

Parameters

  • updateActiveInfo: boolean
  • endEdit: boolean

Returns number

Example

this.grid.refreshSearch();

Selects all columns

selectAllColumns(): void

Returns void

Example

this.grid.deselectAllColumns();

Selects all rows

selectAllRows(onlyFilterData: boolean): void

Parameters

  • onlyFilterData: boolean

Returns void

Example

this.grid.selectAllRows();
this.grid.selectAllRows(false);

Select specified columns.

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

Parameters

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

    if true clears the current selection

Returns void

Example

this.grid.selectColumns(['ID','Name'], true);

Get current selected columns.

selectedColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

Example

Returns an array with selected columns

const selectedColumns = this.grid.selectedColumns();

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

selectRange(arg: IgrGridSelectionRange[]): void

Parameters

Returns void

Select specified rows by ID.

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

Parameters

  • rowIDs: any[]
  • clearCurrentSelection: boolean

    if true clears the current selection

Returns void

Example

this.grid.selectRows([1,2,5], true);

Sort a single ColumnComponent.

sort(expression: IgrSortingExpression[]): void

Parameters

Returns void

Example

this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });

Toggles the specified column's visibility.

toggleColumnVisibility(args: IgrColumnVisibilityChangedEventArgs): void

Parameters

Returns void

Example

this.grid1.toggleColumnVisibility({
      column: this.grid1.columns[0],
      newValue: true
});

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

Example

this.grid.toggleRow(rowID);

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

Example

this.grid.pinColumn("ID");

Updates the GridRowComponent 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

Example

this.gridWithPK.updateCell('Updated', 1, 'ProductName');

Updates the GridRowComponent

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

Parameters

  • value: any
  • rowSelector: any

    correspond to rowID

Returns void

Example

grid.updateRow({
      ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')
  }, 1);
onActiveNodeChange(args: CustomEvent<IgrActiveNodeChangeEventArgs>): void

Parameters

Returns void

onAdvancedFilteringExpressionsTreeChange

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

Parameters

Returns void

onCellClick(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

onCellEdit(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onCellEditDone(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onCellEditEnter(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onCellEditExit(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onColumnInit(args: CustomEvent<IgrColumnComponent>): void

Parameters

Returns void

onColumnMoving(args: CustomEvent<IgrColumnMovingEventArgs>): void

Parameters

Returns void

onColumnMovingEnd(args: CustomEvent<IgrColumnMovingEndEventArgs>): void

Parameters

Returns void

onColumnMovingStart(args: CustomEvent<IgrColumnMovingStartEventArgs>): void

Parameters

Returns void

onColumnPin(args: CustomEvent<IgrPinColumnCancellableEventArgs>): void

Parameters

Returns void

onColumnPinned(args: CustomEvent<IgrPinColumnEventArgs>): void

Parameters

Returns void

onColumnResized(args: CustomEvent<IgrColumnResizeEventArgs>): void

Parameters

Returns void

onColumnsAutogenerated(args: CustomEvent<IgrColumnsAutoGeneratedEventArgs>): void

Parameters

Returns void

onColumnSelectionChanging(args: CustomEvent<IgrColumnSelectionEventArgs>): void

Parameters

Returns void

onColumnVisibilityChanged(args: CustomEvent<IgrColumnVisibilityChangedEventArgs>): void

Parameters

Returns void

onColumnVisibilityChanging(args: CustomEvent<IgrColumnVisibilityChangingEventArgs>): void

Parameters

Returns void

onContextMenu(args: CustomEvent<IgrGridContextMenuEventArgs>): void

Parameters

Returns void

onDataChanged(args: CustomEvent<IgrForOfDataChangeEventArgs>): void

Parameters

Returns void

onDataChanging(args: CustomEvent<IgrForOfDataChangeEventArgs>): void

Parameters

Returns void

onDataPreLoad(args: CustomEvent<IgrForOfState>): void

Parameters

Returns void

onDoubleClick(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

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

Parameters

Returns void

onFiltering(args: CustomEvent<IgrFilteringEventArgs>): void

Parameters

Returns void

onFilteringDone(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

Returns void

onFilteringExpressionsTreeChange(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

Returns void

onFormGroupCreated(args: CustomEvent<IgrGridFormGroupCreatedEventArgs>): void

Parameters

Returns void

onGridCopy(args: CustomEvent<IgrGridClipboardEvent>): void

Parameters

Returns void

onGridKeydown(args: CustomEvent<IgrGridKeydownEventArgs>): void

Parameters

Returns void

onGridScroll(args: CustomEvent<IgrGridScrollEventArgs>): void

Parameters

Returns void

onGroupingDone(args: CustomEvent<IgrGroupingDoneEventArgs>): void

Parameters

Returns void

onGroupingExpansionStateChange(args: CustomEvent<IgrGroupByExpandState[]>): void

Parameters

Returns void

onGroupingExpressionsChange(args: CustomEvent<IgrGroupingExpression[]>): void

Parameters

Returns void

onRangeSelected(args: CustomEvent<IgrGridSelectionRange>): void

Parameters

Returns void

onRendered(args: CustomEvent<boolean>): void

Parameters

Returns void

onRowAdd(args: CustomEvent<IgrRowDataCancelableEventArgs>): void

Parameters

Returns void

onRowAdded(args: CustomEvent<IgrRowDataEventArgs>): void

Parameters

Returns void

onRowClick(args: CustomEvent<IgrGridRowEventArgs>): void

Parameters

Returns void

onRowDelete(args: CustomEvent<IgrRowDataCancelableEventArgs>): void

Parameters

Returns void

onRowDeleted(args: CustomEvent<IgrRowDataEventArgs>): void

Parameters

Returns void

onRowDragEnd(args: CustomEvent<IgrRowDragEndEventArgs>): void

Parameters

Returns void

onRowDragStart(args: CustomEvent<IgrRowDragStartEventArgs>): void

Parameters

Returns void

onRowEdit(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onRowEditDone(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onRowEditEnter(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onRowEditExit(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onRowPinned(args: CustomEvent<IgrPinRowEventArgs>): void

Parameters

Returns void

onRowPinning(args: CustomEvent<IgrPinRowEventArgs>): void

Parameters

Returns void

onRowSelectionChanging(args: CustomEvent<IgrRowSelectionEventArgs>): void

Parameters

Returns void

onRowToggle(args: CustomEvent<IgrRowToggleEventArgs>): void

Parameters

Returns void

onSelected(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

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

Parameters

Returns void

onSorting(args: CustomEvent<IgrSortingEventArgs>): void

Parameters

Returns void

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

Parameters

Returns void

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

Parameters

Returns void

onToolbarExporting(args: CustomEvent<IgrGridToolbarExportEventArgs>): void

Parameters

Returns void

onValidationStatusChange(args: CustomEvent<IgrGridValidationStatusEventArgs>): void

Parameters

Returns void