Properties

activeNodeChange: CustomEvent<IgcActiveNodeChangeEventArgs>

Emmited when the active node is changed.

Example

<igx-grid [data]="data" [autoGenerate]="true" (activeNodeChange)="activeNodeChange($event)"></igx-grid>
advancedFilteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>

Emitted after advanced filtering is performed.

Remarks

Returns the advanced filtering expressions tree.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
(advancedFilteringExpressionsTreeChange)="advancedFilteringExprTreeChange($event)"></igx-grid>
cellClick: CustomEvent<IgcGridCellEventArgs>

Emitted when a cell is clicked.

Remarks

Returns the IgxGridCell.

Example

<igx-grid #grid (cellClick)="cellClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
cellEdit: CustomEvent<IgcGridEditEventArgs>

Emitted when cell has been edited.

Remarks

Event is fired after editing is completed, when the cell is exiting edit mode. This event is cancelable.

Example

<igx-grid #grid3 (cellEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
</igx-grid>
cellEditDone: CustomEvent<IgcGridEditDoneEventArgs>

Emitted after cell has been edited and editing has been committed.

Example

<igx-grid #grid3 (cellEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
</igx-grid>
cellEditEnter: CustomEvent<IgcGridEditEventArgs>

Emitted when cell enters edit mode.

Remarks

This event is cancelable.

Example

<igx-grid #grid3 (cellEditEnter)="editStart($event)" [data]="data" [primaryKey]="'ProductID'">
</igx-grid>
cellEditExit: CustomEvent<IgcGridEditDoneEventArgs>

Emitted when cell exits edit mode.

Example

<igx-grid #grid3 (cellEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'">
</igx-grid>
columnInit: CustomEvent<IgcColumnComponent>

Emitted when a column is initialized.

Remarks

Returns the column object.

Example

<igx-grid #grid [data]="localData" (columnInit)="initColumns($event)" [autoGenerate]="true"></igx-grid>
columnMoving: CustomEvent<IgcColumnMovingEventArgs>

Emitted during the column moving operation.

Remarks

Returns the source and target IgxColumnComponent objects. This event is cancelable.

Example

<igx-grid (columnMoving)="moving($event)"></igx-grid>
columnMovingEnd: CustomEvent<IgcColumnMovingEndEventArgs>

Emitted when column moving ends.

Remarks

Returns the source and target IgxColumnComponent objects.

Example

<igx-grid (columnMovingEnd)="movingEnds($event)"></igx-grid>
columnMovingStart: CustomEvent<IgcColumnMovingStartEventArgs>

Emitted when column moving starts.

Remarks

Returns the moved IgxColumnComponent object.

Example

<igx-grid (columnMovingStart)="movingStart($event)"></igx-grid>
columnPin: CustomEvent<IgcPinColumnCancellableEventArgs>

Emitted before IgxColumnComponent is pinned.

Remarks

The index at which to insert the column may be changed through the insertAtIndex property.

Example

public columnPinning(event) {
if (event.column.field === "Name") {
event.insertAtIndex = 0;
}
}
columnPinned: CustomEvent<IgcPinColumnEventArgs>

Emitted after IgxColumnComponent is pinned.

Remarks

The index that the column is inserted at may be changed through the insertAtIndex property.

Example

public columnPinning(event) {
if (event.column.field === "Name") {
event.insertAtIndex = 0;
}
}
columnResized: CustomEvent<IgcColumnResizeEventArgs>

Emitted after column is resized.

Remarks

Returns the IgxColumnComponent object's old and new width.

Example

<igx-grid #grid [data]="localData" (columnResized)="resizing($event)" [autoGenerate]="true"></igx-grid>
columnSelectionChanging: CustomEvent<IgcColumnSelectionEventArgs>

Emitted when IgxColumnComponent is selected.

Example

<igx-grid #grid (columnSelectionChanging)="columnSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>
columnVisibilityChanged: CustomEvent<IgcColumnVisibilityChangedEventArgs>

Emitted after column visibility is changed.

Remarks

Args: { column: IgxColumnComponent, newValue: boolean }

Example

<igx-grid (columnVisibilityChanged)="visibilityChanged($event)"></igx-grid>
columnVisibilityChanging: CustomEvent<IgcColumnVisibilityChangingEventArgs>

Emitted before column visibility is changed.

Remarks

Args: { column: any, newValue: boolean }

Example

<igx-grid (columnVisibilityChanging)="visibilityChanging($event)"></igx-grid>
contextMenu: CustomEvent<IgcGridContextMenuEventArgs>

Emitted when a cell or row is right clicked.

Remarks

Returns the IgxGridCell object if the immediate context menu target is a cell or an IgxGridRow otherwise.

