tooltip

Configures tooltips.

Type: Object

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.

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: Format
Default Value: undefined
NOTE
DevExtreme widgets provide a wide choice of predefined formats. If you are, however, going to use custom formats, link the Globalize library to your project. Learn how to do this from the Installation topic.
See Also
  • format - provides a comprehensive overview of formatting capabilities.
  • Data Formatting - shows how to apply formatting to various widget elements.
Show Example:
jQuery

In this example, text in tooltips is formatted. A tooltip displays the argument of a point in a 'monthAndDay' format.


                                    

                                    

argumentPrecision

Deprecated

Use the tooltip | argumentFormat | precision option instead.

Specifies a precision for formatted arguments displayed in tooltips.

Type: Number
Default Value: undefined

arrowLength

Specifies the length of the tooltip's arrow in pixels.

Type: Number
Default Value: 10

Show Example:
jQuery

In this example, tooltips have a 5-pixel arrow.


                                    

                                    

border

Specifies the appearance of the tooltip's border.

Type: Object

Show Example:
jQuery

In this example, several options of the tooltip's border are changed.


                                    

                                    

color

Specifies the color of tooltips.

Type: String
Default Value: '#ffffff'

This option supports the following colors.

This option sets one color for all tooltips in the widget. To specify a color for a particular tooltip, use the customizeTooltip option.

Show Example:
jQuery

In this example, tooltips are painted in 'powderblue' using the color option.


                                    

                                    

container

Specifies the container to draw tooltips inside of it.

Default Value: undefined

By default, tooltips are shown within the body DOM element. Use this option if you need to specify another container for tooltips.

customizeTooltip

Allows you to change the appearance of specified tooltips.

Type: function
Function parameters:
pointInfo: Object

Defines the point value to be displayed in a tooltip.

Return Value: Object

The text or markup to be displayed in a tooltip, along with the tooltip's settings.

Default Value: undefined
Cannot be used in themes.

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.

  • html
    Specifies the HTML markup displayed by a tooltip. [note]If you are going to use external resources (for example, images) in the markup, specify the size of the area they will occupy beforehand.

  • 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 property is specified.
  • valueText (for candle stick and stock series)
    Specifies a string of the values of the currently represented point. This string contains the highValueText, openValueText, closeValueText and lowValueText values.
    The format of the string is the following: "h: %highValueText% o: %openValueText% c: %closeValueText% l: %lowValueText%".
  • valueText (for range area and range bar series)
    Specifies a string of the values of the currently represented point. This string contains the rangeValue1Text and rangeValue2Text values.
    The format of the string is the following: "%rangeValue1Text% - %rangeValue2Text%".
  • 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 option is specified.
  • size (for bubble series only)
    Specifies the size of the bubble that is hovered over as it is set in the data source.
  • 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 following fields come with the stacked-like series such as full-stacked bar or full-stacked area.

  • percent
    Specifies the percent value of the currently hovered point.
  • percentText
    Specifies the percent value of the currently hovered point with percentPrecision (optional) applied.
  • total
    Specifies the total value of all the points with the same argument as the currently hovered point.
  • totalText
    Specifies the total value of all the points with the same argument as the currently hovered point. This value is displayed with applied formatting if the format option is specified.

The following fields come with the range-like series, such as range area or range bar.

  • originalMinValue
    Specifies the first range value of the currently hovered point as it is set in the data source.
  • rangeValue1
    Specifies the first range value of the currently hovered point. Differs from the originalMinValue when the axis value type is specified explicitly. In this instance, the rangeValue1 field contains the first range value in the specified type.
  • rangeValue1Text
    Specifies the first range value of the currently hovered point with applied formatting if the format property is specified.
  • originalValue
    Specifies the second range value of the currently hovered point as it is set in the data source.
  • rangeValue2
    Specifies the second range value of the currently hovered point. Differs from the originalValue when the axis value type is specified explicitly. In this instance, the rangeValue2 field contains the second range value in the specified type.
  • rangeValue2Text
    Specifies the second range value of the currently hovered point with applied formatting if the format property is specified.

