JavaScript/jQuery BarGauge Methods
This section describes the methods that can be used in code to manipulate objects related to the BarGauge widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
dispose()
After calling this method, remove the DOM element associated with the widget:
$("#myBarGauge").dxBarGauge("dispose");
$("#myBarGauge").remove();Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-bar-gauge ...
*ngIf="condition">
</dx-bar-gauge>Vue
<template>
<DxBarGauge ...
v-if="condition">
</DxBarGauge>
</template>
<script>
import DxBarGauge from 'devextreme-vue/bar-gauge';
export default {
components: {
DxBarGauge
}
}
</script>React
import React from 'react';
import BarGauge from 'devextreme-react/bar-gauge';
function DxBarGauge(props) {
if (!props.shouldRender) {
return null;
}
return (
<BarGauge ... >
</BarGauge>
);
}
class App extends React.Component {
render() {
return (
<DxBarGauge shouldRender="condition" />
);
}
}
export default App;See Also
element()
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
exportTo(fileName, format)
See Also
- DevExpress.viz.exportWidgets(widgetInstances, options)
- export
- print()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
getInstance is a static method that the widget class supports. The following code demonstrates how to get the BarGauge instance found in an element with the myBarGauge ID:
// Modular approach
import BarGauge from "devextreme/viz/bar_gauge";
...
let element = document.getElementById("myBarGauge");
let instance = BarGauge.getInstance(element) as BarGauge;
// Non-modular approach
let element = document.getElementById("myBarGauge");
let instance = DevExpress.viz.dxBarGauge.getInstance(element);See Also
getSize()
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
hideLoadingIndicator()
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
- showLoadingIndicator()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
instance()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
print()
See Also
- exportTo(fileName, format)
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
render()
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
showLoadingIndicator()
See Also
- hideLoadingIndicator()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
svg()
See Also
- DevExpress.viz.getMarkup(widgetInstances)
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
values()
Gets all the values.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
values(newValues)
Updates all the values.
Use this method to change gauge values at runtime.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core