Hierarchy · Intermediate

Treemap

Shares of a hierarchy shown as area.

Use when: Two levels of share at once, such as products within categories
Avoid when: Exact size comparison matters

Try it

Reduce motion

Treemap

Product sales share by category

Treemap data
Cushion Run · Running shoes	22 · 22%
Race X · Running shoes	14 · 14%
Daily Run · Running shoes	10 · 10%
Trail · Outdoor	14 · 14%
Hiking boots · Outdoor	10 · 10%
Jacket · Apparel	11 · 11%
T-shirt · Apparel	7 · 7%
Socks · Gear	7 · 7%
Insoles · Gear	5 · 5%

Hover over the chart, or Tab in and use the arrow keys to move between items. The numbers are sample data.

Variants

Named looks for this chart. Each one is the example above with a few options or fields changed. The CLI (ztd-charts example treemap --variant <id>) and the MCP server know the same names.

Names only

Product sales share by category

Values only

Product sales share by category

Code

Treemap.tsx

import { ChartCard, Treemap } from "ztd-charts";

const data = [
  {"category":"Running shoes","product":"Cushion Run","share":22},
  {"category":"Running shoes","product":"Race X","share":14},
  {"category":"Running shoes","product":"Daily Run","share":10},
  {"category":"Outdoor","product":"Trail","share":14},
  {"category":"Outdoor","product":"Hiking boots","share":10},
  {"category":"Apparel","product":"Jacket","share":11},
  // … 3 more rows
];

export function Example() {
  return (
    <ChartCard number="05" title="Treemap" subtitle="Product sales share by category" takeaway="Shares within a hierarchy" level="intermediate" replay>
      <Treemap
        data={data}
        label="product"
        value="share"
        group="category"
      />
    </ChartCard>
  );
}

Props

<Treemap> takes these props. Rows marked Common work the same on every chart.

28 props

SunburstA hierarchy drawn in rings

Prop	Type	Default	Description
`data`RequiredAn array of objects. Pass CSV, REST or database rows as they areobject[]	object[]	-	An array of objects. Pass CSV, REST or database rows as they are
`label`RequiredLeaf (lowest level) namestring \| (d, i) => string	string \| (d, i) => string	-	Leaf (lowest level) name
`value`RequiredValue fieldstring \| (d, i) => number	string \| (d, i) => number	-	Value field
`group`Parent group fieldstring \| (d, i) => string	string \| (d, i) => string	-	Parent group field
`path`Field list for multi-level pathsstring[]	string[]	-	Field list for multi-level paths
`labelMode`What cell labels show"both" \| "name" \| "value" \| "none"Default `"both"`	"both" \| "name" \| "value" \| "none"	"both"	What cell labels show
`sort`Sort largest firstbooleanDefault `true`	boolean	true	Sort largest first
`height`CommonHeight in px. Without it, each chart picks a default that fits its widthnumber	number	-	Height in px. Without it, each chart picks a default that fits its width
`width`CommonFixed width in px. Without it, the chart fits its parentnumber	number	-	Fixed width in px. Without it, the chart fits its parent
`highlight`CommonItem to highlight. An index, a name, an array, or "max" \| "min" \| "first" \| "last" \| "none"number \| string \| (number\|string)[] \| "max" …	number \| string \| (number\|string)[] \| "max" …	-	Item to highlight. An index, a name, an array, or "max" \| "min" \| "first" \| "last" \| "none"
`format`CommonValue format. "number" \| "integer" \| "percent" (values are already percents: 42 → "42%") \| "ratio" (0.42 → "42%") \| "compact" \| "currency" (KRW for Korean locales, otherwise USD; for another currency pass Intl options with currency) \| "decimal" or Intl.NumberFormat options"number" \| "percent" \| "compact" \| …	"number" \| "percent" \| "compact" \| …	-	Value format. "number" \| "integer" \| "percent" (values are already percents: 42 → "42%") \| "ratio" (0.42 → "42%") \| "compact" \| "currency" (KRW for Korean locales, otherwise USD; for another currency pass Intl options with currency) \| "decimal" or Intl.NumberFormat options
`unit`CommonUnit appended to values. For example "%" or "ms"string	string	-	Unit appended to values. For example "%" or "ms"
`locale`CommonLocale for numbers, dates and the text a chart writes itself (tooltips, screen reader sentences). "ko" or "ko-*" switches to Korean. Falls back to the ThemeProvider localestringDefault `"en-US"`	string	"en-US"	Locale for numbers, dates and the text a chart writes itself (tooltips, screen reader sentences). "ko" or "ko-*" switches to Korean. Falls back to the ThemeProvider locale
`animate`CommonEntry and update animationbooleanDefault `true`	boolean	true	Entry and update animation
`duration`CommonAnimation length (ms)number	number	-	Animation length (ms)
`easing`CommonMotion curve"spring" \| "easeOut" \| "easeInOut" \| "linear"Default `"spring"`	"spring" \| "easeOut" \| "easeInOut" \| "linear"	"spring"	Motion curve
`stagger`CommonDelay between items as they enter (ms)number	number	-	Delay between items as they enter (ms)
`reducedMotion`Common"auto" follows the OS setting. true always turns motion offanyDefault `"auto"`	any	"auto"	"auto" follows the OS setting. true always turns motion off
`animateOnView`CommonPlay when the chart scrolls into viewbooleanDefault `true`	boolean	true	Play when the chart scrolls into view
`showLabels`CommonLabels drawn on the chart (values and names)booleanDefault `true`	boolean	true	Labels drawn on the chart (values and names)
`tooltip`CommonShow tooltips. { template: "{label} · {value} · owner {owner}" } writes them: {label}, {value}, {series} or any other column of the row. \n starts a new line, and a line with an empty value is left outtooltipDefault `true`	tooltip	true	Show tooltips. { template: "{label} · {value} · owner {owner}" } writes them: {label}, {value}, {series} or any other column of the row. \n starts a new line, and a line with an empty value is left out
`syncId`CommonCharts with the same syncId show the hovered x together (line, area, bar, candlestick). <ChartGrid sync> sets one for every chart inside itstring	string	-	Charts with the same syncId show the hovered x together (line, area, bar, candlestick). <ChartGrid sync> sets one for every chart inside it
`ariaLabel`CommonName for screen readersstring	string	-	Name for screen readers
`description`CommonDescription for screen readers. Built from the data when omittedstring	string	-	Description for screen readers. Built from the data when omitted
`onHover`CommonRuns when hover or keyboard focus moves to another item(e: ChartEvent \| null) => void	(e: ChartEvent \| null) => void	-	Runs when hover or keyboard focus moves to another item
`onClick`CommonRuns on click, Enter or Space(e: ChartEvent) => void	(e: ChartEvent) => void	-	Runs on click, Enter or Space
`replayKey`CommonReplays the entry animation when it changesstring \| number	string \| number	-	Replays the entry animation when it changes
`theme`CommonChanges theme tokens for this chart onlyPartial<ChartTheme>	Partial<ChartTheme>	-	Changes theme tokens for this chart only

Try it

Variants

Code

Props

Also in Hierarchy