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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- namerequiredstring
- Unique node name (inferred from from / to values).
- columnrequirednumber
- Column index (0-based topological depth).
- valuerequirednumber
- Total flow value (max of incoming and outgoing sums).
- formattedrequiredstring
- Pre-formatted value string.
- colorrequiredstring
- Resolved CSS colour string.
- xrequirednumber
- SVG x coordinate of the node rect's left edge.
- yrequirednumber
- SVG y coordinate of the node rect's top edge.
- heightrequirednumber
- Node rect height in SVG user units, proportional to value.
- outgoingOffsetrequirednumber
- Accumulated outgoing y offset (used during link placement).
- incomingOffsetrequirednumber
- 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