Methods

This section describes the methods that can be used in code to manipulate objects related to the CircularGauge 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.

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

hideLoadingIndicator()

Conceals the loading indicator.

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

If you need to show the loading indicator, invoke the showLoadingIndicator() method.

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.

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.

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 at one method call. Available events are listed in the Events section.

See Also

option()

Returns the configuration options of this component.

Return Value:

Object

An object representing the configuration options of this component.

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.

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.

option(options)

Sets one or more options of this component.

Parameters:
options:

Object

An object containing the required configuration options.

print()

Opens the browser's print window.

See Also

render()

Redraws the widget.

Normally, the widget will redraw itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, e.g., after the widget container is resized. For this purpose, call the render() method.

showLoadingIndicator()

Displays the loading indicator.

This method shows the loading indicator. To hide it, call the hideLoadingIndicator() method.

subvalues()

Returns an array of gauge subvalues.

Return Value:

Array

An array of gauge subvalues.

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

View Demo

subvalues(subvalues)

Updates gauge subvalues.

Parameters:
subvalues:

Array

A new array of gauge 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

svg()

Returns the widget's SVG markup.

Return Value:

String

The widget's SVG markup.

value()

Returns the main gauge value.

Return Value:

Number

The main gauge value.

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

View Demo

value(value)

Updates a gauge value.

Parameters:
value:

Number

A new gauge value.

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

View Demo