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"
Type: PivotGridFieldChooserTypes.default

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

See Also

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.
applyChangesMode

Specifies when to apply changes made in the widget to the PivotGrid.
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 function that is executed when the widget's content is ready and each time the content is changed.
onContextMenuPreparing

A function that is executed before the context menu is rendered.
onDisposing

A function that is executed before the widget is disposed of.
onInitialized

A function used in JavaScript frameworks to save the widget instance.
onOptionChanged

A function that is executed after a widget option 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.
state

The widget's state.
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.

See Also

Methods

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

Name Description
applyChanges()

Applies changes made in the widget to the PivotGrid. Takes effect only if applyChangesMode is "onDemand".
beginUpdate()

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

Cancels changes made in the widget without applying them to the PivotGrid. Takes effect only if applyChangesMode is "onDemand".
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 without reloading data. Call it to update the widget's markup.
resetOption(optionName)

Resets an option to its default value.
updateDimensions()

Updates the widget to the size of its content.

See Also

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.
contextMenuPreparing

Raised before the context menu is rendered.
disposing

Raised before the widget is disposed of.
initialized

Raised only once, after the widget is initialized.
optionChanged

Raised after a widget option is changed.

See Also