IChartSankeyLink

interface
Chart

Internal link descriptor for each IChartSankeyDatum after Sankey layout. Carries the rendered SVG cubic Bezier path d attribute, visual metadata and resolved colour. Produced by the Sankey layout engine — not intended for direct consumer use.

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.

index
required
number
Index in the original data array.
from
required
string
Source node name.
to
required
string
Target node name.
value
required
number
Raw numeric flow value.
formatted
required
string
Pre-formatted value string.
d
required
string
Rendered SVG cubic Bezier path string.
color
required
string
Resolved CSS stroke colour string (defaults to source node color).
strokeWidth
required
number
Stroke width in SVG user units.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Internal Sankey link descriptor

typescript