Methods

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

beginUpdate()

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

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

dispose()

Removes the widget from the DOM.

element()

Gets the root element of the widget.

Return Value:

Element (jQuery or HTML)

The widget's root element. An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the widget into a document with a specified name and format.

Parameters:
fileName:

String

The name of a destination file.

format:

String

A required format.
Accepted Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'

NOTE
IE9 and Safari on Mac OS do not implement an API for saving files. Therefore, exporting in these browsers requires setting up a server-side proxy. For details, refer to the export | proxyUrl option description.
See Also

getInstance(element)

Gets the widget's instance using a DOM element.

Parameters:
element:

DOM Node

|

jQuery

An element containing the widget.

Return Value:

Object

The widget's instance.

getSize()

Gets the current size of the widget.

Return Value: BaseWidgetOptions_size

The current size of the widget.

Returns an object with the following fields.

  • width
    The width of the widget in pixels.
  • height
    The height of the widget in pixels.
See Also

hideLoadingIndicator()

Hides the loading indicator.

Although the loading indicator hides automatically once the widget is ready, you can hide it from code at the required moment using this method.

See Also
Show Example:
jQuery

In this example, data is loaded with five seconds delay. You can show/hide the loading indicator using the buttons under the widget. Note that the loading indicator can be displayed or concealed manually at any time no matter whether the data is loaded or not.


                                    

                                    

instance()

Returns this widget's instance. Use it to access other methods of the widget.

Return Value:

Object

This widget's instance.

See Also
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.

See Also

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.

See Also

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.

Use this method to subscribe to one of the events listed in the Events section.

See Also

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.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets the widget's options.

Return Value:

Object

The widget's options.

See Also
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 a specific option value.

Parameters:
optionName:

String

The option name or the full path to the option.

Return Value: any

This option value.

See Also
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)

Assigns a new value to a specific option.

Parameters:
optionName:

String

The option name or the full path to the option.

optionValue: any

A new value for this option.

See Also
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.

Parameters:
options:

Object

The options along with their new values.

See Also
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.


                                    

                                    

print()

Opens the browser's print window.

render()

Redraws the widget.

Normally, the widget redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the widget's container is resized. For this purpose, call the render() method.

See Also
Show Example:
jQuery

showLoadingIndicator()

Shows the loading indicator.

Show Example:
jQuery

In this example, the loading indicator is displayed until data is ready (5 seconds in this example). You can show and hide the loading indicator using the corresponding buttons below.


                                    

                                    

svg()

Returns the widget's SVG markup.

Return Value:

String

The widget's SVG markup.

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<Number>

An array of gauge values.

View Demo

See Also
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<Number>

A set of new values.

Use this method to change gauge values at runtime.

View Demo

See Also
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.