PivotGrid Methods

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

beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods allow you to apply several modifications to the component. After the beginUpdate() method is called, the component does not update the UI until the endUpdate() method is called. The usage of these methods prevents excessive component updating when you are changing multiple component settings at once.

bindChart(chart, integrationOptions)

Binds a Chart to the PivotGrid.

Parameters:
Chart to be bound to PivotGrid.
Accepts the instance, jQuery element or selector of Chart's container.
integrationOptions: Object
Configures **Chart**contents and appearance.
Object structure:
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.
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".
NOTE: Applies only if **PivotGrid** contains several data fields.
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.
alternateDataFields: Boolean
Default Value: true.
Specifies whether to alternate data fields in the resulting chart or not.
NOTE: Applies only if **PivotGrid** contains several data fields.
processCell: function(cellData)
Allows you to process data of a grid cell before it will be visualized by the chart.
customizeChart: function(chartOptions)
Allows you to customize the appearance of the chart.
customizeSeries: function(seriesName, seriesOptions)
Allows you to customize the chart series.
Return Value: function | null
Unbinds the chart. If null, then binding failed.

For a comprehensive overview of this feature, refer to the Integration with Chart article.

defaultOptions(rule)

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

Parameters:
rule: Object
An object specifying default options for the component and the device for which the options must be applied.
Object structure:
device: Object|Array|function
An object representing device parameters, or an array of objects representing device parameters, or a function that provides information on the current device as an input parameter and returning a Boolean value.
options: Object
A configuration object with specified options.

The defaultOptions method is a static method supported by the widget class. The following code demonstrates how to specify default options for all buttons in the application executed on the iOS platform.

JavaScript
DevExpress.ui.dxButton.defaultOptions({ 
    device: { platform: "ios" },
    options: {
        text: "Click me"
    }
});

element()

Returns the root HTML element of the widget.

Return Value: jQuery
The root element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

The beginUpdate() and endUpdate() methods allow you to apply several modifications to the component. After the beginUpdate() method is called, the component does not update the UI until the endUpdate() method is called. The usage of these methods prevents excessive component updating when you change multiple component setting at once.

exportToExcel()

Exports pivot grid data to the Excel file.

focus()

Sets focus on the widget.

getDataSource()

Gets the PivotGridDataSource instance.

Return Value: PivotGridDataSource
The data source of the pivot grid.

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

getFieldChooserPopup()

Gets the Popup instance of the field chooser window.

Return Value: dxPopup
The field chooser 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();

instance()

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
Return Value: Object
The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
eventHandler: function
The handler to be detached from the specified event.
Return Value: Object
The object for which this method is called.

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName: String
The name of the event to be subscribed.
eventHandler: function
An event handler for the specified event.
Return Value: Object
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 the specified events.

Parameters:
events: Object
An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}
Return Value: Object
The object for which this method is called.

Use this method to subscribe to several events at one method call. Available events are listed in the Events section.

See Also

option()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

option(options)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

Parameters:
key: String
Specifies the key for which to register a handler.
handler: function
A handler function.

The handler function is called when the specified key is pressed if the widget is focused.

The key argument accepts the following values.

  • "backspace"
  • "tab"
  • "enter"
  • "escape"
  • "pageUp"
  • "pageDown"
  • "end"
  • "home"
  • "leftArrow"
  • "upArrow"
  • "rightArrow"
  • "downArrow"
  • "del"
  • "space"
  • "F"
  • "A"
  • "asterisk"
  • "minus"

NOTE: If you specify a custom handler for a key, the default handler for this key is canceled.

repaint()

Redraws the widget.

After performing some external modifications that lead to a change of the widget container's size or visibility, the widget's state may become invalid. In this instance, use the repaint() method to redraw the widget.

updateDimensions()

Updates the widget to the size of its content.