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

Disposes of all the resources allocated to the CircularGauge instance.

The following code disposes of an CircularGauge instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:

jQuery
JavaScript
$("#myCircularGauge").dxCircularGauge("dispose");
$("#myCircularGauge").remove();
Angular
HTML
<dx-circular-gauge #circularGaugeVar id="myCircularGauge"></dx-circular-gauge>
TypeScript
import { ..., ViewChild } from "@angular/core";
import { DxCircularGaugeComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("circularGaugeVar") circularGauge: DxCircularGaugeComponent;

    removeCircularGauge (e) {
        this.circularGauge.instance.dispose();
        document.getElementById("myCircularGauge").remove();
    }
}

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

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.

View Demo

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.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the CircularGauge instance found in an element with the myCircularGauge ID:

// Modular approach
import CircularGauge from 'devextreme/viz/circular_gauge';
...
let element = document.getElementById("myCircularGauge");
let instance = CircularGauge.getInstance(element) as CircularGauge;

// Non-modular approach
let element = document.getElementById("myCircularGauge");
let instance = DevExpress.viz.dxCircularGauge.getInstance(element);
See Also

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

instance()

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

Return Value:

Object

This widget's instance.

See Also

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

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

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

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

See Also

print()

Opens the browser's print window.

View Demo

See Also

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

showLoadingIndicator()

Shows the loading indicator.

See Also

subvalues()

Gets subvalues.

Return Value:

Array<Number>

The subvalues.

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

View Demo

See Also

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.

Value Indicators API Demo Subvalue Indicators Demo

See Also

svg()

Gets the widget's SVG markup.

Return Value:

String

The widget's SVG markup.

See Also

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

value(value)

Updates the main value.

Parameters:
value:

Number

A new value.

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

Value Indicators API Demo Subvalue Indicators Demo

See Also