IgrPivotGrid | Infragistics API Docs

Pivot Grid provides a way to present and manipulate data in a pivot table view.

Properties

autoGenerateConfig

Gets/Sets whether to auto-generate the pivot configuration based on the provided data.

autoGenerateConfig: boolean

data

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

data: any[]

defaultExpandState

Gets/Sets the default expand state for all rows.

defaultExpandState: boolean

emptyPivotGridTemplate

Gets/Sets a custom template when pivot grid is empty.

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

pivotConfiguration

Gets/Sets the pivot configuration with all related dimensions and values.

pivotConfiguration: IgrPivotConfiguration

pivotUI

pivotUI: IgrPivotUISettings

rowDimensionHeaderTemplate

rowDimensionHeaderTemplate: (ctx: IgrColumnTemplateContext) => React.ReactNode

superCompactMode

Enables a super compact theme for the component.

superCompactMode: boolean

valueChipTemplate

Gets/Sets a custom template for the value chips.

valueChipTemplate: (ctx: IgrPivotGridValueTemplateContext) => React.ReactNode

addRowEmptyTemplate

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

advancedFilteringExpressionsTree

advancedFilteringExpressionsTree: IgrFilteringExpressionsTree

allowAdvancedFiltering

allowAdvancedFiltering: boolean

allowFiltering

allowFiltering: boolean

autoGenerate

autoGenerate: boolean

autoGenerateExclude

autoGenerateExclude: string[]

batchEditing

batchEditing: boolean

cellMergeMode

cellMergeMode: GridCellMergeMode

cellSelection

cellSelection: GridSelectionMode

clipboardOptions

clipboardOptions: IgrClipboardOptions

columnSelection

columnSelection: GridSelectionMode

columnWidth

columnWidth: string

dataCloneStrategy

dataCloneStrategy: IgrDataCloneStrategy

dragGhostCustomTemplate

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

dragIndicatorIconTemplate

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

emptyFilteredGridMessage

emptyFilteredGridMessage: string

emptyGridMessage

emptyGridMessage: string

emptyGridTemplate

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

excelStyleHeaderIconTemplate

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

expansionStates

expansionStates: Map<any, boolean>

filteringExpressionsTree

filteringExpressionsTree: IgrFilteringExpressionsTree

filteringLogic

filteringLogic: FilteringLogic

filterMode

filterMode: FilterMode

filterStrategy

filterStrategy: IgrFilteringStrategy

headerCollapsedIndicatorTemplate

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

headerExpandedIndicatorTemplate

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

headSelectorTemplate

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

height

height: string

hideRowSelectors

hideRowSelectors: boolean

isLoading

isLoading: boolean

loadingGridTemplate

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

locale

locale: string

mergeStrategy

mergeStrategy: IgrGridMergeStrategy

moving

moving: boolean

outlet

outlet: IgrOverlayOutletDirective

pagingMode

pagingMode: GridPagingMode

pinning

pinning: IgrPinningConfig

primaryKey

primaryKey: string

resourceStrings

resourceStrings: IgrGridResourceStrings

rowAddTextTemplate

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

rowClasses

rowClasses: any

rowCollapsedIndicatorTemplate

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

rowDraggable

rowDraggable: boolean

rowEditable

rowEditable: boolean

rowEditActionsTemplate

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

rowEditTextTemplate

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

rowExpandedIndicatorTemplate

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

rowHeight

rowHeight: number

rowSelection

rowSelection: GridSelectionMode

rowSelectorTemplate

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

rowStyles

rowStyles: any

selectRowOnClick

selectRowOnClick: boolean

shouldGenerate

shouldGenerate: boolean

showSummaryOnCollapse

showSummaryOnCollapse: boolean

snackbarDisplayTime

snackbarDisplayTime: number

sortAscendingHeaderIconTemplate

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

sortDescendingHeaderIconTemplate

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

sortHeaderIconTemplate

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

sortingExpressions

sortingExpressions: IgrSortingExpression[]

sortingOptions

sortingOptions: IgrSortingOptions

