PivotGridFieldChooser

A complementary widget for PivotGrid that allows you to manage data displayed in the PivotGrid.

Included in: dx.web.js, dx.viz-web.js, dx.all.js

The field chooser is already integrated in PivotGrid and can be invoked using the context menu. If you need to continuously display the field chooser near the PivotGrid widget, use the PivotGridFieldChooser widget.

You can add the PivotGridFieldChooser widget using one of the following approaches.

  • jQuery
    Use the dxPivotGridFieldChooser jQuery plug-in.

    HTML
    <div id="fieldChooserContainer"></div>
    <div id="pivotGridContainer"></div>
    JavaScript
    $('#fieldChooserContainer').dxPivotGridFieldChooser({
        dataSource: pivotGridDataSource
    });
  • Knockout
    Add a div element and apply the dxPivotGridFieldChooser binding to this element.

    HTML
    <div data-bind="dxPivotGridFieldChooser: { dataSource: pivotGridDataSource }"></div>
  • AngularJS
    Add a div element and apply the dx-pivot-grid-field-chooser directive to this element.

    HTML
    <div dx-pivot-grid-field-chooser="{ dataSource: pivotGridDataSource }"></div>

The pivot grid data source can be acquired from PivotGrid using the getDataSource() method as shown below.

JavaScript
var pivotGridDataSource = $('#pivotGridContainer').dxPivotGrid('instance').getDataSource();

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

To provide data for the PivotGridFieldChooser widget, specify the same dataSource as its PivotGrid has. The easiest way is to get the data source from the PivotGrid widget and assign it to the dataSource field.

View Demo

Configuration

This section describes the configuration options of the PivotGridFieldChooser widget.

Name Description
accessKey

Specifies a shortcut key that sets focus on the widget element.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

dataSource

The data source of a PivotGrid widget.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

focusStateEnabled

Specifies whether or not the widget can be focused.

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

layout

Specifies the field chooser layout.

onContentReady

A handler for the contentReady event.

onContextMenuPreparing

A handler for the contextMenuPreparing event.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onOptionChanged

A handler for the optionChanged event.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

tabIndex

Specifies the widget tab index.

texts

Strings that can be changed or localized in the PivotGridFieldChooser widget.

visible

A Boolean value specifying whether or not the widget is visible.

width

Specifies the width of the widget.

Methods

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

Name Description
beginUpdate()

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

defaultOptions(rule)

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

element()

Returns the root HTML element of the widget.

endUpdate()

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

focus()

Sets focus on the widget.

getDataSource()

Gets the PivotGridDataSource instance.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

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

option(optionName, optionValue)

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

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Redraws the widget.

updateDimensions()

Updates the widget to the size of its content.

Events

This section describes events fired by this widget.

Name Description
contentReady

Fires when widget content is ready.

contextMenuPreparing

Fires before displaying a context menu invoked by a right-click on one of the field chooser's fields.

disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

optionChanged

Fires after an option of the component is changed.