IChartSankeyProps
interface
Chart
Props for <OrigamChartSankey>. The component consumes series[0] only — each item in series[0].data must conform to IChartSankeyDatum ({ from, to, value }). Nodes are inferred automatically; columns are assigned by topological depth. Extends IChartBaseProps.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- nodeWidthnumber
- Width of each node rectangle in SVG pixels. Default 16.
- nodePaddingnumber
- Minimum vertical gap between sibling nodes within the same column, in SVG pixels. Default 8.
- linkOpacitynumber
- Opacity of the flow ribbons (links). Range [0, 1]. Default 0.4.
- showLabelboolean
- Whether to render node labels. Left-column nodes are right-aligned outside their rect; right-column nodes are left-aligned outside. Default true.
- xAxisFormat(value: number | string) => string
- X-axis / value formatter applied to node labels and tooltip values. When omitted the raw number is displayed.
- yAxisFormat(value: number) => string
- Y-axis formatter — alias kept for API symmetry with other families. Same as xAxisFormat for this geometry.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Sankey diagram showing energy flows