Configuration

This section describes the configuration options of the PivotGridFieldChooser widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: false

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

allowSearch

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

Type:

Boolean

Default Value: false

applyChangesMode

Specifies when to apply changes made in the widget to the PivotGrid.

Type:

String

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

The following modes are available:

  • "instantly"
    Applies changes immediately.

  • "onDemand"
    Applies or cancels changes only when this is requested from the API - by calling the applyChanges() or cancelChanges() method or by changing the state object.

View Demo

dataSource

The data source of a PivotGrid widget.

Default Value: null

It is important for the data source of the PivotGridFieldChooser to be the same as the data source of its PivotGrid widget. This will allow the field chooser to manage data in the pivot grid. Use the PivotGrid's getDataSource method to acquire its data source.

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#
Razor VB
@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: false

headerFilter

Configures the header filter feature.

Type:

Object

A header filter allows a user to filter individual field's values by including or excluding them from the applied filter. Cicking a header filter icon invokes a popup menu displaying all the unique field values.

DevExtreme HTML5 JavaScript jQuery Angular Knockout Widget Pivot Grid Field Chooser Header Filter

Assign true to the allowFiltering option to make the icons visible.

height

Specifies the widget's height.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget's height.

Default Value: 400

This option accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

layout

Specifies the field chooser layout.

Type:

Number

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

The image below shows different layout types.

The following abbreviations are used on the image.

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

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.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only when using Knockout.

Default Value: null

onContextMenuPreparing

A handler for the contextMenuPreparing event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

items:

Array<Object>

Items to be displayed in the context menu. Their structure is described in the Default Item Template section.

area:

String

The clicked area's type.

The configuration of the field on which the context menu is invoked.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

Assign a function to perform a custom action before a context menu is displayed in the field chooser. For instance, you can change the set of items in the menu.

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.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

You cannot access widget elements in this handler because it is executed before they are ready. Use the onContentReady handler instead.

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

state

The widget's state.

Type:

Object

Default Value: null

The state includes field configurations, expanded headers, and other settings. The following code shows how to use the state to cancel or apply the settings to the PivotGrid widget:

jQuery
JavaScript
$(function () {
    var pivotGridDataSource = new DevExpress.data.PivotGridDataSource({
        // ...
    });
    $("#pivotGridContainer").dxPivotGrid({
        dataSource: pivotGridDataSource,
        // ...
    });
    var fieldChooser = $("#fieldChooserContainer").dxPivotGridFieldChooser({
        dataSource: pivotGridDataSource,
        applyChangesMode: 'onDemand',
        // ...
    }).dxPivotGridFieldChooser("instance");
    $("#apply").dxButton({
        text: "Apply Changes",
        onClick: function () {
            var state = fieldChooser.option("state");
            pivotGridDataSource.state(state);
        }
    });
    $("#cancel").dxButton({
        text: "Cancel Changes",
        onClick: function () {
            fieldChooser.option("state", pivotGridDataSource.state();
        }
    });
});
Angular
TypeScript
HTML
import {
    DxPivotGridModule,
    DxPivotGridFieldChooserModule, 
    DxButtonModule
} from 'devextreme-angular';
import PivotGridDataSource from 'devextreme/ui/pivot_grid/data_source';
// ...
export class AppComponent {
    pivotGridDataSource: any;
    state: any;
    constructor() {
        this.pivotGridDataSource = new PivotGridDataSource({ ... });
    }
    applyChanges() {
        this.pivotGridDataSource.state(this.state);
    }
    cancelChanges() {
        this.state = this.pivotGridDataSource.state();
    }
}
@NgModule({
    imports: [
        DxPivotGridModule,
        DxPivotGridFieldChooserModule,
        DxButtonModule,
        // ...
    ],
    // ...
})
<dx-pivot-grid
    ...
    [dataSource]="pivotGridDataSource">
</dx-pivot-grid>
<dx-pivot-grid-field-chooser 
    ...
    [dataSource]="pivotGridDataSource"
    applyChangesMode="onDemand"
    [(state)]="state">
</dx-pivot-grid-field-chooser>
<dx-button
    text="Apply Changes"
    (onClick)="applyChanges()">
</dx-button>
<dx-button
    text="Cancel Changes"
    (onClick)="cancelChanges()">
</dx-button>

View Demo

See Also

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

texts

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

Type:

Object

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }