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.

typescript

API

Properties

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

index
required
number
Original index of the data point in series[0].data.
gridX
required
number
Column index from data[i].x.
gridY
required
number
Row index from data[i].y.
points
required
string
SVG points attribute string for the <polygon>.
color
required
string
Resolved CSS colour string.
label
required
string
Tile label (name or formatted value).
name
required
string
Raw name string from the data point.
value
required
number | undefined
Raw value from the data point.
cx
required
number
Centre X in SVG user units.
cy
required
number
Centre Y in SVG user units.
visible
required
boolean
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

typescript