sortStrategy

sortStrategy: IgrGridSortingStrategy

summaryCalculationMode

summaryCalculationMode: GridSummaryCalculationMode

summaryPosition

summaryPosition: GridSummaryPosition

summaryRowHeight

summaryRowHeight: number

totalRecords

totalRecords: number

validationTrigger

validationTrigger: GridValidationTrigger

width

width: string

Accessors

allDimensions

Gets the full list of dimensions.

get allDimensions(): IgrPivotDimension[]

Returns IgrPivotDimension[]

dimensionsSortingExpressions

Gets the sorting expressions generated for the dimensions.

get dimensionsSortingExpressions(): IgrSortingExpression[]

Returns IgrSortingExpression[]

selectedRows

get selectedRows(): any[]

Returns any[]

actionStripComponents

get actionStripComponents(): IgcActionStripToken[]

Returns IgcActionStripToken[]

columnList

get columnList(): IgrColumnComponent[]

Returns IgrColumnComponent[]

columns

Gets an array of ColumnComponents.

get columns(): IgrColumnComponent[]

Example

const colums = this.grid.columns.

Returns IgrColumnComponent[]

dataRowList

A list of currently rendered GridRowComponent's.

get dataRowList(): IgrRowDirective[]

Example

const dataList = this.grid.dataRowList;

Returns IgrRowDirective[]

dataView

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

defaultRowHeight

Gets the default row height.

get defaultRowHeight(): number

Example

const rowHeigh = this.grid.defaultRowHeight;

Returns number

filteredData

Returns an array of objects containing the filtered data.

get filteredData(): any

Example

let filteredData = this.grid.filteredData;

Returns any

filteredSortedData

Returns an array containing the filtered sorted data.

get filteredSortedData(): any[]

Example

const filteredSortedData = this.grid1.filteredSortedData;

Returns any[]

hiddenColumnsCount

Gets the number of hidden columns.

get hiddenColumnsCount(): number

Example

const hiddenCol = this.grid.hiddenColumnsCount;
``

Returns number

lastSearchInfo

Represents the last search information.

get lastSearchInfo(): IgrSearchInfo

Returns IgrSearchInfo

paginationComponents

get paginationComponents(): IgrPaginatorComponent[]

Returns IgrPaginatorComponent[]

pinnedColumns

Gets an array of the pinned ColumnComponents.

get pinnedColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedColumns.

Returns IgrColumnComponent[]

pinnedColumnsCount

Gets the number of pinned columns.

get pinnedColumnsCount(): number

Returns number

pinnedEndColumns

Gets an array of the pinned to the right ColumnComponents.

get pinnedEndColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedEndColumns.

Returns IgrColumnComponent[]

pinnedRows

Gets an array of the pinned RowComponents.

get pinnedRows(): IgrGridRowComponent[]

Example

const pinnedRow = this.grid.pinnedRows;

Returns IgrGridRowComponent[]

pinnedStartColumns

Gets an array of the pinned to the left ColumnComponents.

get pinnedStartColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedStartColumns.

Returns IgrColumnComponent[]

rowList

A list of GridRowComponent.

get rowList(): IgrRowDirective[]

Example

const rowList = this.grid.rowList;

Returns IgrRowDirective[]

get toolbar(): IgrGridToolbarComponent[]

Returns IgrGridToolbarComponent[]

unpinnedColumns

Gets an array of unpinned ColumnComponents.

get unpinnedColumns(): IgrColumnComponent[]

Example

const unpinnedColumns = this.grid.unpinnedColumns.

Returns IgrColumnComponent[]

virtualizationState

Returns the state of the grid virtualization.

get virtualizationState(): IgrForOfState

Example

const gridVirtState = this.grid1.virtualizationState;

Returns IgrForOfState

visibleColumns

Returns an array of visible ColumnComponents.

get visibleColumns(): IgrColumnComponent[]

Example

const visibleColumns = this.grid.visibleColumns.

Returns IgrColumnComponent[]

Methods

autoSizeRowDimension

Auto-sizes row dimension cells.

autoSizeRowDimension(dimension: IgrPivotDimension): void

Parameters

dimension: IgrPivotDimension
The row dimension to size.

Returns void

Example

this.grid.autoSizeRowDimension(dimension);

filterDimension

Filters a single IPivotDimension.

filterDimension(dimension: IgrPivotDimension, value: any, conditionOrExpressionTree: IgrFilteringExpressionsTree | IgrFilteringOperation): void

Parameters

dimension: IgrPivotDimension
value: any
conditionOrExpressionTree: IgrFilteringExpressionsTree | IgrFilteringOperation

Returns void

getColumnGroupExpandState

getColumnGroupExpandState(col: IgrColumnComponent): void

Parameters

col: IgrColumnComponent

Returns void

insertDimensionAt

Inserts dimension in target collection by type at specified index or at the collection's end.

insertDimensionAt(dimension: IgrPivotDimension, targetCollectionType: PivotDimensionType, index: number): void

Parameters

dimension: IgrPivotDimension
The dimension that will be added.
targetCollectionType: PivotDimensionType
The target collection type to add to. Can be Row, Column or Filter.
index: number
The index in the collection at which to add. This parameter is optional. If not set it will add it to the end of the collection.

Returns void

Example

this.grid.insertDimensionAt(dimension, PivotDimensionType.Row, 1);

insertValueAt

Inserts value at specified index or at the end.

insertValueAt(value: IgrPivotValue, index: number): void

Parameters

value: IgrPivotValue
The value definition that will be added.
index: number
The index in the collection at which to add. This parameter is optional. If not set it will add it to the end of the collection.

Returns void

Example

this.grid.insertValueAt(value, 1);

moveDimension

Move dimension from its currently collection to the specified target collection by type at specified index or at the collection's end.

moveDimension(dimension: IgrPivotDimension, targetCollectionType: PivotDimensionType, index: number): void

Parameters

dimension: IgrPivotDimension
The dimension that will be moved.
targetCollectionType: PivotDimensionType
The target collection type to move it to. Can be Row, Column or Filter.
index: number
The index in the collection at which to add. This parameter is optional. If not set it will add it to the end of the collection.

Returns void

Example

this.grid.moveDimension(dimension, PivotDimensionType.Row, 1);

moveValue

Move value from its currently at specified index or at the end.

moveValue(value: IgrPivotValue, index: number): void

Parameters

value: IgrPivotValue
The value that will be moved.
index: number
The index in the collection at which to add. This parameter is optional. If not set it will add it to the end of the collection.

Returns void

Example

this.grid.moveValue(value, 1);

notifyDimensionChange

Notifies for dimension change.

notifyDimensionChange(regenerateColumns: boolean): void

Parameters

regenerateColumns: boolean

Returns void

removeDimension

Removes dimension from its currently collection.

removeDimension(dimension: IgrPivotDimension): void

Parameters

dimension: IgrPivotDimension
The dimension to be removed.

Returns void

Example

this.grid.removeDimension(dimension);

removeValue

Removes value from collection.

removeValue(value: IgrPivotValue): void

Parameters

value: IgrPivotValue
The value to be removed.

Returns void

Example

this.grid.removeValue(dimension);

sortDimension

Sort the dimension and its children in the provided direction.

sortDimension(dimension: IgrPivotDimension, sortDirection: SortingDirection): void

Parameters

dimension: IgrPivotDimension
sortDirection: SortingDirection

Returns void

Example

this.grid.sortDimension(dimension, SortingDirection.Asc);

toggleColumn

toggleColumn(col: IgrColumnComponent): void

Parameters

col: IgrColumnComponent

Returns void

toggleDimension

Toggles the dimension's enabled state on or off.

toggleDimension(dimension: IgrPivotDimension): void

Parameters

dimension: IgrPivotDimension
The dimension to be toggled.

Returns void

Example

this.grid.toggleDimension(dimension);

toggleRowGroup

toggleRowGroup(col: IgrColumnComponent, newState: boolean): void

Parameters

