commonRangeBarSettings text

Deprecated

Use the valueIndicator | text option instead.

Specifies font and formatting options of the text displayed by a range bar.

Type: Object

Note that the range bar's indent property must not be set to 0, if you need to show the text.

customizeText

Deprecated

Use the valueIndicator | text | customizeText option instead.

Specifies a callback function that returns the text to be displayed in the range bar.

Type: function
Default Value: undefined

When implementing a callback function for this property, use the value displayed in the range bar. The value can be accessed using the following properties of the this object.

  • value
    Specifies the scale value to be displayed in the range bar.
  • valueText
    Specifies the scale value using an applied format if the format and precision (optional) properties are specified.

The function's parameter represents the same object as the "this" object. If appropriate, you can use the function's parameter to obtain the scale value that is currently displayed.

font

Deprecated

Use the valueIndicator | text | font option instead.

Specifies font options for the text displayed by a range bar.

Type: Object

format

Deprecated

Use the valueIndicator | text | format option instead.

Specifies a format for the text displayed in a range bar label.

Type: String
Default Value: undefined
Accepted Values: 'currency' | 'fixedPoint' | 'percent' | 'decimal' | 'exponential' | 'largeNumber' | 'thousands' | 'millions' | 'billions' | 'trillions'

The range bar label displays the scale value that the bar points to. You can apply formatting to the label's text using one of the following predefined numeric formats.

  • 'currency' - displays a value as currency
  • 'currency largeNumber' – a value is divided by a number (one thousand, one million, one billion or one trillion) so that the value is less than a thousand; then the letter 'K', 'M', 'B' or 'T' is added and the 'currency' format is applied
  • 'currency thousands' - a value is divided by one thousand, the letter 'K' is added and the 'currency' format is applied
  • 'currency millions' - a value is divided by one million, the letter 'M' is added and the 'currency' format is applied
  • 'currency billions' - a value is divided by one billion, the letter 'B' is added and the 'currency' format is applied
  • 'currency trillions' - a value is divided by one trillion, the letter 'T' is added and the 'currency' format is applied
  • 'fixedPoint' - displays a value as a real numeric value with a specified number of digits for the fractional part and an optional negative sign
  • 'fixedPoint largeNumber' - a value is divided by a number (one thousand, one million, one billion or one trillion) so that the value is less than a thousand; then the letter 'K', 'M', 'B' or 'T' is added and the 'fixedPoint' format is applied
  • 'fixedPoint thousands' - a value is divided by one thousand, the letter 'K' is added and the 'fixedPoint' format is applied
  • 'fixedPoint millions' - a value is divided by one million, the letter 'M' is added and the 'fixedPoint' format is applied
  • 'fixedPoint billions' - a value is divided by one billion, the letter 'B' is added and the 'fixedPoint' format is applied
  • 'fixedPoint trillions' - a value is divided by one trillion, the letter 'T' is added and the 'fixedPoint' format is applied
  • 'decimal' – displays a value as an integer with an optional negative sign
  • 'decimal largeNumber' - a value is divided by a number (one thousand, one million, one billion or one trillion) so that the value is less than a thousand; then the letter 'K', 'M', 'B' or 'T' is added and the 'decimal' format is applied
  • 'decimal thousands' - a value is divided by one thousand, the letter 'K' is added and the 'decimal' format is applied
  • 'decimal millions' - a value is divided by one million, the letter 'M' is added and the 'decimal' format is applied
  • 'decimal billions' - a value is divided by one billion, the letter 'B' is added and the 'decimal' format is applied
  • 'decimal trillions' - a value is divided by one trillion, the letter 'T' is added and the 'decimal' format is applied
  • 'largeNumber' - a value is divided by a number (one thousand, one million, one billion or one trillion) so that the value is less than a thousand; then the letter 'K', 'M', 'B' or 'T' is added and the 'fixedPoint' format is applied
  • 'thousands' - a value is divided by one thousand, the letter 'K' is added and the 'fixedPoint' format is applied
  • 'millions' - a value is divided by one million, the letter 'M' is added and the 'fixedPoint' format is applied
  • 'billions' - a value is divided by one billion, the letter 'B' is added and the 'fixedPoint' format is applied
  • 'trillions' - a value is divided by one trillion, the letter 'T' is added and the 'fixedPoint' format is applied
  • 'percent' - a value is multiplied by 100 and displayed as a percent symbol
  • 'exponential' – displays a value with an exponential notation

NOTE: You can set a precision for the label text when the 'fixedPoint', 'exponential', 'currency' or 'percent' format is applied. Use the precision property to do this.
In addition to the predefined formats above, you can assign a custom format. Use format tokens from the Globalize JavaScript library to do this.

For details on formatting provided, refer to the Data Formatting topic.

indent

Deprecated

Use the valueIndicator | text | indent option instead.

Specifies the label indent from a range bar in pixels.

Type: Number
Default Value: 0

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

precision

Deprecated

Use the valueIndicator | text | precision option instead.

Specifies a precision for the formatted value displayed in a range bar's label.

Type: Number
Default Value: undefined

This property's value must be an integer indicating the number of digits to show in the scale value displayed in the range bar label. This property value is used when the label displays scale values in one of the following numeric formats: 'fixedPoint', 'exponential', 'currency' or 'percent'. To learn how to set a format for the label text, refer to the format property description.

For general information on data formatting, refer to the Data Formatting topic.