# Ohlc

네 가격을 고저선과 시가·종가 눈금으로 읽습니다.

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

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

## sy-ohlc-chart

많은 가격 막대를 간결하게 표시할 때 사용하세요.

캔들과 같은 데이터 형식을 사용합니다. time의 시간대와 간격을 일관되게 유지하세요.

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

| 입력 | 데이터 설명 |
| --- | --- |
| `data` | time·open·high·low·close를 가진 가격 배열입니다. |
| `barStyle` | ohlc·hlc·hilo 중 눈금 형식입니다. |

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

  // Pro: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
  // 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-ohlc-chart",
      "props": {
        "data": [
          {
            "time": 1767225600000,
            "open": 100,
            "close": 95,
            "high": 103,
            "low": 92,
            "volume": 1200
          },
          {
            "time": 1767312000000,
            "open": 104,
            "close": 106,
            "high": 109,
            "low": 101,
            "volume": 1337
          },
          {
            "time": 1767398400000,
            "open": 107,
            "close": 105,
            "high": 110,
            "low": 102,
            "volume": 1474
          },
          {
            "time": 1767484800000,
            "open": 109,
            "close": 114,
            "high": 117,
            "low": 106,
            "volume": 1611
          },
          {
            "time": 1767571200000,
            "open": 108,
            "close": 109,
            "high": 112,
            "low": 105,
            "volume": 1748
          },
          {
            "time": 1767657600000,
            "open": 106,
            "close": 103,
            "high": 109,
            "low": 100,
            "volume": 1885
          },
          {
            "time": 1767744000000,
            "open": 102,
            "close": 106,
            "high": 109,
            "low": 99,
            "volume": 2022
          },
          {
            "time": 1767830400000,
            "open": 100,
            "close": 100,
            "high": 103,
            "low": 97,
            "volume": 2159
          },
          {
            "time": 1767916800000,
            "open": 98,
            "close": 94,
            "high": 101,
            "low": 91,
            "volume": 2296
          },
          {
            "time": 1768003200000,
            "open": 99,
            "close": 102,
            "high": 105,
            "low": 96,
            "volume": 2433
          },
          {
            "time": 1768089600000,
            "open": 101,
            "close": 100,
            "high": 104,
            "low": 97,
            "volume": 2570
          },
          {
            "time": 1768176000000,
            "open": 105,
            "close": 100,
            "high": 108,
            "low": 97,
            "volume": 2707
          },
          {
            "time": 1768262400000,
            "open": 109,
            "close": 111,
            "high": 114,
            "low": 106,
            "volume": 2844
          },
          {
            "time": 1768348800000,
            "open": 113,
            "close": 111,
            "high": 116,
            "low": 108,
            "volume": 2981
          },
          {
            "time": 1768435200000,
            "open": 115,
            "close": 120,
            "high": 123,
            "low": 112,
            "volume": 1318
          },
          {
            "time": 1768521600000,
            "open": 115,
            "close": 116,
            "high": 119,
            "low": 112,
            "volume": 1455
          },
          {
            "time": 1768608000000,
            "open": 114,
            "close": 111,
            "high": 117,
            "low": 108,
            "volume": 1592
          },
          {
            "time": 1768694400000,
            "open": 111,
            "close": 115,
            "high": 118,
            "low": 108,
            "volume": 1729
          },
          {
            "time": 1768780800000,
            "open": 108,
            "close": 108,
            "high": 111,
            "low": 105,
            "volume": 1866
          },
          {
            "time": 1768867200000,
            "open": 105,
            "close": 101,
            "high": 108,
            "low": 98,
            "volume": 2003
          },
          {
            "time": 1768953600000,
            "open": 105,
            "close": 108,
            "high": 111,
            "low": 102,
            "volume": 2140
          },
          {
            "time": 1769040000000,
            "open": 107,
            "close": 106,
            "high": 110,
            "low": 103,
            "volume": 2277
          },
          {
            "time": 1769126400000,
            "open": 110,
            "close": 105,
            "high": 113,
            "low": 102,
            "volume": 2414
          },
          {
            "time": 1769212800000,
            "open": 114,
            "close": 116,
            "high": 119,
            "low": 111,
            "volume": 2551
          },
          {
            "time": 1769299200000,
            "open": 119,
            "close": 117,
            "high": 122,
            "low": 114,
            "volume": 2688
          },
          {
            "time": 1769385600000,
            "open": 121,
            "close": 126,
            "high": 129,
            "low": 118,
            "volume": 2825
          },
          {
            "time": 1769472000000,
            "open": 123,
            "close": 124,
            "high": 127,
            "low": 120,
            "volume": 2962
          },
          {
            "time": 1769558400000,
            "open": 121,
            "close": 118,
            "high": 124,
            "low": 115,
            "volume": 1299
          },
          {
            "time": 1769644800000,
            "open": 119,
            "close": 123,
            "high": 126,
            "low": 116,
            "volume": 1436
          },
          {
            "time": 1769731200000,
            "open": 116,
            "close": 116,
            "high": 119,
            "low": 113,
            "volume": 1573
          },
          {
            "time": 1769817600000,
            "open": 113,
            "close": 109,
            "high": 116,
            "low": 106,
            "volume": 1710
          },
          {
            "time": 1769904000000,
            "open": 112,
            "close": 115,
            "high": 118,
            "low": 109,
            "volume": 1847
          }
        ],
        "barStyle": "ohlc",
        "timeScale": "ordinal",
        "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', 'ohlc 예제 차트');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  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();
    container.replaceChildren();
  }
