JavaScript/jQuery PivotGrid Methods
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
bindChart(chart, integrationOptions)
Binds a Chart to the PivotGrid.
The Chart to be bound to the PivotGrid.
Accepts the Chart's instance, jQuery element or container selector.
| Name | Type | Description |
|---|---|---|
| alternateDataFields |
Default Value: true. |
|
| customizeChart |
Allows you to customize the Chart's appearance. |
|
| customizeSeries |
Allows you to customize the series. |
|
| dataFieldsDisplayMode |
Default Value: "splitAxes".
Applies only if the PivotGrid contains several data fields. |
|
| inverted |
Default Value: false. |
|
| processCell |
Allows you to process cell data before the Chart visualizes it. |
|
| putDataFieldsInto |
Default Value: "series".
|
The customizeChart, customizeSeries, and processCell fields of the integrationOptions object are functions. They accept arguments whose structure is described below.
customizeChart
JavaScriptcustomizeChart: function (chartOptions) { // Change chart properties here return chartOptions; // This line is optional }The chartOptions object has the following structure:
Field name Type Description valueAxis Array Allows you to customize the automatically-created value axes. Each object in this array can contain fields described in the valueAxis property description. When this array holds several objects, use their name field to identify the axis. panes Array Allows you to customize the automatically-created panes. Each object in this array can contain fields described in the panes property description. When this array holds several objects, use their name field to identify the pane. You can also specify any other Chart properties in this object, except dataSource and seriesTemplate.
customizeSeries
JavaScriptcustomizeSeries: function (seriesName, seriesOptions) { // Change series properties here return seriesOptions; // This line is optional }The seriesName argument is a string that allows you to identify a series. The seriesOptions argument is an object with the following structure:
Field name Type Description axis String The name of the axis to which the series belongs. Has a value only when the chart has multiple axes. pane String The name of the pane the series occupies. Has a value only when the chart has multiple panes. You can also specify any other series properties in this object.
processCell
JavaScriptprocessCell: function (cellData) { // Process data here return cellData; // This line is optional }The cellData object has the following structure:
Field name Type Description rowPath Array The path to the data cell by row field values. rowPathFormatted Array Same as rowPath, but with format and customizeText applied. rowFields Array Contains objects that are row fields. maxRowLevel Number A zero-based index that indicates the lowest expanded row level. Equals 0 when the pivot grid has no row fields, 1 when all rows are collapsed, 2 when at least one first-level row is expanded, etc. columnPath Array The path to the data cell by column field values. columnPathFormatted Array Same as columnPath, but with format and customizeText applied. columnFields Array Contains objects that are column fields. maxColumnLevel Number A zero-based index that indicates the lowest expanded column level. Equals 0 when the pivot grid has no column fields, 1 when all columns are collapsed, 2 when at least one first-level column is expanded, etc. dataFields Array Contains objects that are data fields. dataValues Array Data of the current cell. Contains more than one value if the pivot grid has multiple data fields. dataIndex Number A zero-based index that indicates which data field and value from the dataFields and dataValues arrays are currently processed. visible Boolean Indicates whether the current cell will be passed to the chart. true if the cell belongs to the deepest expanded level. chartDataItem Object The resulting item passed to the Chart's data source. This object's structure is described in the table below. The chartDataItem object has the following structure:
Field name Type Description series String The name of the series to which the data item belongs. arg Number | String | Date The argument of the data item. val Number | String | Date The value of the data item.
Main article: Integration with Chart
See Also
defaultOptions(rule)
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the PivotGrid UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxPivotGrid.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the PivotGrid properties
}
});Angular
import PivotGrid from "devextreme/ui/pivot_grid";
// ...
export class AppComponent {
constructor () {
PivotGrid.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the PivotGrid properties
}
});
}
}Vue
<template>
<div>
<DxPivotGrid id="pivotGrid1" />
<DxPivotGrid id="pivotGrid2" />
</div>
</template>
<script>
import DxPivotGrid from "devextreme-vue/pivot-grid";
import PivotGrid from "devextreme/ui/pivot_grid";
PivotGrid.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the PivotGrid properties
}
});
export default {
components: {
DxPivotGrid
}
}
</script>React
import React, {useEffect} from "react";
import dxPivotGrid from "devextreme/ui/pivot_grid";
import PivotGrid from "devextreme-react/pivot-grid";
export default function App() {
useEffect(() => {
dxPivotGrid.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the PivotGrid properties
}
})
});
return (
<div>
<PivotGrid id="pivotGrid1" />
<PivotGrid id="pivotGrid2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myPivotGrid").dxPivotGrid("dispose");
$("#myPivotGrid").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-pivot-grid ...
*ngIf="condition">
</dx-pivot-grid>Vue
<template>
<DxPivotGrid ...
v-if="condition">
</DxPivotGrid>
</template>
<script>
import DxPivotGrid from 'devextreme-vue/pivot-grid';
export default {
components: {
DxPivotGrid
}
}
</script>React
import React from 'react';
import PivotGrid from 'devextreme-react/pivot-grid';
function DxPivotGrid(props) {
if (!props.shouldRender) {
return null;
}
return (
<PivotGrid ... >
</PivotGrid>
);
}
class App extends React.Component {
render() {
return (
<DxPivotGrid shouldRender="condition" />
);
}
}
export default App;See Also
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the PivotGrid instance found in an element with the myPivotGrid ID:
// Modular approach
import PivotGrid from "devextreme/ui/pivot_grid";
...
let element = document.getElementById("myPivotGrid");
let instance = PivotGrid.getInstance(element) as PivotGrid;
// Non-modular approach
let element = document.getElementById("myPivotGrid");
let instance = DevExpress.ui.dxPivotGrid.getInstance(element);