React LinearGauge - rangeContainer

Specifies gauge range container options.

Type:

Object

For the purpose of more intelligible data visualization, you can combine values into ranges and color each range differently. For instance, you can indicate the range of warm and cold temperatures. To set the ranges, assign an array of objects defining the ranges to the ranges property of the rangeContainer configuration object. In addition, you can specify the orientation of the ranges relative to an invisible scale line, and an offset from this line using the rangeContainer properties.

backgroundColor

Specifies a range container's background color.

Type:

String

Default Value: '#808080'

The background color is used to indicate the area reserved for the range container in the gauge. This color is replaced with the colors of the ranges contained in the range container.

This option supports the following colors:

horizontalOrientation

Specifies the orientation of the range container. Applies only if the geometry.orientation option is "vertical".

Type:

String

Default Value: 'right'
Accepted Values: 'center' | 'left' | 'right'

This option specifies the range container orientation relative to an invisible scale line.

When using the widget as an ASP.NET MVC Control, specify this option using the HorizontalAlignment enum. This enum accepts the following values: Left, Center and Right.

offset

Specifies the offset of the range container from an invisible scale line in pixels.

Type:

Number

Default Value: 0

View Demo

palette

Sets the name of the palette or an array of colors to be used for coloring the gauge range container.

Type:

Array<String>

|

String

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

Use this option to set a predefined or custom palette. The colors listed in the specified palette will be used to draw ranges of the range container. If the number of the ranges is greater than the number of colors in the palette, palette colors are repeated, but slightly modified.

You can override the color of an individual range by specifying the color option of this range's configuration object. 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.

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.

View Demo

ranges[]

An array of objects representing ranges contained in the range container.

Type:

Array<Object>

Default Value: []
Cannot be used in themes.

Ranges allow you to mark certain value ranges in the gauge. Visually, the ranges are displayed as bars along scales. To define ranges, introduce the ranges array. Specify a start value, an end value and a color for each range.

verticalOrientation

Specifies the orientation of the range container. Applies only if the geometry.orientation option is "horizontal".

Type:

String

Default Value: 'bottom'
Accepted Values: 'bottom' | 'center' | 'top'

This option specifies the range container orientation relative to an invisible scale line.

When using the widget as an ASP.NET MVC Control, specify this option using the VerticalAlignment enum. This enum accepts the following values: Top, Center and Bottom.

width

Specifies the width of the range container's start and end boundaries in the LinearGauge widget.

Type:

Object

|

Number

If you need the LinearGauge widget range container to be rectangular, set the width of its start/end boundary for this property. If you need the range container to be triangular, assign an object to the width property. Set 0 to the start/end property of the width object and the required numeric value to the width object's end/start property. If you need the range container to be trapezoid, set the required values to the start and end properties of the width object.