# Treemap

계층별 크기를 사각형의 면적으로 표현합니다.

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

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

## sy-treemap

제품 구성·저장 용량처럼 부분과 전체의 비율을 살펴보세요.

작은 영역의 레이블은 생략될 수 있습니다. 드릴다운과 데이터 표로 세부 항목을 확인하세요.

기본 차트 등급: Pro. 추가 렌더러·커스텀 브랜딩 등 기능의 권한은 별도입니다.

| 입력 | 데이터 설명 |
| --- | --- |
| `data` | { id, label?, value?, children? } 노드 배열입니다. 가지 값은 자식의 합으로 계산됩니다. |

- [Components에서 실행하기](https://chart.syidax.com/charts/treemap) — 옵션 변경과 프레임워크별 코드
- [공통 설치와 연결](https://chart.syidax.com/ko/docs/getting-started.md)

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

## 전체 적용 예제

```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: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
  // 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-treemap",
      "props": {
        "data": [
          {
            "id": "all",
            "label": "전체",
            "children": [
              {
                "id": "platform",
                "label": "플랫폼",
                "color": "#8263d9",
                "children": [
                  {
                    "id": "web",
                    "label": "웹",
                    "value": 42
                  },
                  {
                    "id": "mobile",
                    "label": "모바일",
                    "value": 28
                  }
                ]
              },
              {
                "id": "service",
                "label": "서비스",
                "color": "#239c91",
                "children": [
                  {
                    "id": "consult",
                    "label": "컨설팅",
                    "value": 18
                  },
                  {
                    "id": "support",
                    "label": "지원",
                    "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 예제 차트');
    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);

  // SPA에서는 화면이 해제될 때 이 함수를 호출하세요.
  function disposeChart() {
    observer.disconnect();
    chart.removeEventListener('nodeClick', onEvent);
    container.replaceChildren();
  }
</script>
```

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

## Properties

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

### data

{ id, label?, value?, children? } 노드 배열입니다. 가지 값은 자식의 합으로 계산됩니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `data` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `TreemapData` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [TreemapData](https://chart.syidax.com/ko/docs/types/TreemapData.md) — 타입 정의

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

### width

차트의 너비를 px 단위로 지정합니다. 컨테이너 너비가 변하는 앱에서는 ResizeObserver에서 width를 갱신하세요.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `width` |
| HTML attribute | `width` |
| 타입 | `number` |
| 기본값 | `900` |

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

### height

차트의 높이를 px 단위로 지정합니다. 축, 제목과 범례가 차지하는 공간을 함께 고려하세요.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `height` |
| HTML attribute | `height` |
| 타입 | `number` |
| 기본값 | `400` |

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

### brandLogo

기본값은 Syidax 심볼과 워드마크입니다. Pro의 chart.branding 권한으로 none을 지정해 제거하거나 PNG·JPEG·WebP data URL로 교체할 수 있습니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `brandLogo` |
| HTML attribute | `brand-logo` |
| 타입 | `string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### brandPosition

로고를 고정할 코너입니다. Community·Pro 모두 네 코너 중 하나를 선택할 수 있으며 화면과 이미지 내보내기에 같은 위치를 사용합니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `brandPosition` |
| HTML attribute | `brand-position` |
| 타입 | `'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'` |
| 기본값 | `'bottom-right'` |
| 허용값 | `top-left`, `top-right`, `bottom-left`, `bottom-right` |

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

### padding

Inner spacing of each branch, in CSS pixels.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `padding` |
| HTML attribute | `padding` |
| 타입 | `number` |
| 기본값 | `3` |

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

### drilldown

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `drilldown` |
| HTML attribute | `drilldown` |
| 타입 | `boolean` |
| 기본값 | `false` |

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

### headerHeight

Reserved header band inside each branch, in CSS pixels.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `headerHeight` |
| HTML attribute | `header-height` |
| 타입 | `number` |
| 기본값 | `18` |

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

### color

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `color` |
| HTML attribute | `color` |
| 타입 | `string` |
| 기본값 | `'auto'` |

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

### activeColor

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `activeColor` |
| HTML attribute | `active-color` |
| 타입 | `string` |
| 기본값 | `'#f59e0b'` |

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

### nodeLabels

허용값: auto, show, hide. 기본값: 'auto'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `nodeLabels` |
| HTML attribute | `node-labels` |
| 타입 | `TreemapLabelMode` |
| 기본값 | `'auto'` |
| 허용값 | `auto`, `show`, `hide` |

- [TreemapLabelMode](https://chart.syidax.com/ko/docs/types/TreemapLabelMode.md) — 타입 정의

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

### nodeLabelValue

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `nodeLabelValue` |
| HTML attribute | `node-label-value` |
| 타입 | `boolean` |
| 기본값 | `false` |

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

### chartTitle

차트 내부 제목입니다. 데이터의 단위와 의미를 함께 설명하세요.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `chartTitle` |
| HTML attribute | `chart-title` |
| 타입 | `string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### chartSubtitle

차트 내부 부제목입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `chartSubtitle` |
| HTML attribute | `chart-subtitle` |
| 타입 | `string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### enableMouseTracking

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `enableMouseTracking` |
| HTML attribute | `enable-mouse-tracking` |
| 타입 | `boolean` |
| 기본값 | `true` |

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

### tooltip

포인터에 따라 표시할 값, 위치, 내용의 툴팁 설정입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `tooltip` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `CartesianTooltipInput` |
| 기본값 | `undefined` |
| 타입에 포함된 리터럴 | `auto`, `off` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [CartesianTooltipInput](https://chart.syidax.com/ko/docs/types/CartesianTooltipInput.md) — 타입 정의

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

### tooltipEnabled

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `tooltipEnabled` |
| HTML attribute | `tooltip-show` |
| 타입 | `boolean` |
| 기본값 | `true` |

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

### tooltipFormat

JavaScript 프로퍼티로 전달합니다. 타입: (detail: TreemapHitDetail) => string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `tooltipFormat` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `(detail: TreemapHitDetail) => string` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [TreemapHitDetail](https://chart.syidax.com/ko/docs/types/TreemapHitDetail.md) — 타입 정의

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

### animated

초기 표시와 데이터 변경의 애니메이션 사용 여부입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `animated` |
| HTML attribute | `animate` |
| 타입 | `boolean` |
| 기본값 | `false` |

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

### animationDuration

애니메이션 지속 시간(ms).

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `animationDuration` |
| HTML attribute | `animation-duration` |
| 타입 | `number` |
| 기본값 | `600` |

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

### animationEasing

허용값: linear, ease-out, ease-in, ease-in-out. 기본값: 'ease-out'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `animationEasing` |
| HTML attribute | `animation-easing` |
| 타입 | `TreemapEasing` |
| 기본값 | `'ease-out'` |
| 허용값 | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

- [TreemapEasing](https://chart.syidax.com/ko/docs/types/TreemapEasing.md) — 타입 정의

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

### animationType

허용값: initial, update. 기본값: undefined.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `animationType` |
| HTML attribute | `animation-type` |
| 타입 | `TreemapAnimationType` |
| 기본값 | `undefined` |
| 허용값 | `initial`, `update` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [TreemapAnimationType](https://chart.syidax.com/ko/docs/types/TreemapAnimationType.md) — 타입 정의

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

### streamSource

실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `streamSource` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `TreemapStreamSource` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [TreemapStreamSource](https://chart.syidax.com/ko/docs/types/TreemapStreamSource.md) — 타입 정의

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

### streamMax

보관할 스트리밍 데이터의 최대 수입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `streamMax` |
| HTML attribute | `stream-max` |
| 타입 | `number` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### streamWindow

화면에 유지할 스트리밍 데이터 구간입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `streamWindow` |
| HTML attribute | `stream-window` |
| 타입 | `number` |
| 기본값 | `undefined` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

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

### zoom

확대·축소와 표시 범위의 동작 설정입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `zoom` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `CartesianZoomInput` |
| 기본값 | `undefined` |
| 타입에 포함된 리터럴 | `auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside` |

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

- [CartesianZoomInput](https://chart.syidax.com/ko/docs/types/CartesianZoomInput.md) — 타입 정의

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

### engine

auto·standard·pro 렌더러 선택입니다. 엔진 선택은 차트 종류의 Pro 사용 권한과 별개입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `engine` |
| HTML attribute | `engine` |
| 타입 | `TreemapEngineMode` |
| 기본값 | `'auto'` |
| 허용값 | `auto`, `standard`, `pro` |

- [TreemapEngineMode](https://chart.syidax.com/ko/docs/types/TreemapEngineMode.md) — 타입 정의

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

### unavailable

허용값: fallback, error. 기본값: 'fallback'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `unavailable` |
| HTML attribute | `unavailable` |
| 타입 | `TreemapUnavailableBehaviour` |
| 기본값 | `'fallback'` |
| 허용값 | `fallback`, `error` |

- [TreemapUnavailableBehaviour](https://chart.syidax.com/ko/docs/types/TreemapUnavailableBehaviour.md) — 타입 정의

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

## Events

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

### rendered

차트 그리기가 완료되면 렌더링 결과를 detail로 전달합니다.

이벤트 이름: `rendered`. 대소문자를 구분합니다. payload는 `CustomEvent<TreemapRenderResult & { tier: TreemapEngineTier }>`의 `detail`에서 읽습니다.

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

- [TreemapRenderResult](https://chart.syidax.com/ko/docs/types/TreemapRenderResult.md) — 타입 정의
- [TreemapEngineTier](https://chart.syidax.com/ko/docs/types/TreemapEngineTier.md) — 타입 정의

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

### nodeClick

CustomEvent.detail 타입: TreemapHitDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `nodeClick`. 대소문자를 구분합니다. payload는 `CustomEvent<TreemapHitDetail>`의 `detail`에서 읽습니다.

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

- [TreemapHitDetail](https://chart.syidax.com/ko/docs/types/TreemapHitDetail.md) — 타입 정의

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

### nodeHover

CustomEvent.detail 타입: TreemapHitDetail | null. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `nodeHover`. 대소문자를 구분합니다. payload는 `CustomEvent<TreemapHitDetail | null>`의 `detail`에서 읽습니다.

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

- [TreemapHitDetail](https://chart.syidax.com/ko/docs/types/TreemapHitDetail.md) — 타입 정의

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

### selectionChanged

CustomEvent.detail 타입: TreemapSelectionChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `selectionChanged`. 대소문자를 구분합니다. payload는 `CustomEvent<TreemapSelectionChangeEventDetail>`의 `detail`에서 읽습니다.

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

- [TreemapSelectionChangeEventDetail](https://chart.syidax.com/ko/docs/types/TreemapSelectionChangeEventDetail.md) — 타입 정의

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

### pointContextMenu

CustomEvent.detail 타입: ChartPointContextMenuEventDetail<TreemapHitDetail>. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `pointContextMenu`. 대소문자를 구분합니다. payload는 `CustomEvent<ChartPointContextMenuEventDetail<TreemapHitDetail>>`의 `detail`에서 읽습니다.

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

- [ChartPointContextMenuEventDetail](https://chart.syidax.com/ko/docs/types/ChartPointContextMenuEventDetail.md) — 타입 정의
- [TreemapHitDetail](https://chart.syidax.com/ko/docs/types/TreemapHitDetail.md) — 타입 정의

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

### appended

CustomEvent.detail 타입: { count: number; replaced: number }. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `appended`. 대소문자를 구분합니다. payload는 `CustomEvent<{ count: number; replaced: number }>`의 `detail`에서 읽습니다.

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

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

### windowSlid

CustomEvent.detail 타입: { dropped: number }. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `windowSlid`. 대소문자를 구분합니다. payload는 `CustomEvent<{ dropped: number }>`의 `detail`에서 읽습니다.

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

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

### tooltipShow

내장 툴팁 표시 여부입니다.

이벤트 이름: `tooltipShow`. 대소문자를 구분합니다. payload는 `CustomEvent<CartesianTooltipEventDetail>`의 `detail`에서 읽습니다.

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

- [CartesianTooltipEventDetail](https://chart.syidax.com/ko/docs/types/CartesianTooltipEventDetail.md) — 타입 정의

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

### tooltipHide

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `tooltipHide`. 대소문자를 구분합니다. payload는 `CustomEvent<void>`의 `detail`에서 읽습니다.

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

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

### tooltipAction

CustomEvent.detail 타입: CartesianTooltipActionEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `tooltipAction`. 대소문자를 구분합니다. payload는 `CustomEvent<CartesianTooltipActionEventDetail>`의 `detail`에서 읽습니다.

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

- [CartesianTooltipActionEventDetail](https://chart.syidax.com/ko/docs/types/CartesianTooltipActionEventDetail.md) — 타입 정의

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

### chartAnimationStart

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `chartAnimationStart`. 대소문자를 구분합니다. payload는 `CustomEvent<void>`의 `detail`에서 읽습니다.

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

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

### chartAnimationEnd

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `chartAnimationEnd`. 대소문자를 구분합니다. payload는 `CustomEvent<void>`의 `detail`에서 읽습니다.

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

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

### chartAnimationInterrupted

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `chartAnimationInterrupted`. 대소문자를 구분합니다. payload는 `CustomEvent<void>`의 `detail`에서 읽습니다.

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

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

### zoomChange

CustomEvent.detail 타입: CartesianZoomChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `zoomChange`. 대소문자를 구분합니다. payload는 `CustomEvent<CartesianZoomChangeEventDetail>`의 `detail`에서 읽습니다.

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

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/ko/docs/types/CartesianZoomChangeEventDetail.md) — 타입 정의

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

### drillChange

CustomEvent.detail 타입: TreemapDrillChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: `drillChange`. 대소문자를 구분합니다. payload는 `CustomEvent<TreemapDrillChangeEventDetail>`의 `detail`에서 읽습니다.

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

- [TreemapDrillChangeEventDetail](https://chart.syidax.com/ko/docs/types/TreemapDrillChangeEventDetail.md) — 타입 정의

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

## Methods

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

### redraw

현재 데이터와 옵션으로 차트를 다시 그립니다. 반환되는 Promise가 완료되면 렌더링 결과를 확인할 수 있습니다.

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

반환 타입: `Promise<TreemapRenderResult>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapRenderResult](https://chart.syidax.com/ko/docs/types/TreemapRenderResult.md) — 타입 정의

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

### getActiveTier

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

반환 타입: `Promise<TreemapEngineTier>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapEngineTier](https://chart.syidax.com/ko/docs/types/TreemapEngineTier.md) — 타입 정의

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

반환 타입: `Promise<string | undefined>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

### setData

Replace the bar set.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `data` | `TreemapData` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapData](https://chart.syidax.com/ko/docs/types/TreemapData.md) — 타입 정의

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

### getNodes

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

반환 타입: `Promise<TreemapNode[]>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapNode](https://chart.syidax.com/ko/docs/types/TreemapNode.md) — 타입 정의

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

### getNode

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `index` | `number` | 필수 |

반환 타입: `Promise<TreemapNode | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapNode](https://chart.syidax.com/ko/docs/types/TreemapNode.md) — 타입 정의

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

### getNodeById

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `id` | `string` | 필수 |

반환 타입: `Promise<TreemapNode | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapNode](https://chart.syidax.com/ko/docs/types/TreemapNode.md) — 타입 정의

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

### getNodeCount

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

반환 타입: `Promise<number>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

### getExtent

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

반환 타입: `Promise<TreemapExtent>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapExtent](https://chart.syidax.com/ko/docs/types/TreemapExtent.md) — 타입 정의

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

반환 타입: `Promise<TreemapLayoutResult>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapLayoutResult](https://chart.syidax.com/ko/docs/types/TreemapLayoutResult.md) — 타입 정의

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

### appendPoint

스트림에 값 하나를 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `node` | `TreemapNodeInput` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapNodeInput](https://chart.syidax.com/ko/docs/types/TreemapNodeInput.md) — 타입 정의

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

### appendBatch

스트림에 여러 값을 한 번에 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `nodes` | `ReadonlyArray<TreemapNodeInput>` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapNodeInput](https://chart.syidax.com/ko/docs/types/TreemapNodeInput.md) — 타입 정의

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

### shift

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

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `count` | `number` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `nodes` | `ReadonlyArray<TreemapNodeInput>` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapNodeInput](https://chart.syidax.com/ko/docs/types/TreemapNodeInput.md) — 타입 정의

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

반환 타입: `Promise<ChartEngineStatus>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [ChartEngineStatus](https://chart.syidax.com/ko/docs/types/ChartEngineStatus.md) — 타입 정의

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

반환 타입: `Promise<TreemapStreamSource | undefined>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapStreamSource](https://chart.syidax.com/ko/docs/types/TreemapStreamSource.md) — 타입 정의

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

### pauseAnimation

진행 중인 애니메이션을 일시 정지합니다.

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

### resumeAnimation

일시 정지한 애니메이션을 다시 진행합니다.

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

### setAnimation

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `options` | `{ enabled?: boolean; duration?: number; easing?: TreemapEasing; type?: TreemapAnimationType }` | 필수 |

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapEasing](https://chart.syidax.com/ko/docs/types/TreemapEasing.md) — 타입 정의
- [TreemapAnimationType](https://chart.syidax.com/ko/docs/types/TreemapAnimationType.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `cssX` | `number` | 필수 |
| `cssY` | `number` | 필수 |

반환 타입: `Promise<TreemapHitDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapHitDetail](https://chart.syidax.com/ko/docs/types/TreemapHitDetail.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `index` | `number` | 필수 |

반환 타입: `Promise<TreemapHitDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapHitDetail](https://chart.syidax.com/ko/docs/types/TreemapHitDetail.md) — 타입 정의

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

### clearSelection

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

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

반환 타입: `Promise<TreemapSelection>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapSelection](https://chart.syidax.com/ko/docs/types/TreemapSelection.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `rootId` | `string \| null` | 필수 |

반환 타입: `Promise<TreemapDrillChangeEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapDrillChangeEventDetail](https://chart.syidax.com/ko/docs/types/TreemapDrillChangeEventDetail.md) — 타입 정의

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

### drillDown

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

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `nodeIndex` | `number` | 필수 |

반환 타입: `Promise<TreemapDrillChangeEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapDrillChangeEventDetail](https://chart.syidax.com/ko/docs/types/TreemapDrillChangeEventDetail.md) — 타입 정의

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

### drillUp

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

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

반환 타입: `Promise<TreemapDrillChangeEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapDrillChangeEventDetail](https://chart.syidax.com/ko/docs/types/TreemapDrillChangeEventDetail.md) — 타입 정의

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

반환 타입: `Promise<TreemapNode | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapNode](https://chart.syidax.com/ko/docs/types/TreemapNode.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `index` | `number` | 필수 |

반환 타입: `Promise<CartesianTooltipEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [CartesianTooltipEventDetail](https://chart.syidax.com/ko/docs/types/CartesianTooltipEventDetail.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `index` | `number` | 필수 |

반환 타입: `Promise<CartesianTooltipEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [CartesianTooltipEventDetail](https://chart.syidax.com/ko/docs/types/CartesianTooltipEventDetail.md) — 타입 정의

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

### hideTooltip

현재 표시 중인 툴팁을 닫습니다.

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

반환 타입: `Promise<void>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `request` | `CartesianZoomRequest` | 필수 |

반환 타입: `Promise<CartesianZoomChangeEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/ko/docs/types/CartesianZoomChangeEventDetail.md) — 타입 정의
- [CartesianZoomRequest](https://chart.syidax.com/ko/docs/types/CartesianZoomRequest.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `factor` | `number` | 필수 |
| `anchorFraction` | `number` | 선택 |

반환 타입: `Promise<CartesianZoomChangeEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/ko/docs/types/CartesianZoomChangeEventDetail.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `delta` | `{ x?: number; y?: number }` | 필수 |

반환 타입: `Promise<CartesianZoomChangeEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/ko/docs/types/CartesianZoomChangeEventDetail.md) — 타입 정의

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

### resetZoom

확대·이동한 범위를 초기 데이터 범위로 되돌립니다.

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

반환 타입: `Promise<CartesianZoomChangeEventDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [CartesianZoomChangeEventDetail](https://chart.syidax.com/ko/docs/types/CartesianZoomChangeEventDetail.md) — 타입 정의

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

### getZoom

현재 확대 범위를 읽습니다. 반환 타입의 null 허용 여부와 축별 범위를 확인하세요.

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

반환 타입: `Promise<CartesianZoomState | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [CartesianZoomState](https://chart.syidax.com/ko/docs/types/CartesianZoomState.md) — 타입 정의

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `request` | `CartesianZoomExtentRequest` | 선택 |

반환 타입: `Promise<CartesianZoomExtentDetail | null>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [CartesianZoomExtentDetail](https://chart.syidax.com/ko/docs/types/CartesianZoomExtentDetail.md) — 타입 정의
- [CartesianZoomExtentRequest](https://chart.syidax.com/ko/docs/types/CartesianZoomExtentRequest.md) — 타입 정의

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

### getDataTable

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

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

반환 타입: `Promise<ChartDataTable>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [ChartDataTable](https://chart.syidax.com/ko/docs/types/ChartDataTable.md) — 타입 정의

<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[]>
```

반환 타입: `Promise<TreemapLabel[]>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [TreemapLabel](https://chart.syidax.com/ko/docs/types/TreemapLabel.md) — 타입 정의