col: IgrColumnComponent
newState: boolean

Returns void

toggleValue

Toggles the value's enabled state on or off.

toggleValue(value: IgrPivotValue): void

Parameters

value: IgrPivotValue
The value to be toggled.

Returns void

Example

this.grid.toggleValue(value);

addRow

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

beginAddRowById

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

beginAddRowByIndex

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

clearCellSelection

Deselect selected cells.

clearCellSelection(): void

Returns void

Example

this.grid.clearCellSelection();

clearFilter

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

clearSearch

Removes all the highlights in the cell.

clearSearch(): void

Returns void

Example

this.grid.clearSearch();

clearSort

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

closeAdvancedFilteringDialog

Closes the advanced filtering dialog.

closeAdvancedFilteringDialog(applyChanges: boolean): void

Parameters

applyChanges: boolean
indicates whether the changes should be applied

Returns void

collapseAll

Collapses all rows.

collapseAll(): void

Returns void

Example

this.grid.collapseAll();

collapseRow

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

deleteRow

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

deselectAllColumns

Deselects all columns

deselectAllColumns(): void

Returns void

Example

this.grid.deselectAllColumns();

deselectAllRows

Deselects all rows

deselectAllRows(onlyFilterData: boolean): void

Parameters

onlyFilterData: boolean

Returns void

Example

this.grid.deselectAllRows();

deselectColumns

Deselect specified columns by field.

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

Parameters

columns: string[] | IgrColumnComponent[]

Returns void

Example

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

deselectRows

Deselect specified rows by ID.

deselectRows(rowIDs: any[]): void

Parameters

rowIDs: any[]

Returns void

Example

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

disableSummaries

Disable summaries for the specified column.

disableSummaries(rest: any[]): void

Parameters

rest: any[]

Returns void

Example

grid.disableSummaries('ProductName');

enableSummaries

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.

endEdit

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

Expands all rows.

expandAll(): void

Returns void

Example

this.grid.expandAll();

expandRow

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

filter

Filters a single ColumnComponent.

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

Parameters

name: string
value: any
conditionOrExpressionTree: IgrFilteringExpressionsTree | IgrFilteringOperation
ignoreCase: boolean

Returns void

filterGlobal

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

findNext

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

findPrev

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

getColumnByName

Returns the ColumnComponent by field name.

getColumnByName(name: string): IgrColumnComponent

Parameters

name: string

Returns IgrColumnComponent

Example

const myCol = this.grid1.getColumnByName("ID");

getColumnByVisibleIndex

getColumnByVisibleIndex(index: number): IgrColumnComponent

Parameters

index: number

Returns IgrColumnComponent

getHeaderGroupWidth

Gets the width to be set on GridHeaderGroupComponent.

getHeaderGroupWidth(column: IgrColumnComponent): string

Parameters

column: IgrColumnComponent

Returns string

getNextCell

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

Example

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

getPinnedEndWidth

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

getPinnedStartWidth

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

getPreviousCell

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

Example

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

getRowData

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

getSelectedColumnsData

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

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

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

Parameters

formatters: boolean
headers: boolean

Returns void

getSelectedRanges

Get the currently selected ranges in the grid.

getSelectedRanges(): IgrGridSelectionRange[]

Returns IgrGridSelectionRange[]

isRecordPinnedByIndex

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

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

moveColumn

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

navigateTo

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

openAdvancedFilteringDialog

Opens the advanced filtering dialog.

openAdvancedFilteringDialog(overlaySettings: IgrOverlaySettings): void

Parameters

overlaySettings: IgrOverlaySettings

Returns void

pinColumn

Pins a column by field name.

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

Parameters

columnName: string
index: number
pinningPosition: ColumnPinningPosition

Returns boolean

Example

this.grid.pinColumn("ID");

pinRow

Pin the row by its id.

pinRow(rowID: any, index: number, row: IgrRowType): 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.
row: IgrRowType

Returns boolean

Example

this.grid.pinRow(rowID);

recalculateAutoSizes

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

recalculateAutoSizes(): void

