JavaScript/jQuery PivotGridFieldChooser API

A complementary UI component 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 UI component, use the PivotGridFieldChooser UI component.

import PivotGridFieldChooser from "devextreme/ui/pivot_grid_field_chooser"

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 UI components as shown in the code above.

View Demo

See Also
jQuery
Angular
Vue
React
jQuery
Angular
Vue
React

Options

This section describes the configuration properties of the PivotGridFieldChooser UI component.

Name Description
accessKey

Specifies the shortcut key that sets focus on the UI component.
activeStateEnabled

Specifies whether the UI component changes its visual state as a result of user interaction.
allowSearch

Specifies whether the field chooser allows search operations in the "All Fields" section.
applyChangesMode

Specifies when to apply changes made in the UI component to the PivotGrid.
dataSource

The data source of a PivotGrid UI component.
disabled

Specifies whether the UI component responds to user interaction.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
encodeHtml

Specifies whether HTML tags are displayed as plain text or applied to the values of the header filter.
focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.
headerFilter

Configures the header filter feature.
height

Specifies the UI component's height.
hint

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
layout

Specifies the field chooser layout.
onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.
onContextMenuPreparing

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

A function that is executed before the UI component is disposed of.
onInitialized

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

A function that is executed after a UI component property is changed.
rtlEnabled

Switches the UI component 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 UI component'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 UI component.
visible

Specifies whether the UI component is visible.
width

Specifies the UI component's width.

See Also
jQuery
Angular
Vue
React

Methods

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

Name Description
applyChanges()

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

Postpones rendering that can negatively affect performance until the endUpdate() method is called.
cancelChanges()

Cancels changes made in the UI component without applying them to the PivotGrid. Takes effect only if applyChangesMode is "onDemand".
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the PivotGridFieldChooser instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
focus()

Sets focus on the UI component.
getDataSource()

Gets the PivotGridDataSource instance.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
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 UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
registerKeyHandler(key, handler)

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

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
resetOption(optionName)

Resets a property to its default value.
updateDimensions()

Updates the UI component to the size of its content.

See Also
jQuery
Angular
Vue
React

Events

This section describes events fired by this UI component.

Name Description
contentReady

Raised when the UI component is rendered and each time the component is repainted.
contextMenuPreparing

Raised before the context menu is rendered.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
optionChanged

Raised after a UI component property is changed.

See Also
jQuery
Angular
Vue
React

Types

Name Description
ContentReadyEvent

The type of the contentReady event handler's argument.
ContextMenuPreparingEvent

The type of the contextMenuPreparing event handler's argument.
DisposingEvent

The type of the disposing event handler's argument.
InitializedEvent

The type of the initialized event handler's argument.
OptionChangedEvent

The type of the optionChanged event handler's argument.