Blazorise Pivot Grid API
Explore the Blazorise Pivot Grid API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the Pivot Grid documentation.
API
Parameters
PivotGrid
| Parameter | Default | Type |
|---|---|---|
AggregateHeaderTemplate | null | RenderFragment<PivotGridAggregateHeaderContext<TItem>> |
Custom content for aggregate header cells. | ||
Bordered | true | bool |
Defines whether table cells have borders. | ||
CellTemplate | null | RenderFragment<PivotGridCellContext<TItem>> |
Custom content for aggregate value cells. | ||
ChildContent | null | RenderFragment |
Defines child content. Field components can be declared directly here. | ||
ColumnGroupCaptionMode | Leaf | PivotGridGroupCaptionMode |
Defines how column group captions are displayed. Possible values: FullPathLeafFieldHidden | ||
ColumnHeaderTemplate | null | RenderFragment<PivotGridColumnHeaderContext<TItem>> |
Custom content for column header cells. | ||
ColumnTotalPosition | After | PivotGridTotalPosition |
Defines column subtotal position. Possible values: AfterBefore | ||
Data | null | IEnumerable<TItem> |
Defines the source data to be analyzed. | ||
DataProvider | null | IPivotGridDataProvider<TItem> |
Defines an external data provider used to read pivot grid data. When assigned, it has priority over ReadData and Data. | ||
EmptyTemplate | null | RenderFragment |
Custom content shown when the pivot result is empty. | ||
ExpandableColumns | false | bool |
Enables expanding and collapsing column groups. | ||
ExpandableRows | true | bool |
Enables expanding and collapsing row groups. | ||
FieldChooser | false | bool |
Enables the runtime field chooser. | ||
GroupCaptionSeparator | " / " | string |
Defines the separator used when group captions show the full path. | ||
HeaderTemplate | null | RenderFragment<PivotGridHeaderContext<TItem>> |
Custom content for row field header cells. | ||
HeaderThemeContrast | None | ThemeContrast |
Defines whether header uses theme contrast. Possible values: NoneLightDark | ||
Hoverable | true | bool |
Defines whether rows show hover styling. | ||
InitiallyExpanded | true | bool |
Defines whether expandable groups are expanded on first render. | ||
Localizers | null | PivotGridLocalizers |
Custom localizer handlers to override default PivotGrid localization. | ||
MaxPaginationLinks | 5 | int |
Maximum number of page links visible at once. | ||
MissingValuesTemplate | null | RenderFragment |
Custom content shown when no value fields are declared. | ||
Narrow | false | bool |
Defines whether cells use narrow spacing. | ||
NoDataTemplate | null | RenderFragment |
Custom content shown when there are no data rows. | ||
Page | 1 | int |
Currently selected page. | ||
PageByGroups | false | bool |
Defines whether paging is applied to top-level row groups instead of rendered pivot rows. | ||
PagerSize | Default | Size? |
Pager control size. When omitted, uses Size.Default. | ||
PageSize | 10 | int |
Number of rendered pivot rows per page. | ||
PageSizes | [5, 10, 25, 50, 100] | IEnumerable<int> |
Available page size options. | ||
Responsive | true | bool |
Defines whether table is responsive. | ||
RowGroupCaptionMode | FullPath | PivotGridGroupCaptionMode |
Defines how row group captions are displayed. Possible values: FullPathLeafFieldHidden | ||
RowHeaderTemplate | null | RenderFragment<PivotGridRowHeaderContext<TItem>> |
Custom content for row header cells. | ||
RowTotalPosition | After | PivotGridTotalPosition |
Defines row subtotal position. Possible values: AfterBefore | ||
ShowColumnSubtotals | true | bool |
Shows subtotal columns for column dimensions. | ||
ShowColumnTotals | true | bool |
Shows totals for each column as total rows. | ||
ShowPager | false | bool |
Shows pager controls for rendered pivot rows. | ||
ShowPageSizes | false | bool |
Shows page size selector in the pager. | ||
ShowRowSubtotals | true | bool |
Shows subtotal rows for row dimensions. | ||
ShowRowTotals | true | bool |
Shows totals for each row as total columns. | ||
ShowToolbar | false | bool |
Shows built-in PivotGrid toolbar commands when available. Use ToolbarTemplate for custom toolbar content. | ||
Striped | false | bool |
Defines whether rows are striped. | ||
ToolbarOptions | new() | PivotGridToolbarOptions |
Defines options for the built-in toolbar. | ||
ToolbarTemplate | null | RenderFragment<PivotGridToolbarContext<TItem>> |
Custom toolbar content. | ||
Virtualize | false | bool |
Enables virtualized rendering of pivot rows. Ignored when ShowPager is enabled. When local Data is used, virtualization reduces rendered rows only; the full pivot result is still computed before rendering. For large remote datasets, use ReadData or DataProvider with Virtualize and return prepared Result rows for the requested range. | ||
VirtualizeOptions | null | PivotGridVirtualizeOptions |
Defines virtualized row rendering options. These options tune rendered row virtualization only. They do not change local pivot grouping or aggregate calculation behavior. | ||
PivotGridField
| Parameter | Default | Type |
|---|---|---|
Caption | Field | string |
Optional caption shown in headers. | ||
DisplayFormat | — | string |
Specifies a direct format specifier or composite format string for the default display text. | ||
DisplayFormatProvider | null | IFormatProvider |
Specifies display format provider. | ||
DisplayTemplate | null | RenderFragment<PivotGridFieldValueContext<TItem>> |
Defines custom field value template. | ||
EmptyText | string.Empty | string |
Text shown when the field value is null. | ||
Field | — | string |
Field path bound to this PivotGrid field. | ||
HeaderTemplate | null | RenderFragment<PivotGridHeaderContext<TItem>> |
Defines custom header template. | ||
Visible | true | bool |
Determines whether this field participates in the PivotGrid. | ||
PivotGridColumn
| Parameter | Default | Type |
|---|---|---|
Caption | Field | string |
Optional caption shown in headers. | ||
DisplayFormat | — | string |
Specifies a direct format specifier or composite format string for the default display text. | ||
DisplayFormatProvider | null | IFormatProvider |
Specifies display format provider. | ||
DisplayTemplate | null | RenderFragment<PivotGridFieldValueContext<TItem>> |
Defines custom field value template. | ||
EmptyText | string.Empty | string |
Text shown when the field value is null. | ||
Field | — | string |
Field path bound to this PivotGrid field. | ||
HeaderTemplate | null | RenderFragment<PivotGridHeaderContext<TItem>> |
Defines custom header template. | ||
Visible | true | bool |
Determines whether this field participates in the PivotGrid. | ||
PivotGridRow
| Parameter | Default | Type |
|---|---|---|
Caption | Field | string |
Optional caption shown in headers. | ||
DisplayFormat | — | string |
Specifies a direct format specifier or composite format string for the default display text. | ||
DisplayFormatProvider | null | IFormatProvider |
Specifies display format provider. | ||
DisplayTemplate | null | RenderFragment<PivotGridFieldValueContext<TItem>> |
Defines custom field value template. | ||
EmptyText | string.Empty | string |
Text shown when the field value is null. | ||
Field | — | string |
Field path bound to this PivotGrid field. | ||
HeaderTemplate | null | RenderFragment<PivotGridHeaderContext<TItem>> |
Defines custom header template. | ||
Visible | true | bool |
Determines whether this field participates in the PivotGrid. | ||
PivotGridAggregate
| Parameter | Default | Type |
|---|---|---|
Aggregate | Sum | PivotGridAggregateFunction |
Defines which built-in aggregate function is used. Possible values: CountCountNonNullSumAverageMinMax | ||
Caption | Field | string |
Optional caption shown in headers. | ||
CellTemplate | null | RenderFragment<PivotGridCellContext<TItem>> |
Defines custom aggregate cell template. | ||
DisplayFormat | — | string |
Specifies a direct format specifier or composite format string for the default display text. | ||
DisplayFormatProvider | null | IFormatProvider |
Specifies display format provider. | ||
DisplayTemplate | null | RenderFragment<PivotGridFieldValueContext<TItem>> |
Defines custom field value template. | ||
EmptyText | string.Empty | string |
Text shown when the field value is null. | ||
Field | — | string |
Field path bound to this PivotGrid field. | ||
HeaderTemplate | null | RenderFragment<PivotGridHeaderContext<TItem>> |
Defines custom header template. | ||
Visible | true | bool |
Determines whether this field participates in the PivotGrid. | ||
PivotGridToolbarOptions
| Parameter | Default | Type |
|---|---|---|
ShowExpandCollapseButtons | true | bool |
Gets or sets whether the expand all and collapse all buttons are shown. | ||
ShowFieldChooserButton | true | bool |
Gets or sets whether the field chooser button is shown. | ||
ShowRefreshButton | false | bool |
Gets or sets whether the refresh button is shown. | ||
ShowResetLayoutButton | true | bool |
Gets or sets whether the reset layout button is shown. | ||
PivotGridVirtualizeOptions
| Parameter | Default | Type |
|---|---|---|
Height | "500px" | string |
Gets or sets the PivotGrid table container height when virtualization is enabled. | ||
ItemSize | 50f | float |
Gets or sets the expected virtualized item size in pixels. | ||
MaxHeight | "500px" | string |
Gets or sets the PivotGrid table container maximum height when virtualization is enabled. | ||
OverscanCount | 10 | int |
Gets or sets how many additional items will be rendered before and after the visible region. | ||
Events
PivotGrid
| Event | Type |
|---|---|
CellClicked | EventCallback<PivotGridCellClickedEventArgs<TItem>> |
Occurs when an aggregate cell is clicked. | |
CellStyling | Action<PivotGridCellContext<TItem>, PivotGridCellStyling> |
Custom styling for aggregate value cells. | |
ColumnHeaderStyling | Action<PivotGridColumnHeaderContext<TItem>, PivotGridCellStyling> |
Custom styling for column header cells. | |
PageChanged | EventCallback<int> |
Occurs after the page has changed. | |
PageSizeChanged | EventCallback<int> |
Occurs after the page size has changed. | |
ReadData | EventCallback<PivotGridReadDataEventArgs<TItem>> |
Occurs when the pivot grid requests data from an external provider. Ignored when DataProvider is assigned. | |
RowHeaderStyling | Action<PivotGridRowHeaderContext<TItem>, PivotGridCellStyling> |
Custom styling for row header cells. | |
PivotGridAggregate
| Event | Type |
|---|---|
Aggregator | Func<IReadOnlyList<TItem>, object> |
Defines a custom aggregate function. When set, it takes precedence over Aggregate. | |
Methods
PivotGrid
| Method | Return | Parameters |
|---|---|---|
Reload | Task | — |
Reloads the PivotGrid data and rebuilds the pivot result.
| ||
PivotGridField
| Method | Return | Parameters |
|---|---|---|
FormatValue | string | object value |
Formats a field value.
| ||
GetCaption | string | — |
Gets the field caption.
| ||
GetValue | object | TItem item |
Gets the field value from the supplied item.
| ||
PivotGridColumn
| Method | Return | Parameters |
|---|---|---|
FormatValue | string | object value |
Formats a field value.
| ||
GetCaption | string | — |
Gets the field caption.
| ||
GetValue | object | TItem item |
Gets the field value from the supplied item.
| ||
PivotGridRow
| Method | Return | Parameters |
|---|---|---|
FormatValue | string | object value |
Formats a field value.
| ||
GetCaption | string | — |
Gets the field caption.
| ||
GetValue | object | TItem item |
Gets the field value from the supplied item.
| ||
PivotGridAggregate
| Method | Return | Parameters |
|---|---|---|
Calculate | object | IReadOnlyList<TItem> items |
Calculates the aggregate value for the supplied source items.
| ||
FormatValue | string | object value |
Formats a field value.
| ||
GetCaption | string | — |
Gets the field caption.
| ||
GetValue | object | TItem item |
Gets the field value from the supplied item.
| ||