IChartStreamgraphRibbon
interface
Data Visualisation
Pre-computed ribbon descriptor produced by the streamgraph geometry engine for a single series at a single render pass. Contains the resolved SVG path, colour and raw values for tooltip display.
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.
- seriesIndexrequirednumber
- Index of the series in the original series array.
- namerequiredstring
- Display name from series[i].name.
- colorrequiredstring
- Resolved CSS colour string for this ribbon.
- drequiredstring
- SVG <path d="…"> — top path forward + bottom path reverse, forming a closed ribbon shape.
- visiblerequiredboolean
- Whether this ribbon is currently toggled visible via the legend.
- valuesrequiredArray<number>
- Raw data values at each X position, used for tooltip breakdown display.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Consuming IChartStreamgraphRibbon in a custom tooltip