IChartSankeySlots

interface
Chart

Slot signatures exposed by <OrigamChartSankey>. Extends IChartBaseSlots with a node-label slot that replaces the label rendered beside each node, receiving the node name, value, formatted value, resolved colour and column index.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

'node-label'
(bindings: { name: string value: number formatted: string color: string column: number }) => any
Replace the label rendered beside each node. Receives the node name, raw value, formatted value, resolved colour and column index.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Custom node label on a Sankey diagram

vue