IChartStreamgraphProps
interface
Data Visualisation
Props for OrigamChartStreamgraph. Multiple series are rendered as continuous flowing ribbons stacked over time on the X axis. The baseline offset algorithm is controlled by offsetMode: wiggle (canonical streamgraph), silhouette, expand, or zero.
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.
- offsetModeTChartStreamgraphOffset'wiggle'
- Baseline offset algorithm. 'wiggle' — Byron-Wattenberg: centred baseline minimising total slope change (canonical). 'silhouette' — centred at half total stack. 'expand' — normalised to 100% height. 'zero' — traditional stacked area.
- smoothing'none' | 'curve''curve'
- Path interpolation. 'curve' applies Catmull-Rom smoothing on each ribbon's top and bottom polylines. 'none' uses straight linear segments.
- showAxisbooleantrue
- Toggle the X / Y axis guides.
- showGridbooleanfalse
- Toggle background grid lines.
- xAxisFormat(value: string | number) => string
- Formatter applied to each X-axis category label.
- yAxisFormat(value: number) => string
- Formatter applied to Y-axis tick labels.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Streamgraph with percent-normalised expand mode