Skip to main content

PivotGridBuilder<T> Methods

A PivotGrid control.
Name Description
AllowExpandAll(JS) Allows users to expand/collapse all header items within the same header level. Ignored if the PivotGridDataSource's paginate property is true. Mirrors the client-side allowExpandAll option.
AllowExpandAll(Boolean) Allows users to expand/collapse all header items within the same header level. Ignored if the PivotGridDataSource's paginate property is true. Mirrors the client-side allowExpandAll option.
AllowFiltering(JS) Allows a user to filter fields by selecting or deselecting values in the popup menu. Mirrors the client-side allowFiltering option.
AllowFiltering(Boolean) Allows a user to filter fields by selecting or deselecting values in the popup menu. Mirrors the client-side allowFiltering option.
AllowSorting(JS) Allows an end user to change sorting properties. Mirrors the client-side allowSorting option.
AllowSorting(Boolean) Allows an end user to change sorting properties. Mirrors the client-side allowSorting option.
AllowSortingBySummary(JS) Allows users to sort the pivot grid by summary values instead of field values. Ignored if the PivotGridDataSource's paginate property is true. Mirrors the client-side allowSortingBySummary option.
AllowSortingBySummary(Boolean) Allows users to sort the pivot grid by summary values instead of field values. Ignored if the PivotGridDataSource's paginate property is true. Mirrors the client-side allowSortingBySummary option.
DataFieldArea(PivotGridDataFieldArea) Specifies the area to which data field headers must belong. Mirrors the client-side dataFieldArea option.
DataSource(Action<PivotGridDataSourceBuilder<T>>) Binds a PivotGrid control to data from an OLAP cube.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
EncodeHtml(JS) Mirrors the client-side encodeHtml option that specifies whether to display HTML tags as plain text or apply them to cell values.
EncodeHtml(Boolean) Mirrors the client-side encodeHtml option that specifies whether to display HTML tags as plain text or apply them to cell values.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Export(Action<PivotGridExportBuilder>) Configures client-side exporting. Mirrors the client-side export object.
FieldChooser(Action<PivotGridFieldChooserBuilder>) The Field Chooser configuration properties. Mirrors the client-side fieldChooser object.
FieldPanel(Action<PivotGridFieldPanelBuilder>) Configures the field panel. Mirrors the client-side fieldPanel object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
HeaderFilter(Action<PivotGridHeaderFilterBuilder>) Configures the header filter feature. Mirrors the client-side headerFilter object.
Height(JS) Specifies the UI component's height. Mirrors the client-side height option.
Height(Double) Specifies the UI component's height. Mirrors the client-side height option.
Height(String) Specifies the UI component's height. Mirrors the client-side height option.
HideEmptySummaryCells(JS) Specifies whether or not to hide rows and columns with no data. Mirrors the client-side hideEmptySummaryCells option.
HideEmptySummaryCells(Boolean) Specifies whether or not to hide rows and columns with no data. Mirrors the client-side hideEmptySummaryCells option.
Hint(JS) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
Hint(String) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
LoadPanel(Action<PivotGridLoadPanelBuilder>) Specifies properties configuring the load panel. Mirrors the client-side loadPanel object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnCellClick(RazorBlock) A function that is executed when a pivot grid cell is clicked or tapped. Mirrors the client-side onCellClick option.
OnCellClick(String) A function that is executed when a pivot grid cell is clicked or tapped. Mirrors the client-side onCellClick option.
OnCellPrepared(RazorBlock) A function that is executed after a pivot grid cell is created. Mirrors the client-side onCellPrepared option.
OnCellPrepared(String) A function that is executed after a pivot grid cell is created. Mirrors the client-side onCellPrepared option.
OnContentReady(RazorBlock) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnContentReady(String) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnContextMenuPreparing(RazorBlock) A function that is executed before the context menu is rendered. Mirrors the client-side onContextMenuPreparing option.
OnContextMenuPreparing(String) A function that is executed before the context menu is rendered. Mirrors the client-side onContextMenuPreparing option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnExporting(RazorBlock) A function that is executed before data is exported. Mirrors the client-side onExporting option.
OnExporting(String) A function that is executed before data is exported. Mirrors the client-side onExporting option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
Option(String, Object) Specifies an option by its name.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
RowHeaderLayout(PivotGridRowHeadersLayout) Specifies the layout of items in the row header. Mirrors the client-side rowHeaderLayout option.
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
Scrolling(Action<PivotGridScrollingBuilder>) A configuration object specifying scrolling properties. Mirrors the client-side scrolling object.
ShowBorders(JS) Specifies whether the outer borders of the grid are visible or not. Mirrors the client-side showBorders option.
ShowBorders(Boolean) Specifies whether the outer borders of the grid are visible or not. Mirrors the client-side showBorders option.
ShowColumnGrandTotals(JS) Specifies whether to display the Grand Total column. Mirrors the client-side showColumnGrandTotals option.
ShowColumnGrandTotals(Boolean) Specifies whether to display the Grand Total column. Mirrors the client-side showColumnGrandTotals option.
ShowColumnTotals(JS) Specifies whether to display the Total columns. Mirrors the client-side showColumnTotals option.
ShowColumnTotals(Boolean) Specifies whether to display the Total columns. Mirrors the client-side showColumnTotals option.
ShowRowGrandTotals(JS) Specifies whether to display the Grand Total row. Mirrors the client-side showRowGrandTotals option.
ShowRowGrandTotals(Boolean) Specifies whether to display the Grand Total row. Mirrors the client-side showRowGrandTotals option.
ShowRowTotals(JS) Specifies whether to display the Total rows. Applies only if rowHeaderLayout is 'standard'. Mirrors the client-side showRowTotals option.
ShowRowTotals(Boolean) Specifies whether to display the Total rows. Applies only if rowHeaderLayout is 'standard'. Mirrors the client-side showRowTotals option.
ShowTotalsPrior(PivotGridTotalsDisplayMode) Specifies where to show the total rows or columns. Mirrors the client-side showTotalsPrior option.
StateStoring(Action<PivotGridStateStoringBuilder>) A configuration object specifying properties related to state storing. Mirrors the client-side stateStoring object.
TabIndex(JS) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
TabIndex(Int32) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
Texts(Action<PivotGridTextsBuilder>) Strings that can be changed or localized in the PivotGrid UI component. Mirrors the client-side texts object.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
Visible(JS) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Visible(Boolean) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Width(JS) Specifies the UI component's width. Mirrors the client-side width option.
Width(Double) Specifies the UI component's width. Mirrors the client-side width option.
Width(String) Specifies the UI component's width. Mirrors the client-side width option.
WordWrapEnabled(JS) Specifies whether long text in header items should be wrapped. Mirrors the client-side wordWrapEnabled option.
WordWrapEnabled(Boolean) Specifies whether long text in header items should be wrapped. Mirrors the client-side wordWrapEnabled option.
See Also