PivotTable Properties

Name	Type	Default	Description
ColumnReorder	bool	false	Enables or retrieves the current setting that determines whether users can reorder columns, allowing columns to be rearranged via drag-and-drop or similar interactions. If enabled, columns can be moved to a new position within the layout; if disabled, the column order remains fixed.
Columns	IEnumerable<IPivotTableColumn>	N/A	Provides detailed metadata for each column in the PivotTable’s underlying tabular data source. These settings define attributes such as column names, data types, and formatting options. Using this configuration and the connected data source, the PivotTable dynamically generates its actual columns, ensuring that the displayed data structure accurately reflects both the source data and the specified settings.
ColumnTotals	bool	false	Controls the visibility of total columns for each pivot data point. When enabled, total columns are displayed, showing summary values for each data group. Note: All summary columns must use the same summary function (e.g., sum, average) to ensure consistent calculation of the total columns. This setting both determines whether total columns are shown and allows you to retrieve their current visibility status.
ColumnTotalsPosition	PivotTableColumnTotalsPosition	PivotTableColumnTotalsPosition.Near	Gets or sets the position of the total columns, which are displayed only when columnTotals is enabled. This option determines where the summary columns appear in the table, such as at the end (right side) of all columns.
ConditionalFormatting	IEnumerable<IPivotTableConditionalFormatting>	N/A	Gets or sets the conditional formatting rules that determine how the PivotTable's cells are visually styled based on their values or other criteria. This allows you to dynamically highlight, color, or format cells within the PivotTable according to specified conditions.
DataSource	object		Specifies the initial tabular data source—such as a worksheet range, table, or external database—from which the PivotTable retrieves and organizes its data. This property identifies where the PivotTable’s underlying data originates.
DefaultSortByRowGroups	bool	false	Specifies or retrieves whether the original tabular data source for the PivotTable should be pre-sorted according to the columns defined with the rowGroup property, and in the same order as those columns appear. This ensures that when the PivotTable is generated, its underlying data is already organized based on the designated row groups, potentially optimizing performance and ensuring consistent grouping behavior.
Designer	bool	false	Specifies whether the PivotTable designer panel is shown together with the PivotTable. When enabled, the designer provides an interface for configuring column settings, such as rearranging or renaming columns, and applying data filters directly within the PivotTable view. This property can be set to show or hide the designer alongside the table, and can also be used to determine the current visibility state of the designer.
DesignerPosition	PivotTableDesignerPosition	PivotTableDesignerPosition.Far	Gets or sets the position of the PivotTable’s designer interface, which appears when the designer option is enabled. This property allows you to specify or retrieve where the designer UI is displayed within the application layout.
Disabled	bool	false	Prevents the user from interacting with the element, disabling all mouse, keyboard, and touch inputs such as clicks, typing, and focus events. The element will not respond to any user actions while this setting is applied.
DrillDown	bool	false	When this option is enabled, double-clicking a PivotTable summary cell or pressing F2 will display the underlying tabular data that was used to calculate the aggregated value in that cell.
DrillDownDataExport	PivotTableDrillDownDataExport	PivotTableDrillDownDataExport.	Displays an export button within the drill-down dialog when this option is enabled, allowing users to export data directly from the dialog.
DrillDownDataExportName	string	""	Specifies or retrieves the file name used when exporting data from the drill-down table. This determines the default name of the exported file generated during the export operation.
DrillDownTableInit	Action<object>	N/A	Defines or retrieves the callback function that is triggered when the drill-down dialog is opened in the PivotTable. The callback receives the drill-down Table component as its argument, allowing you to customize the appearance, behavior, or data of the resulting table before it is displayed. Use this function to apply custom formatting, event handlers, or modifications to the drill-down Table component.
DrillDownCustomAction	Action<object>	N/A	Enhancements for clarity and detail: "Defines or retrieves the callback function that handles custom drill-down actions. When a drill-down event occurs in the PivotTable, this callback is invoked with the drill-down data source as its argument. By providing a custom callback, you can override the default drill-down user interface (which typically displays our Dialog with a Table) and implement your own UI or behavior for presenting the drill-down data."
EnableSortByRowGroups	bool	false	Determines whether column-based sorting is enabled or disabled when using the classic row groups layout mode. When enabled, users can sort data within each column in the classic row grouping layout. This property can be used to either retrieve the current sorting status or set a new value.
FreezeHeader	bool	false	Determines whether the column headers in the PivotTable remain visible (sticky/frozen) at the top of the view when the user scrolls vertically. Setting this property to true keeps the column headers fixed in place, while false allows them to scroll out of view. This property can be used to set or retrieve the current sticky/frozen state of the PivotTable’s column headers.
GetDefaultSummaryFunction	Action<object>	N/A	A callback function that provides the default summary operation (e.g., sum, average, count) for a summary column when the column is dynamically assigned as a summary field—such as when a user assigns it by dragging and dropping in the UI designer. This function is invoked to ensure that the appropriate summary logic is applied automatically whenever the summary column configuration changes at runtime.
GrandTotal	bool	false	Specifies whether to display a Grand Total row that aggregates the values of all data rows. When enabled, this option will add a summary row at the bottom of the data set, showing the total or combined values for each relevant column. Can also be used to retrieve the current setting.
GroupLayout	PivotTableGroupLayout	PivotTableGroupLayout.Default	Defines or retrieves how nested rows—determined by the specified rowGroup columns—are visually organized and displayed within the grid. This setting controls the appearance and structure of hierarchical row groupings.
HideCellSelectionTooltip	bool	false	Determines whether the tooltip displaying detailed information is shown or hidden when multiple summary cells, each containing non-null values, are selected. When enabled, the tooltip with details will be suppressed; when disabled, the tooltip will appear as usual. This property can be set to control the tooltip's visibility or retrieved to check its current state.
HideEmptyRows	bool	false	Specifies whether rows containing only 0 or null values should be hidden or displayed. This setting is only effective when one or more rowGroup columns are defined. Use this property to control the visibility of empty or zero-value rows within grouped data.
KeyboardNavigation	bool	false	Enables or retrieves the setting that determines whether users can navigate the PivotTable using keyboard shortcuts or arrow keys. When enabled, keyboard navigation allows users to move between cells, fields, and items within the PivotTable, enhancing accessibility and ease of use.
UnlockKey	string	""	Sets or retrieves the unlockKey property, a unique code or token required to access and activate the product’s full functionality.
Locale	string	"en"	Specifies or retrieves the current language code for the component. This property determines which set of localized messages from the messages object will be used for display. Changing the language automatically updates all text and labels according to the selected locale.
Messages	object	N/A	Defines or retrieves an object containing the localized strings used within the element's user interface. This object allows you to customize text elements (such as labels, messages, or tooltips) in different languages. This property works together with the locale property to display the appropriate translations based on the selected or active locale.
NullDefaultValue	int	N/A	Specifies the value to display in cells that lack aggregated data. When set, this value will be shown in any cell where there is no aggregation result available. By default (null), these cells will appear empty. Setting a custom value (such as "N/A" or 0) allows you to indicate explicitly that no data is present in those cells.
OnCellRender	Action<object>	N/A	A callback function that is invoked every time a cell within the PivotTable is rendered. This function allows you to customize the content, formatting, or behavior of individual PivotTable cells during the rendering process. It receives contextual information about the cell, such as its row, column, and data value.
OnColumnRender	Action<object>	N/A	A callback function that is invoked whenever a column header cell is rendered in the PivotTable. This function allows you to customize the appearance or behavior of each column header as it is generated during the rendering process.
OnInit	Action<object>	N/A	A callback function that is executed during the initialization phase of the PivotTable, allowing custom logic to run before the PivotTable is fully rendered or populated with data. This function receives relevant initialization parameters, enabling developers to modify settings or data sources prior to the PivotTable’s display.
PageSize	PivotTablePageSize	PivotTablePageSize.10	Specifies or retrieves the number of items displayed per page when paging is enabled. This property determines the page size, allowing you to control how many records are shown on each paginated view.
PageIndex	int	0	Sets or retrieves the current page index, using a zero-based numbering system (i.e., the first page is index 0). This property is applicable only when paging is enabled, allowing navigation between different pages of content.
Paging	bool	false	Gets or sets a value indicating whether paging functionality is enabled, allowing data to be divided and displayed across multiple pages.
RightToLeft	bool	false	Specifies or retrieves whether the element's text direction and alignment are set to support right-to-left (RTL) languages—such as Arabic or Hebrew—by adapting the layout and text flow accordingly. This property ensures that the element properly displays content for users whose locale requires RTL formatting.
RowSort	bool	false	Determines whether sorting by row is enabled when a row group cell is clicked. If columnTotals is also enabled, sorting will be applied within each "column group" individually. If columnTotals is not enabled, sorting will be applied across all columns together. This property can be used to both retrieve the current sorting behavior and to enable or disable sorting by row group interactions.
RowSummary	bool	true	Controls whether row summaries appear in the row headers. When set to true, row headers display summarized information such as "Peterson(40)" (indicating a summary value). When set to false, row headers show only the row label, like "Peterson", without any summary details. Use this option to toggle the visibility of summary data in your row headers.
RowTotals	bool	false	Determines whether to display row total columns alongside each summary column. When enabled, this option will show an additional column for each summary column, presenting the total value for each row. You can use this property to enable (show) or disable (hide) row total columns as needed.
RowTotalsPosition	PivotTableRowTotalsPosition	PivotTableRowTotalsPosition.Near	Sets or retrieves the position of row total columns within the table. This option determines where the columns displaying the total values for each row will appear when the rowTotals feature is enabled. Adjusting this setting allows you to control whether the row totals are displayed at the beginning, end, or a specific location among the table columns.
Selection	bool	false	Determines whether users can select table rows using checkboxes. When enabled, a checkbox appears next to each row, allowing selection. This property can be used to enable or check the current state of row selection functionality.
SelectionMode	PivotTableSelectionMode	PivotTableSelectionMode.Many	Specifies or retrieves the selection mode for the component. This property is effective only when the selection feature is enabled. When disabled, changing or accessing the selection mode has no effect.
SortMode	PivotTableSortMode	PivotTableSortMode.None	Specifies the sorting mode applied to the PivotTable, controlling how data rows or columns are ordered (e.g., ascending, descending, or custom criteria). This setting determines the sequence in which PivotTable items are displayed based on the selected sort option.
Theme	string	""	Specifies the theme applied to the element. The theme controls the overall appearance, including colors, fonts, and styles, ensuring a consistent look and feel throughout the element.
Toolbar	bool	false	Controls the visibility of the PivotTable toolbar. When displayed, the toolbar includes two breadcrumb components that enable users to modify the row groups and pivot columns directly. It also features "Conditional Formatting" and "Fields" buttons, each of which opens a dialog for configuring additional PivotTable settings.
Tooltip	bool	false	Determines whether a tooltip displaying the full content will appear when hovering over a table cell with truncated (overflowing) content. When enabled, users can view the entire cell content by hovering their mouse over the truncated cell. This property can be set to enable or disable this tooltip behavior and can also be used to check its current status.

PivotTable Methods

Name	Type	Arguments	Description
AddFilter	void	string dataField, object filter	Applies a filter to a designated column, enabling users to display only the rows that meet specified criteria within that column. This helps refine and customize the data view according to user-defined conditions.Args: string dataField - The column's data field.,object filter - FilterGroup object.
ClearFilters	void	N/A	Removes all currently applied filters from the data set, resetting the view to display unfiltered results.
ClearSelection	void	N/A	Removes any currently selected items or text, resetting the selection state to none.
ClearSort	void	N/A	Removes any applied sorting from the PivotTable, restoring the original item order based on the data source’s default arrangement.
CollapseAllRows	void	N/A	Collapses all rows within the table, minimizing the display of all grouped row sections when multiple row groups are present. This action hides the contents of each group, showing only the group headers or summary rows.
CollapseRow	void	object rowId	Collapses a row within a table that has multiple row groups, hiding its detailed content and displaying only the summary or header for that group. This action helps to organize and condense complex tables for easier navigation and viewing.Args: string rowId - The id of the row to collapse. Can be retrieved from the "rows" collection.
CollapseRow	void	string rowId	Collapses a row within a table that has multiple row groups, hiding its detailed content and displaying only the summary or header for that group. This action helps to organize and condense complex tables for easier navigation and viewing.Args: string rowId - The id of the row to collapse. Can be retrieved from the "rows" collection.
CollapseRow	void	int rowId	Collapses a row within a table that has multiple row groups, hiding its detailed content and displaying only the summary or header for that group. This action helps to organize and condense complex tables for easier navigation and viewing.Args: int rowId - The id of the row to collapse. Can be retrieved from the "rows" collection.
ExpandAllRows	void	N/A	Expands all rows in the data grid, including those within multiple row groups, allowing users to view every row regardless of group hierarchy or nesting.
ExpandRow	void	object rowId	Expands a specific row within the table, allowing additional content or details to be displayed, when multiple row groups are present. This function helps users view more information for a selected row without collapsing the grouping structure.Args: string rowId - The id of the row to expand. Can be retrieved from the "rows" collection.
ExpandRow	void	string rowId	Expands a specific row within the table, allowing additional content or details to be displayed, when multiple row groups are present. This function helps users view more information for a selected row without collapsing the grouping structure.Args: string rowId - The id of the row to expand. Can be retrieved from the "rows" collection.
ExpandRow	void	int rowId	Expands a specific row within the table, allowing additional content or details to be displayed, when multiple row groups are present. This function helps users view more information for a selected row without collapsing the grouping structure.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 all data from the PivotTable in a structured format, allowing for further analysis, reporting, or use in external applications.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 all data from the PivotTable in a structured format, allowing for further analysis, reporting, or use in external applications.
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 an array of the currently active dynamic pivot columns, reflecting the fields that have been selected or computed for pivoting in the current view or dataset. This allows developers to access and manipulate the current pivot configuration programmatically.
GetPageIndexAsync()	Task<int>	'N/A'	Gets the &quot;PageIndex&quot; property as Task&lt;int&gt;.
GetSelection	IEnumerable<object>	N/A	Returns an array representing the current selection within the grid, based on the specified "selectionMode":<br/><br/>- When "selectionMode" is set to "'many'" or "'extended'", the array contains the IDs of all selected rows.<br/>- When "selectionMode" is set to "'cell'", the array contains objects with details about each selected cell (such as row and column identifiers).<br/><br/>The structure of the returned array adapts dynamically to match the current selection mode.
Refresh	void	'N/A'	Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements.
Refresh	void	N/A	Updates the PivotTable data and recalculates all its values, ensuring that any changes in the underlying data source are reflected in the PivotTable’s current view.
RemoveFilter	void	string dataField	Removes all active filters from a specified column, restoring the column to display its full, unfiltered dataset.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	Enables selection of rows or cells within the data grid, depending on the specified "selectionMode":<br/><br/>- When "selectionMode" is set to "'many'" or "'extended'", this function allows for the selection of one or multiple rows.<br/>- When "selectionMode" is set to "'cell'" and a second argument is provided, it allows for the selection of a single cell instead of an entire row.<br/><br/>Use the appropriate "selectionMode" and arguments to control whether users can select individual rows, multiple rows, or specific cells within the grid.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	Enables selection of rows or cells within the data grid, depending on the specified selectionMode: - When selectionMode is set to 'many' or 'extended', this function allows for the selection of one or multiple rows. - When selectionMode is set to 'cell' and a second argument is provided, it allows for the selection of a single cell instead of an entire row. Use the appropriate selectionMode and arguments to control whether users can select individual rows, multiple rows, or specific cells within the grid.
Select	void	string rowId, string dataField	Enables selection of rows or cells within the data grid, depending on the specified "selectionMode":<br/><br/>- When "selectionMode" is set to "'many'" or "'extended'", this function allows for the selection of one or multiple rows.<br/>- When "selectionMode" is set to "'cell'" and a second argument is provided, it allows for the selection of a single cell instead of an entire row.<br/><br/>Use the appropriate "selectionMode" and arguments to control whether users can select individual rows, multiple rows, or specific cells within the grid.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	Enables selection of rows or cells within the data grid, depending on the specified selectionMode: - When selectionMode is set to 'many' or 'extended', this function allows for the selection of one or multiple rows. - When selectionMode is set to 'cell' and a second argument is provided, it allows for the selection of a single cell instead of an entire row. Use the appropriate selectionMode and arguments to control whether users can select individual rows, multiple rows, or specific cells within the grid.
Select	void	int rowId, string dataField	Enables selection of rows or cells within the data grid, depending on the specified "selectionMode":<br/><br/>- When "selectionMode" is set to "'many'" or "'extended'", this function allows for the selection of one or multiple rows.<br/>- When "selectionMode" is set to "'cell'" and a second argument is provided, it allows for the selection of a single cell instead of an entire row.<br/><br/>Use the appropriate "selectionMode" and arguments to control whether users can select individual rows, multiple rows, or specific cells within the grid.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	Enables selection of rows or cells within the data grid, depending on the specified selectionMode: - When selectionMode is set to 'many' or 'extended', this function allows for the selection of one or multiple rows. - When selectionMode is set to 'cell' and a second argument is provided, it allows for the selection of a single cell instead of an entire row. Use the appropriate selectionMode and arguments to control whether users can select individual rows, multiple rows, or specific cells within the grid.
SetLocale	void	string locale, object messages	Sets the locale of a component.Args: string locale - The locale abbreviation. For example: 'de'.,object messages - Object containing the locale messages.
SetLocale	void	string locale	Sets the locale of a component.
SortBy	void	object columnDefinition, string sortOrder	Sorts the data based on the values in a summary or grouping column, allowing you to organize records according to aggregated results or group identifiers.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 the data based on the values in a summary or grouping column, allowing you to organize records according to aggregated results or group identifiers.
StateHasChanged	void	'N/A'	Refreshes the state and Re-renders the Blazor Component, if necessary.
Unselect	void	IEnumerable<object> rowId, string dataField	Deselects one or more rows when "selectionMode" is set to "'many'" or "'extended'". Alternatively, if "selectionMode" is "'cell'" and a second argument specifying the target cell is provided, this method will deselect the specified cell. This allows for flexible unselection behavior depending on the current selection mode and provided arguments.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	Deselects one or more rows when selectionMode is set to 'many' or 'extended'. Alternatively, if selectionMode is 'cell' and a second argument specifying the target cell is provided, this method will deselect the specified cell. This allows for flexible unselection behavior depending on the current selection mode and provided arguments.
Unselect	void	string rowId, string dataField	Deselects one or more rows when "selectionMode" is set to "'many'" or "'extended'". Alternatively, if "selectionMode" is "'cell'" and a second argument specifying the target cell is provided, this method will deselect the specified cell. This allows for flexible unselection behavior depending on the current selection mode and provided arguments.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	Deselects one or more rows when selectionMode is set to 'many' or 'extended'. Alternatively, if selectionMode is 'cell' and a second argument specifying the target cell is provided, this method will deselect the specified cell. This allows for flexible unselection behavior depending on the current selection mode and provided arguments.
Unselect	void	int rowId, string dataField	Deselects one or more rows when "selectionMode" is set to "'many'" or "'extended'". Alternatively, if "selectionMode" is "'cell'" and a second argument specifying the target cell is provided, this method will deselect the specified cell. This allows for flexible unselection behavior depending on the current selection mode and provided arguments.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	Deselects one or more rows when selectionMode is set to 'many' or 'extended'. Alternatively, if selectionMode is 'cell' and a second argument specifying the target cell is provided, this method will deselect the specified cell. This allows for flexible unselection behavior depending on the current selection mode and provided arguments.

