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.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

index
required
number
Original index of the datum in series[0].data.
xCat
required
string
Column category string.
yCat
required
string
Row category string.
value
required
number
Raw numeric value.
color
required
string
Resolved CSS colour string for the cell fill.
rx
required
number
SVG x position (left edge of the rect).
ry
required
number
SVG y position (top edge of the rect).
rw
required
number
Cell width in SVG user units.
rh
required
number
Cell height in SVG user units.
labelX
required
number
Centre X for the value label text.
labelY
required
number
Centre Y for the value label text.
labelFits
required
boolean
true when the cell is tall / wide enough to show the label.
visible
required
boolean
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

vue