React LinearGauge - valueIndicator.text

Specifies the appearance of the text displayed in an indicator of the rangeBar type.

Type:

Object

This member is exposed by the following entities:

Note that the indent option of the text configuration object must not be set to 0 if you need to show the text.

customizeText

Specifies a callback function that returns the text to be displayed in an indicator.

Type:

Function

Function parameters:
indicatedValue:

Object

Information on the indicated value.

Object structure:
Name Type Description
value

Number

The raw value.
valueText

String

The formatted value converted to a string.
Return Value:

String

The text for the indicator to display.

Default Value: undefined
This member is exposed by the following entities:
Cannot be used in themes.

NOTE
As an alternative to the function’s parameter you can use the this keyword.

font

Specifies font options for the text displayed by the indicator.

Type:

Object

This member is exposed by the following entities:

format

Formats a value before it is displayed in an indicator. Accepts only numeric formats.

Type:

Format

Default Value: undefined
This member is exposed by the following entities:

See the format section for details on accepted values.

See Also

indent

Specifies the range bar's label indent in pixels.

Type:

Number

Default Value: 0
This member is exposed by the following entities:

If this property is set to 0, the range bar text is not shown.

precision Deprecated

Use the text.format.precision option instead.

Specifies a precision for the formatted value displayed by an indicator.

Type:

Number

Default Value: undefined
This member is exposed by the following entities: