Configuration
An object that defines configuration options for the dxLoadPanel widget.
closeOnOutsideClick
A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlapping window.
Holds the jQuery event caused the widget closing.
The required option value.
The function passed to this option enables you to specify a custom condition for widget closing. For instance, you can prevent closing if a user clicks a certain element.
var lookupOptions = {
. . .,
closeOnOutsideClick: function(e){
return e.target !== $("#myElement").get()[0];
}
}contentReadyAction
Use the onContentReady option instead.
deferRendering
Specifies whether widget content is rendered when the widget is shown or when rendering the widget.
If this option is set to true, widget content is rendered when showing the widget. Otherwise, widget content is rendered when rendering the widget.
delay
The delay in milliseconds after which the load panel is displayed.
height
The height of the widget.
The option can hold a value of the following types.
number
The height of the widget in pixelsstring
A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")function
A function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })
hoverStateEnabled
A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.
indicatorSrc
A URL pointing to an image to be used as a load indicator.
message
The text displayed in the load panel.
onDisposing
A handler for the disposing event.
onHidden
A handler for the hidden event.
Assign a function to perform a custom action after the widget is hidden.
onHiding
A handler for the hiding event.
Provides function parameters.
Provides access to the widget instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
Indicates whether to cancel hiding the overlay.
Assign a function to perform a custom action before hiding the widget.
onInitialized
A handler for the initialized event.
Assign a function to perform a custom action when the widget is initialized.
onOptionChanged
A handler for the optionChanged event.
Provides function parameters.
Provides access to the widget instance.
Specifies the name of the option whose value is changed.
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
Specifies a new value for the option.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
Assign a function to perform a custom action after an option of the component is changed.
onShowing
A handler for the showing event.
Assign a function to perform a custom action before showing the widget.
onShown
A handler for the shown event.
Assign a function to perform a custom action after the widget is shown.
position
An object defining widget positioning options.
rtlEnabled
Specifies whether or not the current component supports a right-to-left representation.
If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.
shading
A Boolean value specifying whether or not the main screen is inactive while 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.
width
The width of the widget.
The option can hold a value of the following types.
- numeric - the widget width in pixels
- string - a CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit")
- function - the function returning the widget width (e.g., width:function(){ return baseWidth - 10 + "%"; })