New to Kendo UI for Vue? Start a free 30-day trial

Sankey

Component

Definition

Package:@progress/kendo-vue-charts

Properties Interface:SankeyProps

Syntax:

vue
<Sankey :data-nodes="nodes" :data-links="links" />

Properties

Sets the links between the Sankey nodes.

Example:
vue
<Sankey :data-nodes="nodes" :data-links="[{ sourceId: 1, targetId: 2, value: 40 }]" />

Sets the nodes of the Sankey.

Example:
vue
<Sankey :data-nodes="[{ id: 1, label: { text: 'Income' } }, { id: 2, label: { text: 'Savings' } }]" :data-links="links" />

dir?

string

Sets the dir HTML attribute of the Sankey. Use rtl to render the Sankey from right to left.

Example:
vue
<Sankey :dir="'rtl'" />

When set to true, the Sankey does not arrange its nodes automatically (see example).

Example:
vue
<Sankey :disable-auto-layout="true" />

When set to true, the Sankey turns off its keyboard navigation (see example).

Example:
vue
<Sankey :disable-keyboard-navigation="true" />

Sets the default options of the Sankey labels. The Sankey applies them to all labels unless the label of a node in dataNodes overrides them.

Example:
vue
<Sankey :labels="{ visible: true, font: '14px sans-serif' }" />

Sets the legend of the Sankey (see example).

Example:
vue
<Sankey :legend="{ position: 'bottom' }" />

Sets the default options of the Sankey links. The Sankey applies them to all links unless a link in dataLinks overrides them.

Example:
vue
<Sankey :links="{ colorType: 'source', opacity: 0.5 }" />

Sets the default options of the Sankey nodes. The Sankey applies them to all nodes unless a node in dataNodes overrides them.

Example:
vue
<Sankey :nodes="{ width: 20, padding: 10 }" />

onLinkclick?

(event: SankeyEvent) => void

Fires when the user clicks a link.

Parameters:eventSankeyEvent
Example:
vue
<Sankey @linkclick="handleLinkClick" />

onLinkenter?

(event: SankeyEvent) => void

Fires when the mouse pointer enters a link. It works like the mouseenter event.

Parameters:eventSankeyEvent
Example:
vue
<Sankey @linkenter="handleLinkEnter" />

onLinkleave?

(event: SankeyEvent) => void

Fires when the mouse pointer leaves a link. It works like the mouseleave event.

Parameters:eventSankeyEvent
Example:
vue
<Sankey @linkleave="handleLinkLeave" />

onNodeclick?

(event: SankeyEvent) => void

Fires when the user clicks a node.

Parameters:eventSankeyEvent
Example:
vue
<Sankey @nodeclick="handleNodeClick" />

onNodeenter?

(event: SankeyEvent) => void

Fires when the mouse pointer enters a node. It works like the mouseenter event.

Parameters:eventSankeyEvent
Example:
vue
<Sankey @nodeenter="handleNodeEnter" />

onNodeleave?

(event: SankeyEvent) => void

Fires when the mouse pointer leaves a node. It works like the mouseleave event.

Parameters:eventSankeyEvent
Example:
vue
<Sankey @nodeleave="handleNodeLeave" />

Sets the title of the Sankey (see example).

Example:
vue
<Sankey :title="{ text: 'Energy Flow' }" />

Sets the tooltips of the Sankey (see example).

Example:
vue
<Sankey :tooltip="{ visible: true, offset: 20 }" />