IChartHoneycombTile
interface
Chart
Internal tile descriptor produced by the honeycomb geometry engine. Contains every pre-computed value needed to render one <polygon>, its label, and tooltip / accessibility content.
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.
- indexrequirednumber
- Original index of the data point in series[0].data.
- gridXrequirednumber
- Column index from data[i].x.
- gridYrequirednumber
- Row index from data[i].y.
- pointsrequiredstring
- SVG points attribute string for the <polygon>.
- colorrequiredstring
- Resolved CSS colour string.
- labelrequiredstring
- Tile label (name or formatted value).
- namerequiredstring
- Raw name string from the data point.
- valuerequirednumber | undefined
- Raw value from the data point.
- cxrequirednumber
- Centre X in SVG user units.
- cyrequirednumber
- Centre Y in SVG user units.
- visiblerequiredboolean
- Whether this tile is currently visible (legend toggle).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Accessing tile descriptors from the composable