Methods

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

beginUpdate()

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

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you are changing multiple component settings at once.

element()

Returns the root HTML element of the widget.

Return Value: jQuery
The root element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you change multiple component setting at once.

hideLoadingIndicator()

Conceals the loading indicator.

Although the loading indicator hides automatically when a gauge is ready, you can hide it from code at the required time using the hideLoadingIndicator() method.

To show the loading indicator, invoke the showLoadingIndicator() method.

Show Example:
jQuery

In this example, the gauge options are assigned five seconds after the example is loaded. You can show/hide the loading indicator using the buttons under the gauge. Note that the loading indicator can be displayed or concealed manually at any time regardless of whether the gauge is ready or not.


                                    

                                    

instance()

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

Show Example:
jQuery

In the following example, the instance() method is used to get access to the gauge options. This method is called not like the other methods. To call the instance() method, the following construction is used.

<!--JavaScript -->$('#circularGaugeContainer').dxCircularGauge('instance')

Use the drop-down menu to change the gauge's palette.


                                    

                                    

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
Return Value: Object
The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
eventHandler: function
The handler to be detached from the specified event.
Return Value: Object
The object for which this method is called.

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName: String
The name of the event to be subscribed.
eventHandler: function
An event handler for the specified event.
Return Value: Object
The object for which this method is called.

on(events)

Subscribes to the specified events.

Parameters:
events: Object
An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}
Return Value: Object
The object for which this method is called.

option()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

Show Example:
jQuery

In this example, the option() method is used to obtain the value of the tooltip | enabled option and display it under the gauge. To change this value, use the check box below.


                                    

                                    

option(optionName)

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

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

Show Example:
jQuery

In this example, the option(optionName) method is used to obtain the value of the tooltip | enabled option and display it under the gauge. To change this value, use the check box below.


                                    

                                    

option(optionName, optionValue)

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

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

Show Example:
jQuery

In this example, the option(optionName, optionValue) method is used to set the value of the tooltip | enabled option at runtime. To change this value, use the check box below.


                                    

                                    

option(options)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

Show Example:
jQuery

In this example, the option(options) method is used to set the value of both the tooltip | enabled and animation | enabled options at runtime. To change this value, use the check box below. Hover over a bar to see whether any tooltips appear or not. In addition, change the set of indicated values using the radio buttons to check whether animation performs.


                                    

                                    

render()

Redraws the widget.

By default, the dxBarGauge widget rerenders when the size of the parent window is changed. But there may be situations when a gauge should be rerendered manually, i.e., when the size of the gauge container is changed. To rerender a widget, use the render() method.

Show Example:
jQuery

Click the 'Change the container size' button to switch between two sizes of the gauge container. You can set the size either to 400x400 or 300x300 pixels. The render() method is used to redraw the gauge after the container size changes.


                                    

                                    

showLoadingIndicator()

Displays the loading indicator.

The loading indicator does not appear automatically. In order to display it, the showLoadingIndicator() method should be invoked.

To hide the loading indicator from code, use the hideLoadingIndicator() method.

Show Example:
jQuery

In this example, the gauge options are assigned five seconds after the example is loaded. You can show/hide the loading indicator using the buttons under the gauge. Note that the loading indicator can be displayed or concealed manually at any time regardless of whether the gauge is ready or not.


                                    

                                    

svg()

Returns the widget's SVG markup.

Return Value: String
The widget's SVG markup.
NOTE
This method does not support Internet Explorer 8.
Show Example:
jQuery

Click the Get SVG below the gauge, and the SVG copy of this gauge will appear.


                                    

                                    

values()

Returns an array of gauge values.

Return Value: Array
An array of gauge values.
Show Example:
jQuery

In this example, the values() method is used to obtain a set of gauge values. Initially, all the values are set to 0. Click the button under the gauge to increase one of these values by 1. The value to be increased will be chosen randomly.


                                    

                                    

values(newValues)

Updates the values displayed by a gauge.

Parameters:
values: Array
A set of new values.

Use this method to change gauge values at runtime.

View Demo

Show Example:
jQuery

In this example, the values(newValues) method is used to update gauge values. Initially, all the values are set to 0. Click the button under the gauge to increase one of these values by 1. The value to be increased will be chosen randomly.