PivotSettings
Configures local relational pivoting for the Grid.
Defines the report layout, aggregation values, and expansion behavior for pivot result generation.
Requires the PivotModule feature registration.
Props
The following table outlines the props for the PivotSettings:
| Name | Type | Default | Description |
|---|---|---|---|
| columns | (Extract<keyof T, string> | (string & {}))[] | - | Column dimensions included in the pivot report. Each value represents a source field that builds the horizontal hierarchy. |
| defaultExpanded | boolean | false | Expands each result hierarchy by default. |
| deferLayoutUpdate | boolean | false | Defers layout updates until the user applies the current pivot configuration. |
| enabled | boolean | false | Enables or disables pivot result rendering. |
| maxGeneratedColumns | number | 200 | Maximum generated value columns, including totals, before the report is capped. |
| memberFilters | - | Source-member selections applied before aggregation. Supports engine paging and worker-driven calculations when enabled. | |
| memberSorts | - | Member ordering applied independently to row and column dimensions. | |
| rows | (Extract<keyof T, string> | (string & {}))[] | - | Row dimensions included in the pivot report. Each value represents a source field that builds the vertical hierarchy. |
| showGrandTotals | boolean | true | Shows a bottom total row and trailing total columns for the result matrix. |
| showPanel | boolean | false | Shows the pivot field panel and toggle UI. |
| showSubTotals | boolean | true | Shows summary values for parent rows in the hierarchy. |
| showTooltip | boolean | false | Shows a hover tooltip on pivot value cells.
Displays default measure summary content when |
| tooltipTemplate | (context: PivotCellContext<T>) => node | - | Custom content renderer for pivot value-cell tooltips. Receives the cell context for the hovered value intersection. |
| useEnginePaging | boolean | false | Calculates result pages using a retained engine session. |
| values | - | Summary definitions used to calculate values for each pivot intersection. |