tooltip

Configures tooltips - small pop-up rectangles that display information about a data-visualizing widget element being pressed or hovered over with the mouse pointer.

Type:

Object

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

|

DOM Node

|

jQuery

Default Value: undefined

customizeTooltip

Customizes a specific tooltip's appearance.

Type:

function

Function parameters:
info:

Object

Information on the funnel item being pressed or hovered over with the mouse pointer.

Object structure:

The Item object.

value:

Number

The raw item value.

valueText:

String

The item's formatted value converted to a string.

percent:

Number

The item's percentage value.

percentText:

String

The item's formatted percentage value converted to a string.

Return Value:

Object

The tooltip's text or markup and appearance settings.

Default Value: undefined

Set this option to a function that returns an object with the following fields:

  • color
    Colors the tooltip.

  • text
    Specifies the tooltip's text.

  • html
    Specifies the HTML markup the tooltip displays.

    NOTE
    If you are going to use external resources (for example, images) in the markup, specify the size of the area they occupy beforehand.
  • fontColor
    Colors the tooltip's text.

  • borderColor
    Colors the tooltip's border.

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

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

precision

Deprecated

Use the tooltip.format.precision option instead.

Specifies the precision of formatted values in a tooltip.

Type:

Number

Default Value: undefined

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.