label

Specifies common options for scale labels.

Type: Object

Scale labels represent textual values for major scale ticks. The label object exposes properties that allow you to specify custom text for scale labels and properties to change the text font.

Show Example:
jQuery

In this example, the text of the scale labels is customized using the customizeText option. In addition, the color and size options of the scale label text are changed.


                                    

                                    

customizeText

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

Type: function(scaleValue)
Function parameters:
scaleValue: Object
Defines a scale value.
Object structure:
value: Number
Specifies the scale value represented by a label.
valueText: String
Specifies the scale value with an applied format, if the format and precision (optional) properties are specified.
Return Value: String
The text to be displayed by a scale label.
Cannot be used in themes.

When implementing a callback function for this property, use the scale value to be displayed in a label. This value can be accessed using the fields of the object that is passed as the function's parameter. Alternatively, you can use the this object within the function. This object has the same structure as the object passed as a parameter.

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

View Demo

Show Example:
jQuery

In this example, the text of the scale labels is customized using the customizeText option.


                                    

                                    

font

Specifies font options for the text displayed in the scale labels of the gauge.

Type: Object

Show Example:
jQuery

In this example, font options of the scale labels are changed.


                                    

                                    

format

Specifies a format for the text displayed in scale labels.

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

Labels display scale values. You can apply formatting to the label text using one of the numeric formats.

NOTE: You can set a precision for the label text using the precision option.

In addition to the predefined numeric formats, 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.

Show Example:
jQuery

In this example, the text of the scale labels is displayed in a percent format.


                                    

                                    

indentFromTick

Specifies the spacing between scale labels and ticks.

Type: Number
Default Value: -10

Show Example:
jQuery

In this example, the scale labels are indented from the scale ticks by 20 pixels.


                                    

                                    

overlappingBehavior

Specifies the overlap resolving options to be applied to scale labels.

Type: Object

precision

Specifies a precision for the formatted value displayed in the scale labels.

Type: Number
Default Value: 2

This field's value must be an integer indicating the number of digits to show in the scale values displayed in labels. This option can be applied only along with the format option. To learn how to set a format for scale values, refer to the format option description.

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

Show Example:
jQuery

In this example, the text of the scale labels is displayed in a fixedPoint format with the precision set to 1.


                                    

                                    

useRangeColors

Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container.

Type: Boolean
Default Value: false

To paint all scale labels in a single color, you can use the color option of the font object. Alternatively, you can paint scale labels similarly to ranges in the range container. For this purpose, assign true to the useRangeColors option.

visible

Specifies whether or not scale labels are visible on the gauge.

Type: Boolean
Default Value: true

Show Example:
jQuery

Change the visibility of the scale labels by toggling the check box under the gauge.