React CircularGauge - subvalueIndicator
The CircularGauge widget can display one main value and several subvalues. The gauge's main value and subvalues are indicated by special pointers. You can customize the appearance of these pointers using the valueIndicator and subvalueIndicator configuration objects correspondingly.
The subvalue indicator is a pointer which designates an extra value on a scale. There are several types of subvalue indicators. Set the required one by using the type option, and then specify the options that are specific to this type, if needed. To learn about the options that can be specified for a particular type, refer to one of the following sections.
baseValue
By default, a range bar starts from the beginning of the gauge scale. If you need to draw the range bar starting from a specific scale value, assign the required value to the baseValue option. In this instance, the range bar will display the range from the baseValue to the main gauge value.
horizontalOrientation
Specifies the orientation of the rangeBar indicator. Applies only if the geometry.orientation option is "vertical".
This option specifies the orientation of the indicator relative to an invisible scale line.
When using the widget as an ASP.NET MVC Control, specify this option using the HorizontalEdge
enum. This enum accepts the following values: Left
and Right
.
indentFromCenter
Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type.
palette
Use this option to color subvalue indicators. If the number of colors in the specified array is less than the number of subvalue indicators, the colors are repeated, but slightly modified.
If you need to draw all subvalue indicators in one color, specify the subvalueIndicator.color option.
When using the widget as an ASP.NET MVC Control, you can specify this option using the VizPalette
enum. This enum accepts the following values: Default
, SoftPastel
, HarmonyLight
, Pastel
, Bright
, Soft
, Ocean
, Vintage
, Violet
, Carmine
, DarkMoon
, SoftBlue
, DarkViolet
and GreenMist
.
secondColor
When you use a twoColorNeedle indicator, define the colors for it using the color and secondColor options. The color option sets the color for the base of the needle. The secondColor option sets the color for the tip of the needle.
In addition, you can specify the ratio between the main and the second color using the secondFraction option.
type
Different options of the subvalueIndicator configuration object can be set for different types of the subvalue indicators. These options are listed within the Indicator Types section.
When using the widget as an ASP.NET MVC Control, specify this option using the GaugeIndicatorType
enum. This enum accepts the following values: RectangleNeedle
, TriangleNeedle
, TwoColorNeedle
, RangeBar
, TriangleMarker
and TextCloud
.
verticalOrientation
Specifies the orientation of the rangeBar indicator. Applies only if the geometry.orientation option is "horizontal".
This option specifies the orientation of an indicator relative to an invisible scale line.
When using the widget as an ASP.NET MVC Control, specify this option using the VerticalEdge
enum. This enum accepts the following values: Top
and Bottom
.
If you have technical questions, please create a support ticket in the DevExpress Support Center.