JavaScript/jQuery Chart - 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.

argumentFormat

Formats the point argument before it is displayed in the tooltip. To format the point value, use the format option.

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 topics in the Installation section.
See Also
  • format - provides a comprehensive overview of formatting capabilities.
  • Data Formatting - shows how to apply formatting to various widget elements.

arrowLength

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

Type:

Number

Default Value: 10

border

Configures a tooltip's border.

Type:

Object

color

Colors all tooltips.

Type:

String

Default Value: '#ffffff'

This option supports the following colors:

This option sets one color for all tooltips. You can specify a particular tooltip's color in the tooltip.customizeTooltip function.

container

Specifies the container in which to draw tooltips. The default container is the HTML DOM <body> element.

Type:

String

|

Element

|

jQuery

Default Value: undefined

contentComponent

An alias for the contentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

contentRender

An alias for the contentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

contentTemplate

Specifies a custom template for a tooltip.

Type:

template

Template Data:

Object

Information on the series point being pressed or hovered over.

Default Name: undefined

View Demo

The pointInfo object has different fields for different series types. The following fields are available for all series types:

Field name Description
originalValue The value of the represented point as it is set in the data source.
value The value of the represented point. Differs from the originalValue when the axis value type is specified explicitly. In this instance, the value field contains a value of the specified type.
valueText The value of the point being hovered over with applied formatting if the format property is specified
originalArgument The argument value of the represented point as it is set in the data source.
argument The argument value of the 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 similar type as the argument axis.
argumentText The argument value of the represented point with applied formatting if the argumentFormat option is specified.
seriesName The series name of the point being hovered over.
point Information on the point being hovered over. For more information about the field and the point object's methods, refer to the Point topic.
points An array of points with the same argument as the point being hovered over. This field is accessible when the tooltip's shared option is set to true.
size (for bubble series only) The size of the bubble being hovered over as it is set in the data source.

The following pointInfo fields are available for stacked series such as the full-stacked bar or full-stacked area:

Field name Description
percent The percentage value of the point being hovered over.
percentText The percentage value of the point being hovered over.
total The total value of all the points with the same argument as the point being hovered over.
totalText The total value of all the points with the same argument as the point being hovered over. This value is displayed with applied formatting if the format option is specified.

The following pointInfo fields are available for the range-like series, such as range area or range bar:

Field name Description
originalMinValue The value of the first range the point being hovered over as it is set in the data source.
rangeValue1 The first range value of the point being hovered over. Differs from the originalMinValue when the axis value type is specified explicitly. In this instance, the rangeValue1 field contains the first range value of the specified type.
rangeValue1Text The first range value of the point being hovered over with applied formatting if the format property is specified.
originalValue The value of the second range the point being hovered over as it is set in the data source.
rangeValue2 The second range value of the point being hovered over. 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 The second range value of the point being hovered over with applied formatting if the format property is specified.
valueText A string that contains the following values of the represented point: rangeValue1Text and rangeValue2Text. The format of the string is the following: "*%rangeValue1Text%* - *%rangeValue2Text%*".

The following pointInfo fields are available for the financial chart series, such as candle stick or stock:

Field name Description
originalOpenValue The open value of the point being hovered over as it is set in the data source.
openValue The open value of the point being hovered over. Differs from the originalOpenValue when the value in the data source is not in a numeric format.
openValueText The open value of the point being hovered over with applied formatting if the format option is specified.
originalCloseValue The close value of the point being hovered over as it is set in the data source.
closeValue The close value of the point being hovered over. Differs from the originalCloseValue when the value in the data source is not in a numeric format.
closeValueText The close value of the point being hovered over with applied formatting if the format option is specified.
originalHighValue The high value of the point being hovered over as it is set in the data source.
highValue The high value of the point being hovered over. Differs from the originalHighValue when the value in the data source is not in a numeric format.
highValueText The high value of the point being hovered over with applied formatting if the format option is specified.
originalLowValue The low value of the point being hovered over as it is set in the data source.
lowValue The low value of the point being hovered over. Differs from the originalLowValue when the value in the data source is not in a numeric format.
lowValueText The low value of the point being hovered over with applied formatting if the format option is specified.
reductionValue The reduction value of the point being hovered over.
reductionValueText The reduction value of the point being hovered over with applied formatting if the format option is specified.
valueText A string that contains the following values of the represented point: highValueText, openValueText, closeValueText and lowValueText. The format of the string is the following: "h: %highValueText% o: %openValueText% c: %closeValueText% l: %lowValueText%".
NOTE
As an alternative to the function’s parameter you can use the this keyword.

Display a Tooltip Demo Tooltip HTML Support Demo

See Also

cornerRadius

Makes all the tooltip's corners rounded.

Type:

Number

Default Value: 0, 4 (Material)

The following table demonstrates how the corner's curvature depends on the cornerRadius value:

cornerRadius Result
cornerRadius: 0 DevExtreme Chart: tooltip with cornerRadius set to 0
cornerRadius: 15 DevExtreme Chart: tooltip with cornerRadius set to 15
cornerRadius: 35 DevExtreme Chart: tooltip with cornerRadius set to 35

customizeTooltip

Allows you to change tooltip appearance.

Type:

Function

Function parameters:
pointInfo:

Object

Information on the series point being pressed or hovered over with the mouse pointer.

Return Value:

Object

The tooltip's text or markup and appearance settings.

