All docs
V19.1
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
A newer version of this page is available. Switch to the current version.

jQuery PivotGrid API

The PivotGrid is a widget that allows you to display and analyze multi-dimensional data from a local storage or an OLAP cube.

import PivotGrid from "devextreme/ui/pivot_grid"
Type:

Object

Configuration

This section describes the configuration options of the PivotGrid widget.

Name Description
allowExpandAll

Allows an end-user to expand/collapse all header items within a header level.

allowFiltering

Allows a user to filter fields by selecting or deselecting values in the popup menu.

allowSorting

Allows an end-user to change sorting options.

allowSortingBySummary

Allows an end-user to sort columns by summary values.

dataFieldArea

Specifies the area to which data field headers must belong.

dataSource

Binds the widget to data.

disabled

Specifies whether the widget responds to user interaction.

elementAttr

Specifies the attributes to be attached to the widget's root element.

export

Configures client-side exporting.

fieldChooser

The Field Chooser configuration options.

fieldPanel

Configures the field panel.

headerFilter

Configures the header filter feature.

height

Specifies the widget'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 widget.

loadPanel

Specifies options 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 widget's content is ready and each time the content is changed.

onContextMenuPreparing

A function that is executed before the context menu is rendered.

onDisposing

A function that is executed before the widget is disposed of.

onExported

A function that is executed after data is exported.

onExporting

A function that is executed before data is exported.

onFileSaving

A function that is executed before a file with exported data is saved to the user's local storage.

onInitialized

A function used in JavaScript frameworks to save the widget instance.

onOptionChanged

A function that is executed after a widget option is changed.

rowHeaderLayout

Specifies the layout of items in the row header.

rtlEnabled

Switches the widget to a right-to-left representation.

scrolling

A configuration object specifying scrolling options.

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. Applies only if rowHeaderLayout is "standard".

stateStoring

A configuration object specifying options 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 widget.

visible

Specifies whether the widget is visible.

width

Specifies the widget's width.

wordWrapEnabled

Specifies whether long text in header items should be wrapped.

See Also

Methods

This section describes the methods that can be used to manipulate the PivotGrid widget.

Name Description
beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

bindChart(chart, integrationOptions)

Binds a Chart to the PivotGrid.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

dispose()

Disposes of all the resources allocated to the PivotGrid instance.

element()

Gets the root widget element.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

exportToExcel()

Exports pivot grid data to the Excel file.

focus()

Sets focus on the widget.

getDataSource()

Gets the PivotGridDataSource instance.

getFieldChooserPopup()

Gets the Popup instance of the field chooser window.

getInstance(element)

Gets the instance of a widget found using its DOM node.

instance()

Gets the widget's instance. Use it to access other methods of the widget.

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 widget options.

option(optionName)

Gets the value of a single option.

option(optionName, optionValue)

Updates the value of a single option.

option(options)

Updates the values of several options.

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

updateDimensions()

Updates the widget to the size of its content.

See Also

Events

This section describes events fired by this widget.

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 widget's content is ready.

contextMenuPreparing

Raised before the context menu is rendered.

disposing

Raised before the widget is disposed of.

exported

Raised after data is exported.

exporting

Raised before data is exported.

fileSaving

Raised before a file with exported data is saved to the user's local storage.

initialized

Raised only once, after the widget is initialized.

optionChanged

Raised after a widget option is changed.

See Also

Summary Cell

An object exposing methods that manipulate a summary cell and provide access to its neighboring cells.

Type:

Object

Pivot Grid Cell

An object containing information about the pivot grid cell.

Type:

Object