</script>
```

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

## Properties

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

### barStyle

ohlc·hlc·hilo 중 눈금 형식입니다.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `barStyle` |
| HTML attribute | `bar-style` |
| 타입 | `'ohlc' \| 'hlc' \| 'hilo'` |
| 기본값 | `'ohlc'` |
| 허용값 | `ohlc`, `hlc`, `hilo` |

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

### data

time·open·high·low·close를 가진 가격 배열입니다.

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

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

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

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

### xAxis

가로축의 종류, 범주, 범위와 표시 형식을 설정합니다. category 축은 categories의 순서를 값 배열의 인덱스와 맞추세요. 여러 축을 받는 경우 축 배열로 전달할 수 있습니다.

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

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

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

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

### yAxis

세로축의 범위, 눈금, 레이블과 방향을 설정합니다. 비교하는 값의 단위를 맞추고, 막대의 길이를 비교할 때는 0 기준을 고려하세요.

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

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

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

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

### gridLines

허용값: auto, off. 기본값: undefined.

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

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

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

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

### crosshair

Crosshair that follows the cursor across the plot (forwarded; the inner `crosshairMove` bubbles through the host).

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

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

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

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

### zoom

Zoom (Storybook parity 2026-09-10) — the candlestick's shared cartesian zoom, forwarded; the inner `zoomChange` bubbles through the host.

| 항목 | 값 |
| --- | --- |
| 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-xMin"></a>

### xMin

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `xMin` |
| HTML attribute | `x-min` |
| 타입 | `number` |
| 기본값 | `undefined` |

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

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

### xMax

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

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

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

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

### yMin

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `yMin` |
| HTML attribute | `y-min` |
| 타입 | `number` |
| 기본값 | `undefined` |

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

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

### yMax

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

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

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

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

### padding

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

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

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

### upColor

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `upColor` |
| HTML attribute | `up-color` |
| 타입 | `string` |
| 기본값 | `'#26a69a'` |

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

### downColor

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

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

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

### flatColor

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `flatColor` |
| HTML attribute | `flat-color` |
| 타입 | `string` |
| 기본값 | `'#9ca3af'` |

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

### candleWidth

The tick length's share of the bar pitch (the candle body ratio; 0.7 by default).

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

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

### candleMinPx

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `candleMinPx` |
| HTML attribute | `candle-min-px` |
| 타입 | `number` |
| 기본값 | `1` |

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

### candleMaxPx

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `candleMaxPx` |
| HTML attribute | `candle-max-px` |
| 타입 | `number` |
| 기본값 | `40` |

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

### wickWidth

The spine and tick thickness in CSS px.

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

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

### tickLength

(carry-over D5) — the open / close tick length in CSS px (default: the body half-width).

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `tickLength` |
| HTML attribute | `tick-length` |
| 타입 | `number` |
| 기본값 | `undefined` |

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

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

### fillAlpha

(carry-over D5) — the band fill alpha 0 … 1 (default 0.12).

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `fillAlpha` |
| HTML attribute | `fill-alpha` |
| 타입 | `number` |
| 기본값 | `undefined` |

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

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

### bodyMinPx

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `bodyMinPx` |
| HTML attribute | `body-min-px` |
| 타입 | `number` |
| 기본값 | `1` |

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

### bodyStyle

Candle-only lanes, forwarded for parity (an OHLC bar has no body to hollow).

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `bodyStyle` |
| HTML attribute | `body-style` |
| 타입 | `CandlestickBodyStyle` |
| 기본값 | `'solid'` |
| 허용값 | `solid`, `hollow`, `hollow-up` |

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

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

### bodyBorderPx

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `bodyBorderPx` |
| HTML attribute | `body-border-px` |
| 타입 | `number` |
| 기본값 | `1` |

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

### wickColor

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

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

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

### antialias

허용값: auto, off, on. 기본값: 'auto'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `antialias` |
| HTML attribute | `antialias` |
| 타입 | `CandlestickAntialias` |
| 기본값 | `'auto'` |
| 허용값 | `auto`, `off`, `on` |

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

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

### pixelSnap

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

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

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

### timeScale

허용값: linear, ordinal. 기본값: 'ordinal'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `timeScale` |
| HTML attribute | `time-scale` |
| 타입 | `CandlestickTimeScale` |
| 기본값 | `'ordinal'` |
| 허용값 | `linear`, `ordinal` |

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

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

### session

JavaScript 프로퍼티로 전달합니다. 타입: CandlestickSessionInput | string.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `session` |
| HTML attribute | 객체·배열·콜백은 JavaScript 프로퍼티로 전달 |
| 타입 | `CandlestickSessionInput \| string` |
| 기본값 | `'24x7'` |

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

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

### labelLocale

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

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

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

### volume

허용값: off, pane. 기본값: 'off'.

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `volume` |
| HTML attribute | `volume` |
| 타입 | `CandlestickVolumeMode` |
| 기본값 | `'off'` |
| 허용값 | `off`, `pane` |

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

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

### volumeHeight

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

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

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

### volumeUpColor

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

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

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

### volumeDownColor

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

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

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

### volumeAlpha

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

| 항목 | 값 |
| --- | --- |
| JavaScript 프로퍼티 | `volumeAlpha` |
| HTML attribute | `volume-alpha` |
| 타입 | `number` |
| 기본값 | `0.45` |

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

### overlays

JavaScript 프로퍼티로 전달합니다. 타입: CandlestickOverlayInput | string.

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

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

- [CandlestickOverlayInput](https://chart.syidax.com/ko/docs/types/CandlestickOverlayInput.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-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: CandlestickPointEventDetail) => string.

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

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

- [CandlestickPointEventDetail](https://chart.syidax.com/ko/docs/types/CandlestickPointEventDetail.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` |
| 타입 | `CandlestickEasing` |
| 기본값 | `'ease-out'` |
| 허용값 | `linear`, `ease-out`, `ease-in`, `ease-in-out` |

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

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

