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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- indexrequirednumber
- Index in the original data array.
- fromrequiredstring
- Source node name.
- torequiredstring
- Target node name.
- valuerequirednumber
- Raw numeric flow value.
- formattedrequiredstring
- Pre-formatted value string.
- drequiredstring
- Rendered SVG cubic Bezier path string.
- colorrequiredstring
- Resolved CSS stroke colour string (defaults to source node color).
- strokeWidthrequirednumber
- 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