LoadIndicator

The LoadIndicator is a UI element notifying the viewer that a process is in progress.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
LoadIndicator interactive configuration
Copy Code
Copy to Codepen
$("#loadindicator").dxLoadIndicator({
});

                    

You can create the widget using one of the following approaches.

  • jQuery
    Use the dxLoadIndicator jQuery plug-in.

    HTML
    <div id="loadIndicator"></div>
    JavaScript
    $("#loadIndicator").dxLoadIndicator({
        visible: true
    });
  • Knockout
    Add a div element and apply the dxLoadIndicator binding to this element.

    HTML
    <div data-bind="dxLoadIndicator: {
        visible: true
    }"></div>
  • AngularJS
    Add a div element and apply the dx-load-indicator directive to this element.

    HTML
    <div dx-load-indicator="{
        visible: true
    }"></div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

You can find detailed information on the principles of working with the widget in the dxLoadIndicator section of the Individual Widgets article.

View Demo

Configuration

This section describes the configuration options of the LoadIndicator widget.

Name Description
height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

indicatorSrc

Specifies the path to an image used as the indicator.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onOptionChanged

A handler for the optionChanged event.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

visible

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

width

Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

repaint()

Redraws the widget.

Events

This section describes events fired by this widget.

Name Description
disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

optionChanged

Fires after an option of the component is changed.