# Candlestick

Show four prices per period in a candlestick.

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

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

## sy-candlestick-chart

Explore changes in opening, high, low, and closing prices.

The example uses fictional prices. Match time zones, trading sessions, and adjusted-price conventions to your actual data.

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

| Input | Data description |
| --- | --- |
| `data` | An array of { time, open, high, low, close, volume? }. |
| `timeScale` | ordinal reflects trading order; linear reflects elapsed time. |
| `volume` | Select pane to display volume alongside prices. |

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

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

## Complete implementation example

```html
<div id="chart-container" style="width: 100%; min-width: 0;"></div>

<script type="module">
  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-candlestick-chart.js';
  define0();

  // Pro: complete registerLicense at app startup using your issued certificate.
  // The website preview certificate is not for use in customer apps.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-candlestick-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
          }
        ],
        "timeScale": "ordinal",
        "volume": "off",
        "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', 'candlestick example chart');
    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);

  // In an SPA, call this function when the view is disposed.
  function disposeChart() {
    observer.disconnect();
    chart.removeEventListener('pointClick', onEvent);
    container.replaceChildren();
  }
</script>
```

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

## Properties

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

### data

An array of { time, open, high, low, close, volume? }.

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

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

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

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

### width

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

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

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

### height

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

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

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

### brandLogo

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

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

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

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

### brandPosition

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

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

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

### xAxis

Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array.

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

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

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

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

### yAxis

Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths.

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

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

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

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

### gridLines

Allowed values: auto, off. Default: undefined.

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

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

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

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

### crosshair

Crosshair that follows the cursor across the plot.

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

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

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

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

### zoom

Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes — x narrows the bar window (slots under the ordinal scale, wall time under linear), y the price; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches.

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

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

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

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

### xMin

Explicit domain ends (an omitted end follows the bars; `x-axis` / `y-axis` `min` / `max` also set them).

| Item | Value |
| --- | --- |
| JavaScript property | `xMin` |
| HTML attribute | `x-min` |
| Type | `number` |
| Default | `undefined` |

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

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

### xMax

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

| Item | Value |
| --- | --- |
| JavaScript property | `xMax` |
| HTML attribute | `x-max` |
| Type | `number` |
| Default | `undefined` |

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

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

### yMin

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

| Item | Value |
| --- | --- |
| JavaScript property | `yMin` |
| HTML attribute | `y-min` |
| Type | `number` |
| Default | `undefined` |

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

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

### yMax

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

| Item | Value |
| --- | --- |
| JavaScript property | `yMax` |
| HTML attribute | `y-max` |
| Type | `number` |
| Default | `undefined` |

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

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

### padding

The price padding above and below the bars (a fraction of the span; default 0.05).

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

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

### upColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `upColor` |
| HTML attribute | `up-color` |
| Type | `string` |
| Default | `DEFAULT_UP_COLOR` |

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

### downColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `downColor` |
| HTML attribute | `down-color` |
| Type | `string` |
| Default | `DEFAULT_DOWN_COLOR` |

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

### flatColor

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

| Item | Value |
| --- | --- |
| JavaScript property | `flatColor` |
| HTML attribute | `flat-color` |
| Type | `string` |
| Default | `DEFAULT_FLAT_COLOR` |

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

### candleWidth

The body's share of the bar pitch (0 … 1; default 0.7).

| Item | Value |
| --- | --- |
| JavaScript property | `candleWidth` |
| HTML attribute | `candle-width` |
| Type | `number` |
| Default | `CANDLE_DEFAULT_WIDTH_RATIO` |

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

### candleMinPx

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

| Item | Value |
| --- | --- |
| JavaScript property | `candleMinPx` |
| HTML attribute | `candle-min-px` |
| Type | `number` |
| Default | `CANDLE_DEFAULT_MIN_PX` |

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

### candleMaxPx

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

| Item | Value |
| --- | --- |
| JavaScript property | `candleMaxPx` |
| HTML attribute | `candle-max-px` |
| Type | `number` |
| Default | `CANDLE_DEFAULT_MAX_PX` |

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

### wickWidth

The wick width in CSS px.

| Item | Value |
| --- | --- |
| JavaScript property | `wickWidth` |
| HTML attribute | `wick-width` |
| Type | `number` |
| Default | `1` |

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

### bodyMinPx

The minimum body height in CSS px (a doji stays visible).

| Item | Value |
| --- | --- |
| JavaScript property | `bodyMinPx` |
| HTML attribute | `body-min-px` |
| Type | `number` |
| Default | `1` |

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

