JavaScript/jQuery DeferRendering Options
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.
Use this property when you display the component on a platform whose guidelines include the active state change for UI components.
animation
You can pass a configuration object defining the required animation or the name of one of the registered animations.
Note that you can specify a staggered animation so that content elements with a similar selector are animated using the specified animation one after another with a specified delay.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#deferRenderingContainer").dxDeferRendering({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-defer-rendering ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-defer-rendering>
import { DxDeferRenderingModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxDeferRenderingModule ], // ... })
Vue
<template> <DxDeferRendering ... :element-attr="deferRenderingAttributes"> </DxDeferRendering> </template> <script> import DxDeferRendering from 'devextreme-vue/defer-rendering'; export default { components: { DxDeferRendering }, data() { return { deferRenderingAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import DeferRendering from 'devextreme-react/defer-rendering'; class App extends React.Component { deferRenderingAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <DeferRendering ... elementAttr={this.deferRenderingAttributes}> </DeferRendering> ); } } export default App;
height
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"
,"20vh"
,"80%"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onInitialized
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
Angular
<dx-defer-rendering ... (onInitialized)="saveInstance($event)"> </dx-defer-rendering>
import { Component } from "@angular/core"; import DeferRendering from "devextreme/ui/data_grid"; // ... export class AppComponent { deferRenderingInstance: DeferRendering; saveInstance (e) { this.deferRenderingInstance = e.component; } }
Vue
<template> <div> <DxDeferRendering ... @initialized="saveInstance"> </DxDeferRendering> </div> </template> <script> import DxDeferRendering from 'devextreme-vue/defer-rendering'; export default { components: { DxDeferRendering }, data: function() { return { deferRenderingInstance: null }; }, methods: { saveInstance: function(e) { this.deferRenderingInstance = e.component; } } }; </script>
<template> <div> <DxDeferRendering ... @initialized="saveInstance"> </DxDeferRendering> </div> </template> <script setup> import DxDeferRendering from 'devextreme-vue/defer-rendering'; let deferRenderingInstance = null; const saveInstance = (e) => { deferRenderingInstance = e.component; } </script>
React
import DeferRendering from 'devextreme-react/defer-rendering'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.deferRenderingInstance = e.component; } render() { return ( <div> <DeferRendering onInitialized={this.saveInstance} /> </div> ); } }
See Also
onOptionChanged
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#deferRenderingContainer").dxDeferRendering({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-defer-rendering ... (onOptionChanged)="handlePropertyChange($event)"> </dx-defer-rendering>
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 { DxDeferRenderingModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxDeferRenderingModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxDeferRendering ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxDeferRendering from 'devextreme-vue/defer-rendering'; export default { components: { DxDeferRendering }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import DeferRendering from 'devextreme-react/defer-rendering'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <DeferRendering ... onOptionChanged={handlePropertyChange} /> ); }
onRendered
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onShown
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
rtlEnabled
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.
DevExpress.config({ rtlEnabled: true });
staggerItemSelector
Elements with the selector specified by this property will be searched within the UI component's content. The found elements will be shown with animation specified by the animation property. If the specified animation is staggered, the elements will be animated one after another with the delay specified within the animation's configuration.
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
width
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"
,"20vw"
,"80%"
,"auto"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
If you have technical questions, please create a support ticket in the DevExpress Support Center.