JavaScript/jQuery BarGauge API

The BarGauge UI component contains several circular bars that each indicates a single value.

import BarGauge from "devextreme/viz/bar_gauge"

View Demo Read Guides

See Also
jQuery
Angular
Vue
React
jQuery
Angular
Vue
React

Options

An object that defines configuration properties for the BarGauge UI component.

Name Description
animation

Specifies animation properties.
backgroundColor

Specifies a color for the remaining segment of the bar's track.
barSpacing

Specifies a distance between bars in pixels.
baseValue

Specifies a base value for bars.
centerComponent

An alias for the centerTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
centerRender

An alias for the centerTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
centerTemplate

Specifies a custom template for content in the component's center.
disabled

Specifies whether the UI component responds to user interaction.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
endValue

Specifies an end value for the gauge's invisible scale.
export

Configures the exporting and printing features.
geometry

Defines the shape of the gauge's arc.
label

Specifies the properties of the labels that accompany gauge bars.
legend

Configures the legend.
loadingIndicator

Configures the loading indicator.
margin

Generates space around the UI component.
onDisposing

A function that is executed before the UI component is disposed of.
onDrawn

A function that is executed when the UI component's rendering has finished.
onExported

A function that is executed after the UI component is exported.
onExporting

A function that is executed before the UI component is exported.
onFileSaving

A function that is executed before a file with exported UI component is saved to the user's local storage.
onIncidentOccurred

A function that is executed when an error or warning occurs.
onInitialized

A function used in JavaScript frameworks to save the UI component instance.
onOptionChanged

A function that is executed after a UI component property is changed.
onTooltipHidden

A function that is executed when a tooltip becomes hidden.
onTooltipShown

A function that is executed when a tooltip appears.
palette

Sets the palette to be used for colorizing bars in the gauge.
paletteExtensionMode

Specifies what to do with colors in the palette when their number is less than the number of bars in the gauge.
pathModified

Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path.
redrawOnResize

Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates.
relativeInnerRadius

Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar.
resolveLabelOverlapping

Specifies how the UI component should behave when bar labels overlap.
rtlEnabled

Switches the UI component to a right-to-left representation.
size

Specifies the UI component's size in pixels.
startValue

Specifies a start value for the gauge's invisible scale.
theme

Sets the name of the theme the UI component uses.
title

Configures the UI component's title.
tooltip

Configures tooltips.
values

Specifies the array of values to be indicated on a bar gauge.

See Also
jQuery
Angular
Vue
React

Methods

This section describes the methods that can be used in code to manipulate objects related to the BarGauge UI component.

Name Description
beginUpdate()

Postpones rendering that can negatively affect performance until the endUpdate() method is called.
dispose()

Disposes of all the resources allocated to the BarGauge instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
exportTo(fileName, format)

Exports the UI component.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
getSize()

Gets the current UI component size.
hideLoadingIndicator()

Hides the loading indicator.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
print()

Opens the browser's print window.
render()

Redraws the UI component.
resetOption(optionName)

Resets a property to its default value.
showLoadingIndicator()

Shows the loading indicator.
svg()

Gets the UI component's SVG markup.
values()

Gets all the values.
values(newValues)

Updates all the values.

See Also
jQuery
Angular
Vue
React

Events

This section describes events fired by this UI component.

Name Description
disposing

Raised before the UI component is disposed of.
drawn

Raised when the UI component's rendering has finished.
exported

Raised after the UI component is exported.
exporting

Raised before the UI component is exported.
fileSaving

Raised before a file with exported UI component is saved to the user's local storage.
incidentOccurred

Raised when an error or warning occurs.
initialized

Raised only once, after the UI component is initialized.
optionChanged

Raised after a UI component property is changed.
tooltipHidden

Raised when a tooltip becomes hidden.
tooltipShown

Raised when a tooltip appears.

See Also
jQuery
Angular
Vue
React

Interfaces

This section describes interfaces that the BarGauge component uses.

Types

Name Description
DisposingEvent

The type of the disposing event handler's argument.
DrawnEvent

The type of the drawn event handler's argument.
ExportedEvent

The type of the exported event handler's argument.
ExportingEvent

The type of the exporting event handler's argument.
FileSavingEvent

The type of the fileSaving event handler's argument.
GaugeIndicatorType

Specifies the gauge indicator type.
IncidentOccurredEvent

The type of the incidentOccurred event handler's argument.
InitializedEvent

The type of the initialized event handler's argument.
Legend

Configures the legend.
LoadingIndicator

Configures the loading indicator.
OptionChangedEvent

The type of the optionChanged event handler's argument.
Tooltip

Configures tooltips.
TooltipHiddenEvent

The type of the tooltipHidden event handler's argument.
TooltipShownEvent

The type of the tooltipShown event handler's argument.