### barStyle

`candle` (default) or `ohlc` (a high–low spine, an open tick left, a close tick right); `hlc` (no open tick). `<sy-ohlc-chart>` takes `ohlc` / `hlc`.

| Item | Value |
| --- | --- |
| JavaScript property | `barStyle` |
| HTML attribute | `bar-style` |
| Type | `CandlestickBarStyle` |
| Default | `'candle'` |
| Allowed values | `candle`, `ohlc`, `hlc`, `hilo` |

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

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

### tickLength

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

| Item | Value |
| --- | --- |
| JavaScript property | `tickLength` |
| HTML attribute | `tick-length` |
| Type | `number` |
| Default | `undefined` |

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

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

### fillAlpha

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

| Item | Value |
| --- | --- |
| JavaScript property | `fillAlpha` |
| HTML attribute | `fill-alpha` |
| Type | `number` |
| Default | `undefined` |

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

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

### bodyStyle

`solid` (default), `hollow`, or `hollow-up` (rising bars hollow, falling filled).

| Item | Value |
| --- | --- |
| JavaScript property | `bodyStyle` |
| HTML attribute | `body-style` |
| Type | `CandlestickBodyStyle` |
| Default | `'solid'` |
| Allowed values | `solid`, `hollow`, `hollow-up` |

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

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

### bodyBorderPx

the hollow ring's border in CSS px.

| Item | Value |
| --- | --- |
| JavaScript property | `bodyBorderPx` |
| HTML attribute | `body-border-px` |
| Type | `number` |
| Default | `1` |

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

### wickColor

the wick colour; `auto` follows the body colour.

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

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

### antialias

the edge coverage: `auto` (on while the pitch is at least two device px), `on`, `off`.

| Item | Value |
| --- | --- |
| JavaScript property | `antialias` |
| HTML attribute | `antialias` |
| Type | `CandlestickAntialias` |
| Default | `'auto'` |
| Allowed values | `auto`, `off`, `on` |

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

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

### pixelSnap

snap the body and the wick to integer device-px widths (crisp, uniform candles).

| Item | Value |
| --- | --- |
| JavaScript property | `pixelSnap` |
| HTML attribute | `pixel-snap` |
| Type | `boolean` |
| Default | `true` |

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

### timeScale

ordinal reflects trading order; linear reflects elapsed time.

| Item | Value |
| --- | --- |
| JavaScript property | `timeScale` |
| HTML attribute | `time-scale` |
| Type | `CandlestickTimeScale` |
| Default | `'ordinal'` |
| Allowed values | `linear`, `ordinal` |

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

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

### session

the exchange session the labels read: `24x7`, `us-equity`, or an object / JSON string `{ timezone, sessions, holidays, closedWeekdays }`.

| Item | Value |
| --- | --- |
| JavaScript property | `session` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CandlestickSessionInput \| string` |
| Default | `'24x7'` |

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

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

### labelLocale

the BCP-47 locale of the month labels.

| Item | Value |
| --- | --- |
| JavaScript property | `labelLocale` |
| HTML attribute | `label-locale` |
| Type | `string` |
| Default | `'en-US'` |

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

### volume

Select pane to display volume alongside prices.

| Item | Value |
| --- | --- |
| JavaScript property | `volume` |
| HTML attribute | `volume` |
| Type | `CandlestickVolumeMode` |
| Default | `'off'` |
| Allowed values | `off`, `pane` |

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

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

### volumeHeight

the volume pane's share of the plot height (0.05 … 0.8).

| Item | Value |
| --- | --- |
| JavaScript property | `volumeHeight` |
| HTML attribute | `volume-height` |
| Type | `number` |
| Default | `0.25` |

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

### volumeUpColor

the volume bar colours; `auto` follows up-color / down-color.

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

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

### volumeDownColor

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

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

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

### volumeAlpha

the volume bars' alpha.

| Item | Value |
| --- | --- |
| JavaScript property | `volumeAlpha` |
| HTML attribute | `volume-alpha` |
| Type | `number` |
| Default | `0.45` |

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

### overlays

moving-average overlays over the closes: spec objects `{ kind, period?, color?, width?, label? }`, a JSON string of them, or the compact `"sma:20 ema:50"`; the kinds are the stock chart's (sma, ema, wma, dema, tema, vwma, hma, linreg). A legend at the top of the price pane names each line and reads its value under the pointer.

| Item | Value |
| --- | --- |
| JavaScript property | `overlays` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CandlestickOverlayInput \| string` |
| Default | `undefined` |

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

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

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

