Methods

This section describes methods that can be used to manipulate the 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 widget element.

Return Value:

Element (jQuery or HTML)

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.

Parameters:
fileName:

String

The name of the file to which the widget is about to be exported.

format:

String

The file's format.
Possible 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 instance of a widget found using its DOM node.

Parameters:
element:

DOM Node

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getSize()

Gets the current widget size.

Return Value: BaseWidgetOptions_size

The current widget size.

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()

Gets the 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 unlike the other methods. To call the instance() method, the following construction is used:.

<!--JavaScript -->$('#linearGaugeContainer').dxLinearGauge('instance')

Use the drop-down menu to change the type of the value indicator.


                                    

                                    

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Object

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

function

The event's handler.

Return Value:

Object

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

function

The event's handler.

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 events.

Parameters:
events:

Object

Events with their handlers: { "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 all widget 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 the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's 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)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

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)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

See Also
Show Example:
jQuery

In this example, the option(options) method is used to alter a set of options at once. To change the values of the tooltip.enabled and tooltip.arrowLength options, use the check box below.


                                    

                                    

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

Click the 'Change the container size' button to switch between two sizes of the widget container. The render() method is used to redraw the widget after the container size changes.


                                    

                                    

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.


                                    

                                    

subvalues()

Gets subvalues.

Return Value:

Array<Number>

The subvalues.

See the subvalues option description for more information on gauge subvalues.

View Demo

See Also
Show Example:
jQuery

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


                                    

                                    

subvalues(subvalues)

Updates subvalues.

Parameters:
subvalues:

Array<Number>

New subvalues.

Use this method to change gauge subvalues at runtime.

NOTE
It is necessary to set the subvalues option in order to use the subvalues(subvalues) method. Set this option to an empty array, in case you don't need to show subvalues initially.

View Demo

See Also
Show Example:
jQuery

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


                                    

                                    

svg()

Gets 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.


                                    

                                    

value()

Gets the main value.

Return Value:

Number

The main value.

See the value option description for more information on the main gauge value.

View Demo

See Also
Show Example:
jQuery

In this example, the value() method is used to obtain the main gauge value. Click the button under the gauge to increase this value by 1. When the gauge needle reaches the end of the scale, a click on this button will decrease the main gauge value.


                                    

                                    

value(value)

Updates the main value.

Parameters:
value:

Number

A new value.

Use this method to change the main gauge value at runtime.

View Demo

See Also
Show Example:
jQuery

In this example, the value(value) method is used to update the main gauge value. Click the button under the gauge to increase this value by 1. When the gauge needle reaches the end of the scale, a click on this button will decrease the main gauge value.