Configuration

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

See Also

animation

Specifies animation properties.

Type:

Object

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.

jQuery
index.js
$(function() {
    $("#barGaugeContainer").dxBarGauge({
        // ...
        animation: {
            easing: "linear",
            duration: 500
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-bar-gauge ... >
    <dxo-animation
        easing="linear"
        [duration]="500">
    </dxo-animation>
</dx-bar-gauge>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxBarGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxBarGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxBarGauge ... >
        <DxAnimation
            easing="linear"
            :duration="500"
        />
    </DxBarGauge>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxBarGauge, {
    DxAnimation
} from 'devextreme-vue/bar-gauge';

export default {
    components: {
        DxBarGauge,
        DxAnimation
    },
    // ...
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import BarGauge, {
    Animation 
} from 'devextreme-react/bar-gauge';

class App extends React.Component {
    render() {
        return (
            <BarGauge ... >
                <Animation
                    easing="linear"
                    duration={500}
                />
            </BarGauge>
        );
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().BarGauge()
    @* ... *@
    .Animation(a => a
        .Easing(VizAnimationEasing.Linear)
        .Duration(500)
    )
)

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.

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: {}

jQuery
$(function(){
    $("#barGaugeContainer").dxBarGauge({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-bar-gauge ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-bar-gauge>
import { DxBarGaugeModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxBarGaugeModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxBarGauge ...
        :element-attr="barGaugeAttributes">
    </DxBarGauge>
</template>

<script>
import DxBarGauge from 'devextreme-vue/bar-gauge';

export default {
    components: {
        DxBarGauge
    },
    data() {
        return {
            barGaugeAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import BarGauge from 'devextreme-react/bar-gauge';

class App extends React.Component {
    barGaugeAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <BarGauge ...
                elementAttr={this.barGaugeAttributes}>
            </BarGauge>
        );
    }
}
export default App;

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:

Object

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:

Object

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.

Type:

Object

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:

Object

WidgetMargin DevExtreme ChartJS

jQuery
index.js
$(function() {
    $("#barGaugeContainer").dxBarGauge({
        // ...
        margin: {
            top: 20,
            bottom: 20,
            left: 30,
            right: 30
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-bar-gauge ... >
    <dxo-margin
        [top]="20"
        [bottom]="20"
        [left]="30"
        [right]="30">
    </dxo-margin>
</dx-bar-gauge>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxBarGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxBarGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxBarGauge ... >
        <DxMargin
            :top="20"
            :bottom="20"
            :left="30"
            :right="30"
        />
    </DxBarGauge>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxBarGauge, {
    DxMargin 
} from 'devextreme-vue/bar-gauge';

export default {
    components: {
        DxBarGauge,
        DxMargin
    },
    // ...
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import BarGauge, {
    Margin 
} from 'devextreme-react/bar-gauge';

class App extends React.Component {
    render() {
        return (
            <BarGauge ... >
                <Margin
                    top={20}
                    bottom={20}
                    left={30}
                    right={30}
                />
            </BarGauge>
        );
    }
}
export default App;

onDisposing

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement or jQuery

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

model

Object

Model data. Available only if you use Knockout.

Default Value: null

onDrawn

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement or jQuery

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

model

Object

The model data. Available only if you use Knockout.

Default Value: null
Cannot be used in themes.

onExported

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement or jQuery

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

model

Object

The model data. Available only if you use Knockout.

Default Value: null

onExporting

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to prevent exporting.

component

BarGauge

The UI component's instance.

element

HTMLElement or jQuery

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

fileName

String

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

format

String

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

model

Object

The model data. Available only if you use Knockout.

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:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to prevent file saving.

component

BarGauge

The UI component's instance.

data

BLOB

Exported data as a BLOB.

element

HTMLElement or jQuery

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

fileName

String

The name of the file to be saved.

format

String

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

Default Value: null

onIncidentOccurred

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement or jQuery

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

model

Object

The model data. Available only if you use Knockout.

target any

Information on the occurred incident.

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:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement or jQuery

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

Default Value: null

See Also

onOptionChanged

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

fullName

String

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

name

String

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

value any

The modified property's new value.

element

HTMLElement or jQuery

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

model

Object

Model data. Available only if you use Knockout.

Default Value: null

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

jQuery
index.js
$(function() {
    $("#barGaugeContainer").dxBarGauge({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-bar-gauge ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-bar-gauge>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxBarGaugeModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxBarGaugeModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  
Vue
App.vue
<template> 
    <DxBarGauge ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script> 
import 'devextreme/dist/css/dx.common.css'; 
import 'devextreme/dist/css/dx.light.css'; 
import DxBarGauge from 'devextreme-vue/bar-gauge'; 

export default { 
    components: { 
        DxBarGauge
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 
React
App.js
import React from 'react'; 
import 'devextreme/dist/css/dx.common.css'; 
import 'devextreme/dist/css/dx.light.css'; 

import BarGauge from 'devextreme-react/bar-gauge'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <BarGauge ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

onTooltipHidden

A function that is executed when a tooltip becomes hidden.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement or jQuery

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

model

Object

The model data. Available only if you use Knockout.

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:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

BarGauge

The UI component's instance.

element

HTMLElement or jQuery

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

model

Object

The model data. Available only if you use Knockout.

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>

|

String

Default Value: 'Material'
Accepted Values: 'Bright' | 'Harmony Light' | 'Ocean' | 'Pastel' | 'Soft' | 'Soft Pastel' | 'Vintage' | 'Violet' | 'Carmine' | 'Dark Moon' | 'Dark Violet' | 'Green Mist' | 'Soft Blue' | 'Material' | 'Office'

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

Use the VizPalette enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Default, SoftPastel, HarmonyLight, Pastel, Bright, Soft, Ocean, Vintage, Violet, Carmine, DarkMoon, SoftBlue, DarkViolet, and GreenMist.

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.

Type:

String

Default Value: 'blend'
Accepted Values: 'alternate' | 'blend' | 'extrapolate'

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

Use the VizPaletteExtensionMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Blend, Alternate, and Extrapolate.

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 parent browser window 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 parent window changes.

NOTE
To redraw the UI component after the size of its container has changed, call the render() method of the UI component's instance.

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: hide certain labels or leave them overlapped.

Type:

String

Default Value: 'hide'
Accepted Values: 'hide' | 'none'

Use the BarGaugeResolveLabelOverlapping enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Hide and None.

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:

Object

Default Value: undefined

The UI component occupies its container's entire area by default. Use the size object to specify the UI component's size if it should be different from that of its container. Assign 0 to size object's height and width properties to hide the UI component.

jQuery
index.js
$(function() {
    $("#barGaugeContainer").dxBarGauge({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-bar-gauge ... >
    <dxo-size
        [height]="300"
        [width]="600">
    </dxo-size>
</dx-bar-gauge>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxBarGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxBarGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxBarGauge ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxBarGauge>
</template>

<script>

import DxBarGauge, {
    DxSize
} from 'devextreme-vue/bar-gauge';

export default {
    components: {
        DxBarGauge,
        DxSize
    },
    // ...
}
</script>
React
App.js
import React from 'react';

import BarGauge, {
    Size
} from 'devextreme-react/bar-gauge';

class App extends React.Component {
    render() {
        return (
            <BarGauge ... >
                <Size
                    height={300}
                    width={600}
                />
            </BarGauge>
        );
    }
}
export default App;

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

jQuery
index.js
styles.css
$(function() {
    $("#barGauge").dxBarGauge({
        // ...
    });
});
#barGauge {
    width: 85%;
    height: 70%;
}
Angular
app.component.html
app.styles.css
<dx-bar-gauge ...
    id="barGauge">
</dx-bar-gauge>
#barGauge {
    width: 85%;
    height: 70%;
}
Vue
App.vue
<template>
    <DxBarGauge ...
        id="barGauge">
    </DxBarGauge>
</template>

<script>
import DxBarGauge from 'devextreme-vue/bar-gauge';

export default {
    components: {
        DxBarGauge
    },
    // ...
}
</script>

<style>
#barGauge {
    width: 85%;
    height: 70%;
}
</style>
React
App.js
styles.css
import React from 'react';

import BarGauge from 'devextreme-react/bar-gauge';

class App extends React.Component {
    render() {
        return (
            <BarGauge ...
                id="barGauge">
            </BarGauge>
        );
    }
}
export default App;
#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:

String

Default Value: 'generic.light'
Accepted Values: 'generic.dark' | 'generic.light' | 'generic.contrast' | 'generic.carmine' | 'generic.darkmoon' | 'generic.darkviolet' | 'generic.greenmist' | 'generic.softblue' | 'material.blue.light' | 'material.lime.light' | 'material.orange.light' | 'material.purple.light' | 'material.teal.light'

A theme is a UI component configuration that gives the UI component a distinctive appearance. Use 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.

Use the VizTheme enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, GenericCarmine, GenericDarkMoon, GenericSoftBlue, GenericDarkViolet, GenericGreenMist, MaterialBlueLight, MaterialLimeLight, MaterialOrangeLight, MaterialPurpleLight, MaterialTealLight.

title

Configures the UI component's title.

Type:

Object

|

String

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:

Object

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: optionChanged
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