JavaScript/jQuery PivotGrid - fieldChooser

The Field Chooser configuration properties.

Type:

Object

A field chooser is a pivot grid element that allows an end-user to configure data displayed in the pivot grid. To invoke the field chooser, right-click any pivot grid header and select the Show Field Chooser item. You can also display PivotGridFieldChooser as a separate UI component.

View Demo

allowSearch

Specifies whether the field chooser allows searching in the "All Fields" section.

Type:

Boolean

Default Value: false

View Demo

applyChangesMode

Specifies when to apply changes made in the field chooser to the PivotGrid.

Type:

String

Default Value: 'instantly'
Accepted Values: 'instantly' | 'onDemand'

The following modes are available:

  • "instantly"
    Applies changes immediately.

  • "onDemand"
    Applies changes when a user clicks OK or cancels them when a user clicks Cancel.

View Demo

enabled

Enables or disables the field chooser.

Type:

Boolean

Default Value: true

View Demo

height

Specifies the field chooser height.

Type:

Number

Default Value: 600

View Demo

layout

Specifies the field chooser layout.

Type:

Number

Default Value: 0
Accepted Values: 0 | 1 | 2

The image below shows different layout types.

DevExtreme PivotGrid: Field chooser layouts

The following abbreviations are used on the image.

  • A — All Fields
  • F — Filter Fields
  • R — Row Fields
  • C — Column Fields
  • D — Data Fields

View Demo

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.

Type:

Number

Default Value: 500

texts

Strings that can be changed or localized in the pivot grid's integrated Field Chooser.

Type:

Object

NOTE
Due to technical restrictions, you cannot obtain this object at runtime if you have not specified it beforehand when configuring the UI component.

title

Specifies the text to display as a title of the field chooser popup window.

Type:

String

Default Value: 'Field Chooser'

width

Specifies the field chooser width.

Type:

Number

Default Value: 600