IPivotExpandableDimension
Configuration of a pivot dimension.
Properties
Section titled "Properties"Optional childLevel
Section titled "childLevel"Inherited from: IPivotDimension
Allows defining a hierarchy when multiple sub groups need to be extracted from single member.
childLevel?: IPivotDimensionDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:113
Optional dataType
Section titled "dataType"Inherited from: IPivotDimension
The dataType of the related data field.
dataType?: GridColumnDataTypeDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:138
Optional displayName
Section titled "displayName"Inherited from: IPivotDimension
Display name to show instead of the field name of this value. *
displayName?: stringDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:122
enabled
Section titled "enabled"Inherited from: IPivotDimension
Enables/Disables a particular dimension from pivot structure.
enabled: booleanDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:124
expandable
Section titled "expandable"expandable: booleanDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:165
Optional filter
Section titled "filter"Inherited from: IPivotDimension
A predefined or defined via the igxPivotSelector filter expression tree for the current dimension to be applied in the filter pipe.
filter?: IFilteringExpressionsTree | nullDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:128
Optional headerFormatter
Section titled "headerFormatter"Inherited from: IPivotDimension
Optional function to format the display value of a dimension header.
Unlike memberFunction, this does not affect the data key used for grouping or sorting —
it is applied when rendering the dimension header text (both row and column dimension headers).
When set, the return value of this function is shown instead of the raw dimension value.
Return null or undefined to fall back to the raw value.
headerFormatter?: objectDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:161
Example
// Display dates in a locale-aware short date format.
{ memberName: 'Date', enabled: true, headerFormatter: (value) => new Date(value).toLocaleDateString() }Optional horizontalSummary
Section titled "horizontalSummary"Inherited from: IPivotDimension
horizontalSummary?: booleanDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:145
Optional level
Section titled "level"Inherited from: IPivotDimension
Level of the dimension.
level?: numberDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:142
Optional memberFunction
Section titled "memberFunction"Inherited from: IPivotDimension
Function that extracts the value
memberFunction?: objectDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:120
memberName
Section titled "memberName"Inherited from: IPivotDimension
Unique member to extract related data field value or the result of the memberFunction.
memberName: stringDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:115
Optional sortable
Section titled "sortable"Inherited from: IPivotDimension
Enable/disable sorting for a particular dimension. True by default.
sortable?: booleanDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:130
Optional sortDirection
Section titled "sortDirection"Inherited from: IPivotDimension
The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension.
sortDirection?: SortingDirectionDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:134
Optional width
Section titled "width"Inherited from: IPivotDimension
The width of the dimension cells to be rendered.Can be pixel, % or "auto".
width?: stringDefined in projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts:140