tooltip

Specifies tooltip options.

Type: Object

A tooltip is a small pop-up rectangle that displays information about a hovered series point. 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. To learn more on tooltips and their options, refer to the Tooltips topic.

Show Example:
jQuery

In this example, tooltips are enabled. Hover over any point to see a tooltip.


                                    

                                    

argumentFormat

Specifies a format for arguments of the chart's series points.

Type: String
Default Value: ''
Accepted Values: 'currency' | 'fixedPoint' | 'percent' | 'decimal' | 'exponential' | 'largeNumber' | 'thousands' | 'millions' | 'billions' | 'trillions' | 'longDate' | 'longTime' | 'monthAndDay' | 'monthAndYear' | 'quarterAndYear' | 'shortDate' | 'shortTime' | 'millisecond' | 'day' | 'month' | 'quarter' | 'year'

Use this property to set a format for arguments when they are displayed in tooltips. For a list of acceptable formats, refer to the format property. To learn how to set custom text for tooltips so that they include an argument value for the point that is currently hovered, refer to the customizeTooltip property. For general information on data formatting, refer to the Data Formatting topic.

Show Example:
jQuery

The example below shows a chart with formatted tooltip text. The tooltip displays the argument of the corresponding point in a 'monthAndDay' format.


                                    

                                    

argumentPrecision

Specifies a precision for formatted arguments displayed in tooltips.

Type: Number
Default Value: 0

This property's value must be an integer indicating how many digits to show in the argument displayed in tooltips. This property value is considered when tooltips display arguments in one of the following numeric formats: 'fixedPoint', 'exponential', 'currency', 'percent'. To learn how to set a format for arguments, refer to the argumentFormat property description. To learn how to set a custom text for tooltips so that they include an argument value of the currently hovered point, refer to the customizeTooltip property description. For general information on data formatting, refer to the Data Formatting topic.

Show Example:
jQuery

The example below represents a polar chart with formatted tooltip text. The tooltip displays the combination of the point's argument and value. The argument is formatted as a fixed-point number with the precision of 2.


                                    

                                    

arrowLength

Specifies the length of the tooltips' arrow, in pixels.

Type: Number
Default Value: 10

Show Example:
jQuery

In this example, the tooltip's arrowLength option is set to 30.


                                    

                                    

border

Specifies the appearance of the tooltip's border.

Type: Object

Show Example:
jQuery

This example shows how to configure the tooltip's border. Hover over any point to see a tooltip with custom border settings.


                                    

                                    

color

Specifies a color for the chart's tooltips.

Type: String
Default Value: '#ffffff'

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.

Show Example:
jQuery

In this example, the tooltip's color option is set to limegreen.


                                    

                                    

customizeTooltip

Allows you to change the appearance of specific tooltips.

Type: function
Function parameters:
pointInfo: Object

Defines the point that is currently hovered over.

Return Value: Object

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.

  • fontColor
    Specifies the color of the text displayed by a tooltip.

  • borderColor
    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.

  • originalValue
    Specifies the value of the currently represented point as it is set in the data source.
  • value
    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.
  • valueText
    Specifies the value of the currently hovered point with applied formatting if the format and precision (optional) properties are specified.
  • originalArgument
    Specifies the argument value of the currently represented point as it is set in the data source.
  • argument
    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.
  • argumentText
    Specifies the argument value of the currently hovered point with applied formatting if the argumentFormat and argumentPrecision (optional) options are specified.
  • seriesName
    Specifies the series of the currently hovered point.
  • 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.

Show Example:
jQuery

In this example, those points, whose value is greater than 1 billion, have a tooltip painted in 'powderblue'.


                                    

                                    

enabled

Specifies whether or not tooltips are enabled in the chart.

Type: Boolean
Default Value: false

Show Example:
jQuery

In the example below, use the check box to enable/disable tooltips. Hover over any point of the chart to see the effect.


                                    

                                    

font

Specifies font options for the text displayed by tooltips.

Type: Object

Show Example:
jQuery

This example shows how to configure a tooltip's font. Hover over any point to see the tooltip with custom font settings.


                                    

                                    

format

Specifies a format for the text displayed by tooltips.

Type: String
Default Value: ''
Accepted Values: 'currency' | 'fixedPoint' | 'percent' | 'decimal' | 'exponential' | 'largeNumber' | 'thousands' | 'millions' | 'billions' | 'trillions' | 'longDate' | 'longTime' | 'monthAndDay' | 'monthAndYear' | 'quarterAndYear' | 'shortDate' | 'shortTime' | 'millisecond' | 'day' | 'month' | 'quarter' | 'year'

Tooltips display the value(s) of the point that is currently being hovered over by default. You can apply formatting to this value using one of the available formats.

NOTE: You can set a precision for a tooltip value when the 'fixedPoint', 'exponential', 'currency' or 'percent' format is applied. Use the precision and argumentPrecision properties to do this.

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

Show Example:
jQuery

The example below represents a chart with formatted tooltip text. The tooltip displays the value of the hovered point in the 'exponential' format.


                                    

                                    

opacity

Specifies the opacity of tooltips.

Type: Number
Default Value: undefined

Show Example:
jQuery

In this example, tooltips are displayed with a 0.6 opacity.


                                    

                                    

paddingLeftRight

Specifies the blank space between a tooltip's left/right boundaries and the inner text, in pixels.

Type: Number
Default Value: 18

TooltipPadding ChartJS

paddingTopBottom

Specifies the blank space between a tooltip's top/bottom boundaries and the inner text, in pixels.

Type: Number
Default Value: 15

TooltipPadding ChartJS

percentPrecision

Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series.

Type: Number
Default Value: 0

To display a percent value in tooltips, use the customizeTooltip callback function. Return an object from this function. Within this object, assign the percent or percentText field of the this object to the text field.

Show Example:
jQuery

In this example, the tooltip text for a stacked-bar series type is displayed as a percentage value. The precision of this value is set to 2 digits after the comma using the percentPrecision option.


                                    

                                    

precision

Specifies a precision for formatted values displayed in tooltips.

Type: Number
Default Value: 0

This property's value must be an integer indicating how many digits to show in the value displayed in tooltips. This property value is considered when tooltips display values in one of the following numeric formats: 'fixedPoint', 'exponential', 'currency', 'percent'. To learn how to set a format for point values, refer to the format property description. For general information on data formatting, refer to the Data Formatting topic.

Show Example:
jQuery

The example below shows a polar chart with formatted tooltip text. The tooltip displays the value of the corresponding point in the 'percent' format with a precision of 2.


                                    

                                    

shadow

Specifies options of the tooltip's shadow.

Type: Object

Show Example:
jQuery

This example shows how to configure the tooltip's shadow. Hover over any point to see a tooltip with custom shadow settings.


                                    

                                    

shared

Specifies the kind of information to display in a tooltip.

Type: Boolean
Default Value: false

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.

Show Example:
jQuery

In this example, shared tooltips are enabled. Hover over any point to see the shared tooltips.