text

Specifies font and formatting options for text displayed in 'textCloud' markers.

Type: Object

customizeText

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

Type: function
Default Value: undefined

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

  • value
    Specifies the scale value to be displayed in a marker.
  • 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 currently displayed scale value.

font

Specifies font options for the text displayed by a 'textCloud' marker.

Type: Object

format

Specifies a format for the text displayed in a 'textCloud' marker.

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

The 'textCloud' markers display the scale values that they point to. You can apply formatting to the marker 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 marker 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, refer to the Data Formatting topic.

precision

Specifies a precision for the formatted value displayed in a 'cloudText' marker.

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 a 'cloudText' marker. This property value is used when the marker displays scale values in one of the following numeric formats: 'fixedPoint', 'exponential', 'currency' or 'percent'. To learn how to set a format for a marker text, refer to the format property description.

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