React BarGauge Props
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
animation
To make your gauge "live", enable animation for it by setting the enabled option 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 option and specify how long the animation should run using the duration option.
jQuery
$(function() { $("#barGaugeContainer").dxBarGauge({ // ... animation: { easing: "linear", duration: 500 } }); });
Angular
<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
<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
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
@(Html.DevExtreme().BarGauge() @* ... *@ .Animation(a => a .Easing(VizAnimationEasing.Linear) .Duration(500) ) )
backgroundColor
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 option.
This option supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
- Paint server address
baseValue
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 option. In this instance, each bar will display the range from the baseValue to the corresponding value specified to this bar.
elementAttr
Specifies the attributes to be attached to the widget's root element.
jQuery
$(function(){ $("#barGaugeContainer").dxBarGauge({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-bar-gauge ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-bar-gauge>
import { DxBarGaugeModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxBarGaugeModule ], // ... })
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
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;
export
These features allow a user to export your widget into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the widget. 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
label
Each gauge bar is accompanied by a label that usually displays the value of the bar. Use the options 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 option or assign false straight to the label option.
See Also
loadingIndicator
When the widget is bound to a remote data source, it can display a loading indicator while data is loading.
To change the loading indicator's visibility, use the show option or the showLoadingIndicator() and hideLoadingIndicator() methods.
margin
jQuery
$(function() { $("#barGaugeContainer").dxBarGauge({ // ... margin: { top: 20, bottom: 20, left: 30, right: 30 } }); });
Angular
<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
<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
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 widget is disposed of.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onDrawn
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
onExported
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
onExporting
Name | Type | Description |
---|---|---|
cancel |
Allows you to prevent exporting. |
|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
fileName |
The name of the file to which the widget is about to be exported. |
|
format |
The resulting file format. One of PNG, PDF, JPEG, SVG and GIF. |
|
model |
The model data. Available only if you use Knockout. |
onFileSaving
A function that is executed before a file with exported widget is saved to the user's local storage.
Name | Type | Description |
---|---|---|
cancel |
Allows you to prevent file saving. |
|
component |
The widget's instance. |
|
data |
Exported data as a BLOB. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
fileName |
The name of the file to be saved. |
|
format |
The format of the file to be saved. |
onIncidentOccurred
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
|
target | any |
Information on the occurred incident. |
The widget 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 option 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 widget that produced the error or warning. - version
The used DevExtreme version.
onInitialized
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified option that includes all parent options. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
name |
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into. |
|
value | any |
The modified option's new value. |
onTooltipHidden
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
|
target |
Information on the bar being pressed or hovered over with the mouse pointer. Contains the index field. |
onTooltipShown
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
|
target |
Information on the bar being pressed or hovered over with the mouse pointer. Contains the index field. |
palette
This option accepts either the name of a predefined palette or an array of colors. The array can include the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
Use the VizPalette
enum to specify this option when the widget 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
.
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.
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.
Use the VizPaletteExtensionMode
enum to specify this option when the widget 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
redrawOnResize
Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.
When this option is set to true, the widget will be redrawn automatically in case the size of its parent window changes.
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 widget should behave when bar labels overlap: hide certain labels or leave them overlapped.
Use the BarGaugeResolveLabelOverlapping
enum to specify this option when the widget 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
When this option is set to true, the widget 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.
DevExpress.config({ rtlEnabled: true });
size
The widget occupies its container's entire area by default. Use the size object to specify the widget's size if it should be different from that of its container. Assign 0 to size object's height and width options to hide the widget.
jQuery
$(function() { $("#barGaugeContainer").dxBarGauge({ // ... size: { height: 300, width: 600 } }); });
Angular
<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
<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
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 widget's container using CSS:
jQuery
$(function() { $("#barGauge").dxBarGauge({ // ... }); });
#barGauge { width: 85%; height: 70%; }
Angular
<dx-bar-gauge ... id="barGauge"> </dx-bar-gauge>
#barGauge { width: 85%; height: 70%; }
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
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%; }
theme
A theme is a widget configuration that gives the widget a distinctive appearance. Use can use one of the predefined themes or create a custom one. Changing the option values in the widget's configuration object overrides the theme's corresponding values.
Use the VizTheme
enum to specify this option when the widget 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
The widget'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 option. Otherwise, set this option 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
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.
values
Apart from specifying an array of values when configuring the BarGauge widget, you can obtain this array at runtime using the values() method, and change it using the values(newValues) method.
If you have technical questions, please create a support ticket in the DevExpress Support Center.