Treemap.
PRORepresent hierarchical sizes as rectangle areas.
LIVE EXAMPLE
Product composition
Appearance and style5
Legend and interaction11
Title and dimensions3
Represent hierarchy leaf values as rectangle areas. All values are sample data.
View code
<div id="chart-container" style="width: 100%; min-width: 0;"></div>
<script type="module">
import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-treemap.js';
define0();
// Pro: complete registerLicense at app startup using your issued certificate.
// The website preview certificate is not for use in customer apps.
const specs = [
{
"id": "example-chart",
"tag": "sy-treemap",
"props": {
"data": [
{
"id": "all",
"label": "All",
"children": [
{
"id": "platform",
"label": "Platform",
"color": "#8263d9",
"children": [
{
"id": "web",
"label": "Web",
"value": 42
},
{
"id": "mobile",
"label": "Mobile",
"value": 28
}
]
},
{
"id": "service",
"label": "Services",
"color": "#239c91",
"children": [
{
"id": "consult",
"label": "Consulting",
"value": 18
},
{
"id": "support",
"label": "Support",
"value": 12
}
]
}
]
}
],
"width": 640,
"height": 360,
"brandPosition": "bottom-right",
"brandLogo": ""
}
}
];
const container = document.querySelector('#chart-container');
const elements = specs.map(({ tag, id, props }) => {
const element = document.createElement(tag);
element.id = id;
Object.assign(element, props);
element.setAttribute('aria-label', 'treemap example chart');
return element;
});
container.replaceChildren(...elements);
const chart = elements.at(-1);
const onEvent = event => {
console.log('nodeClick', event.detail);
};
chart.addEventListener('nodeClick', onEvent);
const observer = new ResizeObserver(([entry]) => {
const width = Math.max(160, Math.floor(entry.contentRect.width));
elements.forEach(element => { element.width = width; });
});
observer.observe(container);
// In an SPA, call this function when the view is disposed.
function disposeChart() {
observer.disconnect();
chart.removeEventListener('nodeClick', onEvent);
container.replaceChildren();
}
</script>Usage and data
#Explore part-to-whole proportions, such as product composition or storage usage.
Labels may be omitted in small areas. Use drilldown and a data table to inspect details.
Data contract
| Property | Input format |
|---|---|
data | An array of nodes as { id, label?, value?, children? }. Branch values are calculated from their children. |
Updating data
Assign a new array or object to the property instead of mutating values inside an array. Chart events provide selection results through event.detail. When disposing of the view, clean up ResizeObserver and event listeners registered by your app.
Feature examples
#Try 25 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.
Hierarchy navigationPRO
Double-click a parent region with children to explore its subtree. Return using the breadcrumb buttons above.
View code
Hierarchy spacingPRO
Adjust inner padding and the hierarchy's title area.
View code
Inspect values with the pointerPRO
Point to data to view the value at that location.
View code
Drag to zoom and panPRO
Drag to zoom and hold Shift to pan. Use Ctrl + wheel to zoom in or out.
View code
Replay animationPRO
Redraw the same example to inspect its initial display animation.
View code
AnimationPRO
Compare 2 examples of Animation. Buttons and options update both the live result and source code.
View code
ColorPRO
Compare 3 examples of Color. Buttons and options update both the live result and source code.
View code
Data inputPRO
Compare 3 examples of Data input. Buttons and options update both the live result and source code.
View code
DrilldownPRO
Compare 4 examples of Drilldown. Buttons and options update both the live result and source code.
View code
LabelPRO
Compare 6 examples of Label. Buttons and options update both the live result and source code.
View code
LayoutPRO
Compare 5 examples of Layout. Buttons and options update both the live result and source code.
View code
Large datasetsPRO
Compare 2 examples of Large datasets. Buttons and options update both the live result and source code.
View code
SizePRO
Compare 1 examples of Size. Buttons and options update both the live result and source code.
View code
TooltipPRO
Compare 12 examples of Tooltip. Buttons and options update both the live result and source code.
View code
Zoom and panPRO
Compare 7 examples of Zoom and pan. Buttons and options update both the live result and source code.
View code
Context menuPRO
Compare 1 examples of Context menu. Buttons and options update both the live result and source code.
View code
Drill ChangePRO
Compare 1 examples of Drill Change. Buttons and options update both the live result and source code.
View code
HoverPRO
Compare 2 examples of Hover. Buttons and options update both the live result and source code.
View code
Node ClickPRO
Compare 1 examples of Node Click. Buttons and options update both the live result and source code.
View code
Data context menuPRO
Compare 1 examples of Data context menu. Buttons and options update both the live result and source code.
View code
ExportPRO
Compare 1 examples of Export. Buttons and options update both the live result and source code.
View code
Read coordinates and dataPRO
Compare 1 examples of Read coordinates and data. Buttons and options update both the live result and source code.
View code
OptionalPRO
Compare 2 examples of Optional. Buttons and options update both the live result and source code.
View code
OverviewPRO
Compare 2 examples of Overview. Buttons and options update both the live result and source code.
View code
Streaming · Add and update live dataPRO
Compare 5 examples of Add and update live data. Buttons and options update both the live result and source code.
View code
Add to your interface
#The code tabs below the preview contain the full data, options, event bindings, and responsive sizing for the current example. Copy them into an app project, such as Vite, that can resolve the installed packages.
API reference
#The full public API for sy-treemap. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.
Key properties
| Attribute / Property | Type / Default | Description |
|---|---|---|
TreemapDataDefault: undefined | An array of nodes as { id, label?, value?, children? }. Branch values are calculated from their children. | |
numberDefault: 900 | Chart width in pixels. Update with ResizeObserver when the container changes. | |
numberDefault: 400 | Chart height in pixels. | |
| brandLogo | stringDefault: undefined | The default is the Syidax logo. With the Pro chart.branding entitlement, use none or a PNG, JPEG, or WebP data URL. |
| brandPosition | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'Default: 'bottom-right' | The corner where the logo is anchored. Applies equally to Community and Pro, on screen and in image exports. |
numberDefault: 3 | Inner spacing of each branch, in CSS pixels. | |
booleanDefault: false | Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts. | |
| headerHeight | numberDefault: 18 | Reserved header band inside each branch, in CSS pixels. |
| nodeLabels | TreemapLabelModeDefault: 'auto' | Allowed values: auto, show, hide. Default: 'auto'. |
| nodeLabelValue | booleanDefault: false | Set as an HTML attribute or JavaScript property. type: boolean. |
| chartTitle | stringDefault: undefined | The title inside the chart. Explain the data's unit and meaning alongside it. |
| chartSubtitle | stringDefault: undefined | The subtitle inside the chart. |
CartesianTooltipInputDefault: undefined | Tooltip settings for pointer-driven values, position, and content. | |
| tooltipEnabled | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| animated | booleanDefault: false | Whether to animate initial display and data changes. |
| animationDuration | numberDefault: 600 | Animation duration in milliseconds. |
| animationEasing | TreemapEasingDefault: 'ease-out' | Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'. |
| animationType | TreemapAnimationTypeDefault: undefined | Allowed values: initial, update. Default: undefined. |
CartesianZoomInputDefault: undefined | Settings for zooming and the visible range. |
Other properties 9
| Attribute / Property | Type / Default | Description |
|---|---|---|
stringDefault: 'auto' | Set as an HTML attribute or JavaScript property. type: string. | |
| activeColor | stringDefault: '#f59e0b' | Set as an HTML attribute or JavaScript property. type: string. |
| enableMouseTracking | booleanDefault: true | Set as an HTML attribute or JavaScript property. type: boolean. |
| tooltipFormat | (detail: TreemapHitDetail) => stringDefault: undefined | Pass as a JavaScript property. type: (detail: TreemapHitDetail) => string. |
| streamSource | TreemapStreamSourceDefault: undefined | A stream source for live data. Check the contract for the specific type. |
| streamMax | numberDefault: undefined | The maximum number of streaming data points to retain. |
| streamWindow | numberDefault: undefined | The streaming data range to keep visible. |
TreemapEngineModeDefault: 'auto' | Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type. | |
TreemapUnavailableBehaviourDefault: 'fallback' | Allowed values: fallback, error. Default: 'fallback'. |
Events 15
| Events | Detail type | Description |
|---|---|---|
TreemapRenderResult & { tier: TreemapEngineTier } | Emits rendering results in detail when chart drawing completes. | |
TreemapHitDetail | CustomEvent.detail type: TreemapHitDetail. Event names are case-sensitive. | |
TreemapHitDetail | null | CustomEvent.detail type: TreemapHitDetail | null. Event names are case-sensitive. | |
TreemapSelectionChangeEventDetail | CustomEvent.detail type: TreemapSelectionChangeEventDetail. Event names are case-sensitive. | |
ChartPointContextMenuEventDetail<TreemapHitDetail> | CustomEvent.detail type: ChartPointContextMenuEventDetail<TreemapHitDetail>. Event names are case-sensitive. | |
{ count: number; replaced: number } | CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive. | |
{ dropped: number } | CustomEvent.detail type: { dropped: number }. Event names are case-sensitive. | |
CartesianTooltipEventDetail | Whether to display the built-in tooltip. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
CartesianTooltipActionEventDetail | CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
void | CustomEvent.detail type: void. Event names are case-sensitive. | |
CartesianZoomChangeEventDetail | CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive. | |
TreemapDrillChangeEventDetail | CustomEvent.detail type: TreemapDrillChangeEventDetail. Event names are case-sensitive. |
Methods 39
Stencil methods return Promises. Use await within an async function to read the result.
| Method / Arguments | Return type | Description |
|---|---|---|
Promise<TreemapRenderResult> | An asynchronous method. Check the argument and return types below. | |
Promise<TreemapEngineTier> | An asynchronous method. Check the argument and return types below. | |
Promise<string | undefined> | An asynchronous method. Check the argument and return types below. | |
| data: TreemapData | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<TreemapNode[]> | An asynchronous method. Check the argument and return types below. | |
| index: number | Promise<TreemapNode | null> | An asynchronous method. Check the argument and return types below. |
| id: string | Promise<TreemapNode | null> | An asynchronous method. Check the argument and return types below. |
Promise<number> | An asynchronous method. Check the argument and return types below. | |
Promise<TreemapExtent> | An asynchronous method. Check the argument and return types below. | |
Promise<TreemapLayoutResult> | The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed. | |
| node: TreemapNodeInput | Promise<void> | An asynchronous method. Check the argument and return types below. |
| nodes: ReadonlyArray<TreemapNodeInput> | Promise<void> | An asynchronous method. Check the argument and return types below. |
| count: number | Promise<void> | An asynchronous method. Check the argument and return types below. |
| nodes: ReadonlyArray<TreemapNodeInput> | Promise<void> | An asynchronous method. Check the argument and return types below. |
Promise<ChartEngineStatus> | Requested vs effective engine and why (CHART-ADD-08), with the chart.type.treemap license state. | |
Promise<TreemapStreamSource | undefined> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| options: { enabled?: boolean; duration?: number; easing?: TreemapEasing; type?: TreemapAnimationType } | Promise<void> | An asynchronous method. Check the argument and return types below. |
| cssX: number, cssY: number | Promise<TreemapHitDetail | null> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<TreemapHitDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
Promise<TreemapSelection> | An asynchronous method. Check the argument and return types below. | |
| rootId: string | null | Promise<TreemapDrillChangeEventDetail | null> | Enter a positive branch by stable ID; null returns to the complete forest. Requires drilldown. |
| nodeIndex: number | Promise<TreemapDrillChangeEventDetail | null> | Enter a positive branch by its normalized data index. Requires drilldown. |
Promise<TreemapDrillChangeEventDetail | null> | Return to the current branch's parent, then the forest. | |
Promise<TreemapNode | null> | An asynchronous method. Check the argument and return types below. | |
| index: number | Promise<CartesianTooltipEventDetail | null> | An asynchronous method. Check the argument and return types below. |
| index: number | Promise<CartesianTooltipEventDetail | null> | An asynchronous method. Check the argument and return types below. |
Promise<void> | An asynchronous method. Check the argument and return types below. | |
| request: CartesianZoomRequest | Promise<CartesianZoomChangeEventDetail | null> | Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation). |
| factor: number, anchorFraction?: number | Promise<CartesianZoomChangeEventDetail | null> | Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre). |
| delta: { x?: number; y?: number } | Promise<CartesianZoomChangeEventDetail | null> | Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent. |
Promise<CartesianZoomChangeEventDetail | null> | Back to the full diagram. | |
Promise<CartesianZoomState | null> | The current zoom state (`null` = the full diagram). | |
| request?: CartesianZoomExtentRequest | Promise<CartesianZoomExtentDetail | null> | The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout). |
Promise<ChartDataTable> | An asynchronous method. Check the argument and return types below. | |
Promise<TreemapLabel[]> | The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed. |
No matching APIs.