JavaScript/jQuery LoadPanel Options
An object that defines configuration options for the LoadPanel widget.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
closeOnOutsideClick
Specifies whether to close the widget if a user clicks outside it.
Event (jQuery or EventObject)
The event that caused widget closing. It is a dxEvent or a jQuery.Event when you use jQuery.
true if the widget should be closed; otherwise 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.
var widgetOptions = { // ... closeOnOutsideClick: function(e) { return e.target === $("#someElement").get()[0]; } }
The closeOnOutsideClick function is called when a user clicks the widget or outside it.
container
Specifies the widget's container.
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.
elementAttr
Specifies the attributes to be attached to the widget's root element.
jQuery
$(function(){ $("#loadPanelContainer").dxLoadPanel({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<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 Controls
@(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" } }) )
height
Specifies the widget's height in pixels.
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%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
hint
Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled
Specifies whether the widget changes its state when a user pauses on it.
maxHeight
Specifies the maximum height the widget can reach while resizing.
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%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
maxWidth
Specifies the maximum width the widget can reach while resizing.
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:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
message
Specifies the text displayed in the load panel. Ignored in the Material Design theme.
minHeight
Specifies the minimum height the widget can reach while resizing.
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%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
minWidth
Specifies the minimum width the widget can reach while resizing.
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:JavaScriptwidth: 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.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only when using Knockout. |
onDisposing
A function that is executed before the widget is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
onHidden
A function that is executed after the widget is hidden.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
onHiding
A function that is executed before the widget is hidden.
Information about the event.
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel overlay hiding. |
|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
onInitialized
A function used in JavaScript frameworks to save the widget instance.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
A function that is executed after a widget option is changed.
Information about the event.
Name | Type | Description |
---|---|---|
model |
The model data. Available only if you use Knockout. |
|
fullName |
The path to the modified option that includes all parent options. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
name |
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into. |
|
value | any |
The modified option's new value. |
onShowing
A function that is executed before the widget is displayed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
onShown
A function that is executed after the widget is displayed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
position
Positions the widget.
This option accepts one of the following:
Position configuration object
An object that specifies the widget's position.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 based on a condition.
Use the PositionAlignment
enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. 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.
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.
DevExpress.config({ rtlEnabled: true });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
shading
Specifies whether to shade the background when the widget is active.
shadingColor
Specifies the shading color.
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.
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.
visible
A Boolean value specifying whether or not the widget is visible.
You can show and hide the widget by changing the value of an observable variable passed to this option.
The widget is automatically hidden after the time specified in the displayTime option.
width
Specifies the widget's width in pixels.
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:JavaScriptwidth: function() { return window.innerWidth / 1.5; }