PivotTable Properties

Name	Type	Default	Description
ColumnReorder	bool	false	Sets or gets whether the reordering of columns is enabled.
Columns	IEnumerable<IPivotTableColumn>	N/A	Describes the columns of the PivotTable's original tabular data. Based on these settings and the data source, the actual columns of the PivotTable are dynamically generated.
ColumnTotals	bool	false	Sets or gets whether to show total columns for each pivot data point. When enabled, all summary columns must have the same summary function set by which total columns are calculated.
ColumnTotalsPosition	PivotTableColumnTotalsPosition	PivotTableColumnTotalsPosition.Near	Sets or gets the position of total columns (shown when columnTotals is enabled).
ConditionalFormatting	IEnumerable<IPivotTableConditionalFormatting>	N/A	Sets or gets details about conditional formatting to be applied to the PivotTable's cells.
DataSource	object		Determines the original tabular data source of the PivotTable.
DefaultSortByRowGroups	bool	false	Sets or gets whether the original tabular data sourse of the PivotTable will be pre-sorted based on columns with the rowGroup property (and their order).
Designer	bool	false	Sets or gets whether to display the PivotTable's designer alongside the table itself. The designer allows for configuring column settings and applying filtering.
DesignerPosition	PivotTableDesignerPosition	PivotTableDesignerPosition.Far	Sets or gets the position of the PivotTable's designer (shown when designer is enabled).
Disabled	bool	false	Disables the interaction with the element.
DrillDown	bool	false	If enabled, shows the original tabular data that has been aggregated in a PivotTable summary cell when the cell is double-clicked or F2 is pressed.
DrillDownDataExport	PivotTableDrillDownDataExport	PivotTableDrillDownDataExport.	If set, shows an export button in the drill down dialog.
DrillDownDataExportName	string	""	Sets or gets the drill down table export file name.
DrillDownTableInit	Action<object>	N/A	Sets or gets the drill down dialog callback function. The argument of the callback passed by the PivotTable is the drill-down Table component. You can use it to customize the table.
DrillDownCustomAction	Action<object>	N/A	Sets or gets the drill down custom action callback function. The argument of the callback passed by the PivotTable is the drill-down data source. You can use it to override the default drill-down UI i.e to replace our Dialog with Table.
EnableSortByRowGroups	bool	false	Sets or gets whether sorting based on columns in classic row groups layout mode is enabled.
FreezeHeader	bool	false	Sets or gets whether the PivotTable's column header is sticky/frozen.
GetDefaultSummaryFunction	Action<object>	N/A	A callback function that returns the default summary function of a summary column when it is dynamically assigned as such (e.g. by drag-drop in the designer).
GrandTotal	bool	false	Sets or gets whether to show a Grand total row aggregating the data of all rows.
GroupLayout	PivotTableGroupLayout	PivotTableGroupLayout.Default	Sets or gets the way row nesting (based on rowGroup columns) is displayed.
HideCellSelectionTooltip	bool	false	Sets or gets whether to hide the tooltip that displays details when multiple summary cells with non-null values are selected.
HideEmptyRows	bool	false	Sets or gets whether to hide rows that contain only 0 or null values. Applicable only when there are rowGroup columns.
KeyboardNavigation	bool	false	Sets or gets whether navigation with the keyboard is enabled in the PivotTable.
Locale	string	"en"	Sets or gets the language. Used in conjunction with the property messages.
Messages	object	N/A	Sets or gets an object specifying strings used in the element that can be localized. Used in conjunction with the property locale.
NullDefaultValue	int	N/A	Sets or gets what value is shown in cells that do not have aggregated data to display. By default (null), such cells are empty.
OnCellRender	Action<object>	N/A	A callback function executed each time a PivotTable cell is rendered.
OnColumnRender	Action<object>	N/A	A callback function executed each time a PivotTable column header cell is rendered.
OnInit	Action<object>	N/A	A callback function executed when the PivotTable is being initialized.
RightToLeft	bool	false	Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
RowSort	bool	false	Sets or gets whether sorting by row (when a row group cell is clicked) is enabled. When columnTotals is also enabled, sorting is applied per "column group"; otherwise - for all columns.
RowSummary	bool	true	Sets or gets whether row summaries are displayed in the row headers. Example: Peterson(40) vs Peterson, when rowSummary is set to false.
RowTotals	bool	false	Sets or gets whether to show row total columns for each summary column.
RowTotalsPosition	PivotTableRowTotalsPosition	PivotTableRowTotalsPosition.Near	Sets or gets the position of row total columns (shown when rowTotals is enabled).
Selection	bool	false	Sets or gets whether row selection (via checkboxes) is enabled.
SelectionMode	PivotTableSelectionMode	PivotTableSelectionMode.Many	Sets or gets the selection mode. Only applicable when selection is enabled.
SortMode	PivotTableSortMode	PivotTableSortMode.None	Determines the sorting mode of the PivotTable.
Theme	string	""	Determines the theme. Theme defines the look of the element
Toolbar	bool	false	Sets or gets whether the PivotTable's toolbar is shown. It contains two breadcrumb components that allow the modification of the row group and pivot columns, as well as the "Conditional Formatting" and "Fields" buttons that open a dialog with additional settings.
Tooltip	bool	false	Sets or gets whether when hovering a cell with truncated content, a tooltip with the full content will be shown.

