IChartSankeyNode

interface
Chart

Internal node descriptor produced by the Sankey layout engine. All coordinates are in SVG-user-unit space. Nodes are inferred from the union of all from and to strings in IChartSankeyDatum; column is assigned by topological depth (Kahn's algorithm).

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.

name
required
string
Unique node name (inferred from from / to values).
column
required
number
Column index (0-based topological depth).
value
required
number
Total flow value (max of incoming and outgoing sums).
formatted
required
string
Pre-formatted value string.
color
required
string
Resolved CSS colour string.
x
required
number
SVG x coordinate of the node rect's left edge.
y
required
number
SVG y coordinate of the node rect's top edge.
height
required
number
Node rect height in SVG user units, proportional to value.
outgoingOffset
required
number
Accumulated outgoing y offset (used during link placement).
incomingOffset
required
number
Accumulated incoming y offset (used during link placement).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Internal Sankey node descriptor

typescript