references/diagrams/treemap.md
Treemap Diagram
Back to Style Guide — Read the style guide first for emoji, color, and accessibility rules.
Syntax keyword: treemap-beta
Tested Mermaid version: 12.0.0; check support on older hosts
Best for: Hierarchical data proportions, budget breakdowns, disk usage, portfolio composition
When NOT to use: Simple flat proportions (use Pie), flow-based hierarchy (use Sankey)
Accessibility: Mermaid 12.0.0 emits
accTitle/accDescrfor this type. Keep a visible description and verify older destination renderers.⚠️ GitHub support: Treemap remains experimental — verify it renders on the target host before using.
Exemplar Diagram
Treemap showing annual cloud infrastructure costs broken down by service category and specific service, with rectangle sizes proportional to spend:
treemap-beta
accTitle: Treemap Example
accDescr: Illustrative treemap diagram; the surrounding text describes its data and relationships.
"Compute"
"EC2 Instances": 45000
"Lambda Functions": 12000
"ECS Containers": 8000
"Storage"
"S3 Buckets": 18000
"RDS Databases": 15000
"DynamoDB": 6000
"Networking"
"CloudFront CDN": 9000
"API Gateway": 7000
"Observability"
"CloudWatch": 5000
"Datadog": 8000
Tips
- Parent nodes (sections) use quoted text:
"Section Name" - Leaf nodes add a value:
"Leaf Name": 123 - Hierarchy is created by indentation (spaces or tabs)
- Use nonnegative values with a common unit and defined denominator. Rectangle area encodes the value; it does not display uncertainty
- Keep to 2–3 levels of nesting for clarity
- Use
classDefand:::classsyntax for styling nodes - Always pair with a Markdown text description above for screen readers
Template
Description of the hierarchical data and what the proportions represent:
treemap-beta
accTitle: Treemap Example
accDescr: Illustrative treemap diagram; the surrounding text describes its data and relationships.
"Category A"
"Sub A1": 40
"Sub A2": 25
"Category B"
"Sub B1": 20
"Sub B2": 15
Verified reference
Syntax examples reviewed against official Mermaid documentation and rendered with Mermaid 12.0.0 (2026-10-01). Check the destination version; appearance and accessibility are not guaranteed by a successful parse.