Class IgrRowIsland

Row island

Callable

IgrRowIsland(): ReactNode
Returns ReactNode

Accessors

Events

Properties

Accessors

columns

columns: IgrColumn[]

Gets an array of IgxColumnComponents.

dataRowList

dataRowList: IgrRowDirective[]

A list of currently rendered IgxGridRowComponent's.

defaultHeaderGroupMinWidth

defaultHeaderGroupMinWidth: number

Returns the IgxGridHeaderGroupComponent's minimum allowed width.

defaultRowHeight

defaultRowHeight: number

Gets the default row height.

pinnedRows

pinnedRows: IgrGridRowComponent[]

Gets an array of the pinned IgxRowComponents.

rowList

rowList: IgrRowDirective[]

A list of IgxGridRowComponent.

Events

onActiveNodeChange

onActiveNodeChange: (args: CustomEvent<IgrActiveNodeChangeEventArgsDetail>) => void

Type declaration

onAdvancedFilteringExpressionsTreeChange

onAdvancedFilteringExpressionsTreeChange: (args: CustomEvent<IgrFilteringExpressionsTree>) => void

Type declaration

onCellClick

onCellClick: (args: CustomEvent<IgrGridCellEventArgsDetail>) => void

Type declaration

onCellEdit

onCellEdit: (args: CustomEvent<IgrGridEditEventArgsDetail>) => void

Type declaration

onCellEditDone

onCellEditDone: (args: CustomEvent<IgrGridEditDoneEventArgsDetail>) => void

Type declaration

onCellEditEnter

onCellEditEnter: (args: CustomEvent<IgrGridEditEventArgsDetail>) => void

Type declaration

onCellEditExit

onCellEditExit: (args: CustomEvent<IgrGridEditDoneEventArgsDetail>) => void

Type declaration

onColumnInit

onColumnInit: (args: CustomEvent<IgrColumn>) => void

Type declaration

onColumnMoving

onColumnMoving: (args: CustomEvent<IgrColumnMovingEventArgsDetail>) => void

Type declaration

onColumnMovingEnd

onColumnMovingEnd: (args: CustomEvent<IgrColumnMovingEndEventArgsDetail>) => void

Type declaration

onColumnMovingStart

onColumnMovingStart: (args: CustomEvent<IgrColumnMovingStartEventArgsDetail>) => void

Type declaration

onColumnPin

onColumnPin: (args: CustomEvent<IgrPinColumnCancellableEventArgsDetail>) => void

Type declaration

onColumnPinned

onColumnPinned: (args: CustomEvent<IgrPinColumnEventArgsDetail>) => void

Type declaration

onColumnResized

onColumnResized: (args: CustomEvent<IgrColumnResizeEventArgsDetail>) => void

Type declaration

onColumnsAutogenerated

onColumnsAutogenerated: (args: CustomEvent<IgcColumnsAutoGeneratedEventArgs>) => void

Type declaration

onColumnSelectionChanging

onColumnSelectionChanging: (args: CustomEvent<IgrColumnSelectionEventArgsDetail>) => void

Type declaration

onColumnVisibilityChanged

onColumnVisibilityChanged: (args: CustomEvent<IgrColumnVisibilityChangedEventArgsDetail>) => void

Type declaration

onColumnVisibilityChanging

onColumnVisibilityChanging: (args: CustomEvent<IgrColumnVisibilityChangingEventArgsDetail>) => void

Type declaration

onContextMenu

onContextMenu: (args: CustomEvent<IgrGridContextMenuEventArgsDetail>) => void

Type declaration

onDataChanged

onDataChanged: (args: CustomEvent<IgrForOfDataChangeEventArgsDetail>) => void

Type declaration

onDataChanging

onDataChanging: (args: CustomEvent<IgrForOfDataChangeEventArgsDetail>) => void

Type declaration

onDataPreLoad

onDataPreLoad: (args: CustomEvent<IgrForOfState>) => void

Type declaration

onDoubleClick

onDoubleClick: (args: CustomEvent<IgrGridCellEventArgsDetail>) => void

Type declaration

onExpansionStatesChange

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

Type declaration

onFiltering

onFiltering: (args: CustomEvent<IgrFilteringEventArgsDetail>) => void

Type declaration

onFilteringDone

onFilteringDone: (args: CustomEvent<IgrFilteringExpressionsTree>) => void

Type declaration

onFilteringExpressionsTreeChange

onFilteringExpressionsTreeChange: (args: CustomEvent<IgrFilteringExpressionsTree>) => void

Type declaration

onFormGroupCreated

onFormGroupCreated: (args: CustomEvent<IgrGridFormGroupCreatedEventArgsDetail>) => void

Type declaration

onGridCopy

onGridCopy: (args: CustomEvent<IgrGridClipboardEvent>) => void

Type declaration

onGridCreated

onGridCreated: (args: CustomEvent<IgrGridCreatedEventArgsDetail>) => void

Type declaration

onGridInitialized

onGridInitialized: (args: CustomEvent<IgrGridCreatedEventArgsDetail>) => void

Type declaration

onGridKeydown

onGridKeydown: (args: CustomEvent<IgrGridKeydownEventArgsDetail>) => void

Type declaration

onGridScroll

onGridScroll: (args: CustomEvent<IgrGridScrollEventArgsDetail>) => void

Type declaration

onRangeSelected

onRangeSelected: (args: CustomEvent<IgrGridSelectionRange>) => void

Type declaration

onRendered

onRendered: (args: CustomEvent<boolean>) => void

Type declaration

onRowAdd

onRowAdd: (args: CustomEvent<IgrRowDataCancelableEventArgsDetail>) => void

Type declaration

onRowAdded

onRowAdded: (args: CustomEvent<IgrRowDataEventArgsDetail>) => void

Type declaration

onRowClick

onRowClick: (args: CustomEvent<IgrGridRowEventArgsDetail>) => void

Type declaration

onRowDelete

onRowDelete: (args: CustomEvent<IgrRowDataCancelableEventArgsDetail>) => void

Type declaration

onRowDeleted

onRowDeleted: (args: CustomEvent<IgrRowDataEventArgsDetail>) => void

Type declaration

onRowDragEnd

onRowDragEnd: (args: CustomEvent<IgrRowDragEndEventArgsDetail>) => void

Type declaration

onRowDragStart

onRowDragStart: (args: CustomEvent<IgrRowDragStartEventArgsDetail>) => void

Type declaration

onRowEdit

onRowEdit: (args: CustomEvent<IgrGridEditEventArgsDetail>) => void

Type declaration

onRowEditDone

onRowEditDone: (args: CustomEvent<IgrGridEditDoneEventArgsDetail>) => void

Type declaration

onRowEditEnter

onRowEditEnter: (args: CustomEvent<IgrGridEditEventArgsDetail>) => void

Type declaration

onRowEditExit

onRowEditExit: (args: CustomEvent<IgrGridEditDoneEventArgsDetail>) => void

Type declaration

onRowPinned

onRowPinned: (args: CustomEvent<IgrPinRowEventArgsDetail>) => void

Type declaration

onRowPinning

onRowPinning: (args: CustomEvent<IgrPinRowEventArgsDetail>) => void

Type declaration

onRowSelectionChanging

onRowSelectionChanging: (args: CustomEvent<IgrRowSelectionEventArgsDetail>) => void

Type declaration

onRowToggle

onRowToggle: (args: CustomEvent<IgrRowToggleEventArgsDetail>) => void

Type declaration

onSelected

onSelected: (args: CustomEvent<IgrGridCellEventArgsDetail>) => void

Type declaration

onSelectedRowsChange

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

Type declaration

onSorting

onSorting: (args: CustomEvent<IgrSortingEventArgsDetail>) => void

Type declaration

onSortingDone

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

Type declaration

onSortingExpressionsChange

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

Type declaration

onToolbarExporting

onToolbarExporting: (args: CustomEvent<IgrGridToolbarExportEventArgsDetail>) => void

Type declaration

onValidationStatusChange

onValidationStatusChange: (args: CustomEvent<IgrGridValidationStatusEventArgsDetail>) => void

Type declaration

Methods

addRow

