JavaScript/jQuery LoadIndicator API
The LoadIndicator is a UI element notifying the viewer that a process is in progress.
Options
This section describes the configuration properties of the LoadIndicator UI component.
Name | Description |
---|---|
elementAttr | Specifies the global attributes to be attached to the UI component's container element. |
height | Specifies the UI component's height. |
hint | Specifies text for a hint that appears when a user pauses on the UI component. |
indicatorSrc | Specifies the path to an image used as the indicator. |
onContentReady | A function that is executed when the UI component's content is ready and each time the content is changed. |
onDisposing | A function that is executed before the UI component is disposed of. |
onInitialized | A function used in JavaScript frameworks to save the UI component instance. |
onOptionChanged | A function that is executed after a UI component property is changed. |
rtlEnabled | Switches the UI component to a right-to-left representation. |
visible | Specifies whether the UI component is visible. |
width | Specifies the UI component's width. |
Methods
This section describes members used to manipulate the UI component.
Name | Description |
---|---|
beginUpdate() | Prevents the UI component from refreshing until the endUpdate() method is called. |
defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
dispose() | Disposes of all the resources allocated to the LoadIndicator instance. |
element() | Gets the root UI component element. |
endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
getInstance(element) | Gets the instance of a UI component found using its DOM node. |
instance() | Gets the UI component's instance. Use it to access other methods of the UI component. |
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 UI component properties. |
option(optionName) | Gets the value of a single property. |
option(optionName, optionValue) | Updates the value of a single property. |
option(options) | Updates the values of several properties. |
repaint() | Repaints the UI component without reloading data. Call it to update the UI component's markup. |
resetOption(optionName) | Resets a property to its default value. |
Events
This section describes events fired by this UI component.
Name | Description |
---|---|
contentReady | Raised when the UI component's content is ready. |
disposing | Raised before the UI component is disposed of. |
initialized | Raised only once, after the UI component is initialized. |
optionChanged | Raised after a UI component property is changed. |