Methods

This section describes the methods that can be used in code to manipulate objects related to the dxLinearGauge widget.

beginUpdate()

Prevents the widget from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the widget. After the beginUpdate method is called, the widget does not raise events, and does not rerender itself until the endUpdate method is called. Using these methods prevents excessive widget updates when changing multiple widget settings at once.

endUpdate()

Enables the widget to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the widget. After the beginUpdate method is called, the widget does not raise events, and does not rerender itself until the endUpdate method is called. Using these methods prevents excessive widget updates when changing multiple widget settings at once.

instance()

Returns an instance of the widget.

Return Value: Object

An instance of the widget.

Use this method to access the widget.

option()

Returns the object representing the configuration options of the widget.

Return Value: Object

The object representing the configuration options of the widget.

Use the fields of the returned object to configure the widget.

option(optionName)

Gets the value of the specified configuration option of the widget.

Parameters:
optionName: String

The name of the option to get.

Return Value: any

The value of the specified option.

To get the value of a configuration option, specify the path to the field representing this option in the configuration object. For example, pass the "commonAxisSettings.visible" value as the optionName parameter to get the value of the commonAxisSettings | visible option of the dxChart widget.

option(optionName, optionValue)

Sets a value to the specified configuration option of the widget.

Parameters:
optionName: String

The name of the required option.

optionValue: any

The value to be assigned to the required option.

To set a value to the configuration option, specify the path to the field representing this option in the configuration object. For example, to set the commonAxisSettings | visible option of the dxChart widget to true, pass the "commonAxisSettings.visible" value as the optionName parameter and the "true" value as the optionValue parameter.

option(options)

Sets one or more options of the widget.

Parameters:
options: Object

An object containing required configuration options.

To set one or more widget options, pass the object containing these options as the options parameter.

The following code sample illustrates the example of the object to be passed as this parameter.

JavaScript
var newOptionsObject = {
    commonAxisSettings: {
        visible: true,
        grid: {
            visible: true
        }
    }
}

This method is useful if you need to configure several widget options at once.