JavaScript/jQuery PivotGrid Methods
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
beginUpdate()
Prevents the widget from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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".
|
Main article: Integration with Chart
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the PivotGrid widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxPivotGrid.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the PivotGrid options } });
Angular
import PivotGrid from "devextreme/ui/pivot_grid"; // ... export class AppComponent { constructor () { PivotGrid.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the PivotGrid options } }); } }
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 options } }); export default { components: { DxPivotGrid } } </script>
React
import React from "react"; import dxPivotGrid from "devextreme/ui/pivot_grid"; import PivotGrid from "devextreme-react/pivot-grid"; class App extends React.Component { render () { dxPivotGrid.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the PivotGrid options } }) return ( <div> <PivotGrid id="pivotGrid1" /> <PivotGrid id="pivotGrid2" /> </div> ) } } export default App;
dispose()
After calling this method, remove the DOM element associated with the widget:
$("#myPivotGrid").dxPivotGrid("dispose"); $("#myPivotGrid").remove();
Use this method only if the widget 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
element()
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
exportToExcel()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getDataSource()
The PivotGridDataSource instance.
This method is commonly used to link the pivot grid with the PivotGridFieldChooser widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getFieldChooserPopup()
Use this method to show and hide the field chooser window programmatically. The code below demonstrates how you can display the field chooser from code.
pivotGrid.getFieldChooserPopup().show();
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
getInstance is a static method that the widget 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);
See Also
instance()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
updateDimensions()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core