JavaScript/jQuery BarGauge Options

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

animation

Specifies animation properties.

Type: any

To make your gauge "live", enable animation for it by setting the enabled property of the animation object to true. In this instance, the gauge indicators will appear in motion. In addition, within the animation object, you can set an appropriate easing mode using the easing property and specify how long the animation should run using the duration property.

backgroundColor

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

Type:

String

Default Value: '#e0e0e0'

BarGauge displays values in the form of several circular bars each placed on a separate track. Since a bar indicates a value, it occupies only a segment of this track. The remaining segment is drawn in the color specified by the backgroundColor property.

This property supports the following colors:

barSpacing

Specifies a distance between bars in pixels.

Type:

Number

Default Value: 4

baseValue

Specifies a base value for bars.

Type:

Number

Default Value: 0
Cannot be used in themes.

By default, all bars start from the beginning of the gauge's scale. If you need to draw them starting from a specific scale value, assign the required value to the baseValue property. In this instance, each bar will display the range from the baseValue to the corresponding value specified to this bar.

centerTemplate

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

Type:

template

| undefined
Function parameters:
component:

BarGauge

The UI component's instance.

element:

SVGGElement

An empty SVGGElement that acts as a container for the template content.

Return Value:

String

|

SVGElement

|

jQuery

One of the following:

  • SVG markup as a string
  • An SVGElement
  • SVG markup wrapped in a jQuery element
Default Value: undefined

You need to render template content as an SVG element. The following code snippet shows how to specify a custom template for content in the BarGauge's center:

  • $(function(){
  • $("#barGaugeContainer").dxBarGauge({
  • // ...
  • centerTemplate: (gauge, container) => {
  • const rect = createRect(50, 50, 'transparent');
  • const text = createText(10, 200, 12, 'start', gauge.value());
  •  
  • container.appendChild(rect);
  • container.appendChild(text);
  • },
  • });
  • });
  •  
  • function createRect(width, height, fill) {
  • const rect = document.createElementNS('http://www.w3.org/2000/svg', 'rect');
  •  
  • rect.setAttribute('x', 0);
  • rect.setAttribute('y', 0);
  • rect.setAttribute('width', width);
  • rect.setAttribute('height', height);
  • rect.setAttribute('fill', fill);
  •  
  • return rect;
  • }
  •  
  • function createText(x, y, fontSize, textAnchor, content) {
  • const text = document.createElementNS('http://www.w3.org/2000/svg', 'text');
  •  
  • text.setAttribute('x', x);
  • text.setAttribute('y', y);
  • text.setAttribute('fill', '#000');
  • text.setAttribute('text-anchor', textAnchor);
  • text.setAttribute('font-size', fontSize);
  •  
  • text.textContent = content;
  •  
  • return text;
  • }

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false
Cannot be used in themes.

elementAttr

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

Type:

Object

Default Value: {}

  • $(function(){
  • $("#barGaugeContainer").dxBarGauge({
  • // ...
  • elementAttr: {
  • id: "elementId",
  • class: "class-name"
  • }
  • });
  • });

endValue

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

Type:

Number

Default Value: 100
Cannot be used in themes.

export

Configures the exporting and printing features.

Type: viz/core/base_widget:BaseWidgetExport

These features allow a user to export your UI component into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the UI component. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

See Also

geometry

Defines the shape of the gauge's arc.

Type:

Object

Specify the startAngle and endAngle properties of the geometry configuration object to customize the shape of the bar gauge's arc. This arc is drawn from the startAngle to the endAngle as illustrated by the following image.

GaugeGeometry ChartJS

label

Specifies the properties of the labels that accompany gauge bars.

Type:

Object

Each gauge bar is accompanied by a label that usually displays the value of the bar. Use the properties of the label object to customize the label's text, specify its format, font, and distance between the label and the bar.

To hide labels, use the label.visible property or assign false straight to the label property.

View Demo

See Also

legend

Configures the legend.

Type:

Legend

The legend is a component that helps a user identify bars. The legend contains several items, one per bar, each consisting of a colored marker and text showing the bar's argument.

DevExtreme BarGauge: Legend

You can make the legend visible by setting the legend.visible property to true.

loadingIndicator

Configures the loading indicator.

When the UI component is bound to a remote data source, it can display a loading indicator while data is loading.

DevExtreme Gauges - Loading indicator

To change the loading indicator's visibility, use the show property or the showLoadingIndicator() and hideLoadingIndicator() methods.

margin

Generates space around the UI component.

Type: viz/core/base_widget:BaseWidgetMargin

WidgetMargin DevExtreme ChartJS

index.js
  • $(function() {
  • $("#barGaugeContainer").dxBarGauge({
  • // ...
  • margin: {
  • top: 20,
  • bottom: 20,
  • left: 30,
  • right: 30
  • }
  • });
  • });

onDisposing

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

BarGauge

The UI component's instance.

Default Value: null

onDrawn

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

BarGauge

The UI component's instance.

Default Value: null
Cannot be used in themes.

onExported

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

BarGauge

The UI component's instance.

Default Value: null

onExporting

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
format

String

The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.

fileName

String

The name of the file to which the UI component is about to be exported.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

BarGauge

The UI component's instance.

Default Value: null

onFileSaving

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
format

String

The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'

fileName

String

The name of the file to be saved.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

data

BLOB

