JavaScript/jQuery DeferRendering Methods
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
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 DeferRendering UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxDeferRendering.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DeferRendering properties } });
Angular
import DeferRendering from "devextreme/ui/defer_rendering"; // ... export class AppComponent { constructor () { DeferRendering.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DeferRendering properties } }); } }
Vue
<template> <div> <DxDeferRendering id="deferRendering1" /> <DxDeferRendering id="deferRendering2" /> </div> </template> <script> import DxDeferRendering from "devextreme-vue/defer-rendering"; import DeferRendering from "devextreme/ui/defer_rendering"; DeferRendering.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DeferRendering properties } }); export default { components: { DxDeferRendering } } </script>
React
import React, {useEffect} from "react"; import dxDeferRendering from "devextreme/ui/defer_rendering"; import DeferRendering from "devextreme-react/defer-rendering"; export default function App() { useEffect(() => { dxDeferRendering.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DeferRendering properties } }) }); return ( <div> <DeferRendering id="deferRendering1" /> <DeferRendering id="deferRendering2" /> </div> ) }
dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myDeferRendering").dxDeferRendering("dispose"); $("#myDeferRendering").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-defer-rendering ... *ngIf="condition"> </dx-defer-rendering>
Vue
<template> <DxDeferRendering ... v-if="condition"> </DxDeferRendering> </template> <script> import DxDeferRendering from 'devextreme-vue/defer-rendering'; export default { components: { DxDeferRendering } } </script>
React
import React from 'react'; import DeferRendering from 'devextreme-react/defer-rendering'; function DxDeferRendering(props) { if (!props.shouldRender) { return null; } return ( <DeferRendering ... > </DeferRendering> ); } class App extends React.Component { render() { return ( <DxDeferRendering 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 DeferRendering instance found in an element with the myDeferRendering
ID:
// Modular approach import DeferRendering from "devextreme/ui/defer_rendering"; ... let element = document.getElementById("myDeferRendering"); let instance = DeferRendering.getInstance(element) as DeferRendering; // Non-modular approach let element = document.getElementById("myDeferRendering"); let instance = DevExpress.ui.dxDeferRendering.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.