BuyLog In
DevExtreme
All docs
V 20.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
V20.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
API Reference
UI Components
Accordion
ActionSheet
Autocomplete
BarGauge
Box
Bullet
Button
ButtonGroup
Calendar
Chart
CheckBox
CircularGauge
ColorBox
ContextMenu
DataGrid
DateBox
DeferRendering
Diagram
Draggable
Drawer
DropDownBox
DropDownButton
FileManager
FileUploader
FilterBuilder
Form
Funnel
Gallery
Gantt
HtmlEditorCTP
LinearGauge
List
LoadIndicator
LoadPanel
Lookup
Map
Menu
MultiView
NavBar
NumberBox
PieChart
PivotGrid
PivotGridFieldChooser
PolarChart
Popover
Popup
ProgressBar
RadioGroup
RangeSelector
RangeSlider
Resizable
ResponsiveBox
Sankey
Configuration
adaptiveLayout
alignment
dataSource
disabled
elementAttr
export
hoverEnabled
label
border
customizeText
font
horizontalOffset
overlappingBehavior
shadow
useNodeColors
verticalOffset
visible
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
weightField
Methods
Events
Node
Link
Scheduler
ScrollView
SelectBox
SlideOut
SlideOutView
Slider
Sortable
Sparkline
SpeedDialAction
Switch
TabPanel
Tabs
TagBox
TextArea
TextBox
TileView
Toast
Toolbar
Tooltip
TreeList
TreeMap
TreeView
ValidationGroup
ValidationSummary
Validator
VectorMap
Markup Components
UI Events
CSS Classes
Data Layer
Types
Utilities
Angular
React
Vue
ASP.NET MVC 5
ASP.NET Core
jQuery
UI Components
Data Binding
Common Features
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 - label

Configures sankey nodes' labels.

Type:

Object

See Also

border

Configures the labels' borders.

Type:

Object

customizeText

Customizes the labels' texts.

Type:

Function

Function parameters:
itemInfo:

Node

The Node object.

Return Value:

String

The text to be displayed in a label.

Cannot be used in themes.

NOTE
The this keyword refers to the current label.

font

Specifies the labels' font properties.

Type:

Object

horizontalOffset

Moves the labels horizontally from their initial positions.

Type:

Number

Default Value: 5

The number assigned to this property specifies the shift in pixels. A negative number shifts the labels to the left, a positive number - to the right.

overlappingBehavior

Specifies how to arrange labels when there is insufficient space to display them all.

Type:

String

Default Value: 'ellipsis'
Accepted Values: 'ellipsis' | 'hide' | 'none'

You can set this property to rearrange two overlapping labels. It accepts the following values:

  • "ellipsis"
    Adds ellipsis to one label to leave more space for the other.

  • "hide"
    Hides one label.

  • "none"
    Leaves labels overlapped.

Use the SankeyLabelOverlappingBehavior enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Ellipsis, Hide, and None.

shadow

Configures the labels' shadows.

Type:

Object

useNodeColors

Specifies whether to color labels in the nodes' colors.

Type:

Boolean

Default Value: false

verticalOffset

Moves the labels vertically from their initial positions.

Type:

Number

Default Value: 0

The number assigned to this property specifies the shift in pixels. A negative number shifts the labels to the top, a positive number - to the bottom.

visible

Specifies whether the labels are visible.

Type:

Boolean

Default Value: true