---
id: "packages/active-charts/all-exports/treemap-chart"
title: "TreemapChart"
description: "TreemapChart, TreemapChartProps: generated from the source of active-charts."
url: "/packages/active-charts/all-exports/treemap-chart"
locale: "en"
revision: "g0mvjxwj5c-88bdbe1c:treemap-chart"
---

# TreemapChart

Exported by `@workspace/active-charts`. Generated from the package source; part of [the index of every export](/packages/active-charts/all-exports).

## `TreemapChart`

| Prop | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | `HierarchyNode<TExtra>` | yes | Root hierarchy node. Children are nested arbitrarily deep. |
| `height` | `number` | yes | Container height in pixels. Width is always responsive. |
| `accessibility` | `StandaloneAccessibilityOptions` | no | Accessible name, description, data table and keyboard navigation. No `announcements`: it switches `<Chart>`'s interaction announcements, which this family does not make. |
| `animation` | `StandaloneAnimationOption<"type">` | no | The entrance: on, off, `duration`, `easing` and the family's entrance `type` (ADR-082, LAB-AT17). |
| `className` | `string` | no | Optional className applied to the outer container. |
| `colorMeasure` | `ColorMeasureOptions` | no | Colour the tiles by a measure (T5): each leaf's own `colorValue` through one scale over the whole tree, with a colour key, while `value` keeps sizing it. Opt-in; without it every branch keeps its colour. The group headers keep their branch colours; a tile without a colour value is drawn in a neutral "no value" paint. See {@link ColorMeasureOptions}. |
| `colors` | `string[]` | no | Categorical palette for this chart only: replaces the host palette (`--chart-1` … `--chart-10`) in the chart's colour assignment, and nothing else. It is a data encoding, not a theme: surfaces, text, grid and semantic roles keep coming from the CSS token contract, and a series, datum or annotation that sets its own colour keeps it. Any CSS colour string (a public token reference such as `var(--chart-3)`, hex, oklch). |
| `contextMenu` | `FeatureOption<ChartContextMenuOptions<HierarchyElement<TExtra>, "copy" \| "export">>` | no | The context menu. Opened on a node, the host's builder receives a typed {@link HierarchyElement} (`node`, `depth`, `path`; the deepest node under the pointer) as `context.target.element`. |
| `defaultSelectedItems` | `readonly ChartItemRef[]` | no | The initial selection of an uncontrolled chart. |
| `dir` | `"ltr" \| "rtl"` | no | The chart's UI direction: the reading direction of its HTML text and chrome (tooltip, legend, menus, the accessible table), and the direction the context menu carries under `<body>`.  Left out, the chart inherits the direction of the page around it (the nearest `dir` attribute, else the computed CSS direction) and follows a later change of that attribute. It is never inferred from `locale`, and it never reverses an axis or reorders data: `reversed` stays an explicit axis choice. Under `rtl` the chrome mirrors (legend flow, tooltip side, context menu and submenus, report text in exports), a title-like label starts at the inline start, and a label placed by geometry (an axis tick, a slice or bar label) keeps its physical side; plot arrow keys stay spatial while legend and menu arrows follow the reading direction. |
| `drilldown` | `boolean` | no | Enable click-to-zoom drilldown into child nodes. Default: false. |
| `events` | `(Omit<ChartEvents, "onLegendChange" \| "onZoomChange"> & ChartSelectionEvents<HierarchyNode<TExtra>, ChartNodeItem<HierarchyNode<TExtra>>>)` | no | The chart's events, and the selection events (T8): an item is a LEAF, named by its `id` (`{kind: 'node', id}`); a group is structure and keeps its header's drilldown. A leaf without an `id` is activated but never selected. |
| `label` | `HierarchyLabelOptions` | no | The label policy (T6): a tile's second line (`secondary`, default `'share'`: its share of the shown total; `'value'`: its value in `valueSemantics`; `'none'`) and the levels whose group headers and tiles draw text (`levels`, counted from the shown root). Visual only: the tooltip, the table and the announcements keep every name and value. See {@link HierarchyLabelOptions}. |
| `locale` | `ValuePresentation` | no | Presentation input for axis labels, tooltips, labels and accessibility announcements: a locale code (notation follows the language), or a presentation-context object (`{languageLocale, dateShape?, dateFormat?, timeFormat?, numberFormat?, currencyDisplay?}`) carrying language and notation independently. `dateShape` is the normal human date shape a plain date consumer inherits; an axis that declares its own preset for readability keeps it. Forwarded untouched to the central `@workspace/active-format`; the package never resolves tenant or application settings itself. When omitted, `<ChartDefaults>` supplies it; with neither, the chart throws a configuration error (no `'en'` fallback, active-format D14). Object inputs must be referentially stable across renders. |
| `onAnimationComplete` | `((event: AnimationCompleteEvent) => void)` | no | Fired when a chart animation completes. - `'load'`: initial mount animation finished (or immediately if animation disabled / prefers-reduced-motion is active). - `'update'`: data-update transition finished.  Not triggered by zoom animations (use `onZoomChange`) or tooltip fades. |
| `onExportComplete` | `((result: ChartExportResult) => void)` | no | Fired after a successful export action (PNG/SVG/CSV/PDF), including from the context menu and from imperative `ChartHandle` calls. |
| `onExportError` | `((format: ChartExportFormat, error: unknown) => void)` | no | Fired when an export could not produce its file (W11), from the handle as well as from the context menu. Without it a failed context-menu export is reported as an error diagnostic (`<ChartDefaults diagnostics>`). |
| `onItemActivate` | `((item: ChartNodeItem<HierarchyNode<TExtra>>, source: ChartInteractionSource) => void)` | no | Fired when the reader activates an item: a click or tap on it, or `Enter` on the focused item (`Shift+Enter` on a sankey, whose `Enter` moves between nodes and links). With a handler, `Enter` activates instead of opening the context menu (`Shift+F10` and the context-menu key still open it). |
| `onReady` | `(() => void)` | no | Fired exactly once per chart instance, after the first successful mount with valid dimensions and **before** any entrance animation starts. "Ready" means: the SVG is in the DOM, layout has run with real dimensions, and the chart can be queried by integration tests.  Distinct from {@link onAnimationComplete} with `type: 'load'`, which fires *after* the load animation finishes. A chart with `animation={false}` still fires `onReady` — animation state has no effect on readiness.  A new React `key` on the host produces a new component instance and `onReady` fires again. Identity changes of the callback itself after the first fire are ignored (latch is per-instance).  **Consumer requirement — stable from first render.** The latch closes on the first effect run regardless of whether `onReady` was defined at that moment. If `onReady` is initially `undefined` and later resolves to a function, the callback will **never** fire — the latch has already closed with a no-op. Pass a stable reference (typically via `useCallback`) or pass the final function unconditionally from the first render. |
| `onSelectionChange` | `((selection: ChartItemRef[], change: ChartSelectionChange<HierarchyNode<TExtra>, ChartNodeItem<HierarchyNode<TExtra>>>) => void)` | no | Fired when the reader changes the selection (pointer, touch or keyboard), and when an uncontrolled selection drops items the data no longer contains. `selection` is the complete selection the change makes; it keeps every reference the selection held, of whatever form. On a controlled chart it is a proposal (`change.requested: true`), computed from the current `selectedItems` and never from an earlier proposal; the host applies it, changes it or ignores it. |
| `padding` | `number` | no | Padding between cells in pixels. Default: 2. |
| `paddingOuter` | `number` | no | Padding around parent groups in pixels. Default: 1. |
| `ref` | `Ref<ChartExportHandle>` | no | Imperative handle: exports and element access. A family built on this type has no data-range zoom, so its handle has no `setZoom`. Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). |
| `selectedItems` | `readonly ChartItemRef[]` | no | The selection, controlled by the host. The chart draws, announces and lists the items it resolves to and never changes it; the host updates it from `onSelectionChange`. A request the host applies is announced when the host passes it back; one it ignores is never announced. A reference to an item that is hidden, zoomed or drilled out of view, or not in the data stays in the host's selection and is not shown as selected. |
| `selection` | `FeatureOption<Omit<ChartSelectionOptions, "itemKey">>` | no | Item selection. `true` = single selection keyed by the default key. |
| `t` | `ChartTranslateFn` | no | The host translator for every text the chart shows or announces. When omitted, `<ChartDefaults>` supplies it; with neither, the chart throws a configuration error (no English fallback, ADR-028). |
| `tooltip` | `StandaloneTooltipOption<never>` | no | Tooltip of the node under the pointer: `enabled`, `renderer`, `valueFormatter` and `style` (ADR-082, LAB-AT17). |
| `valueSemantics` | `ChartValueSemantics` | no | What the node values mean (BC1): unit and precision, declared once with the type the Cartesian charts read (`ChartValueSemantics`). The tooltip, the data table and the announcement write a node's value in it; `tooltip.valueFormatter` still wins in the tooltip. A tile shows its share of the shown total, which stays a percentage. Without a declaration the chart presentation's number applies. CSV and Copy value keep the raw number. |
| `width` | `number` | no | Optional fixed width in pixels. Default: fill container. |

## Types

**TreemapChartProps**

```ts
interface TreemapChartProps<
  TExtra extends Record<string, unknown> = Record<string, unknown>,
>
  extends
    Omit<HierarchicalChartProps<TExtra>, 'events'>,
    ChartSelectionProps<
      HierarchyNode<TExtra>,
      ChartNodeItem<HierarchyNode<TExtra>>,
      Omit<ChartSelectionOptions, 'itemKey'>
    > {
  events?: NonNullable<HierarchicalChartProps<TExtra>['events']> &
    ChartSelectionEvents<
      HierarchyNode<TExtra>,
      ChartNodeItem<HierarchyNode<TExtra>>
    >;
  padding?: number;
  paddingOuter?: number;
  drilldown?: boolean;
  colorMeasure?: ColorMeasureOptions;
  valueSemantics?: ChartValueSemantics;
  label?: HierarchyLabelOptions;
}
```

Props for {@link TreemapChart}. Extends {@link HierarchicalChartProps} for
the wrapper contract (context-driven defaults via `<ChartDefaults>`,
unified event model, colors/accessibility propagation). Chart-specific
fields (`padding`, `paddingOuter`, `drilldown`) remain on this interface.

The `animation` prop drives the entrance animation (default `morph-in`);
there are no hover transitions. The global media query in
`accessibility.css` honours `prefers-reduced-motion` as defense in depth.