JavaScript/jQuery PivotGridFieldChooser Methods
This section describes the methods that can be used to manipulate the PivotGridFieldChooser UI component.
applyChanges()
Applies changes made in the UI component to the PivotGrid. Takes effect only if applyChangesMode is "onDemand".
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
cancelChanges()
Cancels changes made in the UI component without applying them to the PivotGrid. Takes effect only if applyChangesMode is "onDemand".
defaultOptions(rule)
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the PivotGridFieldChooser UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxPivotGridFieldChooser.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the PivotGridFieldChooser properties
}
});Angular
import PivotGridFieldChooser from "devextreme/ui/pivot_grid_field_chooser";
// ...
export class AppComponent {
constructor () {
PivotGridFieldChooser.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the PivotGridFieldChooser properties
}
});
}
}Vue
<template>
<div>
<DxPivotGridFieldChooser id="pivotGridFieldChooser1" />
<DxPivotGridFieldChooser id="pivotGridFieldChooser2" />
</div>
</template>
<script>
import DxPivotGridFieldChooser from "devextreme-vue/pivot-grid-field-chooser";
import PivotGridFieldChooser from "devextreme/ui/pivot_grid_field_chooser";
PivotGridFieldChooser.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the PivotGridFieldChooser properties
}
});
export default {
components: {
DxPivotGridFieldChooser
}
}
</script>React
import React, {useEffect} from "react";
import dxPivotGridFieldChooser from "devextreme/ui/pivot_grid_field_chooser";
import PivotGridFieldChooser from "devextreme-react/pivot-grid-field-chooser";
export default function App() {
useEffect(() => {
dxPivotGridFieldChooser.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the PivotGridFieldChooser properties
}
})
});
return (
<div>
<PivotGridFieldChooser id="pivotGridFieldChooser1" />
<PivotGridFieldChooser id="pivotGridFieldChooser2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myPivotGridFieldChooser").dxPivotGridFieldChooser("dispose");
$("#myPivotGridFieldChooser").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-pivot-grid-field-chooser ...
*ngIf="condition">
</dx-pivot-grid-field-chooser>Vue
<template>
<DxPivotGridFieldChooser ...
v-if="condition">
</DxPivotGridFieldChooser>
</template>
<script>
import DxPivotGridFieldChooser from 'devextreme-vue/pivot-grid-field-chooser';
export default {
components: {
DxPivotGridFieldChooser
}
}
</script>React
import React from 'react';
import PivotGridFieldChooser from 'devextreme-react/pivot-grid-field-chooser';
function DxPivotGridFieldChooser(props) {
if (!props.shouldRender) {
return null;
}
return (
<PivotGridFieldChooser ... >
</PivotGridFieldChooser>
);
}
class App extends React.Component {
render() {
return (
<DxPivotGridFieldChooser shouldRender="condition" />
);
}
}
export default App;See Also
getInstance(element)
getInstance is a static method that the UI component 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
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject 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.