<igx-grid #grid [data]="localData" (contextMenu)="contextMenu($event)" [autoGenerate]="true"></igx-grid>
dataChanged: CustomEvent<any>

Emitted after the grid's data view is changed because of a data operation, rebinding, etc.

Example

 <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanged)='handleDataChangedEvent()'></igx-grid>
dataChanging: CustomEvent<IgcForOfDataChangingEventArgs>

Emitted before the grid's data view is changed because of a data operation, rebinding, etc.

Example

 <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanging)='handleDataChangingEvent()'></igx-grid>
dataPreLoad: CustomEvent<IgcForOfState>

Emitted when a new chunk of data is loaded from virtualization.

Example

 <igx-hierarchical-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true" (dataPreLoad)="handleEvent()">
</igx-hierarchical-grid>
doubleClick: CustomEvent<IgcGridCellEventArgs>

Emitted when a cell is double clicked.

Remarks

Returns the IgxGridCell object.

Example

<igx-grid #grid [data]="localData" (doubleClick)="dblClick($event)" [autoGenerate]="true"></igx-grid>
filtering: CustomEvent<IgcFilteringEventArgs>

Emitted before filtering expressions are applied.

Remarks

Returns an IFilteringEventArgs object. filteringExpressions key holds the filtering expressions for the column.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filtering)="filtering($event)"></igx-grid>
filteringDone: CustomEvent<IgcFilteringExpressionsTree>

Emitted after filtering is performed through the UI.

Remarks

Returns the filtering expressions tree of the column for which filtering was performed.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filteringDone)="filteringDone($event)"></igx-grid>
filteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>

Emitted after filtering is performed.

Remarks

Returns the filtering expressions tree of the column for which filtering was performed.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
(filteringExpressionsTreeChange)="filteringExprTreeChange($event)"></igx-grid>
formGroupCreated: CustomEvent<IgcGridFormGroupCreatedEventArgs>

Emitted when formGroup is created on edit of row/cell.

Example

<igx-grid #grid (formGroupCreated)="formGroupCreated($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
gridCopy: CustomEvent<IgcGridClipboardEvent>

Emitted when a copy operation is executed.

Remarks

Fired only if copy behavior is enabled through the [clipboardOptions]IgxGridBaseDirective#clipboardOptions.

gridCreated: CustomEvent<IgcGridCreatedEventArgs>

Event emitted when a grid is being created based on this row island.

<igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
<igx-row-island [key]="'childData'" (gridCreated)="gridCreated($event)" #rowIsland>
<!-- ... -->
</igx-row-island>
</igx-hierarchical-grid>

Memberof

IgxRowIslandComponent

gridInitialized: CustomEvent<IgcGridCreatedEventArgs>

Emitted after a grid is being initialized for this row island. The emitting is done in ngAfterViewInit.

<igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
<igx-row-island [key]="'childData'" (gridInitialized)="gridInitialized($event)" #rowIsland>
<!-- ... -->
</igx-row-island>
</igx-hierarchical-grid>

Memberof

IgxRowIslandComponent

gridKeydown: CustomEvent<IgcGridKeydownEventArgs>

Emitted when keydown is triggered over element inside grid's body.

Remarks

This event is fired only if the key combination is supported in the grid. Return the target type, target object and the original event. This event is cancelable.

Example

 <igx-grid (gridKeydown)="customKeydown($event)"></igx-grid>
gridScroll: CustomEvent<IgcGridScrollEventArgs>

Emitted when grid is scrolled horizontally/vertically.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
(gridScroll)="onScroll($event)"></igx-grid>
rangeSelected: CustomEvent<IgcGridSelectionRange>

Emitted when making a range selection.

Remarks

Range selection can be made either through drag selection or through keyboard selection.

rendered: CustomEvent<any>

Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM

rowAdd: CustomEvent<IgcRowDataCancelableEventArgs>

Emmited just before the newly added row is commited.

Remarks

This event is cancelable. Returns an IRowDataCancellableEventArgs` object.

Example

<igx-grid #grid [data]="localData" (rowAdd)="rowAdd($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
rowAdded: CustomEvent<IgcRowDataEventArgs>

Emitted when a row is added.

Remarks

Returns the data for the new IgxGridRowComponent object.

Example

<igx-grid #grid [data]="localData" (rowAdded)="rowAdded($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
rowClick: CustomEvent<IgcGridRowEventArgs>

Emitted when a row is clicked.

Remarks

Returns the IgxGridRow.

Example

<igx-grid #grid (rowClick)="rowClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
rowDelete: CustomEvent<IgcRowDataCancelableEventArgs>

Emmited when deleting a row.

Remarks

This event is cancelable. Returns an IRowDataCancellableEventArgs` object.

