Configuration

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

See Also

accessKey

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

Type:

String

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

activeStateEnabled

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

Type:

Boolean

Default Value: false

This property is used when the UI component is displayed on a platform whose guidelines include the active state change for UI components.

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 UI component 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 UI component.

Default Value: null

It is important for the data source of the PivotGridFieldChooser to be the same as the data source of its PivotGrid UI component. 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 UI component responds to user interaction.

Type:

Boolean

Default Value: false

elementAttr

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

Type: any
Default Value: {}

jQuery
$(function(){
    $("#pivotGridFieldChooserContainer").dxPivotGridFieldChooser({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-pivot-grid-field-chooser ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-pivot-grid-field-chooser>
import { DxPivotGridFieldChooserModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxPivotGridFieldChooserModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxPivotGridFieldChooser ...
        :element-attr="pivotGridFieldChooserAttributes">
    </DxPivotGridFieldChooser>
</template>

<script>
import DxPivotGridFieldChooser from 'devextreme-vue/pivot-grid-field-chooser';

export default {
    components: {
        DxPivotGridFieldChooser
    },
    data() {
        return {
            pivotGridFieldChooserAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import PivotGridFieldChooser from 'devextreme-react/pivot-grid-field-chooser';

class App extends React.Component {
    pivotGridFieldChooserAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <PivotGridFieldChooser ...
                elementAttr={this.pivotGridFieldChooserAttributes}>
            </PivotGridFieldChooser>
        );
    }
}
export default App;

focusStateEnabled

Specifies whether the UI component 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 UI component Pivot Grid Field Chooser Header Filter

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

The user's filtering preferences are saved in the filterValues property. The header filter's Select All checkbox changes the filterType property.

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: 400

This property 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%", "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 UI component.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component 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 function that is executed when the UI component's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

PivotGridFieldChooser

The UI component's instance.

element

HTMLElement | jQuery

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

model any

Model data. Available only when using Knockout.

Default Value: null

onContextMenuPreparing

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
area

String

The clicked area's type.

component

PivotGridFieldChooser

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

field

PivotGrid Field

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

items

Array<Object>

Items to be displayed in the context menu. Their structure is described in the items property description.

model any

Model data. Available only if Knockout is used.

Default Value: null

onDisposing

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

PivotGridFieldChooser

The UI component's instance.

element

HTMLElement | jQuery

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

model any

Model data. Available only if you use Knockout.

Default Value: null

onInitialized

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

PivotGridFieldChooser

The UI component's instance.

element

HTMLElement | jQuery

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

Default Value: null

See Also

onOptionChanged

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

PivotGridFieldChooser

The UI component's instance.

fullName

String

The path to the modified property that includes all parent properties.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

value any

The modified property's new value.

element

HTMLElement | jQuery

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

model any

Model data. Available only if you use Knockout.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#pivotGridFieldChooserContainer").dxPivotGridFieldChooser({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-pivot-grid-field-chooser ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-pivot-grid-field-chooser>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxPivotGridFieldChooserModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxPivotGridFieldChooserModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  
Vue
App.vue
<template> 
    <DxPivotGridFieldChooser ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxPivotGridFieldChooser from 'devextreme-vue/pivot-grid-field-chooser'; 

export default { 
    components: { 
        DxPivotGridFieldChooser
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 
React
App.js
import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import PivotGridFieldChooser from 'devextreme-react/pivot-grid-field-chooser'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <PivotGridFieldChooser ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

Boolean

Default Value: false

When this property is set to true, the UI component 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

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

state

The UI component's state.

Type: any
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 UI component:

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 property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

texts

Strings that can be changed or localized in the PivotGridFieldChooser UI component.

Type:

Object

visible

Specifies whether the UI component is visible.

Type:

Boolean

Default Value: true

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

This property 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;
    }