# Treemap

Represent hierarchical sizes as rectangle areas.

Canonical: https://chart.syidax.com/docs/components/treemap/

<a id="overview"></a>

## sy-treemap

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.

Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements.

| Input | Data description |
| --- | --- |
| `data` | An array of nodes as { id, label?, value?, children? }. Branch values are calculated from their children. |

- [Run in Components](https://chart.syidax.com/charts/treemap) — Change options and view framework-specific code
- [Shared installation and integration](https://chart.syidax.com/docs/getting-started.md)

<a id="example"></a>

## Complete implementation example

```html
<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>
```

<a id="props"></a>

## Properties

<a id="property-data"></a>

### data

An array of nodes as { id, label?, value?, children? }. Branch values are calculated from their children.

| Item | Value |
| --- | --- |
| JavaScript property | `data` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `TreemapData` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [TreemapData](https://chart.syidax.com/docs/types/TreemapData.md) — Type definition

<a id="property-width"></a>

### width

Chart width in pixels. If the container width changes, update width from a ResizeObserver.

| Item | Value |
| --- | --- |
| JavaScript property | `width` |
| HTML attribute | `width` |
| Type | `number` |
| Default | `900` |

<a id="property-height"></a>

### height

Chart height in pixels. Allow space for axes, titles, and the legend.

| Item | Value |
| --- | --- |
| JavaScript property | `height` |
| HTML attribute | `height` |
| Type | `number` |
| Default | `400` |

<a id="property-brandLogo"></a>

### brandLogo

The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it.

| Item | Value |
| --- | --- |
| JavaScript property | `brandLogo` |
| HTML attribute | `brand-logo` |
| Type | `string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-brandPosition"></a>

### brandPosition

The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports.

| Item | Value |
| --- | --- |
| JavaScript property | `brandPosition` |
| HTML attribute | `brand-position` |
| Type | `'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'` |
| Default | `'bottom-right'` |
| Allowed values | `top-left`, `top-right`, `bottom-left`, `bottom-right` |

<a id="property-padding"></a>

### padding

Inner spacing of each branch, in CSS pixels.

| Item | Value |
| --- | --- |
| JavaScript property | `padding` |
| HTML attribute | `padding` |
| Type | `number` |
| Default | `3` |

<a id="property-drilldown"></a>

### drilldown

Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts.

| Item | Value |
| --- | --- |
| JavaScript property | `drilldown` |
| HTML attribute | `drilldown` |
| Type | `boolean` |
| Default | `false` |

<a id="property-headerHeight"></a>

### headerHeight

Reserved header band inside each branch, in CSS pixels.

| Item | Value |
| --- | --- |
| JavaScript property | `headerHeight` |
| HTML attribute | `header-height` |
| Type | `number` |
| Default | `18` |

<a id="property-color"></a>

### color

Set as an HTML attribute or JavaScript property. type: string.

| Item | Value |
| --- | --- |
| JavaScript property | `color` |
| HTML attribute | `color` |
| Type | `string` |
| Default | `'auto'` |

<a id="property-activeColor"></a>

### activeColor

Set as an HTML attribute or JavaScript property. type: string.

| Item | Value |
| --- | --- |
| JavaScript property | `activeColor` |
| HTML attribute | `active-color` |
| Type | `string` |
| Default | `'#f59e0b'` |

<a id="property-nodeLabels"></a>

### nodeLabels

Allowed values: auto, show, hide. Default: 'auto'.

| Item | Value |
| --- | --- |
| JavaScript property | `nodeLabels` |
| HTML attribute | `node-labels` |
| Type | `TreemapLabelMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `show`, `hide` |

- [TreemapLabelMode](https://chart.syidax.com/docs/types/TreemapLabelMode.md) — Type definition

<a id="property-nodeLabelValue"></a>

### nodeLabelValue

Set as an HTML attribute or JavaScript property. type: boolean.

| Item | Value |
| --- | --- |
| JavaScript property | `nodeLabelValue` |
| HTML attribute | `node-label-value` |
| Type | `boolean` |
| Default | `false` |

<a id="property-chartTitle"></a>

### chartTitle

The title inside the chart. Explain the data's unit and meaning alongside it.

| Item | Value |
| --- | --- |
| JavaScript property | `chartTitle` |
| HTML attribute | `chart-title` |
| Type | `string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-chartSubtitle"></a>

### chartSubtitle

The subtitle inside the chart.

| Item | Value |
| --- | --- |
| JavaScript property | `chartSubtitle` |
| HTML attribute | `chart-subtitle` |
| Type | `string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-enableMouseTracking"></a>

### enableMouseTracking

Set as an HTML attribute or JavaScript property. type: boolean.

| Item | Value |
| --- | --- |
| JavaScript property | `enableMouseTracking` |
| HTML attribute | `enable-mouse-tracking` |
| Type | `boolean` |
| Default | `true` |

<a id="property-tooltip"></a>

### tooltip

Tooltip settings for pointer-driven values, position, and content.

| Item | Value |
| --- | --- |
| JavaScript property | `tooltip` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianTooltipInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [CartesianTooltipInput](https://chart.syidax.com/docs/types/CartesianTooltipInput.md) — Type definition

<a id="property-tooltipEnabled"></a>

### tooltipEnabled

Set as an HTML attribute or JavaScript property. type: boolean.

| Item | Value |
| --- | --- |
| JavaScript property | `tooltipEnabled` |
| HTML attribute | `tooltip-show` |
| Type | `boolean` |
| Default | `true` |

<a id="property-tooltipFormat"></a>

### tooltipFormat

Pass as a JavaScript property. type: (detail: TreemapHitDetail) => string.

| Item | Value |
| --- | --- |
| JavaScript property | `tooltipFormat` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `(detail: TreemapHitDetail) => string` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [TreemapHitDetail](https://chart.syidax.com/docs/types/TreemapHitDetail.md) — Type definition

<a id="property-animated"></a>

### animated

Whether to animate initial display and data changes.

| Item | Value |
| --- | --- |
| JavaScript property | `animated` |
| HTML attribute | `animate` |
| Type | `boolean` |
| Default | `false` |

<a id="property-animationDuration"></a>

### animationDuration

Animation duration in milliseconds.

| Item | Value |
| --- | --- |
| JavaScript property | `animationDuration` |
| HTML attribute | `animation-duration` |
| Type | `number` |
| Default | `600` |

<a id="property-animationEasing"></a>

### animationEasing

Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.

| Item | Value |
| --- | --- |
| JavaScript property | `animationEasing` |
| HTML attribute | `animation-easing` |
| Type | `TreemapEasing` |
| Default | `'ease-out'` |
| Allowed values | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

- [TreemapEasing](https://chart.syidax.com/docs/types/TreemapEasing.md) — Type definition

<a id="property-animationType"></a>

### animationType

Allowed values: initial, update. Default: undefined.

| Item | Value |
| --- | --- |
| JavaScript property | `animationType` |
| HTML attribute | `animation-type` |
| Type | `TreemapAnimationType` |
| Default | `undefined` |
| Allowed values | `initial`, `update` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [TreemapAnimationType](https://chart.syidax.com/docs/types/TreemapAnimationType.md) — Type definition

<a id="property-streamSource"></a>

### streamSource

A stream source for live data. Check the contract for the specific type.

| Item | Value |
| --- | --- |
| JavaScript property | `streamSource` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `TreemapStreamSource` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [TreemapStreamSource](https://chart.syidax.com/docs/types/TreemapStreamSource.md) — Type definition

<a id="property-streamMax"></a>

### streamMax

The maximum number of streaming data points to retain.

| Item | Value |
| --- | --- |
| JavaScript property | `streamMax` |
| HTML attribute | `stream-max` |
| Type | `number` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-streamWindow"></a>

### streamWindow

The streaming data range to keep visible.

| Item | Value |
| --- | --- |
| JavaScript property | `streamWindow` |
| HTML attribute | `stream-window` |
| Type | `number` |
| Default | `undefined` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

<a id="property-zoom"></a>

### zoom

Settings for zooming and the visible range.

| Item | Value |
| --- | --- |
| JavaScript property | `zoom` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianZoomInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [CartesianZoomInput](https://chart.syidax.com/docs/types/CartesianZoomInput.md) — Type definition

<a id="property-engine"></a>

### engine

Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.

| Item | Value |
| --- | --- |
| JavaScript property | `engine` |
| HTML attribute | `engine` |
| Type | `TreemapEngineMode` |
| Default | `'auto'` |
| Allowed values | `auto`, `standard`, `pro` |

- [TreemapEngineMode](https://chart.syidax.com/docs/types/TreemapEngineMode.md) — Type definition

<a id="property-unavailable"></a>

### unavailable

Allowed values: fallback, error. Default: 'fallback'.

| Item | Value |
| --- | --- |
| JavaScript property | `unavailable` |
| HTML attribute | `unavailable` |
| Type | `TreemapUnavailableBehaviour` |
| Default | `'fallback'` |
| Allowed values | `fallback`, `error` |

- [TreemapUnavailableBehaviour](https://chart.syidax.com/docs/types/TreemapUnavailableBehaviour.md) — Type definition

<a id="events"></a>

## Events

<a id="event-rendered"></a>

### rendered

Emits rendering results in detail when chart drawing completes.

Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapRenderResult & { tier: TreemapEngineTier }>`.

```javascript
chart.addEventListener('rendered', event => {
  console.log(event.detail); // TreemapRenderResult & { tier: TreemapEngineTier }
});
```

- [TreemapRenderResult](https://chart.syidax.com/docs/types/TreemapRenderResult.md) — Type definition
- [TreemapEngineTier](https://chart.syidax.com/docs/types/TreemapEngineTier.md) — Type definition

<a id="event-nodeClick"></a>

### nodeClick

CustomEvent.detail type: TreemapHitDetail. Event names are case-sensitive.

Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapHitDetail>`.

```javascript
chart.addEventListener('nodeClick', event => {
  console.log(event.detail); // TreemapHitDetail
});
```

- [TreemapHitDetail](https://chart.syidax.com/docs/types/TreemapHitDetail.md) — Type definition

<a id="event-nodeHover"></a>

### nodeHover

CustomEvent.detail type: TreemapHitDetail | null. Event names are case-sensitive.

Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapHitDetail | null>`.

```javascript
chart.addEventListener('nodeHover', event => {
  console.log(event.detail); // TreemapHitDetail | null
});
```

- [TreemapHitDetail](https://chart.syidax.com/docs/types/TreemapHitDetail.md) — Type definition

<a id="event-selectionChanged"></a>

### selectionChanged

CustomEvent.detail type: TreemapSelectionChangeEventDetail. Event names are case-sensitive.

Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapSelectionChangeEventDetail>`.

```javascript
chart.addEventListener('selectionChanged', event => {
  console.log(event.detail); // TreemapSelectionChangeEventDetail
});
```

- [TreemapSelectionChangeEventDetail](https://chart.syidax.com/docs/types/TreemapSelectionChangeEventDetail.md) — Type definition

<a id="event-pointContextMenu"></a>

### pointContextMenu

CustomEvent.detail type: ChartPointContextMenuEventDetail<TreemapHitDetail>. Event names are case-sensitive.

Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<TreemapHitDetail>>`.

```javascript
chart.addEventListener('pointContextMenu', event => {
  console.log(event.detail); // ChartPointContextMenuEventDetail<TreemapHitDetail>
});
```

- [ChartPointContextMenuEventDetail](https://chart.syidax.com/docs/types/ChartPointContextMenuEventDetail.md) — Type definition
- [TreemapHitDetail](https://chart.syidax.com/docs/types/TreemapHitDetail.md) — Type definition

<a id="event-appended"></a>

### appended

CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive.

Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`.

```javascript
chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: number; replaced: number }
});
```

<a id="event-windowSlid"></a>

### windowSlid

CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.

Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`.

```javascript
chart.addEventListener('windowSlid', event => {
  console.log(event.detail); // { dropped: number }
});
```

<a id="event-tooltipShow"></a>

### tooltipShow

Whether to display the built-in tooltip.

Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`.

```javascript
chart.addEventListener('tooltipShow', event => {
  console.log(event.detail); // CartesianTooltipEventDetail
});
```

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="event-tooltipHide"></a>

### tooltipHide

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`.

```javascript
chart.addEventListener('tooltipHide', event => {
  console.log(event.detail); // void
});
```

<a id="event-tooltipAction"></a>

### tooltipAction

CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive.

Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`.

```javascript
chart.addEventListener('tooltipAction', event => {
  console.log(event.detail); // CartesianTooltipActionEventDetail
});
```

- [CartesianTooltipActionEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipActionEventDetail.md) — Type definition

<a id="event-chartAnimationStart"></a>

### chartAnimationStart

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`.

```javascript
chart.addEventListener('chartAnimationStart', event => {
  console.log(event.detail); // void
});
```

<a id="event-chartAnimationEnd"></a>

### chartAnimationEnd

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`.

```javascript
chart.addEventListener('chartAnimationEnd', event => {
  console.log(event.detail); // void
});
```

<a id="event-chartAnimationInterrupted"></a>

### chartAnimationInterrupted

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`.

```javascript
chart.addEventListener('chartAnimationInterrupted', event => {
  console.log(event.detail); // void
});
```

<a id="event-zoomChange"></a>

### zoomChange

CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive.

Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`.

```javascript
chart.addEventListener('zoomChange', event => {
  console.log(event.detail); // CartesianZoomChangeEventDetail
});
```

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="event-drillChange"></a>

### drillChange

CustomEvent.detail type: TreemapDrillChangeEventDetail. Event names are case-sensitive.

Event name: `drillChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapDrillChangeEventDetail>`.

```javascript
chart.addEventListener('drillChange', event => {
  console.log(event.detail); // TreemapDrillChangeEventDetail
});
```

- [TreemapDrillChangeEventDetail](https://chart.syidax.com/docs/types/TreemapDrillChangeEventDetail.md) — Type definition

<a id="methods"></a>

## Methods

<a id="method-redraw"></a>

### redraw

Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves.

```typescript
redraw(): Promise<TreemapRenderResult>
```

Return type: `Promise<TreemapRenderResult>`. Call the method after element registration and await its Promise result.

- [TreemapRenderResult](https://chart.syidax.com/docs/types/TreemapRenderResult.md) — Type definition

<a id="method-getActiveTier"></a>

### getActiveTier

An asynchronous method. Check the argument and return types below.

```typescript
getActiveTier(): Promise<TreemapEngineTier>
```

Return type: `Promise<TreemapEngineTier>`. Call the method after element registration and await its Promise result.

- [TreemapEngineTier](https://chart.syidax.com/docs/types/TreemapEngineTier.md) — Type definition

<a id="method-getUnavailableReason"></a>

### getUnavailableReason

Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back.

```typescript
getUnavailableReason(): Promise<string | undefined>
```

Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result.

<a id="method-setData"></a>

### setData

Replace the bar set.

```typescript
setData(data: TreemapData): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `TreemapData` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [TreemapData](https://chart.syidax.com/docs/types/TreemapData.md) — Type definition

<a id="method-getNodes"></a>

### getNodes

An asynchronous method. Check the argument and return types below.

```typescript
getNodes(): Promise<TreemapNode[]>
```

Return type: `Promise<TreemapNode[]>`. Call the method after element registration and await its Promise result.

- [TreemapNode](https://chart.syidax.com/docs/types/TreemapNode.md) — Type definition

<a id="method-getNode"></a>

### getNode

An asynchronous method. Check the argument and return types below.

```typescript
getNode(index: number): Promise<TreemapNode | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<TreemapNode | null>`. Call the method after element registration and await its Promise result.

- [TreemapNode](https://chart.syidax.com/docs/types/TreemapNode.md) — Type definition

<a id="method-getNodeById"></a>

### getNodeById

An asynchronous method. Check the argument and return types below.

```typescript
getNodeById(id: string): Promise<TreemapNode | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `id` | `string` | Required |

Return type: `Promise<TreemapNode | null>`. Call the method after element registration and await its Promise result.

- [TreemapNode](https://chart.syidax.com/docs/types/TreemapNode.md) — Type definition

<a id="method-getNodeCount"></a>

### getNodeCount

An asynchronous method. Check the argument and return types below.

```typescript
getNodeCount(): Promise<number>
```

Return type: `Promise<number>`. Call the method after element registration and await its Promise result.

<a id="method-getExtent"></a>

### getExtent

An asynchronous method. Check the argument and return types below.

```typescript
getExtent(): Promise<TreemapExtent>
```

Return type: `Promise<TreemapExtent>`. Call the method after element registration and await its Promise result.

- [TreemapExtent](https://chart.syidax.com/docs/types/TreemapExtent.md) — Type definition

<a id="method-getLayout"></a>

### getLayout

The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed.

```typescript
getLayout(): Promise<TreemapLayoutResult>
```

Return type: `Promise<TreemapLayoutResult>`. Call the method after element registration and await its Promise result.

- [TreemapLayoutResult](https://chart.syidax.com/docs/types/TreemapLayoutResult.md) — Type definition

<a id="method-appendPoint"></a>

### appendPoint

Append one value to the stream. Check the argument type and the licensing requirements for streaming.

```typescript
appendPoint(node: TreemapNodeInput): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `node` | `TreemapNodeInput` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [TreemapNodeInput](https://chart.syidax.com/docs/types/TreemapNodeInput.md) — Type definition

<a id="method-appendBatch"></a>

### appendBatch

Append multiple values to the stream. Check the argument type and the licensing requirements for streaming.

```typescript
appendBatch(nodes: ReadonlyArray<TreemapNodeInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `nodes` | `ReadonlyArray<TreemapNodeInput>` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [TreemapNodeInput](https://chart.syidax.com/docs/types/TreemapNodeInput.md) — Type definition

<a id="method-shift"></a>

### shift

Drop the oldest streamed categories (the `data` boxes are not the stream).

```typescript
shift(count: number): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `count` | `number` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-replace"></a>

### replace

Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace).

```typescript
replace(nodes: ReadonlyArray<TreemapNodeInput>): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `nodes` | `ReadonlyArray<TreemapNodeInput>` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [TreemapNodeInput](https://chart.syidax.com/docs/types/TreemapNodeInput.md) — Type definition

<a id="method-getEngineStatus"></a>

### getEngineStatus

Requested vs effective engine and why (CHART-ADD-08), with the chart.type.treemap license state.

```typescript
getEngineStatus(): Promise<ChartEngineStatus>
```

Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result.

- [ChartEngineStatus](https://chart.syidax.com/docs/types/ChartEngineStatus.md) — Type definition

<a id="method-getStreamSource"></a>

### getStreamSource

The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.

```typescript
getStreamSource(): Promise<TreemapStreamSource | undefined>
```

Return type: `Promise<TreemapStreamSource | undefined>`. Call the method after element registration and await its Promise result.

- [TreemapStreamSource](https://chart.syidax.com/docs/types/TreemapStreamSource.md) — Type definition

<a id="method-pauseAnimation"></a>

### pauseAnimation

Pause the current animation.

```typescript
pauseAnimation(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-resumeAnimation"></a>

### resumeAnimation

Resume a paused animation.

```typescript
resumeAnimation(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-replayAnimation"></a>

### replayAnimation

Replay the initial sweep from min → value(s). No-op when animation is off / reduced.

```typescript
replayAnimation(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-setAnimation"></a>

### setAnimation

An asynchronous method. Check the argument and return types below.

```typescript
setAnimation(options: { enabled?: boolean; duration?: number; easing?: TreemapEasing; type?: TreemapAnimationType }): Promise<void>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `options` | `{ enabled?: boolean; duration?: number; easing?: TreemapEasing; type?: TreemapAnimationType }` | Required |

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

- [TreemapEasing](https://chart.syidax.com/docs/types/TreemapEasing.md) — Type definition
- [TreemapAnimationType](https://chart.syidax.com/docs/types/TreemapAnimationType.md) — Type definition

<a id="method-hitTest"></a>

### hitTest

The box under a host-local CSS point (the nearest slot, within half a pitch), or null.

```typescript
hitTest(cssX: number, cssY: number): Promise<TreemapHitDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `cssX` | `number` | Required |
| `cssY` | `number` | Required |

Return type: `Promise<TreemapHitDetail | null>`. Call the method after element registration and await its Promise result.

- [TreemapHitDetail](https://chart.syidax.com/docs/types/TreemapHitDetail.md) — Type definition

<a id="method-selectNodeAt"></a>

### selectNodeAt

Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes.

```typescript
selectNodeAt(index: number): Promise<TreemapHitDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<TreemapHitDetail | null>`. Call the method after element registration and await its Promise result.

- [TreemapHitDetail](https://chart.syidax.com/docs/types/TreemapHitDetail.md) — Type definition

<a id="method-clearSelection"></a>

### clearSelection

Release the selection (emits selectionChanged when there was one).

```typescript
clearSelection(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-getSelection"></a>

### getSelection

The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license.

```typescript
getSelection(): Promise<TreemapSelection>
```

Return type: `Promise<TreemapSelection>`. Call the method after element registration and await its Promise result.

- [TreemapSelection](https://chart.syidax.com/docs/types/TreemapSelection.md) — Type definition

<a id="method-drillTo"></a>

### drillTo

Enter a positive branch by stable ID; null returns to the complete forest. Requires drilldown.

```typescript
drillTo(rootId: string | null): Promise<TreemapDrillChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `rootId` | `string \| null` | Required |

Return type: `Promise<TreemapDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [TreemapDrillChangeEventDetail](https://chart.syidax.com/docs/types/TreemapDrillChangeEventDetail.md) — Type definition

<a id="method-drillDown"></a>

### drillDown

Enter a positive branch by its normalized data index. Requires drilldown.

```typescript
drillDown(nodeIndex: number): Promise<TreemapDrillChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `nodeIndex` | `number` | Required |

Return type: `Promise<TreemapDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [TreemapDrillChangeEventDetail](https://chart.syidax.com/docs/types/TreemapDrillChangeEventDetail.md) — Type definition

<a id="method-drillUp"></a>

### drillUp

Return to the current branch's parent, then the forest.

```typescript
drillUp(): Promise<TreemapDrillChangeEventDetail | null>
```

Return type: `Promise<TreemapDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [TreemapDrillChangeEventDetail](https://chart.syidax.com/docs/types/TreemapDrillChangeEventDetail.md) — Type definition

<a id="method-getDrillRoot"></a>

### getDrillRoot

Treemap: current branch with its original identity and index, or null for the forest.

```typescript
getDrillRoot(): Promise<TreemapNode | null>
```

Return type: `Promise<TreemapNode | null>`. Call the method after element registration and await its Promise result.

- [TreemapNode](https://chart.syidax.com/docs/types/TreemapNode.md) — Type definition

<a id="method-showTooltipAtIndex"></a>

### showTooltipAtIndex

open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off.

```typescript
showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="method-showTooltipAtPoint"></a>

### showTooltipAtPoint

Open the tooltip for a dot programmatically. `pointIndex` is the category (row) index; the optional `seriesIndex` selects a group within that row (defaults to the first visible group's dot in the row). Returns the emitted tooltip detail, or null when no dot resolves / the tooltip is disabled.

```typescript
showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `index` | `number` | Required |

Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianTooltipEventDetail](https://chart.syidax.com/docs/types/CartesianTooltipEventDetail.md) — Type definition

<a id="method-hideTooltip"></a>

### hideTooltip

Close the currently visible tooltip.

```typescript
hideTooltip(): Promise<void>
```

Return type: `Promise<void>`. Call the method after element registration and await its Promise result.

<a id="method-zoomTo"></a>

### zoomTo

Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation).

```typescript
zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `CartesianZoomRequest` | Required |

Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition
- [CartesianZoomRequest](https://chart.syidax.com/docs/types/CartesianZoomRequest.md) — Type definition

<a id="method-zoomBy"></a>

### zoomBy

Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre).

```typescript
zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `factor` | `number` | Required |
| `anchorFraction` | `number` | Optional |

Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-panBy"></a>

### panBy

Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent.

```typescript
panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `delta` | `{ x?: number; y?: number }` | Required |

Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-resetZoom"></a>

### resetZoom

Reset the zoomed or panned range to the original data range.

```typescript
resetZoom(): Promise<CartesianZoomChangeEventDetail | null>
```

Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/docs/types/CartesianZoomChangeEventDetail.md) — Type definition

<a id="method-getZoom"></a>

### getZoom

Read the current zoom range. Check the return type's nullability and the range for each axis.

```typescript
getZoom(): Promise<CartesianZoomState | null>
```

Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomState](https://chart.syidax.com/docs/types/CartesianZoomState.md) — Type definition

<a id="method-getZoomExtent"></a>

### getZoomExtent

The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout).

```typescript
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `request` | `CartesianZoomExtentRequest` | Optional |

Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result.

- [CartesianZoomExtentDetail](https://chart.syidax.com/docs/types/CartesianZoomExtentDetail.md) — Type definition
- [CartesianZoomExtentRequest](https://chart.syidax.com/docs/types/CartesianZoomExtentRequest.md) — Type definition

<a id="method-getDataTable"></a>

### getDataTable

Current normalized table, including the retained stream; independent of GPU availability.

```typescript
getDataTable(): Promise<ChartDataTable>
```

Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result.

- [ChartDataTable](https://chart.syidax.com/docs/types/ChartDataTable.md) — Type definition

<a id="method-getLabels"></a>

### getLabels

The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed.

```typescript
getLabels(): Promise<TreemapLabel[]>
```

Return type: `Promise<TreemapLabel[]>`. Call the method after element registration and await its Promise result.

- [TreemapLabel](https://chart.syidax.com/docs/types/TreemapLabel.md) — Type definition