All docs
V20.2
21.1 (CTP)
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

Methods

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

See Also

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.

Parameters:
chart:

String

|

jQuery

|

Object

The Chart to be bound to the PivotGrid.
Accepts the Chart's instance, jQuery element or container selector.

integrationOptions:

Object

The Chart's configuration.

Object structure:
Name Type Description
alternateDataFields

Boolean

Default Value: true.
Specifies whether to alternate data fields in the resulting chart or not.
Applies only if the PivotGrid contains several data fields.

customizeChart

Function

Allows you to customize the Chart's appearance.

customizeSeries

Function

Allows you to customize the series.

dataFieldsDisplayMode

String

Default Value: "splitAxes".
Accepts one of the following values.

  • "singleAxis" - values of all data fields are displayed on a single value axis.
  • "splitAxes" - each data field gets an individual value axis. Applies only if putDataFieldsInto is "series".
  • "splitPanes" - each data field gets an individual pane. Applies only if putDataFieldsInto is "series".

Applies only if the PivotGrid contains several data fields.

inverted

Boolean

Default Value: false.
If true, row field values go to the chart arguments and column field values form series. If false - vice versa.

processCell

Function

Allows you to process cell data before the Chart visualizes it.

putDataFieldsInto

String

Default Value: "series".
Accepts one of the following values.

  • "args" - data fields go to the chart arguments.
  • "series" - data fields go to the chart series.
Return Value:

Function

| null

Unbinds the Chart. If null, then binding failed.

defaultOptions(rule)

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

Parameters:
rule:

Object

The component's default device properties.

Object structure:
Name Type Description
device

Device

|

Array<Device>

|

Function

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

options

Object

Options to be applied.

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
JavaScript
DevExpress.ui.dxPivotGrid.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the PivotGrid properties
    }
});
Angular
TypeScript
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 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 properties
            }
        })
        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 UI component:

JavaScript
$("#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
app.component.html
<dx-pivot-grid ...
    *ngIf="condition">
</dx-pivot-grid>
Vue
App.vue
<template>
    <DxPivotGrid ...
        v-if="condition">
    </DxPivotGrid>
</template>

<script>
import DxPivotGrid from 'devextreme-vue/pivot-grid';

export default {
    components: {
        DxPivotGrid
    }
}
</script>
React
App.js
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()

Gets the root UI component element.

Return Value:

HTMLElement or jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportToExcel() Deprecated

Use the exportPivotGrid(options) method instead.

Exports pivot grid data to the Excel file.

See Also

focus()

Sets focus on the UI component.

See Also

getDataSource()

Gets the PivotGridDataSource instance.

Return Value:

PivotGridDataSource

The PivotGridDataSource instance.

This method is commonly used to link the pivot grid with the PivotGridFieldChooser UI component.

See Also

getFieldChooserPopup()

Gets the Popup instance of the field chooser window.

Return Value:

Popup

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.

JavaScript
pivotGrid.getFieldChooserPopup().show();
See Also

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:
element:

Element

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

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);
See Also

instance()

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

Return Value:

PivotGrid

This UI component's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

PivotGrid

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

PivotGrid

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

PivotGrid

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

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

PivotGrid

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

option()

Return Value:

Object

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Options with their new values.

repaint()

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

See Also

resetOption(optionName)

Resets an property to its default value.

Parameters:
optionName:

String

An property's name.

See Also

updateDimensions()

Updates the UI component to the size of its content.

See Also