JavaScript/jQuery Sankey - tooltip

Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component 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 property supports the following colors:

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:

String

|

Element

|

jQuery

Default Value: undefined

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

customizeLinkTooltip

Customizes link tooltips' appearance.

Type:

Function

Function parameters:
info:

Object

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.
Return Value:

Object

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:

Object

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:

Object

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:

Object

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.

See Also

linkTooltipComponent

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

linkTooltipRender

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

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.
Default Name: undefined

nodeTooltipComponent

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

nodeTooltipRender

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

nodeTooltipTemplate

Specifies a custom template for a node's tooltip.

Type:

template

Template Data:
Name Type Description
label

String

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.
Default Name: undefined

opacity

Specifies tooltips' transparency.

Type:

Number

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:

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 UI component's container has the CSS z-index property specified, and tooltips are displayed incorrectly, configure their z-index using this property.