### animationType

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

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

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

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

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

### streamSource

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

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

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

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

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

### streamMax

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

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

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

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

### streamWindow

The newest N streamed bars the chart renders (the whole buffer when unset).

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

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

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

### engine

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

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

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

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

### unavailable

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

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

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

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

## Methods

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

### redraw

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

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

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

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

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

### getActiveTier

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

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

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

- [CandlestickEngineTier](https://chart.syidax.com/ko/docs/types/CandlestickEngineTier.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: CandlestickData): Promise<void>
```

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

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

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

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

### appendPoint

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

```typescript
appendPoint(bar: CandlestickBarInput): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `bar` | `CandlestickBarInput` | 필수 |

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

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

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

### appendBatch

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

```typescript
appendBatch(bars: ReadonlyArray<CandlestickBarInput>): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `bars` | `ReadonlyArray<CandlestickBarInput>` | 필수 |

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

- [CandlestickBarInput](https://chart.syidax.com/ko/docs/types/CandlestickBarInput.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(bars: ReadonlyArray<CandlestickBarInput>): Promise<void>
```

| 인수 | 타입 | 필수 여부 |
| --- | --- | --- |
| `bars` | `ReadonlyArray<CandlestickBarInput>` | 필수 |

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

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

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

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

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

### setAnimation

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

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

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

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

- [CandlestickEasing](https://chart.syidax.com/ko/docs/types/CandlestickEasing.md) — 타입 정의
- [CandlestickAnimationType](https://chart.syidax.com/ko/docs/types/CandlestickAnimationType.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-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<CandlestickPointEventDetail | null>
```

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

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

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

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

### getBar

The normalised bar at an index (null outside).

```typescript
getBar(index: number): Promise<CandlestickBar | null>
```

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

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

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

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

### getBarAt

The bar nearest to a time (null for an empty series).

```typescript
getBarAt(time: number): Promise<(CandlestickBar & { index: number }) | null>
```

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

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

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

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

### getBarCount

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

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

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

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

### getExtent

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

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

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

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

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

### getDomain

The data domain the grid spans.

```typescript
getDomain(): Promise<CandlestickDomain>
```

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

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

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

### getVisibleRange

The bars the plot shows: the `x-axis` window, narrowed by the zoom when one is in place.

```typescript
getVisibleRange(): Promise<CandlestickVisibleRange>
```

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

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

### hideTooltip

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

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

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

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

### focusBarAt

move the keyboard focus ring to a bar (null outside the visible window); emits pointHover like the walk.

```typescript
focusBarAt(index: number): Promise<CandlestickPointEventDetail | null>
```

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

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

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

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

### getOverlays

the overlays: each settled spec with where its PRIMARY line exists and what is visible (the outputs and the band ride on the spec).

```typescript
getOverlays(): Promise<CandlestickOverlayState[]>
```

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

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

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

### getOverlayValues

the overlay values at a bar index: the primary output under the overlay id, the others under `id.key` (null through a warm-up).

```typescript
getOverlayValues(index: number): Promise<Record<string, number | null>>
```

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

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

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

### getPanes

the panes: the price pane, the volume pane when it exists, the separator, and why there is none.

```typescript
getPanes(): Promise<CandlestickPaneRects>
```

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

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

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

### getTimeScale

the time scale of the visible range: the kind, the slots, the spacing and the ordinal ticks.

```typescript
getTimeScale(): Promise<CandlestickTimeScaleState>
```

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

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

<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 | 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 data 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 (and key) of the primary — or the named — master axes (`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-getEngineStatus"></a>

### getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): the inner candlestick's own status once it is mounted (it gates chart.type.ohlc and chart.type.candlestick); before that, this proxy's chart.type.ohlc decision, read without side effects.

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

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

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