tooltip
Specifies tooltip options for the gauge.
A tooltip is a small pop-up rectangle that displays the value of the indicator that is currently hovered over. You can enable or disable tooltips, format or customize the displayed text, and change the default appearance. Use the properties of the tooltip configuration object to do this.
arrowLength
Specifies the length of the tooltip's arrow in pixels.
color
Specifies the color of tooltips.
This option supports the following colors.
- hexadecimal colors
- RGB colors
- RGBA colors (not supported in Internet Explorer 8)
- predefined/cross-browser color names
- predefined SVG colors (not supported in Internet Explorer 8)
This option sets one color for all tooltips on the widget. To specify a color for a particular tooltip, use the customizeTooltip option.
customizeText
Use the customizeTooltip option instead.
Specifies a callback function that returns the text to be displayed in a tooltip.
The text to be displayed in a tooltip.
When implementing a callback function for this option, you can access the scale value to be displayed in a tooltip. To learn how to do this, refer to the customizeTooltip option description.
customizeTooltip
Allows you to change the appearance of particular tooltips.
Specifies the text to be displayed in a tooltip and a color for the tooltip.
This option should be assigned a function returning a specific object. The following fields can be specified in this object.
color
Specifies the color of a tooltip.text
Specifies the text displayed by a tooltip.
When implementing the function for this option, you can access the scale value represented by a tooltip. 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.
To get general information on data formatting, refer to the Data Formatting topic.
enabled
Specifies whether or not tooltips are enabled in the gauge.
format
Specifies a format for the text displayed in a tooltip.
Tooltips display scale values. You can apply formatting to the tooltip text using one of the numeric formats.
NOTE: You can set a precision for the tooltip text using the precision option.
In addition to predefined formats, you can utilize format tokens from the Globalize JavaScript library to assign a custom format.
For details on formatting, refer to the Data Formatting topic.
paddingLeftRight
Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels.
paddingTopBottom
Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels.
precision
Specifies a precision for the formatted value displayed in a tooltip.
This option's value must be an integer indicating the number of digits to show in the scale value displayed in a tooltip. The value of this option is used when the tooltip displays a scale value with an applied format. To learn how to set a format for the tooltip text, refer to the format option description.
For general information on data formatting, refer to the Data Formatting topic.