Vue CircularGauge API

The CircularGauge is a UI component that indicates values on a circular numeric scale.

import DxCircularGauge from "devextreme-vue/circular-gauge"

Type: DxCircularGaugeTypes.default

Props

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

Name	Description
animation	Specifies animation properties.
containerBackgroundColor	Specifies the color of the parent page element.
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.
export	Configures the exporting and printing features.
geometry	Specifies the properties required to set the geometry of the CircularGauge UI component.
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.
pathModified	Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path.
rangeContainer	Specifies gauge range container properties.
redrawOnResize	Specifies whether to redraw the UI component when the size of the parent browser window changes or a mobile device rotates.
rtlEnabled	Switches the UI component to a right-to-left representation.
scale	Specifies a gauge's scale properties.
size	Specifies the UI component's size in pixels.
subvalueIndicator	Specifies the appearance properties of subvalue indicators.
subvalues	Specifies a set of subvalues to be designated by the subvalue indicators.
theme	Sets the name of the theme the UI component uses.
title	Configures the UI component's title.
tooltip	Configures tooltips.
value	Specifies the main value on a gauge.
valueIndicator	Specifies the appearance properties of the value indicator.

Methods

This section describes methods that can be used to manipulate the UI component.

Name	Description
beginUpdate()	Prevents the UI component from refreshing until the endUpdate() method is called.
dispose()	Disposes of all the resources allocated to the CircularGauge 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.
subvalues()	Gets subvalues.
subvalues(subvalues)	Updates subvalues.
svg()	Gets the UI component's SVG markup.
value()	Gets the main value.
value(value)	Updates the main value.

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.

Indicator Types

This section lists objects that define properties used to configure value and subvalue indicators of specific types.

Name	Description
RangeBar	An object that defines a gauge indicator of the rangeBar type.
RectangleNeedle	An object that defines a gauge indicator of the rectangleNeedle type.
TextCloud	An object that defines a gauge indicator of the textCloud type.
TriangleMarker	An object that defines a gauge indicator of the triangleMarker type.
TriangleNeedle	An object that defines a gauge indicator of the triangleNeedle type.
TwoColorNeedle	An object that defines a gauge indicator of the twoColorNeedle type.

View Demo

Vue CircularGauge API

See Also

Props

See Also

Methods

See Also

Events

See Also

Indicator Types