tooltip

Configures tooltips.

Type:

A tooltip is a miniature rectangle displaying data of an area or a marker. A tooltip appears when the end-user hovers the cursor over an area or a marker. To show tooltips, do the following.

Enable tooltips.
Set the enabled option to true.
Specify text to be displayed in tooltips. Specify the customizeTooltip option.

You can also change the appearance of tooltips using fields of the tooltip configuration object.

View Demo

Show Example:

jQuery

arrowLength

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

Type:

Number

Default Value: 10

Show Example:

jQuery

border

Configures a tooltip's border.

Type:

Object

Show Example:

jQuery

color

Colors all tooltips.

Type:

String

Default Value: '#ffffff'

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.

Show Example:

jQuery

container

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

Type:

String

|

DOM Node

|

jQuery

Default Value: undefined

customizeTooltip

Specifies text and appearance of a set of tooltips.

Type:

function

Function parameters:

info:

Area

|

Marker

Information on the area/marker being pressed or hovered over with the mouse pointer.

Return Value:

Object

The tooltip's text or markup and color.

Default Value: undefined

Cannot be used in themes.

This option should be assigned a function that returns a specific object. The following fields can be specified in this object.

text
Specifies the text displayed by a tooltip. This is an obligatory option. If this option is not specified, the tooltip will not be shown.
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.
color
Specifies the color of a tooltip.
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 access the hovered area or marker. For this purpose, use the object passed as the function's parameter or the this object. To discover the members of the obtained object that can be used, see the Area or Marker class description of the Map Elements reference section.

Colors Customization Demo Tooltip HTML Support Demo

Show Example:

jQuery

enabled

Enables tooltips.

Type:

Boolean

Default Value: false

Show Example:

jQuery

font

Specifies tooltips' font options.

Type:

Object

Show Example:

jQuery

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.

Show Example:

jQuery

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

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.