IChartSankeyDatum

interface
Chart

A single flow datum in the Sankey series. from and to are node name strings — nodes are inferred automatically from the full set of unique names. value must be >= 0. An optional color override accepts a TIntent token or raw CSS colour.

TypeScript

Definition

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

typescript

API

Properties

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

from
required
string
Source node name.
to
required
string
Target node name.
value
required
number
Flow magnitude. Must be >= 0.
color
TIntent | string
Optional per-link colour override. Accepts a design-system intent token or any raw CSS colour string. When absent the source node's colour is used.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Defining flow data for a Sankey diagram

typescript