React CircularGauge Methods
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myCircularGauge").dxCircularGauge("dispose");
$("#myCircularGauge").remove();Angular
Use conditional rendering instead of this method:
<dx-circular-gauge ...
*ngIf="condition">
</dx-circular-gauge>Vue
Use conditional rendering instead of this method:
<template>
<DxCircularGauge ...
v-if="condition">
</DxCircularGauge>
</template>
<script>
import DxCircularGauge from 'devextreme-vue/circular-gauge';
export default {
components: {
DxCircularGauge
}
}
</script>React
Use conditional rendering instead of this method:
import React from 'react';
import CircularGauge from 'devextreme-react/circular-gauge';
function DxCircularGauge(props) {
if (!props.shouldRender) {
return null;
}
return (
<CircularGauge ... >
</CircularGauge>
);
}
class App extends React.Component {
render() {
return (
<DxCircularGauge shouldRender="condition" />
);
}
}
export default App;endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getInstance(element)
getInstance is a static method that the UI component 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()
Returns an object with the following fields.
- width
The width of the UI component in pixels. - height
The height of the UI component in pixels.
See Also
hideLoadingIndicator()
Although the loading indicator hides automatically once the UI component is ready, you can hide it from code at the required moment using this method.
See Also
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
render()
Normally, the UI component redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the UI component's container is resized. For this purpose, call the render() method.
See Also
subvalues()
See the subvalues property description for more information on gauge subvalues.
See Also
subvalues(subvalues)
Use this method to change gauge subvalues at runtime.
Value Indicators API Demo Subvalue Indicators Demo
See Also
value()
Gets the main value.
See the value property description for more information on the main gauge value.
See Also
value(value)
Updates the main value.
Use this method to change the main gauge value at runtime.
Value Indicators API Demo Subvalue Indicators Demo
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.