addRow(data: any): void
Creates a new IgxGridRowComponent and adds the data record to the end of the data source.
Example
```
this.grid1.addRow(record);
```
Parameters
- data: any
Returns void

beginAddRowById

beginAddRowById(rowID: any, asChild?: boolean): void
Enters add mode by spawning the UI under the specified row by rowID.
Remarks
If null is passed as rowID, the row adding UI is spawned as the first record in the data view
Example
```
this.grid.beginAddRowById('ALFKI');
this.grid.beginAddRowById('ALFKI', true);
this.grid.beginAddRowById(null);
```
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

beginAddRowByIndex(index: number): void
Enters add mode by spawning the UI at the specified index.
Remarks
Accepted values for index are integers from 0 to this.grid.dataView.length
Example
```
this.grid.beginAddRowByIndex(0);
```
Parameters
- index: number
  The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length
Returns void

clearCellSelection

clearCellSelection(): void
Deselect selected cells.
Example
```
this.grid.clearCellSelection();
```
Returns void

clearFilter

clearFilter(name?: string): void
If name is provided, clears the filtering state of the corresponding IgxColumnComponent.
Remarks
Otherwise clears the filtering state of all IgxColumnComponents.
Example
```
this.grid.clearFilter();
```
Parameters
- name: string
Returns void

clearSearch

clearSearch(): void
Removes all the highlights in the cell.
Example
```
this.grid.clearSearch();
```
Returns void

clearSort

clearSort(name?: string): void
If name is provided, clears the sorting state of the corresponding IgxColumnComponent.
Remarks
otherwise clears the sorting state of all IgxColumnComponent.
Example
```
this.grid.clearSort();
```
Parameters
- name: string
Returns void

closeAdvancedFilteringDialog

closeAdvancedFilteringDialog(applyChanges: boolean): void
Closes the advanced filtering dialog.

Parameters
- applyChanges: boolean
  indicates whether the changes should be applied
Returns void

collapseAll

collapseAll(): void
Collapses all rows.
Example
```
this.grid.collapseAll();
```
Returns void

collapseRow

collapseRow(rowID: any): void
Collapses the row by its id.
Remarks
ID is either the primaryKey value or the data record instance.
Example
```
this.grid.collapseRow(rowID);
```
Parameters
- rowID: any
  The row id - primaryKey value or the data record instance.
Returns void

deleteRow

deleteRow(rowSelector: any): any
Removes the IgxGridRowComponent and the corresponding data record by primary key.
Remarks
Requires that the primaryKey property is set. The method accept rowSelector as a parameter, which is the rowID.
Example
```
this.grid1.deleteRow(0);
```
Parameters
- rowSelector: any
Returns any

deselectAllColumns

deselectAllColumns(): void
Deselects all columns
Example
```
this.grid.deselectAllColumns();
```
Returns void

deselectAllRows

deselectAllRows(onlyFilterData?: boolean): void
Deselects all rows
Remarks
By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will deselect all rows in the grid exept deleted rows.
Example
```
this.grid.deselectAllRows();
```
Parameters
- onlyFilterData: boolean
Returns void

deselectColumns

deselectColumns(columns: string[] | IgrColumn[]): void
Deselect specified columns by field.
Example
```
this.grid.deselectColumns(['ID','Name']);
```
Parameters
- columns: string[] | IgrColumn[]
Returns void

deselectRows

deselectRows(rowIDs: any[]): void
Deselect specified rows by ID.
Example
```
this.grid.deselectRows([1,2,5]);
```
Parameters
- rowIDs: any[]
Returns void

disableSummaries

disableSummaries(rest: any[]): void
Disable summaries for the specified column.
Example
```
grid.disableSummaries('ProductName');
```
Remarks
Disable summaries for the listed columns.
Example
```
grid.disableSummaries([{ fieldName: 'ProductName' }]);
```
Parameters
- rest: any[]
Returns void

enableSummaries

enableSummaries(rest: any[]): void
Enables summaries for the specified column and applies your customSummary.
Remarks
If you do not provide the customSummary, then the default summary for the column data type will be applied.
Example
```
grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);
```
Enable summaries for the listed columns.
Example
```
grid.enableSummaries('ProductName');
```
Parameters
- rest: any[]
Returns void

