IChartTreemapDatum

interface
Data Visualisation

A single data item for the treemap series. Consumed from series[0].data — each item becomes one tile sized proportionally to its value. The optional color overrides the palette entry for that specific tile. children is reserved for future nested drilldown support and is ignored in v1.

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.

name
required
string
Tile display label shown inside the tile and in the tooltip.
value
required
number
Numeric magnitude that drives the tile area. Must be ≥ 0.
color
TIntent | string
Optional per-tile colour override. Accepts a design-system intent token or any raw CSS colour string.
children
Array<IChartTreemapDatum>
Reserved for future nested / drilldown support. Currently unused — v1 renders a flat single-level treemap only.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Flat treemap dataset with per-tile colour overrides

typescript