IChartPoint
interface
Chart
Hover / click payload bubbled by <OrigamChart> whenever a data point is interacted with. Fields are denormalised — the consumer does not need to re-look-up the series or resolve the colour from the palette.
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 props.series.
- seriesNamerequiredstring
- Series name (mirrors IChartSeries.name).
- dataIndexrequirednumber
- Index of the data point inside the series.
- xrequirednumber | string
- X coordinate (number or category string).
- yrequirednumber
- Y value.
- colorrequiredstring
- Resolved CSS colour string (intent → token → CSS or raw).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Handling the point-click emit