Exported data as a BLOB.

component

BarGauge

The UI component's instance.

cancel

Boolean

Allows you to prevent file saving.

Default Value: null

onIncidentOccurred

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
target any

Information on the occurred incident.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

BarGauge

The UI component's instance.

Default Value: null

The UI component notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

  • id
    The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
  • type
    The incident's type: "error" or "warning".
  • args
    The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the property that was not set properly.
  • text
    The text passed to the browser's console. Includes the args content, if there is any.
  • widget
    The name of the UI component that produced the error or warning.
  • version
    The used DevExtreme version.

onInitialized

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

BarGauge

The UI component's instance.

Default Value: null

See Also
  • Get a UI component Instance in jQuery

onOptionChanged

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.

previousValue any

The UI component's previous value.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

fullName

String

The path to the modified property that includes all parent properties.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

BarGauge

The UI component's instance.

Default Value: null

The following example shows how to subscribe to component property changes:

index.js
  • $(function() {
  • $("#barGaugeContainer").dxBarGauge({
  • // ...
  • onOptionChanged: function(e) {
  • if(e.name === "changedProperty") {
  • // handle the property change here
  • }
  • }
  • });
  • });

onTooltipHidden

A function that is executed when a tooltip becomes hidden.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

target

Object

Information on the bar being pressed or hovered over with the mouse pointer. Contains the index field.

Default Value: null
Cannot be used in themes.

onTooltipShown

A function that is executed when a tooltip appears.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

target

Object

Information on the bar being pressed or hovered over with the mouse pointer. Contains the index field.

Default Value: null
Cannot be used in themes.

palette

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

Type:

Array<String>

|

Palette

Default Value: 'Material'

This property accepts either the name of a predefined palette or an array of colors. The array can include the following colors:

View Demo

See Also

paletteExtensionMode

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

Default Value: 'blend'

The following variants are available:

  • "blend"
    Create a blend of two neighboring colors and insert it between these colors in the palette.

  • "alternate"
    Repeat the full set of palette colors, alternating their normal, lightened, and darkened shades in that order.

  • "extrapolate"
    Repeat the full set of palette colors, changing their shade gradually from dark to light.

View Demo

pathModified

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

Type:

Boolean

Default Value: false
Cannot be used in themes.

If you place the UI component on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the UI component elements may get mixed up or disappear. To solve this problem, set the pathModified property to true.

See Also

redrawOnResize

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

Type:

Boolean

Default Value: true
Cannot be used in themes.

When this property is set to true, the UI component will be redrawn automatically in case the size of its container changes.

relativeInnerRadius

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

Type:

Number

Default Value: 0.3

This property accepts values from the (0, 1) range.

resolveLabelOverlapping

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

Default Value: 'hide'

If a BarGauge displays several values close to each other, the corresponding labels may overlap. If you want to avoid overlapped labels, use the resolveLabelOverlapping property to specify how the gauge adjusts label position or visibility. The following values are available:

  • 'hide'
    The gauge hides labels with smaller values except for the label with the smallest value.

  • 'shift'
    The gauge shifts labels. If the component's size is not big enough to accommodate all labels, the BarGauge hides labels with the smallest values.

  • 'none'
    Labels overlap.

rtlEnabled

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

Type:

Boolean

Default Value: false
Cannot be used in themes.

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
  • DevExpress.config({
  • rtlEnabled: true
  • });
NOTE
In a right-to-left representation, SVG elements have the direction attribute with the rtl value. This might cause problems when rendering left-to-right texts. Use this property if you have only right-to-left texts.

size

Specifies the UI component's size in pixels.

Type: viz/core/base_widget:BaseWidgetSize
Default Value: {height: 300, width: 300}

You can specify a custom width and height for the component:

Fixed Relative
Assign values to the size object's height and width properties or specify a container for the component. Specify a container for the component. The component occupies the container area.
NOTE
The size object has priority over the container.
index.js
  • $(function() {
  • $("#barGaugeContainer").dxBarGauge({
  • // ...
  • size: {
  • height: 300,
  • width: 600
  • }
  • });
  • });

Alternatively, you can use CSS to style the UI component's container:

index.js
styles.css
  • $(function() {
  • $("#barGauge").dxBarGauge({
  • // ...
  • });
  • });
  • #barGauge {
  • width: 85%;
  • height: 70%;
  • }

startValue

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

Type:

Number

Default Value: 0
Cannot be used in themes.

theme

Sets the name of the theme the UI component uses.

Type:

Theme

Default Value: 'generic.light'

A theme is a UI component configuration that gives the UI component a distinctive appearance. You can use one of the predefined themes or create a custom one. Changing the property values in the UI component's configuration object overrides the theme's corresponding values.

title

Configures the UI component's title.

Type: viz/core/base_widget:BaseWidgetTitle

The UI component's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title property. Otherwise, set this property to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

tooltip

Configures tooltips.

Type:

Tooltip

A tooltip is a miniature rectangle displaying the value of a gauge's bar. A tooltip appears when the end-user hovers the cursor over a bar. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

View Demo

values

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

Type:

Array<Number>

Default Value: []
Raised Events: onOptionChanged
Cannot be used in themes.

Apart from specifying an array of values when configuring the BarGauge UI component, you can obtain this array at runtime using the values() method, and change it using the values(newValues) method.

View Demo