PivotTable Events

Name	Type	Description	Event Detail
OnCellClick	EventCallback<Event>	This event is triggered whenever a user clicks on a cell within the component. It provides details about the clicked cell, such as its row and column indices, allowing developers to handle cell-specific actions in response to user interaction.	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 whenever a user clicks on a cell within the component. It provides details about the clicked cell, such as its row and column indices, allowing developers to handle cell-specific actions in response to user interaction.	PivotTableCellClickedEventArgs
OnChange	EventCallback<Event>	This event is triggered whenever the user modifies the current selection, such as highlighting a different portion of text or choosing a new option within a selectable element. It allows you to respond in real time to changes in selection state.	dynamic type- The type of action that initiated the selection change. Possible types: 'programmatic', 'interaction', 'remove'.
Changed	event PivotTableChangedEventHandler	This event is triggered whenever the user modifies the current selection, such as highlighting a different portion of text or choosing a new option within a selectable element. It allows you to respond in real time to changes in selection state.	PivotTableChangedEventArgs
OnColumnClick	EventCallback<Event>	This event is triggered when a user clicks on the header cell of a summary column. It allows you to handle custom actions or logic in response to the user's interaction with the summary column header.	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 user clicks on the header cell of a summary column. It allows you to handle custom actions or logic in response to the user's interaction with the summary column header.	PivotTableColumnClickedEventArgs
OnCollapse	EventCallback<Event>	This event is triggered when a row within the data table is collapsed by the user, indicating that its expanded content or details are now hidden. It allows you to execute custom logic whenever a previously expanded row is closed.	dynamic record- The (aggregated) data of the collapsed row.
Collapsed	event PivotTableCollapsedEventHandler	This event is triggered when a row within the data table is collapsed by the user, indicating that its expanded content or details are now hidden. It allows you to execute custom logic whenever a previously expanded row is closed.	PivotTableCollapsedEventArgs
OnCollapseTotalColumn	EventCallback<Event>	This event is triggered whenever a total column in the data grid is collapsed by the user, signaling that the column’s aggregated summary view has been hidden from display. This allows you to perform custom actions in response to the collapsing of a total column, such as updating UI elements or recalculating totals.	dynamic columnDefinition- The definition of the collapsed total column.
CollapseTotalColumned	event PivotTableCollapseTotalColumnedEventHandler	This event is triggered whenever a total column in the data grid is collapsed by the user, signaling that the column’s aggregated summary view has been hidden from display. This allows you to perform custom actions in response to the collapsing of a total column, such as updating UI elements or recalculating totals.	PivotTableCollapseTotalColumnedEventArgs
OnExpand	EventCallback<Event>	This event is triggered when a user expands a row, typically to reveal additional details or a nested view associated with that row. It signals that the row has transitioned from a collapsed to an expanded state.	dynamic record- The (aggregated) data of the expanded row.
Expanded	event PivotTableExpandedEventHandler	This event is triggered when a user expands a row, typically to reveal additional details or a nested view associated with that row. It signals that the row has transitioned from a collapsed to an expanded state.	PivotTableExpandedEventArgs
OnExpandTotalColumn	EventCallback<Event>	This event is triggered whenever a user expands a total column, typically to reveal underlying details or subrows associated with that column. It allows you to respond to the expansion action, such as loading additional data or updating the user interface accordingly.	dynamic columnDefinition- The definition of the expanded total column.
ExpandTotalColumned	event PivotTableExpandTotalColumnedEventHandler	This event is triggered whenever a user expands a total column, typically to reveal underlying details or subrows associated with that column. It allows you to respond to the expansion action, such as loading additional data or updating the user interface accordingly.	PivotTableExpandTotalColumnedEventArgs
OnFilter	EventCallback<Event>	This event is triggered whenever a user performs an action that initiates, modifies, or removes any filter within the application. It provides an opportunity to respond to changes in filter settings, such as applying, updating, or clearing filters on displayed data or content.	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 whenever a user performs an action that initiates, modifies, or removes any filter within the application. It provides an opportunity to respond to changes in filter settings, such as applying, updating, or clearing filters on displayed data or content.	PivotTableFilteredEventArgs
OnSort	EventCallback<Event>	This event is triggered whenever a user clicks on a column header cell within a table or grid. It typically occurs during user interactions such as sorting or selecting columns, making it useful for implementing custom behaviors in response to column header clicks. The event includes relevant details about the column that was clicked, allowing developers to identify and handle specific columns as needed.	dynamic columns- An array with information about the dynamic columns the PivotTable has been sorted by.
Sorted	event PivotTableSortedEventHandler	This event is triggered whenever a user clicks on a column header cell within a table or grid. It typically occurs during user interactions such as sorting or selecting columns, making it useful for implementing custom behaviors in response to column header clicks. The event includes relevant details about the column that was clicked, allowing developers to identify and handle specific columns as needed.	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

PivotTablePageSize

PivotTablePageSize.Ten

PivotTablePageSize.TwentyFive

PivotTablePageSize.Fifty

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.