Methods

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

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

bindChart(chart, integrationOptions)

Binds a Chart to the PivotGrid.

Parameters:
chart:

String

|

jQuery

|

Object

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

Allows you to process data of a grid cell before it will be visualized by the chart.

customizeChart:

function

Allows you to customize the appearance of the chart.

customizeSeries:

function

Allows you to customize the chart series.

Return Value: method | null

Unbinds the chart. If null, then binding failed.

Main article: Integration with Chart

View Demo

See Also

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<Object>

|

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

dispose()

Removes the widget from the DOM.

element()

Gets the root element of the widget.

Return Value:

Element (jQuery or HTML)

The widget's root element. An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportToExcel()

Exports pivot grid data to the Excel file.

See Also

focus()

Sets focus on the widget.

See Also

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.

See Also

getFieldChooserPopup()

Gets the Popup instance of the field chooser window.

Return Value:

Popup

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

getInstance(element)

Gets the widget's instance using a DOM element.

Parameters:
element:

DOM Node

|

jQuery

An element containing the widget.

Return Value:

Object

The widget's instance.

instance()

Returns this widget's instance. Use it to access other methods of the widget.

Return Value:

Object

This widget's instance.

See Also

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.

See Also

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.

See Also

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 with one method call. Available events are listed in the Events section.

See Also

option()

Gets the widget's options.

Return Value:

Object

The widget's options.

See Also

option(optionName)

Gets a specific option value.

Parameters:
optionName:

String

The option name or the full path to the option.

Return Value: any

This option value.

See Also

option(optionName, optionValue)

Assigns a new value to a specific option.

Parameters:
optionName:

String

The option name or the full path to the option.

optionValue: any

A new value for this option.

See Also

option(options)

Sets one or more options.

Parameters:
options:

Object

The options along with their new values.

See Also

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:
key:

String

The key for which the handler should be registered.

handler:

function

A handler.

The key argument accepts one of the following values:

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

A custom handler for a key cancels the default handler for this key.

See Also

repaint()

Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.

See Also

updateDimensions()

Updates the widget to the size of its content.

See Also