IChartHeatmapCell
interface
Chart
Pre-computed cell descriptor produced by the heatmap geometry engine. Contains every pre-computed value needed to render one <rect>, its label, and tooltip / accessibility content — the SFC renders without arithmetic.
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 datum in series[0].data.
- xCatrequiredstring
- Column category string.
- yCatrequiredstring
- Row category string.
- valuerequirednumber
- Raw numeric value.
- colorrequiredstring
- Resolved CSS colour string for the cell fill.
- rxrequirednumber
- SVG x position (left edge of the rect).
- ryrequirednumber
- SVG y position (top edge of the rect).
- rwrequirednumber
- Cell width in SVG user units.
- rhrequirednumber
- Cell height in SVG user units.
- labelXrequirednumber
- Centre X for the value label text.
- labelYrequirednumber
- Centre Y for the value label text.
- labelFitsrequiredboolean
- true when the cell is tall / wide enough to show the label.
- visiblerequiredboolean
- Whether this cell is currently visible.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Reading cell geometry in a custom heatmap tooltip