Methods
This section describes the methods that can be used to manipulate the PivotGrid widget.
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.
The Chart's configuration.
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".
|
Unbinds the Chart. If null, then binding failed.
Main article: Integration with Chart
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
Specifies the device-dependent default configuration options for this component.
The component's default device options.
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> <dx-pivot-grid id="pivotGrid1" /> <dx-pivot-grid 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()
Disposes of all the resources allocated to the PivotGrid instance.
After calling this method, remove the DOM element associated with the widget:
jQuery
$("#myPivotGrid").dxPivotGrid("dispose"); $("#myPivotGrid").remove();
Angular
<dx-pivot-grid #pivotGridVar id="myPivotGrid"></dx-pivot-grid>
import { ..., ViewChild } from "@angular/core"; import { DxPivotGridComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("pivotGridVar", { static: false }) pivotGrid: DxPivotGridComponent; // Prior to Angular 8 // @ViewChild("pivotGridVar") pivotGrid: DxPivotGridComponent; removePivotGrid (e) { this.pivotGrid.instance.dispose(); document.getElementById("myPivotGrid").remove(); } }
element()
Gets the root widget 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()
Exports pivot grid data to the Excel file.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
Sets focus on the widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getDataSource()
Gets the PivotGridDataSource instance.
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()
Gets the Popup instance of the field chooser window.
The Popup instance.
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)
Gets the instance of a widget found using its DOM node.
The widget's instance.
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()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
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)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
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.
The widget's options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
Repaints the widget without reloading data. Call it to update the widget's markup.
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)
Resets an option to its default value.
An option's name.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
updateDimensions()
Updates the widget to the size of its content.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.
We appreciate your feedback.