A tooltip is a miniature rectangle displaying values of a series point. A tooltip appears when the end-user hovers the cursor over a series point. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.
Specifies a format for arguments of the chart's series points.
Use the tooltip.argumentFormat.precision option instead.
Specifies a precision for formatted arguments displayed in tooltips.
Specifies the length of a tooltip's arrow in pixels.
Colors all tooltips.
This option supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
This option sets one color for all tooltips. You can specify a particular tooltip's color in the tooltip.customizeTooltip function.
Specifies the container in which to draw tooltips. The default container is the HTML DOM
Allows you to change tooltip appearance.
Information on the series point being pressed or hovered over with the mouse pointer.
The tooltip's text or markup and appearance settings.
This option should be assigned a function returning a specific object. The following fields can be specified in this object.
Specifies the color of a tooltip.
Specifies the text displayed by a tooltip.
Specifies the HTML markup displayed by a tooltip.NOTEIf you are going to use external resources (for example, images) in the markup, specify the size of the area they will occupy beforehand.
Specifies the color of the text displayed by a tooltip.
Specifies the color of the tooltip border.
When implementing the function for this option, you can use information about the tooltip's point. For example, you can access the argument or value of this point. To do this, use the following fields of the this object.
Specifies the value of the currently represented point as it is set in the data source.
Specifies the value of the currently represented point. Differs from the originalValue when the axis value type is specified explicitly. In this instance, the value field contains a value in the specified type.
Specifies the value of the currently hovered point with applied formatting if the format property is specified.
Specifies the argument value of the currently represented point as it is set in the data source.
Specifies the argument value of the currently represented point. Differs from the originalArgument when the axis' argument type differs from the argument type in the data source. In this instance, argument has the type of the argument axis.
Specifies the argument value of the currently hovered point with applied formatting if the argumentFormat option is specified.
Specifies the series of the currently hovered point.
Provides access to the hovered point. To learn more about the field and methods of the point object, refer to the Point topic in the "Chart Elements" reference section.
- points (for shared tooltip only)
Provides access to the array of points with the same argument as the currently hovered point. This field is accessible when the shared option of the tooltip object is set to true. To learn more about the fields and methods of the point object, refer to the Point topic in the "Chart Elements" reference section. The function's parameter represents the same object as the this object. If appropriate, you can use the function's parameter to obtain the value that is currently represented by a tooltip.
To get general information on data formatting, refer to the Data Formatting topic.
Formats a value before it is displayed it in a tooltip.
Specifies tooltips' transparency.
This option accepts a value from 0 to 1, where 0 makes tooltips completely transparent, and 1 makes them opaque.
Generates an empty space, measured in pixels, between a tooltip's left/right border and its text.
Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text.
Use the tooltip.format.percentPrecision option instead.
Specifies a precision for a percent value displayed in tooltips for stacked series and PieChart series.
Use the tooltip.format.precision option instead.
Specifies the precision of formatted values in a tooltip.
Specifies the kind of information to display in a tooltip.
By default, a tooltip displays information about the currently hovered series point. If you set the shared option to true, the tooltip will display information about all the points that have the same argument as the hovered point at once.
If the text displayed in the tooltip by default doesn't suit your needs, you can customize it using the customizeTooltip option.
Specifies a tooltip's z-index.
If the widget's container has the CSS z-index property specified, and tooltips are displayed incorrectly, configure their z-index using this option.