PivotTable Methods

Name	Type	Arguments	Description
AddFilter	void	string dataField, object filter	Adds a filter to a specific column.Args: string dataField - The column's data field.,object filter - FilterGroup object.
ClearFilters	void	N/A	Clears applied filters.
ClearSelection	void	N/A	Clears selection.
ClearSort	void	N/A	Clears the PivotTable sorting.
CollapseAllRows	void	N/A	Collapses all rows (when multiple row groups are applied).
CollapseRow	void	object rowId	Collapses a row (when multiple row groups are applied).Args: string rowId - The id of the row to collapse. Can be retrieved from the "rows" collection.
CollapseRow	void	string rowId	Collapses a row (when multiple row groups are applied).Args: string rowId - The id of the row to collapse. Can be retrieved from the "rows" collection.
CollapseRow	void	int rowId	Collapses a row (when multiple row groups are applied).Args: int rowId - The id of the row to collapse. Can be retrieved from the "rows" collection.
ExpandAllRows	void	N/A	Expands all rows (when multiple row groups are applied).
ExpandRow	void	object rowId	Expands a row (when multiple row groups are applied).Args: string rowId - The id of the row to expand. Can be retrieved from the "rows" collection.
ExpandRow	void	string rowId	Expands a row (when multiple row groups are applied).Args: string rowId - The id of the row to expand. Can be retrieved from the "rows" collection.
ExpandRow	void	int rowId	Expands a row (when multiple row groups are applied).Args: int rowId - The id of the row to expand. Can be retrieved from the "rows" collection.
ExportData	object	string dataFormat, string fileName, Action<object> callback	Exports the PivotTable's data.Args: string dataFormat - The file format to export to. Supported formats: 'csv', 'html', 'json', 'pdf', 'tsv', 'xlsx', 'xml'.,string fileName - The name of the file to export to,Action<object> callback - A callback function to pass the exported data to (if fileName is not provided)
ExportData	object	string dataFormat, string fileName	Exports the PivotTable's data.
GetDataSourceAsync()	Task<IEnumerable<object>>	'N/A'	Gets the &quot;DataSource&quot; property as Task&lt;IEnumerable&lt;object&gt;&gt;.
GetDynamicColumns	IEnumerable<object>	N/A	Returns the current dynamic pivot columns.
GetSelection	IEnumerable<object>	N/A	Returns an array of selected row ids (when "selectionMode" is "'many'" or "'extended'") or an array of selected cell details (when "selectionMode" is "'cell'").
Refresh	void	'N/A'	Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements.
Refresh	void	N/A	Refreshes the PivotTable.
RemoveFilter	void	string dataField	Removes filters applied to a specific column.Args: string dataField - The column's data field.
Render	void	'N/A'	Re-renders the Blazor Component. This method will make a full re-render.
Select	void	IEnumerable<object> rowId, string dataField	Selects one or more rows (when "selectionMode" is "'many'" or "'extended'") or a single cell (when "selectionMode" is "'cell'" and the second argument is passed).Args: IEnumerable<object> rowId - The id of the row (or an array of row ids) to select (or of the cell's parent row when "selectionMode" is "'cell'"). Can be retrieved from the "rows" collection.,string dataField - The dataField of the dynamic column (can be retrieved by calling "getDynamicColumns") of the cell to select (only applicable when "selectionMode" is "'cell'").
Select	void	IEnumerable<object> rowId	Selects one or more rows (when selectionMode is 'many' or 'extended') or a single cell (when selectionMode is 'cell' and the second argument is passed).
Select	void	string rowId, string dataField	Selects one or more rows (when "selectionMode" is "'many'" or "'extended'") or a single cell (when "selectionMode" is "'cell'" and the second argument is passed).Args: string rowId - The id of the row (or an array of row ids) to select (or of the cell's parent row when "selectionMode" is "'cell'"). Can be retrieved from the "rows" collection.,string dataField - The dataField of the dynamic column (can be retrieved by calling "getDynamicColumns") of the cell to select (only applicable when "selectionMode" is "'cell'").
Select	void	string rowId	Selects one or more rows (when selectionMode is 'many' or 'extended') or a single cell (when selectionMode is 'cell' and the second argument is passed).
Select	void	int rowId, string dataField	Selects one or more rows (when "selectionMode" is "'many'" or "'extended'") or a single cell (when "selectionMode" is "'cell'" and the second argument is passed).Args: int rowId - The id of the row (or an array of row ids) to select (or of the cell's parent row when "selectionMode" is "'cell'"). Can be retrieved from the "rows" collection.,string dataField - The dataField of the dynamic column (can be retrieved by calling "getDynamicColumns") of the cell to select (only applicable when "selectionMode" is "'cell'").
Select	void	int rowId	Selects one or more rows (when selectionMode is 'many' or 'extended') or a single cell (when selectionMode is 'cell' and the second argument is passed).
SortBy	void	object columnDefinition, string sortOrder	Sorts by a summary or group column.Args: object columnDefinition - The dynamic column's definition. Can be retrieved from the method "getDynamicColumns".,string sortOrder - Sort order. Possible values: 'asc' (ascending), 'desc' (descending), and null (removes sorting by column). If not provided, toggles the sorting.
SortBy	void	object columnDefinition	Sorts by a summary or group column.
StateHasChanged	void	'N/A'	Refreshes the state and Re-renders the Blazor Component, if necessary.
Unselect	void	IEnumerable<object> rowId, string dataField	Unselects one or more rows (when "selectionMode" is "'many'" or "'extended'") or a single cell (when "selectionMode" is "'cell'" and the second argument is passed).Args: IEnumerable<object> rowId - The id of the row (or an array of row ids) to select (or of the cell's parent row when "selectionMode" is "'cell'"). Can be retrieved from the "rows" collection.,string dataField - The dataField of the dynamic column (can be retrieved by calling "getDynamicColumns") of the cell to select (only applicable when "selectionMode" is "'cell'").
Unselect	void	IEnumerable<object> rowId	Unselects one or more rows (when selectionMode is 'many' or 'extended') or a single cell (when selectionMode is 'cell' and the second argument is passed).
Unselect	void	string rowId, string dataField	Unselects one or more rows (when "selectionMode" is "'many'" or "'extended'") or a single cell (when "selectionMode" is "'cell'" and the second argument is passed).Args: string rowId - The id of the row (or an array of row ids) to select (or of the cell's parent row when "selectionMode" is "'cell'"). Can be retrieved from the "rows" collection.,string dataField - The dataField of the dynamic column (can be retrieved by calling "getDynamicColumns") of the cell to select (only applicable when "selectionMode" is "'cell'").
Unselect	void	string rowId	Unselects one or more rows (when selectionMode is 'many' or 'extended') or a single cell (when selectionMode is 'cell' and the second argument is passed).
Unselect	void	int rowId, string dataField	Unselects one or more rows (when "selectionMode" is "'many'" or "'extended'") or a single cell (when "selectionMode" is "'cell'" and the second argument is passed).Args: int rowId - The id of the row (or an array of row ids) to select (or of the cell's parent row when "selectionMode" is "'cell'"). Can be retrieved from the "rows" collection.,string dataField - The dataField of the dynamic column (can be retrieved by calling "getDynamicColumns") of the cell to select (only applicable when "selectionMode" is "'cell'").
Unselect	void	int rowId	Unselects one or more rows (when selectionMode is 'many' or 'extended') or a single cell (when selectionMode is 'cell' and the second argument is passed).

PivotTable Events

Name	Type	Description	Event Detail
OnCellClick	EventCallback<Event>	This event is triggered when a cell has been clicked.	string dataField- The data field of the cell's dynamic column., dynamic row- The data of the cell's row.
CellClicked	event PivotTableCellClickedEventHandler	This event is triggered when a cell has been clicked.	PivotTableCellClickedEventArgs
OnChange	EventCallback<Event>	This event is triggered when the selection is changed.	dynamic type- The type of action that initiated the selection change. Possible types: 'programmatic', 'interaction', 'remove'.
Changed	event PivotTableChangedEventHandler	This event is triggered when the selection is changed.	PivotTableChangedEventArgs
OnColumnClick	EventCallback<Event>	This event is triggered when a summary column header cell has been clicked.	dynamic columnDefinition- An object detailing the clicked dynamic column., string dataField- The data field of the cell's original column.
ColumnClicked	event PivotTableColumnClickedEventHandler	This event is triggered when a summary column header cell has been clicked.	PivotTableColumnClickedEventArgs
OnCollapse	EventCallback<Event>	This event is triggered when a row has been collapsed.	dynamic record- The (aggregated) data of the collapsed row.
Collapsed	event PivotTableCollapsedEventHandler	This event is triggered when a row has been collapsed.	PivotTableCollapsedEventArgs
OnCollapseTotalColumn	EventCallback<Event>	This event is triggered when a total column has been collapsed.	dynamic columnDefinition- The definition of the collapsed total column.
CollapseTotalColumned	event PivotTableCollapseTotalColumnedEventHandler	This event is triggered when a total column has been collapsed.	PivotTableCollapseTotalColumnedEventArgs
OnExpand	EventCallback<Event>	This event is triggered when a row has been expanded.	dynamic record- The (aggregated) data of the expanded row.
Expanded	event PivotTableExpandedEventHandler	This event is triggered when a row has been expanded.	PivotTableExpandedEventArgs
OnExpandTotalColumn	EventCallback<Event>	This event is triggered when a total column has been expanded.	dynamic columnDefinition- The definition of the expanded total column.
ExpandTotalColumned	event PivotTableExpandTotalColumnedEventHandler	This event is triggered when a total column has been expanded.	PivotTableExpandTotalColumnedEventArgs
OnFilter	EventCallback<Event>	This event is triggered when a filtering-related action is made.	dynamic action- The filtering action. Possible actions: 'add', 'remove'., dynamic filters- The added filters. Only when action is 'add'.
Filtered	event PivotTableFilteredEventHandler	This event is triggered when a filtering-related action is made.	PivotTableFilteredEventArgs
OnSort	EventCallback<Event>	This event is triggered when a column header cell has been clicked.	dynamic columns- An array with information about the dynamic columns the PivotTable has been sorted by.
Sorted	event PivotTableSortedEventHandler	This event is triggered when a column header cell has been clicked.	PivotTableSortedEventArgs

Enums

PivotTableColumnAlign

PivotTableColumnAlign.Center

PivotTableColumnAlign.Left

PivotTableColumnAlign.Right

PivotTableColumnDataType

PivotTableColumnDataType.Boolean

PivotTableColumnDataType.Date

PivotTableColumnDataType.Number

PivotTableColumnDataType.String

PivotTableColumnSummary

PivotTableColumnSummary.Avg

PivotTableColumnSummary.Count

PivotTableColumnSummary.Max

PivotTableColumnSummary.Median

PivotTableColumnSummary.Min

PivotTableColumnSummary.Product

PivotTableColumnSummary.Stdev

PivotTableColumnSummary.Stdevp

PivotTableColumnSummary.Sum

PivotTableColumnSummary.Var

PivotTableColumnSummary.Varp

PivotTableColumnTotalsPosition

PivotTableColumnTotalsPosition.Near

PivotTableColumnTotalsPosition.Far

PivotTableConditionalFormattingCondition

PivotTableConditionalFormattingCondition.Between

PivotTableConditionalFormattingCondition.Equal

PivotTableConditionalFormattingCondition.GreaterThan

PivotTableConditionalFormattingCondition.LessThan

PivotTableConditionalFormattingCondition.NotEqual

PivotTableConditionalFormattingFontFamily

PivotTableConditionalFormattingFontFamily.ThedefaultfontFamilyassetinCSS

PivotTableConditionalFormattingFontFamily.Arial

PivotTableConditionalFormattingFontFamily.CourierNew

PivotTableConditionalFormattingFontFamily.Georgia

PivotTableConditionalFormattingFontFamily.TimesNewRoman

PivotTableConditionalFormattingFontFamily.Verdana

PivotTableConditionalFormattingFontSize

PivotTableConditionalFormattingFontSize.Eightpx

PivotTableConditionalFormattingFontSize.Ninepx

PivotTableConditionalFormattingFontSize.Tenpx

PivotTableConditionalFormattingFontSize.Elevenpx

PivotTableConditionalFormattingFontSize.Twelvepx

PivotTableConditionalFormattingFontSize.Thirteenpx

PivotTableConditionalFormattingFontSize.Fourtheenpx

PivotTableConditionalFormattingFontSize.Fifteenpx

PivotTableConditionalFormattingFontSize.Sixteenpx

PivotTableDesignerPosition

PivotTableDesignerPosition.Near

PivotTableDesignerPosition.Far

PivotTableDrillDownDataExport

PivotTableDrillDownDataExport.Null

PivotTableDrillDownDataExport.Xlsx

PivotTableDrillDownDataExport.Pdf

PivotTableDrillDownDataExport.Html

PivotTableDrillDownDataExport.Json

PivotTableDrillDownDataExport.Csv

PivotTableDrillDownDataExport.Tsv

PivotTableDrillDownDataExport.Xml

PivotTableGroupLayout

PivotTableGroupLayout.Classic

PivotTableGroupLayout.Default

PivotTableRowTotalsPosition

PivotTableRowTotalsPosition.Near

PivotTableRowTotalsPosition.Far

PivotTableSelectionMode

PivotTableSelectionMode.Many

PivotTableSelectionMode.Extended

PivotTableSelectionMode.Cell

PivotTableSortMode

PivotTableSortMode.None

PivotTableSortMode.One

PivotTableSortMode.Many

PivotTableColumn Properties

Name	Type	Default	Description
Align	PivotTableColumnAlign	PivotTableColumnAlign.Left	Sets or gets the header cell alignment for pivot and summary columns and cell alignment for row group columns.
AllowFilter	bool	true	Sets or gets whether the column can be filtered.
AllowPivot	bool	false	Sets or gets whether the column can be a pivot column.
AllowRowGroup	bool	false	Sets or gets whether the column can be a row group column.
AllowSort	bool	true	Sets or gets whether summary columns based on the column can be sorted.
DataField	string	""	Sets or gets the column's data source-bound field.
DataType	PivotTableColumnDataType	PivotTableColumnDataType.String	Sets or gets the data type of the column's cells.
Label	string	""	Sets or gets the column's displayed text (for example in summary column headers).
Pivot	bool	false	Sets or gets whether the column is a pivot column. Data from pivot columns is represented as column hierarchy in the PivotTable.
RowGroup	bool	false	Sets or gets whether the column is a row group column. Data from row group columns is represented as rows in the PivotTable. If multiple row groups are set, row hierarchy is displayed based on the order of the row group columns in the columns array.
Summary	PivotTableColumnSummary	PivotTableColumnSummary.Sum	Sets or gets the summary function to aggregate the column's data by and produce dynamic summary columns for each unique pivot data point. There must always be at least one summary column for the PivotTable to make sense. When columnTotals is enabled, all summary columns must have the same summary function set.
SummarySettings	object	new object()	Sets or gets an object with settings for cells in summary columns. These settings are not applied if column formatFunction is also implemented.

PivotTableConditionalFormatting Properties

Name	Type	Default	Description
Column	string	"all"	The data field of a numeric column to format. Set 'all' to format all numeric columns.
Condition	PivotTableConditionalFormattingCondition	PivotTableConditionalFormattingCondition.LessThan	The formatting condition.
FirstValue	int	0	The value to compare by. When condition is 'between', this is the start (from) value.
FontFamily	PivotTableConditionalFormattingFontFamily	PivotTableConditionalFormattingFontFamily.ThedefaultfontFamilyassetinCSS	The fontFamily to apply to formatted cells.
FontSize	PivotTableConditionalFormattingFontSize	PivotTableConditionalFormattingFontSize.Fourtheenpx	The fontSize to apply to formatted cells. The fontSize as set in CSS is used by default.
Highlight	string	"The default backgroundColor as set in CSS"	The background color to apply to formatted cells.
SecondValue	int	1	When condition is 'between', this is the end (to) value. Otherwise, this value is not used.
Text	string	"The default color as set in CSS"	The text color to apply to formatted cells.