• What is KendoReact
  • Getting Started
  • Server Components
  • Components
    • Animation
    • Barcodes
    • Buttons
    • Chartsupdated
    • Common Utilities
    • Conversational UIupdated
    • Data Gridupdated
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdownsupdated
    • Editor
    • Excel Export
    • File Saver
    • Formupdated
    • Ganttupdated
    • Gauges
    • Indicators
    • Inputsupdated
    • Labels
    • Layoutupdated
    • ListBox
    • ListView
    • Map
    • Notification
    • OrgChartnew
    • PDF Processing
    • PDFViewer
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • Spreadsheetupdated
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeViewupdated
    • Upload
  • Sample Applications
  • Styling & Themes
  • Common Features
  • Project Setup
  • Knowledge Base
  • Changelog
  • Updates
  • Troubleshooting
Components / Charts / API / SankeyLabelDefaults / 

SankeyLabelDefaults

Represents the default label options of the Sankey component. The value will be applied to all labels unless overridden by the nodes label prop of the Sankey data option.

NameTypeDefaultDescription

align?

"center" | "left" | "right"

'left'

The alignment of the label.

border?

{ color?: string; dashType?: string; opacity?: number; width?: number; }

{ width: 0 }

The border of the label.

color?

string

The color of the label.

font?

string

The font of the label.

margin?

{ left?: number; right?: number; }

{ left: 8, right: 8 }

The margin of the label.

offset?

SankeyOffset

{ top: 0, left: 0 }

The offset applied to the label's position.

opacity?

number

1

The opacity of the label.

padding?

number | { bottom?: number; left?: number; right?: number; top?: number; }

0

The padding of the label.

position?

"inside" | "after" | "before"

'inside'

The position of the label.

The supported values are:

  • inside—The label is positioned after the node, except for the nodes at the end of the Sankey, that are placed before the node.
  • before—The label is positioned before the node.
  • after—The label is positioned after the node.

visible?

boolean

true

The visibility of the label.

In this article

Not finding the help you need?

Contact Support