Class IgrPivotGrid

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

Callable

IgrPivotGrid(): ReactNode
Returns ReactNode

Accessors

Events

Methods

Properties

Accessors

allDimensions

allDimensions: IgrPivotDimension[]

Gets the full list of dimensions.

dimensionsSortingExpressions

dimensionsSortingExpressions: IgrSortingExpression[]

Gets the sorting expressions generated for the dimensions.

selectedRows

selectedRows: any[]

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

onDimensionInit

onDimensionInit: (args: CustomEvent<IgrPivotDimension>) => void

Type declaration

onDimensionsChange

onDimensionsChange: (args: CustomEvent<IgrDimensionsChange>) => void

Type declaration

onDimensionsSortingExpressionsChange

onDimensionsSortingExpressionsChange: (args: CustomEvent<IgrSortingExpression[]>) => 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

onGridKeydown

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

Type declaration

onGridScroll

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

Type declaration

onPivotConfigurationChange

onPivotConfigurationChange: (args: CustomEvent<IgrPivotConfigurationChangedEventArgsDetail>) => 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

onValueInit

onValueInit: (args: CustomEvent<IgrPivotValue>) => void

Type declaration

onValuesChange

onValuesChange: (args: CustomEvent<IgrValuesChange>) => void

Type declaration

Methods

autoSizeRowDimension

autoSizeRowDimension(dimension: IgrPivotDimension): void
Auto-sizes row dimension cells.
Remarks
Only sizes based on the dimension cells in view.
Example
```
this.grid.autoSizeRowDimension(dimension);
```
Parameters
- dimension: IgrPivotDimension
  The row dimension to size.
Returns void

filterDimension

filterDimension(
    dimension: IgrPivotDimension,
    value: any,
    conditionOrExpressionTree?:
        | IgrFilteringExpressionsTree
        | IgrFilteringOperation,
): void
Filters a single IPivotDimension.
Example
```
public filter() {
     const set = new Set();
     set.add('Value 1');
     set.add('Value 2');
     this.grid1.filterDimension(this.pivotConfigHierarchy.rows[0], set, IgxStringFilteringOperand.instance().condition('in'));
}
```
Parameters
- dimension: IgrPivotDimension
- value: any
- conditionOrExpressionTree: IgrFilteringExpressionsTree | IgrFilteringOperation
Returns void

getColumnGroupExpandState

getColumnGroupExpandState(col: IgrColumn): void
Parameters
- col: IgrColumn
Returns void

insertDimensionAt

insertDimensionAt(
    dimension: IgrPivotDimension,
    targetCollectionType: PivotDimensionType,
    index?: number,
): void
Inserts dimension in target collection by type at specified index or at the collection's end.
Example
```
this.grid.insertDimensionAt(dimension, PivotDimensionType.Row, 1);
```
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

insertValueAt

insertValueAt(value: IgrPivotValue, index?: number): void
Inserts value at specified index or at the end.
Example
```
this.grid.insertValueAt(value, 1);
```
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

moveDimension

moveDimension(
    dimension: IgrPivotDimension,
    targetCollectionType: PivotDimensionType,
    index?: number,
): void
Move dimension from its currently collection to the specified target collection by type at specified index or at the collection's end.
Example
```
this.grid.moveDimension(dimension, PivotDimensionType.Row, 1);
```
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

moveValue

moveValue(value: IgrPivotValue, index?: number): void
Move value from its currently at specified index or at the end.
Example
```
this.grid.moveValue(value, 1);
```
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

notifyDimensionChange

notifyDimensionChange(regenerateColumns?: boolean): void
Notifies for dimension change.

Parameters
- regenerateColumns: boolean
Returns void

removeDimension

removeDimension(dimension: IgrPivotDimension): void
Removes dimension from its currently collection.
Remarks
This is different than toggleDimension that enabled/disables the dimension. This completely removes the specified dimension from the collection.
Example
```
this.grid.removeDimension(dimension);
```
Parameters
- dimension: IgrPivotDimension
  The dimension to be removed.
Returns void

removeValue

removeValue(value: IgrPivotValue): void
Removes value from collection.
Remarks
This is different than toggleValue that enabled/disables the value. This completely removes the specified value from the collection.
Example
```
this.grid.removeValue(dimension);
```
Parameters
- value: IgrPivotValue
  The value to be removed.
Returns void

sortDimension

sortDimension(
dimension: IgrPivotDimension,
sortDirection: SortingDirection,
): void
Sort the dimension and its children in the provided direction.
Example
```
this.grid.sortDimension(dimension, SortingDirection.Asc);
```
Parameters
- dimension: IgrPivotDimension
- sortDirection: SortingDirection
Returns void

toggleColumn

toggleColumn(col: IgrColumn): void
Parameters
- col: IgrColumn
Returns void

toggleDimension

toggleDimension(dimension: IgrPivotDimension): void
Toggles the dimension's enabled state on or off.
Remarks
The dimension remains in its current collection. This just changes its enabled state.
Example
```
this.grid.toggleDimension(dimension);
```
Parameters
- dimension: IgrPivotDimension
  The dimension to be toggled.
Returns void

toggleRowGroup

toggleRowGroup(col: IgrColumn, newState: boolean): void
Parameters
- col: IgrColumn
- newState: boolean
Returns void

toggleValue

toggleValue(value: IgrPivotValue): void
Toggles the value's enabled state on or off.
Remarks
The value remains in its current collection. This just changes its enabled state.
Example
```
this.grid.toggleValue(value);
```
Parameters
- value: IgrPivotValue
  The value to be toggled.
Returns void

Properties

autoGenerateConfig

autoGenerateConfig: boolean

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

data

data: any[]

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

<igx-pivot-grid [data]="Data"></igx-pivot-grid>

defaultExpandState

defaultExpandState: boolean

Gets/Sets the default expand state for all rows.

emptyPivotGridTemplate

emptyPivotGridTemplate: IgcRenderFunction<void>

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

pivotConfiguration

pivotConfiguration: IgrPivotConfiguration

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

pivotUI

pivotUI: IgrPivotUISettings

rowDimensionHeaderTemplate

rowDimensionHeaderTemplate: IgcRenderFunction<IgrColumnTemplateContext>

superCompactMode

superCompactMode: boolean

Enables a super compact theme for the component.

valueChipTemplate

valueChipTemplate: IgcRenderFunction<IgrPivotGridValueTemplateContext>

Gets/Sets a custom template for the value chips.

Class IgrPivotGrid

Callable

Returns ReactNode

Accessors

Events

Methods

Properties

Accessors

allDimensions

dimensionsSortingExpressions

selectedRows

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

onDimensionInit

Type declaration

onDimensionsChange

Type declaration

onDimensionsSortingExpressionsChange

Type declaration

onDoubleClick

Type declaration

onExpansionStatesChange

Type declaration

onFiltering

Type declaration

onFilteringDone

Type declaration

onFilteringExpressionsTreeChange

Type declaration

onFormGroupCreated

Type declaration

onGridCopy

Type declaration

onGridKeydown

Type declaration

onGridScroll

Type declaration

onPivotConfigurationChange

Type declaration