React PivotGridFieldChooser API

A complementary widget for the PivotGrid that allows you to manage data displayed in the PivotGrid. The field chooser is already integrated in the 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.

import PivotGridFieldChooser from "devextreme-react/pivot-grid-field-chooser"

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the PivotGridFieldChooser widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

var pivotGridDataSource = new DevExpress.data.PivotGridDataSource({
    // ...
});
$(function () {
    $("#fieldChooser").dxPivotGridFieldChooser({
        dataSource: pivotGridDataSource
    });
    $("#pivotGrid").dxPivotGrid({
        dataSource: pivotGridDataSource
    });
});

<div id="fieldChooser"></div>
<div id="pivotGrid"></div>

Angular

HTML

TypeScript

<dx-pivot-grid-field-chooser [dataSource]="pivotGridDataSource"></dx-pivot-grid-field-chooser>
<dx-pivot-grid [dataSource]="pivotGridDataSource"></dx-pivot-grid>

import { DxPivotGridFieldChooserModule } from 'devextreme-angular';
import PivotGridDataSource from 'devextreme/ui/pivot_grid/data_source';
// ...
export class AppComponent {
    pivotGridDataSource = new PivotGridDataSource({
        // ...   
    });
}
@NgModule({
    imports: [
        // ...
        DxPivotGridFieldChooserModule
    ],
    // ...
})

AngularJS

HTML

JavaScript

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

angular.module('DemoApp', ['dx'])
    .controller("DemoController", function ($scope) {
        $scope.pivotGridDataSource = new DevExpress.data.PivotGridDataSource({
            // ...   
        });
    });

Knockout

HTML

JavaScript

<div data-bind="dxPivotGridFieldChooser: {
    dataSource: pivotGridDataSource
}"></div>
<div data-bind="dxPivotGrid: {
    dataSource: pivotGridDataSource  
}"></div>

var viewModel = {
    pivotGridDataSource: new DevExpress.data.PivotGridDataSource({
        // ...
    })
};
ko.applyBindings(viewModel);

Both the PivotGridFieldChooser and the PivotGrid must be bound to one and the same instance of the PivotGridDataSource. Create the PivotGridDataSource individually and then assign it to both widgets as shown in the code above.

View Demo

Props

This section describes the configuration options of the PivotGridFieldChooser widget.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the widget.
activeStateEnabled	Specifies whether or not the widget changes its state when interacting with a user.
allowSearch	Specifies whether the field chooser allows searching in the "All Fields" section.
dataSource	The data source of a PivotGrid widget.
disabled	Specifies whether the widget responds to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
focusStateEnabled	Specifies whether the widget can be focused using keyboard navigation.
headerFilter	Configures the header filter feature.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget changes its state when a user pauses on it.
layout	Specifies the field chooser layout.
onContentReady	A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.
onContextMenuPreparing	A handler for the contextMenuPreparing event.
onDisposing	A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
onInitialized	A handler for the initialized event. Executed only once, after the widget is initialized.
onOptionChanged	A handler for the optionChanged event. Executed after an option of the widget is changed.
rtlEnabled	Switches the widget to a right-to-left representation.
searchTimeout	Specifies a delay in milliseconds between when a user finishes typing in the field chooser's search panel, and when the search is executed.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
texts	Strings that can be changed or localized in the PivotGridFieldChooser widget.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.

Methods

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

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
dispose()	Disposes of all the resources allocated to the PivotGridFieldChooser instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
focus()	Sets focus on the widget.
getDataSource()	Gets the PivotGridDataSource instance.
getInstance(element)	Gets the instance of a widget found using its DOM node.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
repaint()	Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.
updateDimensions()	Updates the widget to the size of its content.

Events

This section describes events fired by this widget.

Name	Description
contentReady	Raised when the widget's content is ready.
contextMenuPreparing	Fires before displaying a context menu invoked by a right-click on one of the field chooser's fields.
disposing	Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.

React PivotGridFieldChooser API

jQuery

Angular

AngularJS

Knockout

Props

Methods

Events

See Also