Configuration

This section describes the configuration options of the dxLoadIndicator widget.

height

Specifies the height of the widget.

Type:

|

|

Return Value:

|

The widget height.

Default Value: undefined

The option can hold a value of the following types.

number
The height of the widget in pixels
string
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 + "%"; })

hint

Specifies the text of the hint displayed for the widget.

Type:

String

Default Value: undefined

Show Example:

AngularJS

Knockout

jQuery

indicatorSrc

Specifies the path to an image used as the indicator.

Type:

String

Default Value: ""

Show Example:

AngularJS

Knockout

jQuery

onDisposing

A handler for the disposing event.

Type:

function

Function parameters:

e:

Object

Provides function parameters.

Object structure:

component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

onInitialized

A handler for the initialized event.

Type:

function

Function parameters:

e:

Object

Provides function parameters.

Object structure:

component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onOptionChanged

A handler for the optionChanged event.

Type:

function

Function parameters:

e:

Object

Provides function parameters.

Object structure:

component:

Object

Provides access to the widget instance.

name:

String

Specifies the name of the option whose value is changed.

fullName:

String

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.

value: any

Specifies a new value for the option.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

rtlEnabled

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

Type:

Boolean

Default Value: false

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.

visible

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

Type:

Boolean

Default Value: true

Show Example:

AngularJS

Knockout

jQuery

width

Specifies the width of the widget.

Type:

|

|

Return Value:

|

The widget width.

Default Value: undefined

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. For example, see the following code.
JavaScript
```
width: function () { 
    return baseWidth - 10 + "%";
}
```