tooltip

Configures tooltips.

Type: Object

A tooltip is a miniature rectangle displaying the widget data. A tooltip appears when the end-user hovers the cursor over a widget element. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

arrowLength

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

Type: Number
Default Value: 10

border

Specifies the appearance of the tooltip's border.

Type: Object

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.

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 tooltip appearance.

Type: function
Function parameters:
info: Object

Information about the node that has entered the hover state.

Object structure:
value: Number

The value of the node from the data source.

valueText: String

The value of the node with applied formatting.

The node that has entered the hover state.

Return Value: Object

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

Default Value: undefined

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 a callback function for this option, you can use the value of the node that has entered the hover state. This value can be accessed using the object passed as the function's parameter or the this object.

enabled

Enables tooltips.

Type: Boolean
Default Value: false

font

Specifies the font of the text displayed by a tooltip.

Type: Object

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

opacity

Specifies the opacity of tooltips.

Type: Number
Default Value: undefined

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

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

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.