JavaScript/jQuery PivotGrid API
The PivotGrid is a UI component that allows you to display and analyze multi-dimensional data from a local storage or an OLAP cube.
See Also
jQuery
Angular
Vue
React
Options
| Name | Description |
|---|---|
| allowExpandAll |
Allows users to expand/collapse all header items within the same header level. Ignored if the PivotGridDataSource's paginate property is true. |
| allowFiltering |
Allows a user to filter fields by selecting or deselecting values in the popup menu. |
| allowSorting |
Allows an end user to change sorting properties. |
| allowSortingBySummary |
Allows users to sort the pivot grid by summary values instead of field values. Ignored if the PivotGridDataSource's paginate property is true. |
| dataFieldArea |
Specifies the area to which data field headers must belong. |
| dataSource |
Binds the UI component to data. |
| disabled |
Specifies whether the UI component responds to user interaction. |
| elementAttr |
Specifies the global attributes to be attached to the UI component's container element. |
| encodeHtml |
Specifies whether HTML tags are displayed as plain text or applied to cell values. |
| export |
Configures client-side exporting. |
| fieldChooser |
The Field Chooser configuration properties. |
| fieldPanel |
Configures the field panel. |
| headerFilter |
Configures the header filter feature. |
| height |
Specifies the UI component's height. |
| hideEmptySummaryCells |
Specifies whether or not to hide rows and columns with no data. |
| hint |
Specifies text for a hint that appears when a user pauses on the UI component. |
| loadPanel |
Specifies properties configuring the load panel. |
| onCellClick |
A function that is executed when a pivot grid cell is clicked or tapped. |
| onCellPrepared |
A function that is executed after a pivot grid cell is created. |
| onContentReady |
A function that is executed when the UI component is rendered and each time the component is repainted. |
| onContextMenuPreparing |
A function that is executed before the context menu is rendered. |
| onDisposing |
A function that is executed before the UI component is disposed of. |
| onExporting |
A function that is executed before data is exported. |
| onInitialized |
A function used in JavaScript frameworks to save the UI component instance. |
| onOptionChanged |
A function that is executed after a UI component property is changed. |
| rowHeaderLayout |
Specifies the layout of items in the row header. |
| rtlEnabled |
Switches the UI component to a right-to-left representation. |
| scrolling |
A configuration object specifying scrolling properties. |
| showBorders |
Specifies whether the outer borders of the grid are visible or not. |
| showColumnGrandTotals |
Specifies whether to display the Grand Total column. |
| showColumnTotals |
Specifies whether to display the Total columns. |
| showRowGrandTotals |
Specifies whether to display the Grand Total row. |
| showRowTotals |
Specifies whether to display the Total rows. Applies only if rowHeaderLayout is "standard". |
| showTotalsPrior |
Specifies where to show the total rows or columns. |
| stateStoring |
A configuration object specifying properties related to state storing. |
| tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
| texts |
Strings that can be changed or localized in the PivotGrid UI component. |
| visible |
Specifies whether the UI component is visible. |
| width |
Specifies the UI component's width. |
| wordWrapEnabled |
Specifies whether long text in header items should be wrapped. |
See Also
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
| bindChart(chart, integrationOptions) |
Binds a Chart to the PivotGrid. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration properties for this component. |
| dispose() |
Disposes of all the resources allocated to the PivotGrid instance. |
| element() |
Gets the root UI component element. |
| endUpdate() |
Refreshes the UI component after a call of the beginUpdate() method. |
| focus() |
Sets focus on the UI component. |
| getDataSource() |
Gets the PivotGridDataSource instance. |
| getFieldChooserPopup() |
Gets the Popup instance of the field chooser window. |
| getInstance(element) |
Gets the instance of a UI component found using its DOM node. |
| instance() |
Gets the UI component's instance. Use it to access other methods of the UI component. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all UI component properties. |
| option(optionName) |
Gets the value of a single property. |
| option(optionName, optionValue) |
Updates the value of a single property. |
| option(options) |
Updates the values of several properties. |
| repaint() |
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
| resetOption(optionName) |
Resets a property to its default value. |
| updateDimensions() |
Updates the UI component to the size of its content. |
Events
| Name | Description |
|---|---|
| cellClick |
Raised when a pivot grid cell is clicked or tapped. |
| cellPrepared |
Raised after a pivot grid cell is created. |
| contentReady |
Raised when the UI component is rendered and each time the component is repainted. |
| contextMenuPreparing |
Raised before the context menu is rendered. |
| disposing |
Raised before the UI component is disposed of. |
| exporting |
Raised before data is exported. |
| initialized |
Raised only once, after the UI component is initialized. |
| optionChanged |
Raised after a UI component property is changed. |
Summary Cell
An object exposing methods that manipulate a summary cell and provide access to its neighboring cells.
Types
| Name | Description |
|---|---|
| CellClickEvent |
The type of the cellClick event handler's argument. |
| CellPreparedEvent |
The type of the cellPrepared event handler's argument. |
| ContentReadyEvent |
The type of the contentReady event handler's argument. |
| ContextMenuPreparingEvent |
The type of the contextMenuPreparing event handler's argument. |
| DisposingEvent |
The type of the disposing event handler's argument. |
| ExportingEvent |
The type of the exporting event handler's argument. |
| InitializedEvent |
The type of the initialized event handler's argument. |
| OptionChangedEvent |
The type of the optionChanged event handler's argument. |
| PivotGridArea |
Specifies the field's area. |
| PivotGridDataFieldArea |
Specifies the area to which data field headers must belong. |
| PivotGridDataType |
Specifies field values for a specific data type. |
| PivotGridGroupInterval |
Specifies how the field's values are combined into groups for the headers. |
| PivotGridRowHeaderLayout |
Specifies the layout of items in the row header. |
| PivotGridRunningTotalMode |
Specifies whether to calculate the running total by rows or by columns. |
| PivotGridSortBy |
Specifies how to sort the field's values in the headers. |
| PivotGridStoreType |
Specifies the PivotGridDataSource's storage type. |
| PivotGridSummaryDisplayMode |
Specifies a predefined post-processing function. |
| PivotGridTotalDisplayMode |
Specifies where to show the total rows or columns. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.