Example

<igx-grid #grid [data]="localData" (rowDelete)="rowDelete($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
rowDeleted: CustomEvent<IgcRowDataEventArgs>

Emitted when a row is deleted.

Remarks

Returns an IRowDataEventArgs object.

Example

<igx-grid #grid [data]="localData" (rowDeleted)="rowDeleted($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>
rowDragEnd: CustomEvent<IgcRowDragEndEventArgs>

Emitted when dropping a row.

Remarks

Return the dropped row.

rowDragStart: CustomEvent<IgcRowDragStartEventArgs>

Emitted when start dragging a row.

Remarks

Return the dragged row.

rowEdit: CustomEvent<IgcGridEditEventArgs>

Emitted when exiting edit mode for a row.

Remarks

Emitted when [rowEditable]="true" & endEdit(true) is called. Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row, performing paging operation, column resizing, pinning, moving or hitting Done button inside of the rowEditingOverlay, or hitting the Enter key while editing a cell. This event is cancelable.

Example

<igx-grid #grid3 (rowEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
</igx-grid>
rowEditDone: CustomEvent<IgcGridEditDoneEventArgs>

Emitted after exiting edit mode for a row and editing has been committed.

Remarks

Emitted when [rowEditable]="true" & endEdit(true) is called. Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row, performing paging operation, column resizing, pinning, moving or hitting Done button inside of the rowEditingOverlay, or hitting the Enter key while editing a cell.

Example

<igx-grid #grid3 (rowEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
</igx-grid>
rowEditEnter: CustomEvent<IgcGridEditEventArgs>

Emitted when a row enters edit mode.

Remarks

Emitted when [rowEditable]="true". This event is cancelable.

Example

<igx-grid #grid3 (rowEditEnter)="editStart($event)" [primaryKey]="'ProductID'" [rowEditable]="true">
</igx-grid>
rowEditExit: CustomEvent<IgcGridEditDoneEventArgs>

Emitted when row editing is canceled.

Remarks

Emits when [rowEditable]="true" & endEdit(false) is called. Emitted when changing hitting Esc key during cell editing and when click on the Cancel button in the row editing overlay.

Example

<igx-grid #grid3 (rowEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
</igx-grid>
rowPinned: CustomEvent<IgcPinRowEventArgs>

Emitted when the pinned state of a row is changed.

Example

<igx-grid [data]="employeeData" (rowPinned)="rowPin($event)" [autoGenerate]="true"></igx-grid>
rowPinning: CustomEvent<IgcPinRowEventArgs>

Emitted when the pinned state of a row is changed.

Example

<igx-grid [data]="employeeData" (rowPinning)="rowPin($event)" [autoGenerate]="true"></igx-grid>
rowSelectionChanging: CustomEvent<IgcRowSelectionEventArgs>

Emitted when IgxGridRowComponent is selected.

Example

<igx-grid #grid (rowSelectionChanging)="rowSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>
rowToggle: CustomEvent<IgcRowToggleEventArgs>

Emitted when the expanded state of a row gets changed.

Example

<igx-grid [data]="employeeData" (rowToggle)="rowToggle($event)" [autoGenerate]="true"></igx-grid>
selected: CustomEvent<IgcGridCellEventArgs>

Emitted when a cell is selected.

Remarks

Returns the IgxGridCell.

Example

<igx-grid #grid (selected)="onCellSelect($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>
sorting: CustomEvent<IgcSortingEventArgs>

Emitted before sorting expressions are applied.

Remarks

Returns an ISortingEventArgs object. sortingExpressions key holds the sorting expressions.

Example

<igx-grid #grid [data]="localData" [autoGenerate]="true" (sorting)="sorting($event)"></igx-grid>
sortingDone: CustomEvent<IgcSortingExpression[]>

Emitted after sorting is completed.

Remarks

Returns the sorting expression.

Example

<igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingDone)="sortingDone($event)"></igx-grid>
sortingExpressionsChange: CustomEvent<IgcSortingExpression[]>

Emitted before sorting is performed.

Remarks

Returns the sorting expressions.

Example

<igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingExpressionsChange)="sortingExprChange($event)"></igx-grid>
toolbarExporting: CustomEvent<IgcGridToolbarExportEventArgs>

Emitted when an export process is initiated by the user.

Example

toolbarExporting(event: IGridToolbarExportEventArgs){
const toolbarExporting = event;
}
validationStatusChange: CustomEvent<IgcGridValidationStatusEventArgs>

Emitted when grid's validation status changes.

Example

<igx-grid #grid (validationStatusChange)="validationStatusChange($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>