Default Value: undefined
Cannot be used in themes.

This option should be assigned a function that returns an object with the following fields:

Field name Description
text The tooltip's text.
html The HTML markup displayed in a tooltip. To use external resources (for example, images) in the markup, specify the size of the area they occupy beforehand.
color The tooltip's color.
fontColor The color of the tooltip's text.
borderColor The color of the tooltip's border.

The pointInfo object has different fields for the different series types. The following fields are available for all the series types:

Field name Description
originalValue The value of the represented point as it is set in the data source.
value The value of the represented point. Differs from the originalValue when the axis value type is specified explicitly. In this instance, the value field contains a value of the specified type.
valueText The value of the point being hovered over with applied formatting if the format property is specified
originalArgument The argument value of the represented point as it is set in the data source.
argument The argument value of the 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 similar type as the argument axis.
argumentText The argument value of the represented point with applied formatting if the argumentFormat option is specified.
seriesName The series name of the point being hovered over.
point Information on the point being hovered over. To learn more about the field and methods of the point object, refer to the Point topic.
points An array of points with the same argument as the point being hovered over. This field is accessible when the shared option of the tooltip is set to true.
size (for bubble series only) The size of the bubble being hovered over as it is set in the data source.

The folllowing pointInfo fields are available for the stacked-like series such as full-stacked bar or full-stacked area:

Field name Description
percent The percent value of the point being hovered over.
percentText The percent value of the point being hovered over.
total The total value of all the points with the same argument as the point being hovered over.
totalText The total value of all the points with the same argument as the point being hovered over. This value is displayed with applied formatting if the format option is specified.

The folllowing pointInfo fields are available for the range-like series, such as range area or range bar:

Field name Description
originalMinValue The value of the first range the point being hovered over as it is set in the data source.
rangeValue1 The first range value of the point being hovered over. Differs from the originalMinValue when the axis value type is specified explicitly. In this instance, the rangeValue1 field contains the first range value of the specified type.
rangeValue1Text The first range value of the point being hovered over with applied formatting if the format property is specified.
originalValue The value of the second range the point being hovered over as it is set in the data source.
rangeValue2 The second range value of the point being hovered over. 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 The second range value of the point being hovered over with applied formatting if the format property is specified.
valueText A string that contains the following values of the represented point: rangeValue1Text and rangeValue2Text. The format of the string is the following: "*%rangeValue1Text%* - *%rangeValue2Text%*".

The folllowing pointInfo fields are available for the financial chart series, such as candle stick or stock:

Field name Description
originalOpenValue The open value of the point being hovered over as it is set in the data source.
valueText A string that contains the following values of the represented point: highValueText, openValueText, closeValueText and lowValueText. The format of the string is the following: "h: %highValueText% o: %openValueText% c: %closeValueText% l: %lowValueText%".
openValue The open value of the point being hovered over. Differs from the originalOpenValue when the value in the data source is not in a numeric format.
openValueText The open value of the point being hovered over with applied formatting if the format option is specified.
originalCloseValue The close value of the point being hovered over as it is set in the data source.
closeValue The close value of the point being hovered over. Differs from the originalCloseValue when the value in the data source is not in a numeric format.
closeValueText The close value of the point being hovered over with applied formatting if the format option is specified.
originalHighValue The high value of the point being hovered over as it is set in the data source.
highValue The high value of the point being hovered over. Differs from the originalHighValue when the value in the data source is not in a numeric format.
highValueText The high value of the point being hovered over with applied formatting if the format option is specified.
originalLowValue The low value of the point being hovered over as it is set in the data source.
lowValue The low value of the point being hovered over. Differs from the originalLowValue when the value in the data source is not in a numeric format.
lowValueText The low value of the point being hovered over with applied formatting if the format option is specified.
reductionValue The reduction value of the point being hovered over.
reductionValueText The reduction value of the point being hovered over with applied formatting if the format option is specified.
NOTE
As an alternative to the function’s parameter you can use the this keyword.

Display a Tooltip Demo Tooltip HTML Support Demo

See Also

enabled

Enables tooltips.

Type:

Boolean

Default Value: false

font

Specifies tooltips' font options.

Type:

Object

format

Formats a value before it is displayed it in a tooltip.

Type:

Format

Default Value: undefined

See the format section for details on accepted values.

See Also

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:

Use the ChartTooltipLocation enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Center and Edge.

opacity

Specifies tooltips' transparency.

Type:

Number

Default Value: undefined

This option accepts a value from 0 to 1, where 0 makes tooltips completely transparent, and 1 makes them opaque.

paddingLeftRight

Generates an empty space, measured in pixels, between a tooltip's left/right border and its text.

Type:

Number

Default Value: 18

DevExtreme HTML5 JavaScript Funnel Tooltips Left-Right Padding

paddingTopBottom

Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text.

Type:

Number

Default Value: 15

DevExtreme HTML5 JavaScript Funnel Tooltips Top-Bottom Padding

shadow

Configures a tooltip's shadow.

Type:

Object

shared

Specifies whether the tooltip is shared across all series points with the same argument.

Type:

Boolean

Default Value: false

If this option is false, the tooltip displays information only about the point being hovered over.

If this option is set to true, the tooltip also displays information about all series points that have the same argument as the point being hovered over.

View Demo

See Also

zIndex

Specifies a tooltip's z-index.

Type:

Number

Default Value: undefined

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