### chartTitle

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

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

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

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

### chartSubtitle

The subtitle inside the chart.

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

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

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

### enableMouseTracking

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

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

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

### tooltip

the bar tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …).

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

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

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

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

### tooltipEnabled

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

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

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

### tooltipFormat

a plain-text formatter of the default tooltip (`tooltip.format` wins).

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

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

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

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

### animated

Whether to animate initial display and data changes.

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

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

### animationDuration

Animation duration in milliseconds.

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

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

### animationEasing

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

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

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

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

### animationType

Allowed values: initial, update. Default: undefined.

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

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

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

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

### streamSource

A stream source of bars (§3.6); without one `appendPoint` creates an internal source.

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

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

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

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

### streamMax

The bars the internal stream source tracks at most.

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

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

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

### streamWindow

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

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

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

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

### engine

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

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

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

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

### unavailable

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

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

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

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

## Events

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

### rendered

Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature).

Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CandlestickRenderResult & { tier: CandlestickEngineTier; engine?: ChartEngineStatus }>`.

```javascript
chart.addEventListener('rendered', event => {
  console.log(event.detail); // CandlestickRenderResult & { tier: CandlestickEngineTier; engine?: ChartEngineStatus }
});
```

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

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

### pointClick

A point selection event. Read the selected data and index from CustomEvent.detail.

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

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

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

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

### pointHover

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

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

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

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

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

### crosshairMove

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

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

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

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

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

### pointContextMenu

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

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

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

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

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

### appended

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

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

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

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

### windowSlid

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

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

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

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

### tooltipShow

the tooltip events of the shared contract.

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

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

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

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

### tooltipHide

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

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

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

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

### tooltipAction

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

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

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

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

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

### chartAnimationStart

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

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

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

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

### chartAnimationEnd

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

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

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

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

### chartAnimationInterrupted

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

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

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

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

### zoomChange

Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state.

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

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

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

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

## Methods

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

### getDataTable

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

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

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

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

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

### redraw

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

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

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

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

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

### getActiveTier

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

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

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

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

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

### getUnavailableReason

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

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

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

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

### setData

Replace the bar set.

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

| Arguments | Type | Required |
| --- | --- | --- |
| `data` | `CandlestickData` | Required |

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

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

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

### appendPoint

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `bar` | `CandlestickBarInput` | Required |

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

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

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

### appendBatch

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `bars` | `ReadonlyArray<CandlestickBarInput>` | Required |

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

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

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

### shift

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

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

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

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

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

### replace

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `bars` | `ReadonlyArray<CandlestickBarInput>` | Required |

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

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

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

### getStreamSource

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

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

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

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

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

### setAnimation

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

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

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

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

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

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

### pauseAnimation

Pause the current animation.

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

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

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

### resumeAnimation

Resume a paused animation.

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

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

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

### replayAnimation

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

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

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

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

### hitTest

The bar under a host-local point (the nearest bar within half a pitch, anywhere inside the plot's height).

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

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

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

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

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

### getBar

The normalised bar at an index (null outside).

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

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

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

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

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

| Arguments | Type | Required |
| --- | --- | --- |
| `time` | `number` | Required |

Return type: `Promise<(CandlestickBar & { index: number }) | null>`. Call the method after element registration and await its Promise result.

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

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

### getBarCount

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

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

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

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

### getExtent

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

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

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

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

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

### getDomain

The data domain the grid spans.

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

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

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

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

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

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

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

### showTooltipAtIndex

open the tooltip on a bar by index (null when the tooltip is off or the bar is outside the visible window).

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

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

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

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

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

### hideTooltip

Close the currently visible tooltip.

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

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

<a id="method-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>
```

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

### zoomTo

Zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation; x in slots under the ordinal scale — bar i sits at i — or epoch ms under linear, y in price); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis).

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

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

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

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

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

### zoomBy

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

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

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

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

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

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

### panBy

Slide the zoomed windows by data units (`{ x?, y? }` — x in slots or ms, y in price); a no-op at the full extent.

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

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

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

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

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

### resetZoom

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

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

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

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

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

### getZoom

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

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

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

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

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

### getZoomExtent

The full extent (and key) of the primary — or the named — master axes (x: the visible slot range −0.5 … n − 0.5 under ordinal, the ms window under linear; y: the fitted price domain).

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

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

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

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

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

### getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported.

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

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

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