# Theme River

시간에 따라 달라지는 여러 흐름을 쌓아 보여줍니다.

Canonical: https://chart.syidax.com/ko/docs/components/theme-river/

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

## sy-theme-river

주제별 관심도나 구성의 변화를 탐색하세요.

중앙 기준선이 움직이므로 높이 위치보다 밴드의 두께를 읽으세요. 정확한 비교는 표를 사용하세요.

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

| 입력 | 데이터 설명 |
| --- | --- |
| `data` | { x: [...], series: [{ id, name?, values }] }입니다. 모든 values를 x와 정렬합니다. |
| `offset` | silhouette·zero·expand 기준선입니다. |

- [Components에서 실행하기](https://chart.syidax.com/charts/theme-river) — 옵션 변경과 프레임워크별 코드
- [공통 설치와 연결](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-theme-river.js';
  define0();

  // Pro: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
  // 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-theme-river",
      "props": {
        "data": {
          "x": [0, 1, 2, 3, 4, 5],
          "series": [
            {
              "id": "s0",
              "name": "온라인",
              "values": [24, 29, 27, 38, 43, 40],
              "color": "#8263d9"
            },
            {
              "id": "s1",
              "name": "매장",
              "values": [15, 19, 17, 24, 22, 29],
              "color": "#239c91"
            }
          ]
        },
        "offset": "silhouette",
        "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', 'theme-river 예제 차트');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('pointClick', event.detail);
  };
  chart.addEventListener('pointClick', 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('pointClick', onEvent);
    container.replaceChildren();
  }
</script>
```

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

## Properties

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

### data

{ x: [...], series: [{ id, name?, values }] }입니다. 모든 values를 x와 정렬합니다.

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

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

- [ThemeRiverData](https://chart.syidax.com/ko/docs/types/ThemeRiverData.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` |
| 기본값 | `420` |

<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-offset"></a>

### offset

silhouette·zero·expand 기준선입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `offset` |
| HTML attribute | `offset` |
| 타입 | `ThemeRiverOffset` |
| 기본값 | `'silhouette'` |
| 허용값 | `silhouette`, `zero`, `expand` |

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

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

### order

허용값: input, reverse. 기본값: 'input'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `order` |
| HTML attribute | `order` |
| 타입 | `ThemeRiverOrder` |
| 기본값 | `'input'` |
| 허용값 | `input`, `reverse` |

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

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

### colors

JavaScript 프로퍼티로 전달합니다. 타입: ReadonlyArray<string>.

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

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

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

### opacity

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

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

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

### axes

JavaScript 프로퍼티로 전달합니다. 타입: ThemeRiverAxesOptions.

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

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

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

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

### legend

시리즈 또는 항목의 범례 표시 여부입니다.

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

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

### hiddenSeries

JavaScript 프로퍼티로 전달합니다. 타입: ReadonlyArray<ThemeRiverId>.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `hiddenSeries` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `ReadonlyArray<ThemeRiverId>` |
| 기본값 | `[]` |

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

<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-locale"></a>

### locale

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

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

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

### showEmpty

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

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

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

### activeColor

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

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

<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: ThemeRiverHitDetail) => string.

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

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

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

<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-crosshair"></a>

### crosshair

JavaScript 프로퍼티로 전달합니다. 타입: CartesianCrosshairInput.

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

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

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

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

### crosshairSnapDistance

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `crosshairSnapDistance` |
| HTML attribute | `crosshair-snap-distance` |
| 타입 | `number` |
| 기본값 | `24` |

<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` |
| 타입 | `ThemeRiverEasing` |
| 기본값 | `'ease-out'` |
| 허용값 | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

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

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

### animationType

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

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

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

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

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

### streamSource

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

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

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

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

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

### streamMax

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

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

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

### streamWindow

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

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

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

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

### engine

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

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

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

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

### unavailable

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

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

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

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

## Events

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

### rendered

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

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

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

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

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

### pointClick

점 선택 이벤트입니다. CustomEvent.detail에서 선택한 데이터와 인덱스를 읽습니다.

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

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

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

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

### pointHover

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

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

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

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

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

### selectionChanged

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

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

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

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

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

### crosshairMove

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

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

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

- [ThemeRiverCrosshairDetail](https://chart.syidax.com/ko/docs/types/ThemeRiverCrosshairDetail.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-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-dataValidationError"></a>

### dataValidationError

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

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

```javascript
chart.addEventListener('dataValidationError', event => {
  console.log(event.detail); // {
        message: string;
    }
});
```

<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-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-pointContextMenu"></a>

### pointContextMenu

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

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

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

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

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

## Methods

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

### redraw

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

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

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

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

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

### getActiveTier

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

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

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

- [HeatmapEngineTier](https://chart.syidax.com/ko/docs/types/HeatmapEngineTier.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>
```

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

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

### getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome.

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

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

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

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

### recycleGpu

Without the grant (or while frozen) nothing is recycled: no GPU work starts.

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

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

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

### setData

Replace the bar set.

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

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

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

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

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

### getData

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

```typescript
getData(): Promise<ThemeRiverData>
```

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

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

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

### getLayout

Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom.

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

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

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

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

### getDiagnostics

Normalization diagnostics for the effective base and stream source.

```typescript
getDiagnostics(): Promise<{ columns: number; series: number; points: number; missingValues: number; zeroValues: number; }>
```

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

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

### appendPoint

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

```typescript
appendPoint(row: ThemeRiverRow): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `row` | `ThemeRiverRow` | 필수 |

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

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

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

### appendBatch

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

```typescript
appendBatch(rows: ReadonlyArray<ThemeRiverRow>): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `rows` | `ReadonlyArray<ThemeRiverRow>` | 필수 |

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

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

<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(rows: ReadonlyArray<ThemeRiverRow>): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `rows` | `ReadonlyArray<ThemeRiverRow>` | 필수 |

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

- [ThemeRiverRow](https://chart.syidax.com/ko/docs/types/ThemeRiverRow.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-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<ThemeRiverStreamSource>
```

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

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

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

### clearStream

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

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

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

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

### setAnimation

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

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

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `options` | `{<br>        enabled?: boolean;<br>        duration?: number;<br>        easing?: ThemeRiverEasing;<br>        type?: ThemeRiverAnimationType;<br>    }` | 필수 |

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

- [ThemeRiverEasing](https://chart.syidax.com/ko/docs/types/ThemeRiverEasing.md) — 타입 정의
- [ThemeRiverAnimationType](https://chart.syidax.com/ko/docs/types/ThemeRiverAnimationType.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-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-getCSV"></a>

### getCSV

The tape as a CSV table (ISO time, OHLC, volume).

```typescript
getCSV(options?: CsvOptions): Promise<string>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `options` | `CsvOptions` | 선택 |

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

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

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

### getTable

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

```typescript
getTable(): Promise<string>
```

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

<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<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>
```

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

반환 타입: `Promise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

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

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

### selectPointAt

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

```typescript
selectPointAt(series: number, column: number): Promise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `series` | `number` | 필수 |
| `column` | `number` | 필수 |

반환 타입: `Promise<{ cssX: number; cssY: number; kind: "band"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>`. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

- [ThemeRiverId](https://chart.syidax.com/ko/docs/types/ThemeRiverId.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<ThemeRiverSelection | null>
```

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

- [ThemeRiverSelection](https://chart.syidax.com/ko/docs/types/ThemeRiverSelection.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(series: number, column: number): Promise<CartesianTooltipEventDetail>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `series` | `number` | 필수 |
| `column` | `number` | 필수 |

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

- [CartesianTooltipEventDetail](https://chart.syidax.com/ko/docs/types/CartesianTooltipEventDetail.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>
```

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

반환 타입: `Promise<CartesianTooltipEventDetail>`. 요소 등록이 끝난 뒤 메서드를 호출하고 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-showCrosshairAt"></a>

### showCrosshairAt

show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot.

```typescript
showCrosshairAt(series: number, column: number): Promise<boolean>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `series` | `number` | 필수 |
| `column` | `number` | 필수 |

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

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

### showCrosshairAtData

Quiet source-category synchronization. Categories retain their original string or number type.

```typescript
showCrosshairAtData(request: CartesianCrosshairShowRequest): Promise<boolean>
```

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

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

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

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

### hideCrosshair

hide the crosshair shown by `showCrosshairAt` (or the pointer's).

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

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

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

### zoomTo

zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis).

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

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

반환 타입: `Promise<CartesianZoomChangeEventDetail>`. 요소 등록이 끝난 뒤 메서드를 호출하고 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>
```

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

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

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

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

### panBy

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

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

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

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

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

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

### resetZoom

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

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

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

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

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

### getZoom

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

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

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

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

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

### getZoomExtent

the full extent (and key) of the primary — or the named — master axes (`null` before the first layout).

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

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

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

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