JavaScript/jQuery Sankey - tooltip

arrowLength

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

Type:

Default Value: 10

border

Configures a tooltip's border.

Type:

color

Colors all tooltips.

Type:

Default Value: '#ffffff'

This property supports the following colors:

Hexadecimal colors
RGB colors
RGBA colors
Predefined/cross-browser color names
Predefined SVG colors
Paint server address

This property 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:

HTMLElement | jQuery

Default Value: undefined

cornerRadius

Makes all the tooltip's corners rounded.

Type:

Default Value: 0, 4 (Material)

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

cornerRadius	Result
`cornerRadius: 0`
`cornerRadius: 15`
`cornerRadius: 35`

customizeLinkTooltip

Customizes link tooltips' appearance.

Type:

Function

Function parameters:

info:

Information about a sankey link being pressed or hovered over.

Object structure:

Name	Type	Description
source	String	The title of the link's source node.
target	String	The title of the link's target node.
weight	Number	The link's weight.

Name

Type

Description

source

The title of the link's source node.

target

The title of the link's target node.

weight

The link's weight.

Return Value:

The current tooltip's text or markup and appearance settings.

Default Value: undefined

This property 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. The Sankey evaluates the markup. Make sure that it does not contain malicious code. Refer to the following help topic for more information: Potentially Vulnerable API - customizeTooltip. 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.

View Demo

customizeNodeTooltip

Customizes node tooltips' appearance.

Type:

Function

Function parameters:

info:

Information about a sankey node being pressed or hovered over.

Object structure:

Name	Type	Description
label	String	The node's label.
title	String	Use 'label' instead. The node's label.
weightIn	Number	The total weight of the node's incoming links.
weightOut	Number	The total weight of the node's outgoing links.

Return Value:

The tooltip's text or markup and appearance settings.

Default Value: undefined

This property 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. The Sankey evaluates the markup. Make sure that it does not contain malicious code. Refer to the following help topic for more information: Potentially Vulnerable API - customizeTooltip. 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.

enabled

Enables tooltips.

Type:

Boolean

Default Value: true

font

Specifies tooltips' font properties.

Type:

format

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

Type:

Format

Default Value: undefined

See the format section for information on accepted values.

linkTooltipTemplate

Specifies a custom template for a link's tooltip.

Type:

template

Template Data:

Name	Type	Description
source	String	The label of the link's source node.
target	String	The label of the link's target node.
weight	Number	The link's weight.

Name

Type

Description

source

The label of the link's source node.

target

The label of the link's target node.

weight

The link's weight.

Default Name: undefined

nodeTooltipTemplate

Specifies a custom template for a node's tooltip.

Type:

template

Template Data:

Name

Type

Description

label

The node's label.

weightIn

The total weight of the node's incoming links.

weightOut

The total weight of the node's outgoing links.

Default Name: undefined

opacity

Specifies tooltips' transparency.

Type:

Default Value: undefined

This property 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:

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:

Default Value: 15

DevExtreme HTML5 JavaScript Funnel Tooltips Top-Bottom Padding

shadow

Configures a tooltip's shadow.

Type:

zIndex

Specifies a tooltip's z-index.

Type: