IChartHeatmapDatum

interface
Chart

Single datum shape consumed from series[0].data in a heatmap chart. Each entry represents one cell in the grid, identified by its column key (x), row key (y), and a numeric value that drives the cell colour.

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.

x
required
number | string
Column key — maps to an X-axis category.
y
required
number | string
Row key — maps to a Y-axis category.
value
required
number
Numeric value driving the cell colour (interpolated between colorRange[0] and colorRange[1]).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Providing cell data for a weekday × hour heatmap

typescript