endEdit

endEdit(commit?: boolean, evt?: any): boolean
Finishes the row transactions on the current row and returns whether the grid editing was canceled.
Remarks
If commit === true, passes them from the pending state to the data (or transaction service)
Example
```
<button type="button" igxButton (click)="grid.endEdit(true)">Commit Row</button>
```
Parameters
- commit: boolean
- evt: any
Returns boolean

expandAll

expandAll(): void
Expands all rows.
Example
```
this.grid.expandAll();
```
Returns void

expandRow

expandRow(rowID: any): void
Expands the row by its id.
Remarks
ID is either the primaryKey value or the data record instance.
Example
```
this.grid.expandRow(rowID);
```
Parameters
- rowID: any
  The row id - primaryKey value or the data record instance.
Returns void

filter

filter(
    name: string,
    value: any,
    conditionOrExpressionTree?:
        | IgrFilteringExpressionsTree
        | IgrFilteringOperation,
    ignoreCase?: boolean,
): void
Filters a single IgxColumnComponent.
Example
```
public filter(term) {
     this.grid.filter("ProductName", term, IgxStringFilteringOperand.instance().condition("contains"));
}
```
Parameters
- name: string
- value: any
- conditionOrExpressionTree: IgrFilteringExpressionsTree | IgrFilteringOperation
- ignoreCase: boolean
Returns void

filterGlobal

filterGlobal(value: any, condition: any, ignoreCase?: any): void
Filters all the IgxColumnComponent in the IgxGridComponent with the same condition.
Example
```
grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));
```
Deprecated
Parameters
- value: any
- condition: any
- ignoreCase: any
Returns void

findNext

findNext(text: string, caseSensitive?: boolean, exactMatch?: boolean): number
Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
Remarks
Returns how many times the grid contains the string.
Example
```
this.grid.findNext("financial");
```
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

findPrev(text: string, caseSensitive?: boolean, exactMatch?: boolean): number
Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.
Remarks
Returns how many times the grid contains the string.
Example
```
this.grid.findPrev("financial");
```
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

getColumnByName

getColumnByName(name: string): IgrColumn
Returns the IgxColumnComponent by field name.
Example
```
const myCol = this.grid1.getColumnByName("ID");
```
Parameters
- name: string
Returns IgrColumn

getColumnByVisibleIndex

getColumnByVisibleIndex(index: number): IgrColumn
Parameters
- index: number
Returns IgrColumn

getHeaderGroupWidth

getHeaderGroupWidth(column: IgrColumn): string
Gets the width to be set on IgxGridHeaderGroupComponent.

Parameters
- column: IgrColumn
Returns string

getNextCell

getNextCell(
    currRowIndex: number,
    curVisibleColIndex: number,
    callback?: any,
): IgrCellPosition
Returns ICellPosition which defines the next cell, according to the current position, that match specific criteria.
Remarks
You can pass callback function as a third parameter of getPreviousCell method. The callback function accepts IgxColumnComponent as a param
Example
```
 const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);
```
Parameters
- currRowIndex: number
- curVisibleColIndex: number
- callback: any
Returns IgrCellPosition

getPinnedWidth

getPinnedWidth(takeHidden?: boolean): void
Gets calculated width of the pinned area.
Example
```
const pinnedWidth = this.grid.getPinnedWidth();
```
Parameters
- takeHidden: boolean
  If we should take into account the hidden columns in the pinned area.
Returns void

getPreviousCell

getPreviousCell(
    currRowIndex: number,
    curVisibleColIndex: number,
    callback?: any,
): IgrCellPosition
Returns ICellPosition which defines the previous cell, according to the current position, that match specific criteria.
Remarks
You can pass callback function as a third parameter of getPreviousCell method. The callback function accepts IgxColumnComponent as a param
Example
```
 const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);
```
Parameters
- currRowIndex: number
- curVisibleColIndex: number
- callback: any
Returns IgrCellPosition

getRowData

getRowData(rowSelector: any): any
Returns the data that is contained in the row component.
Remarks
If the primary key is not specified the row selector match the row data.
Example
```
const data = grid.getRowData(94741);
```
Parameters
- rowSelector: any
  correspond to rowID
Returns any

getSelectedColumnsData

getSelectedColumnsData(formatters?: boolean, headers?: boolean): void
Returns an array of the current columns selection in the form of [{ column.field: cell.value }, ...].

Remarks
If formatters is enabled, the cell value will be formatted by its respective column formatter (if any). If headers is enabled, it will use the column header (if any) instead of the column field.

Parameters
- formatters: boolean
- headers: boolean
Returns void

getSelectedData

getSelectedData(formatters?: boolean, headers?: boolean): void
Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...].

Remarks
If formatters is enabled, the cell value will be formatted by its respective column formatter (if any). If headers is enabled, it will use the column header (if any) instead of the column field.

Parameters
- formatters: boolean
- headers: boolean
Returns void

getSelectedRanges

getSelectedRanges(): IgrGridSelectionRange[]
Get the currently selected ranges in the grid.

Returns IgrGridSelectionRange[]

isRecordPinnedByIndex

isRecordPinnedByIndex(rowIndex: number): void
Returns whether the record is pinned or not.

Parameters
- rowIndex: number
  Index of the record in the filteredSortedData collection.
Returns void

markForCheck

markForCheck(): void

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();

Example

grid.markForCheck();

Returns void

moveColumn

moveColumn(column: IgrColumn, target: IgrColumn, pos?: DropPosition): void
Places a column before or after the specified target column.
Example
```
grid.moveColumn(column, target);
```
Parameters
- column: IgrColumn
- target: IgrColumn
- pos: DropPosition
Returns void

navigateTo

navigateTo(rowIndex: number, visibleColIndex?: number, cb?: any): void
Navigates to a position in the grid based on provided rowindex and visibleColumnIndex.
Remarks
Also can execute a custom logic over the target element, through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }
Example
```
 this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });
```
Parameters
- rowIndex: number
- visibleColIndex: number
- cb: any
Returns void

openAdvancedFilteringDialog

openAdvancedFilteringDialog(overlaySettings?: IgrOverlaySettings): void
Opens the advanced filtering dialog.

Parameters
- overlaySettings: IgrOverlaySettings
Returns void

pinColumn

pinColumn(columnName: string, index?: number): boolean
Pins a column by field name.
Remarks
Returns whether the operation is successful.
Example
```
this.grid.pinColumn("ID");
```
Parameters
- columnName: string
- index: number
Returns boolean

pinRow

pinRow(rowID: any, index?: number, row?: IgrRowType): boolean
Pin the row by its id.
Remarks
ID is either the primaryKey value or the data record instance.
Example
```
this.grid.pinRow(rowID);
```
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.
- row: IgrRowType
Returns boolean

recalculateAutoSizes

recalculateAutoSizes(): void
Recalculates all widths of columns that have size set to auto.
Example
```
this.grid1.recalculateAutoSizes();
```
Returns void

refreshSearch

refreshSearch(updateActiveInfo?: boolean, endEdit?: boolean): number
Reapplies the existing search.
Remarks
Returns how many times the grid contains the last search.
Example
```
this.grid.refreshSearch();
```
Parameters
- updateActiveInfo: boolean
- endEdit: boolean
Returns number

selectAllColumns

selectAllColumns(): void
Selects all columns
Example
```
this.grid.deselectAllColumns();
```
Returns void

selectAllRows

selectAllRows(onlyFilterData?: boolean): void
Selects all rows
Remarks
By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.
Example
```
this.grid.selectAllRows();
this.grid.selectAllRows(false);
```
Parameters
- onlyFilterData: boolean
Returns void

selectColumns

selectColumns(
columns: string[] | IgrColumn[],
clearCurrentSelection?: boolean,
): void
Select specified columns.
Example
```
this.grid.selectColumns(['ID','Name'], true);
```
Parameters
- columns: string[] | IgrColumn[]
- clearCurrentSelection: boolean
  if true clears the current selection
Returns void

selectedColumns

selectedColumns(): IgrColumn[]
Get current selected columns.
Example
Returns an array with selected columns
```
const selectedColumns = this.grid.selectedColumns();
```
Returns IgrColumn[]

selectRange

selectRange(arg: IgrGridSelectionRange[]): void
Select range(s) of cells between certain rows and columns of the grid.

Parameters
- arg: IgrGridSelectionRange[]
Returns void

selectRows

selectRows(rowIDs: any[], clearCurrentSelection?: boolean): void
Select specified rows by ID.
Example
```
this.grid.selectRows([1,2,5], true);
```
Parameters
- rowIDs: any[]
- clearCurrentSelection: boolean
  if true clears the current selection
Returns void

sort

sort(expression: IgrSortingExpression[]): void
Sort a single IgxColumnComponent.
Remarks
Sort the IgxGridComponent's IgxColumnComponent based on the provided array of sorting expressions.
Example
```
this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
```
Parameters
- expression: IgrSortingExpression[]
Returns void

toggleColumnVisibility

toggleColumnVisibility(args: IgrColumnVisibilityChangedEventArgsDetail): void
Toggles the specified column's visibility.
Example
```
this.grid1.toggleColumnVisibility({
      column: this.grid1.columns[0],
      newValue: true
});
```
Parameters
- args: IgrColumnVisibilityChangedEventArgsDetail
Returns void

toggleRow

toggleRow(rowID: any): void
Toggles the row by its id.
Remarks
ID is either the primaryKey value or the data record instance.
Example
```
this.grid.toggleRow(rowID);
```
Parameters
- rowID: any
  The row id - primaryKey value or the data record instance.
Returns void

unpinColumn

unpinColumn(columnName: string, index?: number): boolean
Unpins a column by field name. Returns whether the operation is successful.
Example
```
this.grid.pinColumn("ID");
```
Parameters
- columnName: string
- index: number
Returns boolean

unpinRow

unpinRow(rowID: any, row?: IgrRowType): boolean
Unpin the row by its id.
Remarks
ID is either the primaryKey value or the data record instance.
Example
```
this.grid.unpinRow(rowID);
```
Parameters
- rowID: any
  The row id - primaryKey value or the data record instance.
- row: IgrRowType
Returns boolean

updateCell

updateCell(value: any, rowSelector: any, column: string): void
Updates the IgxGridRowComponent and the corresponding data record by primary key.
Remarks
Requires that the primaryKey property is set.
Example
```
this.gridWithPK.updateCell('Updated', 1, 'ProductName');
```
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

updateRow(value: any, rowSelector: any): void
Updates the IgxGridRowComponent
Remarks
The row is specified by rowSelector parameter and the data source record with the passed value. This method will apply requested update only if primary key is specified in the grid.
Example
```
grid.updateRow({
      ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')
  }, 1);
```
Parameters
- value: any
- rowSelector: any
  correspond to rowID
Returns void

Properties

actionStripComponents

actionStripComponents: IgcActionStripToken[]

addRowEmptyTemplate

addRowEmptyTemplate: IgcRenderFunction<void>

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

advancedFilteringExpressionsTree

advancedFilteringExpressionsTree: IgrFilteringExpressionsTree

Gets/Sets the advanced filtering state.

allowAdvancedFiltering

allowAdvancedFiltering: boolean

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

allowFiltering

allowFiltering: boolean

Gets/Sets if the filtering is enabled.

autoGenerate

autoGenerate: boolean

Gets/Sets whether to auto-generate the columns.

autoGenerateExclude

autoGenerateExclude: string[]

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

batchEditing

batchEditing: boolean

cellSelection

cellSelection: GridSelectionMode

Gets/Sets cell selection mode.

childDataKey

childDataKey: string

Sets the key of the row island by which child data would be taken from the row data if such is provided.

childLayoutList

childLayoutList: IgrRowIsland[]

clipboardOptions

clipboardOptions: IgrClipboardOptions

Controls the copy behavior of the grid.

columnList

columnList: IgrColumn[]

columnSelection

columnSelection: GridSelectionMode

Gets/Sets column selection mode

columnWidth

columnWidth: string

Gets/Sets the default width of the columns.

