An object that defines configuration options for the dxBarGauge widget.
Specifies animation options.
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 bars 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.
Specifies a color for the remaining segment of the bar's track.
dxBarGauge 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.
Specifies a distance between bars in pixels.
Specifies a base value for bars.
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.
Use the onDrawn option instead.
Specifies an end value for the gauge's invisible scale.
Defines the shape of the gauge's arc.
Specify the startAngle and endAngle options 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.
Use the onIncidentOccurred option instead.
Specifies the options of the labels that accompany gauge bars.
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, precision, 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.
Specifies the appearance of the loading indicator.
Usually, the widget is quick enough to draw itself instantly for a viewer. There are, however, cases, when the widget takes longer to be drawn. In such cases, displaying the loading indicator is recommended. To display the loading indicator, assign true to the show field of the loadingIndicator object. Use other fields of this object to change the appearance of the loading indicator.
A handler for the disposing event.
Provides function parameters.
A handler for the drawn event.
If you need to perform specific actions when the widget has finished drawing itself, assign a callback function to the drawn option. When implementing this function, you can access the drawn widget using the function's parameter.
A handler for the incidentOccurred event.
When an error or warning appears, the widget notifies you by passing a message to the browser console. This message contains the ID of the incident, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found. However, you can handle errors and warnings in the way that you require. To do this, implement a callback function performing the required actions and assign it to the onIncidentOccurred option. Within this function, you can use information about the incident that occurred. This information can be accessed from the target field of the object passed to the callback function as a parameter. This information includes the following.
Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
Contains the type of the incident. This field equals 'error' for errors or 'warning' for warnings.
Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
Contains the text passed to the browser console. This text includes the content of the args field, if there are any.
Contains the name of the widget that produced the error or warning.
Contains the currently used version of the ChartJS library.
A handler for the initialized event.
Assign a function to perform a custom action when the widget is initialized.
A handler for the optionChanged event.
Provides function parameters.
Provides access to the widget instance.
Specifies the name of the option whose value is changed.
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
Specifies a new value for the option.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
Assign a function to perform a custom action after an option of the component is changed.
A handler for the tooltipHidden event.
The bar's tooltip becomes invisible when a user hovers the mouse cursor over another bar or moves it outside the widget.
When a tooltip is made hidden, you can perform specific actions by handling the tooltipHidden event. To do this, implement a handling function and assign it to this option. When implementing this function, use the object passed to it as its parameter. This object will provide you with the widget instance, its container and the object describing the hovered bar. You can use its index field to get the index of the hovered bar.
A handler for the tooltipShown event.
The tooltip appears when a user hovers the mouse cursor over a bar.
When a tooltip appears, you can perform specific actions by handling the tooltipShown event. To do this, implement a handling function and assign it to this option. When implementing this function, use the object passed to it as its parameter. This object will provide you with the widget instance, its container and the object describing the hovered bar. You can use its index field to get the index of the hovered bar.
Sets the name of the palette or an array of colors to be used for coloring the gauge range container.
Use this option to set a predefined or custom palette. The colors listed in the specified palette will be used to draw bars. If the number of the bars is greater than the number of colors in the palette, palette colors are repeated, but slightly modified.
In addition, you can declare an array of colors and use it as a palette. Refer to the Palettes topic for more information on palettes.
Notifies a widget that it is embedded into an HTML page that uses a path modifier.
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.
Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar.
This option accepts values from the (0, 1) range.
Specifies whether or not the widget supports right-to-left representation.
The most common scenario is switching all the widgets to a right-to-left reading order. In this instance, set the DevExpress.rtlEnabled field to true. If you need to switch the reading order in a particular widget, use the rtlEnabled configuration option of this widget.
Specifies the size of the widget in pixels.
The widget occupies the entire area of the parent container (division). If the container size (width or height) is set to zero, the widget is not displayed.
To set the widget to a specific size that differs from the container size, use the size configuration object. Assign a height and width in pixels to the height and width fields of this object respectively.
Specifies a start value for the gauge's invisible scale.
Specifies a subtitle for a gauge.
This option specifies the appearance of the gauge subtitle (the text below the title). If you need to specify only the subtitle text, assign it directly to the subtitle field. Otherwise, assign an object with the required subtitle options specified to the subtitle option. When a subtitle is not specified, the widget is displayed without it.
Sets the name of the theme to be used in the widget.
Use this property to set a predefined or custom theme. The options defining chart appearance will be set to the values that are set in the specified theme. You can override some of these values within the chart's configuration object.
Specifies a title for a gauge.
Use this option to set a text for the gauge title. If you need to specify only a text for the title, assign this text directly to the title field. Otherwise, assign an object with the required title options specified to the title option. When title is not specified, the widget is displayed without a title.
Specifies options for gauge tooltips.
A tooltip is a small pop-up rectangle that displays the value of the bar that is currently hovered over. You can enable or disable tooltips, format or customize the displayed text, and change the default appearance. Use the options of the tooltip configuration object to do this.
Specifies the array of values to be indicated on a bar gauge.