BuyLog In
DevExtreme
All docs
V 24.1
24.2
24.1
23.2
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
19.1
18.2
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
All docs
V24.1

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
24.2
24.1
23.2
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
19.1
18.2
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
Full-text search
Overview
Getting Started
UI Components
Accordion
ActionSheet
Autocomplete
BarGauge
Box
Bullet
Button
ButtonGroup
Calendar
Chart
CheckBox
CircularGauge
ColorBox
ContextMenu
DataGrid
DateBox
DateRangeBox
DeferRendering
Diagram
Draggable
Drawer
DropDownBox
DropDownButton
FileManager
FileUploader
FilterBuilder
Floating Action Button
Form
Funnel
Gallery
Gantt
HtmlEditor
LinearGauge
List
LoadIndicator
LoadPanel
Lookup
Map
Menu
MultiView
NumberBox
PieChart
PivotGrid
PivotGridFieldChooser
PolarChart
Popover
Popup
ProgressBar
RadioGroup
RangeSelector
RangeSlider
Resizable
ResponsiveBox
Sankey
Overview
How To
API
Configuration
adaptiveLayout
alignment
dataSource
disabled
elementAttr
export
hoverEnabled
label
link
loadingIndicator
margin
node
onDisposing
onDrawn
onExported
onExporting
onFileSaving
onIncidentOccurred
onInitialized
onLinkClick
onLinkHoverChanged
onNodeClick
onNodeHoverChanged
onOptionChanged
palette
paletteExtensionMode
pathModified
redrawOnResize
rtlEnabled
size
sortData
sourceField
targetField
theme
title
tooltip
arrowLength
border
color
container
cornerRadius
customizeLinkTooltip
customizeNodeTooltip
enabled
font
format
linkTooltipTemplate
nodeTooltipTemplate
opacity
paddingLeftRight
paddingTopBottom
shadow
zIndex
weightField
Methods
Events
Node
Link
Types
Demos
Scheduler
ScrollView
SelectBox
Slider
Sortable
Sparkline
Splitter
Switch
TabPanel
Tabs
TagBox
TextArea
TextBox
TileView
Toast
Toolbar
Tooltip
TreeList
TreeMap
TreeView
VectorMap
Common Types
Utilities
Data Binding
Data Validation
TypeScript Guides
Localization and Globalization
UI Customization
Integration Guides
DevExtreme CLI
Data Analytics and BI
.NET Backend Solutions
Advanced Topics
Troubleshooting
Migrate to the New Version

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery Sankey - tooltip

Type:

Tooltip

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

|

HTMLElement | jQuery

Default Value: undefined

cornerRadius

Makes all the tooltip's corners rounded.

Type:

Number

Default Value: 0, 4 (Fluent, 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
weight

Number

The link's weight.
target

String

The title of the link's target node.
source

String

The title of the link's source node.
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
weightOut

Number

The total weight of the node's outgoing links.
weightIn

Number

The total weight of the node's incoming links.
title

String

Use 'label' instead.

The node's label.
label

String

The node's label.
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

Specifies whether the tooltip is enabled.

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

linkTooltipTemplate

Specifies a custom template for a link's tooltip.

Type:

template

Template Data:
Name Type Description
weight

Number

The link's weight.
target

String

The label of the link's target node.
source

String

The label of the link's source node.
Default Name: undefined

nodeTooltipTemplate

Specifies a custom template for a node's tooltip.

Type:

template

Template Data:
Name Type Description
weightOut

Number

The total weight of the node's outgoing links.
weightIn

Number

The total weight of the node's incoming links.
label

String

The node's label.
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.