JavaScript/jQuery LoadPanel API
The LoadPanel is an overlay widget notifying the viewer that loading is in progress.
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Options
An object that defines configuration options for the LoadPanel widget.
| Name | Description |
|---|---|
| animation | Configures widget visibility animations. This object contains two fields: show and hide. |
| closeOnOutsideClick | Specifies whether to close the widget if a user clicks outside it. |
| container | Specifies the widget's container. |
| deferRendering | Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately. |
| delay | The delay in milliseconds after which the load panel is displayed. |
| elementAttr | Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled | Specifies whether or not the widget can be focused. |
| height | Specifies the widget's height in pixels. |
| 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. |
| indicatorSrc | A URL pointing to an image to be used as a load indicator. |
| maxHeight | Specifies the maximum height the widget can reach while resizing. |
| maxWidth | Specifies the maximum width the widget can reach while resizing. |
| 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. |
| minWidth | Specifies the minimum width the widget can reach while resizing. |
| onContentReady | A function that is executed when the widget's content is ready and each time the content is changed. |
| onDisposing | A function that is executed before the widget is disposed of. |
| onHidden | A function that is executed after the widget is hidden. |
| onHiding | A function that is executed before the widget is hidden. |
| onInitialized | A function used in JavaScript frameworks to save the widget instance. |
| onOptionChanged | A function that is executed after a widget option is changed. |
| onShowing | A function that is executed before the widget is displayed. |
| onShown | A function that is executed after the widget is displayed. |
| position | Positions the widget. |
| rtlEnabled | Switches the widget to a right-to-left representation. |
| shading | Specifies whether to shade the background when the widget is active. |
| shadingColor | Specifies the shading color. Applies only if shading is enabled. |
| showIndicator | A Boolean value specifying whether or not to show a load indicator. |
| 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. |
| width | Specifies the widget's width in pixels. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
This section describes members used to manipulate the widget.
| Name | Description |
|---|---|
| beginUpdate() | Prevents the widget from refreshing until the endUpdate() method is called. |
| content() | Gets the widget's content. |
| defaultOptions(rule) | Specifies the device-dependent default configuration options for this component. |
| dispose() | Disposes of all the resources allocated to the LoadPanel instance. |
| element() | Gets the root widget element. |
| endUpdate() | Refreshes the widget after a call of the beginUpdate() method. |
| getInstance(element) | Gets the instance of a widget found using its DOM node. |
| hide() | Hides the widget. |
| instance() | Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) | Detaches all event handlers from a single event. |
| off(eventName, eventHandler) | Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) | Subscribes to an event. |
| on(events) | Subscribes to events. |
| option() | Gets all widget options. |
| option(optionName) | Gets the value of a single option. |
| option(optionName, optionValue) | Updates the value of a single option. |
| option(options) | Updates the values of several options. |
| repaint() | Recalculates the widget's size and position without rerendering. |
| resetOption(optionName) | Resets an option to its default value. |
| show() | Shows the widget. |
| toggle(showing) | Shows or hides the widget depending on the argument. |
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Events
This section describes events fired by this widget.
| Name | Description |
|---|---|
| contentReady | Raised when the widget's content is ready. |
| disposing | Raised before the widget is disposed of. |
| hidden | Raised after the widget is hidden. |
| hiding | Raised before the widget is hidden. |
| initialized | Raised only once, after the widget is initialized. |
| optionChanged | Raised after a widget option is changed. |
| showing | Raised before the widget is displayed. |
| shown | Raised after the widget is displayed. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.