dataCloneStrategy

dataCloneStrategy: IgrDataCloneStrategy

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

dragGhostCustomTemplate

dragGhostCustomTemplate: IgcRenderFunction<IgrGridRowDragGhostContext>

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

dragIndicatorIconTemplate

dragIndicatorIconTemplate: IgcRenderFunction<IgrGridEmptyTemplateContext>

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

emptyFilteredGridMessage

emptyFilteredGridMessage: string

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

emptyGridMessage

emptyGridMessage: string

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

emptyGridTemplate

emptyGridTemplate: IgcRenderFunction<IgrGridTemplateContext>

Gets/Sets a custom template when empty.

excelStyleHeaderIconTemplate

excelStyleHeaderIconTemplate: IgcRenderFunction<IgrGridHeaderTemplateContext>

Gets the excel style header icon.

expandChildren

expandChildren: boolean

Sets if all immediate children of the grids for this IgxRowIslandComponent should be expanded/collapsed.

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

expansionStates

expansionStates: Map<any, boolean>

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

filteringExpressionsTree

filteringExpressionsTree: IgrFilteringExpressionsTree

Gets/Sets the filtering state.

filteringLogic

filteringLogic: FilteringLogic

Gets/Sets the filtering logic of the IgxGridComponent.

filterMode

filterMode: FilterMode

Gets/Sets the filter mode.

filterStrategy

filterStrategy: IgrFilteringStrategy

Gets/Sets the filtering strategy of the grid.

hasChildrenKey

hasChildrenKey: string

Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.

headerCollapsedIndicatorTemplate

headerCollapsedIndicatorTemplate: IgcRenderFunction<IgrGridTemplateContext>

Gets the row collapse indicator template.

headerExpandedIndicatorTemplate

headerExpandedIndicatorTemplate: IgcRenderFunction<IgrGridTemplateContext>

Gets the header expand indicator template.

headSelectorTemplate

headSelectorTemplate: IgcRenderFunction<IgrHeadSelectorTemplateContext>

Gets the header row selector template.

height

height: string

Gets/Sets the height.

hideRowSelectors

hideRowSelectors: boolean

Gets/Sets if the row selectors are hidden.

isLoading

isLoading: boolean

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

loadingGridTemplate

loadingGridTemplate: IgcRenderFunction<IgrGridTemplateContext>

Gets/Sets a custom template when loading.

locale

locale: string

Gets/Sets the locale.

moving

moving: boolean

Controls whether columns moving is enabled in the grid.

paginationComponents

paginationComponents: IgrPaginator[]

paginatorTemplate

paginatorTemplate: IgcRenderFunction<IgrGridPaginatorTemplateContext>

Sets/Gets the paginator template for each child grid created from this row island.

pagingMode

pagingMode: GridPagingMode

pinning

pinning: IgrPinningConfig

Gets/Sets the initial pinning configuration.

primaryKey

primaryKey: string

Gets/Sets the primary key.

resourceStrings

resourceStrings: IgrGridResourceStrings

Gets/Sets the resource strings.

rowAddTextTemplate

rowAddTextTemplate: IgcRenderFunction<IgrGridEmptyTemplateContext>

Gets the row add text template.

rowClasses

rowClasses: 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:

callback = (row: RowType) => { return row.selected > 6; }
rowClasses = { 'className' : this.callback };

<igx-grid #grid [data]="Data" [rowClasses] = "rowClasses" [autoGenerate]="true"></igx-grid>

rowCollapsedIndicatorTemplate

rowCollapsedIndicatorTemplate: IgcRenderFunction<IgrGridRowTemplateContext>

Gets the row collapse indicator template.

rowDraggable

rowDraggable: boolean

Gets/Sets whether rows can be moved.

rowEditable

rowEditable: boolean

Gets/Sets whether the rows are editable.

rowEditActionsTemplate

rowEditActionsTemplate: IgcRenderFunction<IgrGridRowEditActionsTemplateContext>

Gets the row edit actions template.

rowEditTextTemplate

rowEditTextTemplate: IgcRenderFunction<IgrGridRowEditTextTemplateContext>

Gets the row edit text template.

rowExpandedIndicatorTemplate

rowExpandedIndicatorTemplate: IgcRenderFunction<IgrGridRowTemplateContext>

Gets the row expand indicator template.

rowHeight

rowHeight: number

Gets/Sets the row height.

rowSelection

rowSelection: GridSelectionMode

Gets/Sets row selection mode

rowSelectorTemplate

rowSelectorTemplate: IgcRenderFunction<IgrRowSelectorTemplateContext>

Gets the row selector template.

rowStyles

rowStyles: 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.

styles = {
 background: 'yellow',
 color: (row: RowType) => row.selected : 'red': 'white'
}

<igx-grid #grid [data]="Data" [rowStyles]="styles" [autoGenerate]="true"></igx-grid>

selectedRows

selectedRows: any[]

Gets/Sets the current selection state.

selectRowOnClick

selectRowOnClick: boolean

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

shouldGenerate

shouldGenerate: boolean

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

showExpandAll

showExpandAll: boolean

Gets/Sets whether the expand/collapse all button in the header should be rendered.

showSummaryOnCollapse

showSummaryOnCollapse: boolean

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

snackbarDisplayTime

snackbarDisplayTime: number

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

sortAscendingHeaderIconTemplate

sortAscendingHeaderIconTemplate: IgcRenderFunction<IgrGridHeaderTemplateContext>

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

sortDescendingHeaderIconTemplate

sortDescendingHeaderIconTemplate: IgcRenderFunction<IgrGridHeaderTemplateContext>

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

sortHeaderIconTemplate

sortHeaderIconTemplate: IgcRenderFunction<IgrGridHeaderTemplateContext>

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

sortingExpressions

sortingExpressions: IgrSortingExpression[]

Gets/Sets the sorting state.

sortingOptions

sortingOptions: IgrSortingOptions

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

sortStrategy

sortStrategy: IgrGridSortingStrategy

Gets/Sets the sorting strategy of the grid.

summaryCalculationMode

summaryCalculationMode: GridSummaryCalculationMode

Gets/Sets the summary calculation mode.

summaryPosition

summaryPosition: GridSummaryPosition

Gets/Sets the summary position.

summaryRowHeight

summaryRowHeight: number

Get/Set IgxSummaryRow height

toolbar

toolbar: IgrGridToolbar[]

toolbarTemplate

toolbarTemplate: IgcRenderFunction<IgrGridToolbarTemplateContext>

Sets/Gets the toolbar template for each child grid created from this row island.

totalRecords

totalRecords: number

Returns the total number of records.

validationTrigger

validationTrigger: GridValidationTrigger

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

width

width: string

Gets/Sets the width of the grid.

Class IgrRowIsland

Callable

Returns ReactNode

Accessors

Events

Methods

Properties

Accessors

columns

dataRowList

defaultHeaderGroupMinWidth

defaultRowHeight

pinnedRows

rowList

Events

onActiveNodeChange

Type declaration

onAdvancedFilteringExpressionsTreeChange

Type declaration

onCellClick

Type declaration

onCellEdit

Type declaration

onCellEditDone

Type declaration

onCellEditEnter

Type declaration

onCellEditExit

Type declaration

onColumnInit

Type declaration

onColumnMoving

Type declaration

onColumnMovingEnd

Type declaration

onColumnMovingStart

Type declaration

onColumnPin

Type declaration

onColumnPinned

Type declaration

onColumnResized

Type declaration

onColumnsAutogenerated

Type declaration

onColumnSelectionChanging

Type declaration

onColumnVisibilityChanged

Type declaration

onColumnVisibilityChanging

Type declaration

onContextMenu

Type declaration

onDataChanged

Type declaration

onDataChanging

Type declaration

onDataPreLoad

Type declaration

onDoubleClick

Type declaration

onExpansionStatesChange

Type declaration

onFiltering

Type declaration

onFilteringDone

Type declaration

onFilteringExpressionsTreeChange

Type declaration

onFormGroupCreated

Type declaration

onGridCopy

Type declaration

onGridCreated

Type declaration

onGridInitialized

Type declaration

onGridKeydown

Type declaration

onGridScroll