React PivotGridFieldChooser Methods
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.
The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.
See Also
cancelChanges()
Cancels changes made in the widget without applying them to the PivotGrid. Takes effect only if applyChangesMode is "onDemand".
defaultOptions(rule)
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the PivotGridFieldChooser widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxPivotGridFieldChooser.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the PivotGridFieldChooser options } });
Angular
import PivotGridFieldChooser from "devextreme/ui/pivot_grid_field_chooser"; // ... export class AppComponent { constructor () { PivotGridFieldChooser.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the PivotGridFieldChooser options } }); } }
dispose()
The following code disposes of an PivotGridFieldChooser instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:
jQuery
$("#myPivotGridFieldChooser").dxPivotGridFieldChooser("dispose"); $("#myPivotGridFieldChooser").remove();
Angular
<dx-pivot-grid-field-chooser #pivotGridFieldChooserVar id="myPivotGridFieldChooser"></dx-pivot-grid-field-chooser>
import { ..., ViewChild } from "@angular/core"; import { DxPivotGridFieldChooserComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("pivotGridFieldChooserVar") pivotGridFieldChooser: DxPivotGridFieldChooserComponent; removePivotGridFieldChooser (e) { this.pivotGridFieldChooser.instance.dispose(); document.getElementById("myPivotGridFieldChooser").remove(); } }
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
getInstance(element)
getInstance is a static method that the widget class supports. The following code demonstrates how to get the PivotGridFieldChooser instance found in an element with the myPivotGridFieldChooser
ID:
// Modular approach import PivotGridFieldChooser from "devextreme/ui/pivot_grid_field_chooser"; ... let element = document.getElementById("myPivotGridFieldChooser"); let instance = PivotGridFieldChooser.getInstance(element) as PivotGridFieldChooser; // Non-modular approach let element = document.getElementById("myPivotGridFieldChooser"); let instance = DevExpress.ui.dxPivotGridFieldChooser.getInstance(element);
See Also
option()
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(options)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.