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".
|
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);