Gets/Sets a list of property keys to be excluded from the generated column collection
The collection is only used during initialization and changing it will not cause any changes in the generated columns at runtime unless the grid is destroyed and recreated. To modify the columns visible in the UI at runtime, please use their hidden property.
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.
Gets/Sets the data clone strategy of the grid when in edit mode.
A list of currently rendered IgxGridRowComponent's.
Gets the custom template, if any, used for row drag ghost.
The custom template, if any, that should be used when rendering the row drag indicator icon
Gets/Sets a custom template when empty.
Gets the excel style header icon.
Gets/Sets the filtering state.
Gets/Sets the filter mode.
Gets the row collapse indicator template.
Gets the header expand indicator template.
Gets the header row selector template.
Represents the last search information.
Gets/Sets a custom template when loading.
Controls whether columns moving is enabled in the grid.
Gets/Sets the outlet used to attach the grid's overlays to.
Gets an array of the pinned IgxColumnComponents.
Gets the number of pinned columns.
Gets an array of the pinned IgxRowComponents.
Gets/Sets the initial pinning configuration.
Gets the row add text template.
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:
callback = (row: RowType) => { return row.selected > 6; }
rowClasses = { 'className' : this.callback };
<igx-grid #grid [data]="Data" [rowClasses] = "rowClasses" [autoGenerate]="true"></igx-grid>
Gets the row collapse indicator template.
Gets the row edit actions template.
Gets the row edit text template.
Gets the row expand indicator template.
Gets the row selector template.
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.
styles = {
background: 'yellow',
color: (row: RowType) => row.selected : 'red': 'white'
}
<igx-grid #grid [data]="Data" [rowStyles]="styles" [autoGenerate]="true"></igx-grid>
Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid
The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.
The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.
Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.
Gets/Sets the sorting options - single or multiple sorting.
Accepts an ISortingOptions object with any of the mode properties.
Gets/Sets the summary calculation mode.
Get/Set IgxSummaryRow height
Gets an array of unpinned IgxColumnComponents.
Gets/Sets the trigger for validators used when editing the grid.
Returns an array of visible IgxColumnComponents.
Enters add mode by spawning the UI under the specified row by rowID.
The rowID to spawn the add row UI for, or null to spawn it as the first record in the data view
Whether the record should be added as a child. Only applicable to igxTreeGrid.
Closes the advanced filtering dialog.
indicates whether the changes should be applied
Finishes the row transactions on the current row and returns whether the grid editing was canceled.
Filters a single IgxColumnComponent.
Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
the string to search.
optionally, if the search should be case sensitive (defaults to false).
optionally, if the text should match the entire value (defaults to false).
Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
the string to search.
optionally, if the search should be case sensitive (defaults to false).
optionally, if the text should match the entire value (defaults to false).
Returns ICellPosition which defines the next cell,
according to the current position, that match specific criteria.
Returns ICellPosition which defines the previous cell,
according to the current position, that match specific criteria.
Returns an array of the current columns selection in the form of [{ column.field: cell.value }, ...].
Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...].
Get the currently selected ranges in the grid.
Returns whether the record is pinned or not.
Index of the record in the filteredSortedData collection.
Triggers change detection for the IgxGridComponent.
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:
// DON'Ts:
// don't call markForCheck from inside a loop
// don't call markForCheck when a primitive has changed
grid.data.forEach(rec => {
rec = newValue;
grid.markForCheck();
});
// DOs
// call markForCheck after updating a nested property
grid.data.forEach(rec => {
rec.nestedProp1.nestedProp2 = newValue;
});
grid.markForCheck();
Places a column before or after the specified target column.
Navigates to a position in the grid based on provided rowindex and visibleColumnIndex.
Pin the row by its id.
The row id - primaryKey value or the data record instance.
The index at which to insert the row in the pinned collection.
Select specified columns.
if true clears the current selection
Get current selected columns.
Select range(s) of cells between certain rows and columns of the grid.
Sort a single IgxColumnComponent.
Toggles the specified column's visibility.
Unpin the row by its id.
The row id - primaryKey value or the data record instance.
Updates the IgxGridRowComponent and the corresponding data record by primary key.
the new value which is to be set.
corresponds to rowID.
corresponds to column field.
Gets/Sets a custom template for adding row UI when grid is empty.