React LinearGauge - rangeContainer

Specifies gauge range container properties.

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 property supports the following colors:

horizontalOrientation

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

Type:

String

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

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

offset

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

Type:

Number

Default Value: 0

View Demo

palette

Specifies the palette to be used for colorizing ranges in the range container.

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:

View Demo

See Also

paletteExtensionMode

Specifies what to do with colors in the palette when their number is less than the number of ranges in the range container.

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

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.

View Demo

verticalOrientation

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

Type:

String

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

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

width

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

Type:

Object

|

Number

If you need the LinearGauge UI component 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.