The following fields come with financial chart series, such as candle stick or stock.

  • originalOpenValue
    Specifies the open value of the currently hovered point as it is set in the data source.
  • openValue
    Specifies the open value of the currently hovered point. Differs from the originalOpenValue when the value in the data source is not in a numeric format.
  • openValueText
    Specifies the open value of the currently hovered point with applied formatting if the format option is specified.
  • originalCloseValue
    Specifies the close value of the currently hovered point as it is set in the data source.
  • closeValue
    Specifies the close value of the currently hovered point. Differs from the originalCloseValue when the value in the data source is not in a numeric format.
  • closeValueText
    Specifies the close value of the currently hovered point with applied formatting if the format option is specified.
  • originalHighValue
    Specifies the high value of the currently hovered point as it is set in the data source.
  • highValue
    Specifies the high value of the currently hovered point. Differs from the originalHighValue when the value in the data source is not in a numeric format.
  • highValueText
    Specifies the high value of the currently hovered point with applied formatting if the format option is specified.
  • originalLowValue
    Specifies the low value of the currently hovered point as it is set in the data source.
  • lowValue
    Specifies the low value of the currently hovered point. Differs from the originalLowValue when the value in the data source is not in a numeric format.
  • lowValueText
    Specifies the low value of the currently hovered point with applied formatting if the format option is specified.
  • reductionValue
    Specifies the reduction value of the currently hovered point.
  • reductionValueText
    Specifies the reduction value of the currently hovered point with applied formatting if the format option is 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 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

Enables tooltips.

Type: Boolean
Default Value: false

Show Example:
jQuery

In this example, use the check box to enable/disable tooltips. Hover over any series point to see the effect.


                                    

                                    

font

Specifies the font of the text displayed by a tooltip.

Type: Object

Show Example:
jQuery

In this example, the font of the tooltip's text is changed.


                                    

                                    

format

Specifies the format of the value displayed by a tooltip.

Type: Format
Default Value: undefined
NOTE
DevExtreme widgets provide a wide choice of predefined formats. If you are, however, going to use custom formats, link the Globalize library to your project. Learn how to do this from the Installation topic.
See Also
  • format - provides a comprehensive overview of formatting capabilities.
  • Data Formatting - shows how to apply formatting to various widget elements.
Show Example:
jQuery

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


                                    

                                    

location

Specifies whether the tooltip must be located in the center of a series point or on its edge. Applies to bar-like and bubble series only.

Type: String
Default Value: 'center'
Accepted Values: 'center' | 'edge'
This member is exposed by the following entities:

opacity

Specifies the opacity of tooltips.

Type: Number
Default Value: undefined

Show Example:
jQuery

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


                                    

                                    

paddingLeftRight

Generates space on the left and the right of the text displayed by a tooltip.

Type: Number
Default Value: 18

TooltipPadding ChartJS

paddingTopBottom

Generates space above and below the text displayed by a tooltip.

Type: Number
Default Value: 15

TooltipPadding ChartJS

percentPrecision

Deprecated

Use the tooltip | format | percentPrecision option instead.

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

Type: Number
Default Value: undefined

precision

Deprecated

Use the tooltip | format | precision option instead.

Specifies the precision of formatted values in a tooltip.

Type: Number
Default Value: undefined

shadow

Specifies the appearance of the tooltip's shadow.

Type: Object

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

Toggle the check box below to switch between the values of the tooltip | shared option. Hover over any point on the chart to see the effect.


                                    

                                    

zIndex

Specifies the z-index of tooltips.

Type: Number
Default Value: undefined

If the widget container has the CSS z-index property specified and tooltips are displayed incorrectly, configure the z-index of the tooltips using this option.