Returns void

Example

this.grid1.recalculateAutoSizes();

reflow

Recalculates grid width/height dimensions.

reflow(): void

Returns void

Example

this.grid.reflow();

refreshSearch

Reapplies the existing search.

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

Parameters

updateActiveInfo: boolean
endEdit: boolean

Returns number

Example

this.grid.refreshSearch();

selectAllColumns

Selects all columns

selectAllColumns(): void

Returns void

Example

this.grid.deselectAllColumns();

selectAllRows

Selects all rows

selectAllRows(onlyFilterData: boolean): void

Parameters

onlyFilterData: boolean

Returns void

Example

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

selectColumns

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

selectedColumns

Get current selected columns.

selectedColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

Example

Returns an array with selected columns

const selectedColumns = this.grid.selectedColumns();

selectRange

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

selectRange(arg: IgrGridSelectionRange[]): void

Parameters

arg: IgrGridSelectionRange[]

Returns void

selectRows

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

Sort a single ColumnComponent.

sort(expression: IgrSortingExpression[]): void

Parameters

expression: IgrSortingExpression[]

Returns void

Example

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

toggleColumnVisibility

Toggles the specified column's visibility.

toggleColumnVisibility(args: IgrColumnVisibilityChangedEventArgs): void

Parameters

args: IgrColumnVisibilityChangedEventArgs

Returns void

Example

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

toggleRow

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

unpinColumn

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

unpinRow

Unpin the row by its id.

unpinRow(rowID: any, row: IgrRowType): boolean

Parameters

rowID: any
The row id - primaryKey value or the data record instance.
row: IgrRowType

Returns boolean

Example

this.grid.unpinRow(rowID);

updateCell

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

updateRow

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

Events

onActiveNodeChange

onActiveNodeChange(args: CustomEvent<IgrActiveNodeChangeEventArgs>): void

Parameters

args: CustomEvent<IgrActiveNodeChangeEventArgs>

Returns void

onAdvancedFilteringExpressionsTreeChange

onAdvancedFilteringExpressionsTreeChange(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

args: CustomEvent<IgrFilteringExpressionsTree>

Returns void

onCellClick

onCellClick(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

args: CustomEvent<IgrGridCellEventArgs>

Returns void

onCellEdit

onCellEdit(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

args: CustomEvent<IgrGridEditEventArgs>

Returns void

onCellEditDone

onCellEditDone(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

args: CustomEvent<IgrGridEditDoneEventArgs>

Returns void

onCellEditEnter

onCellEditEnter(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

args: CustomEvent<IgrGridEditEventArgs>

Returns void

onCellEditExit

onCellEditExit(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

args: CustomEvent<IgrGridEditDoneEventArgs>

Returns void

onColumnInit

onColumnInit(args: CustomEvent<IgrColumnComponent>): void

Parameters

args: CustomEvent<IgrColumnComponent>

Returns void

onColumnMoving

onColumnMoving(args: CustomEvent<IgrColumnMovingEventArgs>): void

Parameters

args: CustomEvent<IgrColumnMovingEventArgs>

Returns void

onColumnMovingEnd

onColumnMovingEnd(args: CustomEvent<IgrColumnMovingEndEventArgs>): void

Parameters

args: CustomEvent<IgrColumnMovingEndEventArgs>

Returns void

onColumnMovingStart

onColumnMovingStart(args: CustomEvent<IgrColumnMovingStartEventArgs>): void

Parameters

args: CustomEvent<IgrColumnMovingStartEventArgs>

Returns void

onColumnPin

onColumnPin(args: CustomEvent<IgrPinColumnCancellableEventArgs>): void

Parameters

args: CustomEvent<IgrPinColumnCancellableEventArgs>

Returns void

onColumnPinned

onColumnPinned(args: CustomEvent<IgrPinColumnEventArgs>): void

Parameters

args: CustomEvent<IgrPinColumnEventArgs>

Returns void

onColumnResized

onColumnResized(args: CustomEvent<IgrColumnResizeEventArgs>): void

Parameters

args: CustomEvent<IgrColumnResizeEventArgs>

Returns void

onColumnsAutogenerated

onColumnsAutogenerated(args: CustomEvent<IgrColumnsAutoGeneratedEventArgs>): void

Parameters

args: CustomEvent<IgrColumnsAutoGeneratedEventArgs>

Returns void

onColumnSelectionChanging

onColumnSelectionChanging(args: CustomEvent<IgrColumnSelectionEventArgs>): void

Parameters

args: CustomEvent<IgrColumnSelectionEventArgs>

Returns void

onColumnVisibilityChanged

onColumnVisibilityChanged(args: CustomEvent<IgrColumnVisibilityChangedEventArgs>): void

Parameters

args: CustomEvent<IgrColumnVisibilityChangedEventArgs>

Returns void

onColumnVisibilityChanging

onColumnVisibilityChanging(args: CustomEvent<IgrColumnVisibilityChangingEventArgs>): void

Parameters

args: CustomEvent<IgrColumnVisibilityChangingEventArgs>

Returns void

onContextMenu

onContextMenu(args: CustomEvent<IgrGridContextMenuEventArgs>): void

Parameters

args: CustomEvent<IgrGridContextMenuEventArgs>

Returns void

onDataChanged

onDataChanged(args: CustomEvent<IgrForOfDataChangeEventArgs>): void

Parameters

args: CustomEvent<IgrForOfDataChangeEventArgs>

Returns void

onDataChanging

onDataChanging(args: CustomEvent<IgrForOfDataChangeEventArgs>): void

Parameters

args: CustomEvent<IgrForOfDataChangeEventArgs>

Returns void

onDimensionInit

onDimensionInit(args: CustomEvent<IgrPivotDimension>): void

Parameters

args: CustomEvent<IgrPivotDimension>

Returns void

onDimensionsChange

onDimensionsChange(args: CustomEvent<IgrDimensionsChange>): void

Parameters

args: CustomEvent<IgrDimensionsChange>

Returns void

onDimensionsSortingExpressionsChange

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

Parameters

args: CustomEvent<IgrSortingExpression[]>

Returns void

onDoubleClick

onDoubleClick(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

args: CustomEvent<IgrGridCellEventArgs>

Returns void

onExpansionStatesChange

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

Parameters

args: CustomEvent<Map<any, boolean>>

Returns void

onFiltering

onFiltering(args: CustomEvent<IgrFilteringEventArgs>): void

Parameters

args: CustomEvent<IgrFilteringEventArgs>

Returns void

onFilteringDone

onFilteringDone(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

args: CustomEvent<IgrFilteringExpressionsTree>

Returns void

onFilteringExpressionsTreeChange

onFilteringExpressionsTreeChange(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

args: CustomEvent<IgrFilteringExpressionsTree>

Returns void

onFormGroupCreated

onFormGroupCreated(args: CustomEvent<IgrGridFormGroupCreatedEventArgs>): void

Parameters

args: CustomEvent<IgrGridFormGroupCreatedEventArgs>

Returns void

onGridCopy

onGridCopy(args: CustomEvent<IgrGridClipboardEvent>): void

Parameters

args: CustomEvent<IgrGridClipboardEvent>

Returns void

onGridKeydown

onGridKeydown(args: CustomEvent<IgrGridKeydownEventArgs>): void

Parameters

args: CustomEvent<IgrGridKeydownEventArgs>

Returns void

onGridScroll

onGridScroll(args: CustomEvent<IgrGridScrollEventArgs>): void

Parameters

args: CustomEvent<IgrGridScrollEventArgs>

Returns void

onPivotConfigurationChange

onPivotConfigurationChange(args: CustomEvent<IgrPivotConfigurationChangedEventArgs>): void

Parameters

args: CustomEvent<IgrPivotConfigurationChangedEventArgs>

Returns void

onRangeSelected

onRangeSelected(args: CustomEvent<IgrGridSelectionRange>): void

Parameters

args: CustomEvent<IgrGridSelectionRange>

Returns void

onRendered

onRendered(args: CustomEvent<boolean>): void

Parameters

args: CustomEvent<boolean>

Returns void

onRowAdd

onRowAdd(args: CustomEvent<IgrRowDataCancelableEventArgs>): void

Parameters

args: CustomEvent<IgrRowDataCancelableEventArgs>

Returns void

onRowAdded

onRowAdded(args: CustomEvent<IgrRowDataEventArgs>): void

Parameters

args: CustomEvent<IgrRowDataEventArgs>

Returns void

onRowClick

onRowClick(args: CustomEvent<IgrGridRowEventArgs>): void

Parameters

args: CustomEvent<IgrGridRowEventArgs>

Returns void

onRowDelete

onRowDelete(args: CustomEvent<IgrRowDataCancelableEventArgs>): void

Parameters

args: CustomEvent<IgrRowDataCancelableEventArgs>

Returns void

onRowDeleted

onRowDeleted(args: CustomEvent<IgrRowDataEventArgs>): void

Parameters

args: CustomEvent<IgrRowDataEventArgs>

Returns void

onRowDragEnd

onRowDragEnd(args: CustomEvent<IgrRowDragEndEventArgs>): void

Parameters

args: CustomEvent<IgrRowDragEndEventArgs>

Returns void

onRowDragStart

onRowDragStart(args: CustomEvent<IgrRowDragStartEventArgs>): void

Parameters

args: CustomEvent<IgrRowDragStartEventArgs>

Returns void

onRowEdit

onRowEdit(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

args: CustomEvent<IgrGridEditEventArgs>

Returns void

onRowEditDone

onRowEditDone(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

args: CustomEvent<IgrGridEditDoneEventArgs>

Returns void

onRowEditEnter

onRowEditEnter(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

args: CustomEvent<IgrGridEditEventArgs>

Returns void

onRowEditExit

onRowEditExit(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

args: CustomEvent<IgrGridEditDoneEventArgs>

Returns void

onRowPinned

onRowPinned(args: CustomEvent<IgrPinRowEventArgs>): void

Parameters

args: CustomEvent<IgrPinRowEventArgs>

Returns void

onRowPinning

onRowPinning(args: CustomEvent<IgrPinRowEventArgs>): void

Parameters

args: CustomEvent<IgrPinRowEventArgs>

Returns void

onRowSelectionChanging

onRowSelectionChanging(args: CustomEvent<IgrRowSelectionEventArgs>): void

Parameters

args: CustomEvent<IgrRowSelectionEventArgs>

Returns void

onRowToggle

onRowToggle(args: CustomEvent<IgrRowToggleEventArgs>): void

Parameters

args: CustomEvent<IgrRowToggleEventArgs>

Returns void

onSelected

onSelected(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

args: CustomEvent<IgrGridCellEventArgs>

Returns void

onSelectedRowsChange

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

Parameters

args: CustomEvent<any[]>

Returns void

onSorting

onSorting(args: CustomEvent<IgrSortingEventArgs>): void

Parameters

args: CustomEvent<IgrSortingEventArgs>

Returns void

onSortingDone

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

Parameters

args: CustomEvent<IgrSortingExpression[]>

Returns void

onSortingExpressionsChange

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

Parameters

args: CustomEvent<IgrSortingExpression[]>

Returns void

onToolbarExporting

onToolbarExporting(args: CustomEvent<IgrGridToolbarExportEventArgs>): void

Parameters

args: CustomEvent<IgrGridToolbarExportEventArgs>

Returns void

onValidationStatusChange

onValidationStatusChange(args: CustomEvent<IgrGridValidationStatusEventArgs>): void

Parameters

args: CustomEvent<IgrGridValidationStatusEventArgs>

Returns void

onValueInit

onValueInit(args: CustomEvent<IgrPivotValue>): void

Parameters

args: CustomEvent<IgrPivotValue>

Returns void

onValuesChange

onValuesChange(args: CustomEvent<IgrValuesChange>): void

Parameters

args: CustomEvent<IgrValuesChange>