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.
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","80%","inherit".Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
onContentReady
A function that is executed when the UI component's content is ready and each time the content is changed.
| 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. |
|
| model |
Model data. Available only when using Knockout. |
onDisposing
A function that is executed before the UI component is disposed of.
| 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. |
|
| model |
Model data. Available only if you use Knockout. |
onInitialized
| 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. |
onOptionChanged
| Name | Type | Description |
|---|---|---|
| model |
Model data. Available only if you use Knockout. |
|
| 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. |
|
| name |
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. |
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.common.css';
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.common.css';
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. |
|
| model |
Model data. Available only if Knockout is used. |
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. |
|
| model |
Model data. Available only if Knockout is used. |
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
});See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
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","80%","auto","inherit".Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }