Configuration

An object that defines configuration options for the LoadPanel widget.

animation

Configures widget visibility animations. This object contains two fields: show and hide.

Type:

Object

Default Value: null

closeOnOutsideClick

Specifies whether to close the widget if a user clicks outside it.

Type:

Boolean

|

function

Function parameters:
event:

Event (jQuery or dxEvent)

The event that caused widget closing. It is a dxEvent or a jQuery.Event when you use jQuery.

Return Value:

Boolean

true if the widget should be closed; otherwise false.

Default Value: false

The function passed to this option enables you to specify a custom condition for widget closing. For instance, you can prevent closing until a user clicks a certain element.

JavaScript
var widgetOptions = {
    // ...
    closeOnOutsideClick: function(e) {
        return e.target === $("#someElement").get()[0];
    }
}

container

Specifies the widget's container.

Type:

String

|

DOM Node

|

jQuery

Default Value: undefined

The default container is defined during the widget's initialization. It is the viewport, or the body element if the viewport is not found, or the parent element if the previous two are absent.

The specified container is shaded when the LoadPanel is visible; the LoadPanel inherits styles from the container and is scrolled with it.

deferRendering

Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately.

Type:

Boolean

Default Value: true

delay

The delay in milliseconds after which the load panel is displayed.

Type:

Number

Default Value: 0

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}
jQuery
$(function(){
    $("#loadPanelContainer").dxLoadPanel({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-load-panel ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-load-panel>
import { DxLoadPanelModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxLoadPanelModule
    ],
    // ...
})
ASP.NET MVC Control
Razor C#
Razor VB
@(Html.DevExtreme().LoadPanel()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().LoadPanel() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether or not the widget can be focused.

Type:

Boolean

Default Value: false

height

Specifies the widget's height in pixels.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget's height.

Default Value: undefined, function() { return $(window).height() * 0.8 }, 90, 60 (Material)

This option 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%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

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

Type:

String

Default Value: undefined

hoverStateEnabled

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

Type:

Boolean

Default Value: false

indicatorSrc

A URL pointing to an image to be used as a load indicator.

Type:

String

Default Value: ''

maxHeight

Specifies the maximum height the widget can reach while resizing.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The maximum height.

Default Value: null, 60 (Material)

This option 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%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

maxWidth

Specifies the maximum width the widget can reach while resizing.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The maximum width.

Default Value: null, 60 (Material)

This option 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:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }

message

The text displayed in the load panel.

Type:

String

Default Value: 'Loading ...', '' (Material)

minHeight

Specifies the minimum height the widget can reach while resizing.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The minimum height.

Default Value: null

This option 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%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

minWidth

Specifies the minimum width the widget can reach while resizing.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The minimum width.

Default Value: null

This option 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:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onHidden

A function that is executed after the widget is hidden.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

onHiding

A function that is executed before the widget is hidden.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

cancel:

Boolean

Allows you to cancel overlay hiding.

Default Value: null

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready. Use the onContentReady function instead.

onOptionChanged

A function that is executed after a widget option is changed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onShowing

A function that is executed before the widget is displayed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

onShown

A function that is executed after the widget is displayed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

position

Positions the widget.

Default Value: { my: 'center', at: 'center', of: window }
Accepted Values: 'bottom'|'center'|'left'|'left bottom'|'left top'|'right'|'right bottom'|'right top'|'top'

This option accepts one of the following:

  • Position configuration object
    An object that specifies the position in every detail.

  • String
    A shortcut listed in the accepted values. Positions the widget relative to the window.

  • Function
    A function that returns one of the above. Use it to position the widget differently depending on a condition.

When using the widget as an ASP.NET MVC Control, you can specify this option using the PositionAlignment enum. This enum accepts the following values: Bottom, Center, Left, LeftBottom, LeftTop, RightBottom, RightTop, and Top.

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget 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
});
See Also

shading

A Boolean value specifying whether or not the main screen is inactive while the widget is active.

Type:

Boolean

Default Value: true

shadingColor

Specifies the shading color.

Type:

String

Default Value: '', 'transparent', '' (Android, iOS, Windows Mobile)

This option makes sense only if the shading option is set to true.

showIndicator

A Boolean value specifying whether or not to show a load indicator.

Type:

Boolean

Default Value: true

If this option is set to true, a message is displayed and a load indicator turns in a circle while the view's content is loaded. Set this option to false to display only the text message. This can help avoid problems with animation used for the load indicator when running on a slow device.

showPane

A Boolean value specifying whether or not to show the pane behind the load indicator.

Type:

Boolean

Default Value: true

visible

A Boolean value specifying whether or not the widget is visible.

Type:

Boolean

Default Value: false
Raised Events: showing, hiding

You can show and hide the widget by changing the value of an observable variable passed to this option.

width

Specifies the widget's width in pixels.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined, function() {return $(window).width() * 0.8 }, 222, 60 (Material)

This option 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:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }