Treemap chart

chart.treemap

ProductionBounded custom (Class B)Deterministicstrictmoderatev1.0.0

No network

Overview

Render deterministic strict-tree Treemaps whose values live only on leaves, internal totals reconcile exactly, and unreadably small leaves refuse instead of inflating. svg is a complete static, script-free chart. Mark highlight, the dotted guide, and the value panel are not in that SVG, and entry motion, focus, and updates stay inactive there. Pass the entire output.behavior.artifact unchanged to SquillifyChartRuntime.mount(container, artifact, options), then call the returned handle's replay() once to play the entry. A later value change uses update(nextArtifact, {intent}). Injecting svg directly leaves hover and motion off. Interaction is on by default for every host chart: after mount, pointer and keyboard focus open the value panel and the dotted guide. Set behavior.interaction.enabled to false to turn that off. motion.preset accepts only the family's entrance.

Hierarchical totals and area fidelity require one audited pipeline.

Reliability

Internal totals reconcile exactly and every area remains faithful.

Context footprint

CHART_CAPACITY_EXCEEDED means a faithful leaf is unreadable; enlarge the canvas or reduce leaves. CHART_OUTPUT_TOO_LARGE means estimated SVG bytes exceed the bound; reduce nodes or render to file. CHART_THEME_UNKNOWN means the theme is not registered; choose a published theme. CHART_DATA_SHAPE_INVALID means the tree or totals are inconsistent; correct the witnessed nodes. CHART_UNSAFE_OUTPUT means SVG safety validation failed; remove unsafe content. CHART_OUTPUT_TOO_COMPLEX means the mark budget was exceeded; simplify your tree. A successful call costs 4 execution credits.

When to use it

When positive values occur only at strict-tree leaves.

When hierarchy is a DAG or tiny leaves must be aggregated.

Scope

Note

Strict-tree exact hierarchical area partitions.

Non-goals

DAGs
Zoom
Top-N/Other
Circle packing
Area inflation

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

generationimage-processing

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call4 credits

File handling

Accepts file_refProduces file_refMax input976.6 KB

How we handle your data

Sensitive output possible

What this means

This skill may receive sensitive content and may return submitted, transformed, extracted, or reformatted content.

Squillify guarantees

Runs inside Squillify
This skill runs inside Squillify.
Payloads are not sent to an external service by this skill.
Squillify does not permanently store submitted payloads.
Telemetry records metadata only, not submitted content.
Submitted payloads are not used for training.
Submitted payloads are not reviewed by humans.
This skill does not target sensitive data.
The response may contain submitted or transformed content.

Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

Field	Type	Required	Description
nodes	array	Yes	Array of 2..500 objects with id, optional parentId, label, positive exact value on leaves only, and optional assertedValue, meaning and order. Internal nodes omit value.
layoutAlgorithm	string	No	squarified\|sliceDice; defaults to squarified when omitted.
order	string	No	input\|valueAsc\|valueDesc; defaults to input when omitted.
sliceDiceStart	string	No	horizontal\|vertical for sliceDice; defaults to horizontal when omitted.
parentPadding	integer	No	Parent inset in 0..16 design pixels; defaults to 4 when omitted.
leafGap	integer	No	Leaf gap in 0..16 design pixels; defaults to 1 when omitted.
labels	object	No	Optional object with showParents boolean and leafLabel label\|value\|labelAndValue\|none; defaults showParents=true and leafLabel=label.
title	string	No	Bounded title; omission renders no title.
subtitle	string	No	Bounded subtitle; omission renders no subtitle.
behavior	object	No	Object with motion and interaction properties; defaults to disabled when omitted. svg is a complete static, script-free chart. Mark highlight, the dotted guide, and the value panel are not in that SVG, and entry motion, focus, and updates stay inactive there. Pass the entire output.behavior.artifact unchanged to SquillifyChartRuntime.mount(container, artifact, options), then call the returned handle's replay() once to play the entry. A later value change uses update(nextArtifact, {intent}). Injecting svg directly leaves hover and motion off. Interaction is on by default for every host chart: after mount, pointer and keyboard focus open the value panel and the dotted guide. Set behavior.interaction.enabled to false to turn that off. motion.preset accepts only the family's entrance.
width	integer	No	Canvas width in pixels, 100..1600 (optional; default 800). Outside that range the request is refused as invalid input rather than clamped. The ceiling is the size a chart is read at — a full-HD dashboard or a report page; beyond it the canvas stops being what limits how much fits, and type sized for the canvas is illegible once the export is displayed smaller. It applies per side, so a tall portrait canvas for a long horizontal ranking is allowed.
height	integer	No	Canvas height in pixels, 160..1600 (optional; default 500). Outside that range the request is refused as invalid input rather than clamped. The ceiling is the size a chart is read at — a full-HD dashboard or a report page; beyond it the canvas stops being what limits how much fits, and type sized for the canvas is illegible once the export is displayed smaller. It applies per side, so a tall portrait canvas for a long horizontal ranking is allowed.
theme	string	No	Visual language: basic, modern or squillify (optional; default squillify). An unregistered value is rejected with the registered names listed — we never substitute silently.
surface	string	No	Surface the theme renders on: dark or light (optional; default light).
density	string	No	How tightly the chrome is packed: compact, standard or spacious (optional; default standard). Density scales spacing only — it never lowers a legibility minimum.
visualProfile	string	No	What the SVG promises about the host font: portable or certified (optional; default portable). The default is layout-deterministic and tolerates substitution; certified refuses text the certified metrics cannot fully measure.
style	object	No	Optional bounded paint and typography styling; omit it to use the selected theme defaults. text.size is expressed in normalized design pixels at an 800-pixel reference width, so equivalent roles match at equal CSS width. It never changes data or accessibility. 'contract' selects the published semantics. 'tokens' sets design tokens; 'rules' applies typed properties to a role and optional series/category facets; 'palette' accepts a digest-checked palette; 'css' is a bounded post-layout stylesheet. The styleCapabilities section publishes this family's accepted roles, properties and copyable examples. For Bar, target one mark with role 'bar' plus seriesIndex and categoryIndex; categoryIndex alone targets that category across series. A minimal rule is {"target":{"role":"bar"},"set":{"paint.fill":"#2563eb"}}. Unsupported typed rules are refused; unsupported CSS is dropped and reported. Do not discover the grammar through trial calls: style validation failures are currently billable. Before calling, read this contract's styleSurface and styleCapabilities sections for the complete rule shape, accepted roles and properties, limits, and copyable examples.
output	object	No	Output scoping (optional). Nested key output.idNamespace ([a-z][a-z0-9-]{0,31}) is prefixed onto every generated element id when several charts share one host document; omit for a standalone chart. An invalid namespace is rejected.

Output schema

Field	Type	Required	Description
svg	string	Yes	Final script-free canonical SVG. svg is a complete static, script-free chart. Mark highlight, the dotted guide, and the value panel are not in that SVG, and entry motion, focus, and updates stay inactive there. Pass the entire output.behavior.artifact unchanged to SquillifyChartRuntime.mount(container, artifact, options), then call the returned handle's replay() once to play the entry. A later value change uses update(nextArtifact, {intent}). Injecting svg directly leaves hover and motion off. Interaction is on by default for every host chart: after mount, pointer and keyboard focus open the value panel and the dotted guide. Set behavior.interaction.enabled to false to turn that off. motion.preset accepts only the family's entrance.
width	integer	Yes	Resolved canvas width.
height	integer	Yes	Resolved canvas height.
viewBox	string	Yes	Rendered coordinate system.
nodeResults	array	Yes	Every exact total, percentage, path, depth, order and faithful rectangle.
treeResult	object	Yes	Root identity, exact total, topology and pinned layout algorithm.
renderSummary	object	Yes	Object containing bounded nodeCount, leafCount and maxDepth mark counts.
transformationSummary	object	Yes	Always-present bounded report of any label or layout adaptation.
behavior	object	No	Object containing digest-bound manifest, data index, entry plan and transitions when requested. svg is a complete static, script-free chart. Mark highlight, the dotted guide, and the value panel are not in that SVG, and entry motion, focus, and updates stay inactive there. Pass the entire output.behavior.artifact unchanged to SquillifyChartRuntime.mount(container, artifact, options), then call the returned handle's replay() once to play the entry. A later value change uses update(nextArtifact, {intent}). Injecting svg directly leaves hover and motion off. Interaction is on by default for every host chart: after mount, pointer and keyboard focus open the value panel and the dotted guide. Set behavior.interaction.enabled to false to turn that off. motion.preset accepts only the family's entrance.
styleReport	object	No	Always reports the resolved typographyProfile and fontMetrics contract, plus tokensApplied, rulesApplied, typedRulesApplied, typedAssignmentsApplied, rulesDropped, declarationsDropped and, when anything was dropped, a bounded list of reasons.
warnings	array	No	Present when the render succeeded with a known degradation. Each entry is an object with a stable code, a message and details. Every chart can emit FONT_SUBSTITUTION_POSSIBLE under visualProfile 'portable', FONT_GLYPH_UNMEASURED when a code point falls outside the certified metrics, and CHART_STYLE_PARTIALLY_APPLIED when part of your styling was dropped — styleReport then names which part and why. Codes are stable for agent routing. No positive leaf is inflated, pruned, or aggregated.

API contract

POST /v1/execute

curl

curl -sS -X POST "$BASE/v1/execute" \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"skillKey":"chart.treemap","input":{"nodes":[{"id":"root","label":"Portfolio"},{"id":"a","parentId":"root","label":"A","value":"60"},{"id":"b","parentId":"root","label":"B","value":"40"}]}}'

Integrations

TypeScript SDK

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("chart.treemap", {"nodes":[{"id":"root","label":"Portfolio"},{"label":"Equity","parentId":"root","value":"60","id":"equity"},{"label":"Bonds","parentId":"root","value":"40","id":"bonds"}]});

Errors

Code	HTTP	Retryable	Description
VALIDATION_ERROR	400	No	The request payload failed schema validation.
UNAUTHORIZED	401	No	Missing or invalid API key.
SKILL_NOT_ACCESSIBLE	403	No	The API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN	403	No	This skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE	503	Yes	Plan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND	404	No	The requested skill or version does not exist.
TENANT_RATE_LIMITED	429	Yes	Request rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED	429	Yes	Plan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT	504	Yes	Execution exceeded the allowed time budget.
CHART_CAPACITY_EXCEEDED	429	No	A size, quota, rate, or time limit was exceeded.
CHART_OUTPUT_TOO_LARGE	429	No	A size, quota, rate, or time limit was exceeded.
CHART_THEME_UNKNOWN	400	No	The request payload failed this skill's input validation.
CHART_DATA_SHAPE_INVALID	400	No	The request payload failed this skill's input validation.
CHART_UNSAFE_OUTPUT	500	No	The skill encountered an unexpected execution failure.
CHART_OUTPUT_TOO_COMPLEX	500	No	The skill encountered an unexpected execution failure.

Other limits

Limit	Value
Recommended inline bytes	32 KiB

Limitations

DAGs
Zoom
Top-N/Other
Circle packing
Area inflation
Unreadable tiny leaves or non-tree relationships

How to call

POST /v1/execute (requires authentication)

Request bodyjson

{
  "skillKey": "chart.treemap",
  "input": {
    "nodes": [
      {
        "id": "root",
        "label": "Portfolio"
      },
      {
        "label": "Equity",
        "parentId": "root",
        "value": "60",
        "id": "equity"
      },
      {
        "label": "Bonds",
        "parentId": "root",
        "value": "40",
        "id": "bonds"
      }
    ]
  }
}

Examples

Portfolio allocation

Inputjson

{
  "nodes": [
    {
      "id": "root",
      "label": "Portfolio"
    },
    {
      "label": "Equity",
      "parentId": "root",
      "value": "60",
      "id": "equity"
    },
    {
      "label": "Bonds",
      "parentId": "root",
      "value": "40",
      "id": "bonds"
    }
  ]
}

Expected outputjson

{
  "viewBox": "0 0 800 500",
  "treeResult": {
    "rootId": "root",
    "rootTotal": "100",
    "algorithm": "squarified",
    "order": "valueDesc"
  },
  "transformationSummary": {
    "applied": false,
    "operations": [],
    "affectedCategoryCount": 0,
    "affectedPointCount": 0,
    "affectedLabelCount": 0
  },
  "renderSummary": {
    "skill": "chart.treemap",
    "nodeCount": 3,
    "leafCount": 2,
    "maxDepth": 1
  },
  "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"800\" height=\"500\" viewBox=\"0 0 800 500\" role=\"img\" class=\"sq-chart sq-chart--treemap sq-family--hierarchy sq-theme--squillify sq-surface--light sq-density--standard\" data-sq-style-contract=\"CHART_STYLE@1\" data-sq-chart=\"treemap\" data-sq-family=\"hierarchy\" data-sq-theme=\"squillify\" data-sq-theme-version=\"1\" data-sq-surface=\"light\" data-sq-density=\"standard\" data-sq-a11y-detail=\"full\" aria-labelledby=\"sq-2dd1d99c5a82-title-6 sq-2dd1d99c5a82-desc-7\"><title id=\"sq-2dd1d99c5a82-title-6\">Treemap</title><desc id=\"sq-2dd1d99c5a82-desc-7\">Treemap with 3 nodes and exact root total 100 using treemap-layout@1</desc><style>.sq-chart{--sq-chart-axis:#c9d1df;--sq-chart-font-family:'Squillify Mono', 'IBM Plex Mono', monospace;--sq-chart-grid:#d8dee9;--sq-chart-surface:#ffffff;--sq-chart-text-muted:#667085;--sq-chart-text-primary:#101828;--sq-series-1:#2563eb;--sq-series-2:#6d5ce7;--sq-series-3:#168a5b;--sq-series-4:#c45412;--sq-series-5:#d92d20;--sq-series-6:#667085;font-family:var(--sq-chart-font-family);font-weight:500;}.sq-chart .sq-background{fill:var(--sq-chart-surface);}</style><defs><linearGradient id=\"sq-2dd1d99c5a82-gradient-0\" gradientUnits=\"objectBoundingBox\" x1=\"0\" y1=\"0\" x2=\"0\" y2=\"1\"><stop offset=\"0\" stop-color=\"#6f9bff\"/><stop offset=\"1\" stop-color=\"#c9d8ff\"/></linearGradient><linearGradient id=\"sq-2dd1d99c5a82-gradient-1\" gradientUnits=\"objectBoundingBox\" x1=\"0\" y1=\"0\" x2=\"0\" y2=\"1\"><stop offset=\"0\" stop-color=\"#a99cf8\"/><stop offset=\"1\" stop-color=\"#ded9ff\"/></linearGradient><linearGradient id=\"sq-2dd1d99c5a82-gradient-2\" gradientUnits=\"objectBoundingBox\" x1=\"0\" y1=\"0\" x2=\"0\" y2=\"1\"><stop offset=\"0\" stop-color=\"#54bc8b\"/><stop offset=\"1\" stop-color=\"#c8ebda\"/></linearGradient><linearGradient id=\"sq-2dd1d99c5a82-gradient-3\" gradientUnits=\"objectBoundingBox\" x1=\"0\" y1=\"0\" x2=\"0\" y2=\"1\"><stop offset=\"0\" stop-color=\"#f09a5b\"/><stop offset=\"1\" stop-color=\"#f7d4ba\"/></linearGradient><linearGradient id=\"sq-2dd1d99c5a82-gradient-4\" gradientUnits=\"objectBoundingBox\" x1=\"0\" y1=\"0\" x2=\"0\" y2=\"1\"><stop offset=\"0\" stop-color=\"#426cad\"/><stop offset=\"1\" stop-color=\"#b7c8e3\"/></linearGradient><linearGradient id=\"sq-2dd1d99c5a82-gradient-5\" gradientUnits=\"objectBoundingBox\" x1=\"0\" y1=\"0\" x2=\"0\" y2=\"1\"><stop offset=\"0\" stop-color=\"#98a2b3\"/><stop offset=\"1\" stop-color=\"#e4e7ec\"/></linearGradient></defs><rect x=\"0\" y=\"0\" width=\"800\" height=\"500\" fill=\"#ffffff\" class=\"sq-background\" data-sq-role=\"background\"/><g class=\"sq-plot\" data-sq-role=\"plot\"><g class=\"sq-treemap-focus\" data-sq-role=\"treemap-parent\" data-sq-target-key=\"t-treemap-d9b395a68e91d971\"><rect x=\"12\" y=\"12\" width=\"776\" height=\"476\" fill=\"none\" stroke=\"#c9d1df\" stroke-width=\"1\" class=\"sq-mark sq-treemap-node sq-treemap-parent\" data-sq-role=\"treemap-parent\" data-sq-series-index=\"0\" data-sq-category-index=\"0\" data-sq-palette-index=\"0\"/><text x=\"16\" y=\"25\" font-size=\"10\" text-anchor=\"start\" fill=\"#101828\" class=\"sq-label sq-treemap-parent-header\" data-sq-role=\"treemap-parent-header\">Portfolio 100</text></g><g class=\"sq-treemap-focus\" data-sq-role=\"treemap-leaf\" data-sq-target-key=\"t-treemap-9e33bbf2125c50a5\"><rect x=\"16.5\" y=\"34.5\" width=\"459.8\" height=\"449\" fill=\"url(#sq-2dd1d99c5a82-gradient-0)\" stroke=\"#ffffff\" stroke-width=\"1\" class=\"sq-mark sq-treemap-node sq-treemap-leaf\" data-sq-role=\"treemap-leaf\" data-sq-series-index=\"0\" data-sq-category-index=\"0\" data-sq-palette-index=\"0\"/><text x=\"246.4\" y=\"263\" font-size=\"10\" text-anchor=\"middle\" fill=\"#101828\" class=\"sq-label sq-treemap-label\" data-sq-role=\"treemap-label\" data-sq-category-index=\"0\">Equity 60.00%</text></g><g class=\"sq-treemap-focus\" data-sq-role=\"treemap-leaf\" data-sq-target-key=\"t-treemap-af6733b8cfb4d43f\"><rect x=\"477.3\" y=\"34.5\" width=\"306.2\" height=\"449\" fill=\"url(#sq-2dd1d99c5a82-gradient-1)\" stroke=\"#ffffff\" stroke-width=\"1\" class=\"sq-mark sq-treemap-node sq-treemap-leaf\" data-sq-role=\"treemap-leaf\" data-sq-series-index=\"1\" data-sq-category-index=\"1\" data-sq-palette-index=\"1\"/><text x=\"630.4\" y=\"263\" font-size=\"10\" text-anchor=\"middle\" fill=\"#101828\" class=\"sq-label sq-treemap-label\" data-sq-role=\"treemap-label\" data-sq-category-index=\"1\">Bonds 40.00%</text></g></g></svg>",
  "nodeResults": [
    {
      "id": "root",
      "path": [
        "root"
      ],
      "inputIndex": 0,
      "percentOfRoot": "1",
      "rectangle": {
        "width": 776,
        "height": 476,
        "x": 12,
        "y": 12
      },
      "label": "Portfolio",
      "derivedTotal": "100",
      "leaf": false,
      "depth": 0,
      "resolvedSiblingIndex": 0,
      "meaning": "neutral"
    },
    {
      "percentOfRoot": "0.6",
      "inputIndex": 1,
      "resolvedSiblingIndex": 0,
      "leaf": true,
      "percentOfParent": "0.6",
      "id": "equity",
      "path": [
        "root",
        "equity"
      ],
      "value": "60",
      "rectangle": {
        "width": 459.8,
        "height": 449,
        "x": 16.5,
        "y": 34.5
      },
      "label": "Equity",
      "parentId": "root",
      "depth": 1,
      "meaning": "neutral"
    },
    {
      "percentOfRoot": "0.4",
      "inputIndex": 2,
      "resolvedSiblingIndex": 1,
      "leaf": true,
      "percentOfParent": "0.4",
      "id": "bonds",
      "path": [
        "root",
        "bonds"
      ],
      "value": "40",
      "rectangle": {
        "width": 306.2,
        "height": 449,
        "x": 477.3,
        "y": 34.5
      },
      "label": "Bonds",
      "parentId": "root",
      "depth": 1,
      "meaning": "neutral"
    }
  ],
  "width": 800,
  "height": 500
}

Slice dice allocation