JavaScript/jQuery DeferRendering Options

Default Value: false

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type:

Object

Default Value: {}

jQuery

$(function(){
    $("#deferRenderingContainer").dxDeferRendering({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-defer-rendering ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-defer-rendering>

import { DxDeferRenderingModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxDeferRenderingModule
    ],
    // ...
})

Vue

App.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

App.js

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;

focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.

Type:

Default Value: false

height

Specifies the UI component's height.

Type:

| undefined

Return Value:

The UI component's height.

Default Value: undefined

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.

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

| undefined

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Default Value: false

onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.

Type:

Function parameters:

ContentReadyEvent

Information about the event.

Object structure:

Name	Type	Description
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	DeferRendering	The UI component's instance.

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.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function parameters:

DisposingEvent

Information about the event.

Object structure:

Name	Type	Description
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	DeferRendering	The UI component's instance.

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.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function parameters:

InitializedEvent

Information about the event.

Object structure:

Name	Type	Description
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	DeferRendering	The UI component's instance.

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.

Default Value: null

Angular

app.component.html

app.component.ts

<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

App.vue (Options API)

App.vue (Composition API)

<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

App.js

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>
        );
    }
}

jQuery

Get a UI component Instance in jQuery

Angular

Get a UI component Instance in Angular

Vue

Get a UI component Instance in Vue

React

Get a UI component Instance in React

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function parameters:

OptionChangedEvent

Information about the event.

Object structure:

Name	Type	Description
value	any	The modified property's new value.
previousValue	any	The UI component's previous value.
name	String	The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullName	String	The path to the modified property that includes all parent properties.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	DeferRendering	The UI component's instance.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery

index.js

$(function() {
    $("#deferRenderingContainer").dxDeferRendering({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<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

App.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

App.js

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

A function that is executed when the content is rendered but not yet displayed.

Type:

Function parameters:

RenderedEvent

Information about the event.

Object structure:

Name	Type	Description
component	DeferRendering	The UI component's instance.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

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.

Default Value: null

onShown

A function that is executed when the content is displayed and animation is completed.

Type:

Function parameters:

ShownEvent

Information about the event.

Object structure:

Name	Type	Description
component	DeferRendering	The UI component's instance.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

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.

Default Value: null

renderWhen

Specifies when the UI component content is rendered.

Type:

Promise<void> (jQuery or native)

| undefined

Default Value: undefined

The UI component content is rendered when this property is set to true, or when a Promise assigned to this property is resolved.

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

DataGrid Demo Navigation UI Demo Editors Demo

Default Value: false

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.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

showLoadIndicator

Indicates if a load indicator should be shown until the UI component's content is rendered.

Type:

Default Value: false

staggerItemSelector

Specifies a jQuery selector of items that should be rendered using a staggered animation.

Type:

| undefined

Default Value: undefined

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

Specifies the number of the element when the Tab key is used for navigating.

Type:

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

visible

Specifies whether the UI component is visible.

Type:

Default Value: true

width

Specifies the UI component's width.

Type:

| undefined

Return Value: