# getZoom

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

Canonical: https://chart.syidax.com/docs/methods/getZoom/

<a id="definition"></a>

## Definition

```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="related"></a>

## Related charts

- [sy-line-chart](https://chart.syidax.com/docs/components/line.md#method-getZoom)
- [sy-area-chart](https://chart.syidax.com/docs/components/area.md#method-getZoom)
- [sy-column-chart](https://chart.syidax.com/docs/components/column.md#method-getZoom)
- [sy-bar-chart](https://chart.syidax.com/docs/components/bar.md#method-getZoom)
- [sy-scatter-chart](https://chart.syidax.com/docs/components/scatter.md#method-getZoom)
- [sy-bubble-chart](https://chart.syidax.com/docs/components/bubble.md#method-getZoom)
- [sy-polar-chart](https://chart.syidax.com/docs/components/polar.md#method-getZoom)
- [sy-waterfall-chart](https://chart.syidax.com/docs/components/waterfall.md#method-getZoom)
- [sy-histogram-chart](https://chart.syidax.com/docs/components/histogram.md#method-getZoom)
- [sy-box-plot-chart](https://chart.syidax.com/docs/components/box-plot.md#method-getZoom)
- [sy-error-bar-chart](https://chart.syidax.com/docs/components/error-bar.md#method-getZoom)
- [sy-stem-leaf-chart](https://chart.syidax.com/docs/components/stem-leaf.md#method-getZoom)
- [sy-heatmap](https://chart.syidax.com/docs/components/heatmap.md#method-getZoom)
- [sy-calendar-heatmap](https://chart.syidax.com/docs/components/calendar-heatmap.md#method-getZoom)
- [sy-density-map](https://chart.syidax.com/docs/components/density-map.md#method-getZoom)
- [sy-spectrogram](https://chart.syidax.com/docs/components/spectrogram.md#method-getZoom)
- [sy-pictorial-chart](https://chart.syidax.com/docs/components/pictorial.md#method-getZoom)
- [sy-item-chart](https://chart.syidax.com/docs/components/item.md#method-getZoom)
- [sy-word-cloud](https://chart.syidax.com/docs/components/word-cloud.md#method-getZoom)
- [sy-tilemap](https://chart.syidax.com/docs/components/tilemap.md#method-getZoom)
- [sy-treemap](https://chart.syidax.com/docs/components/treemap.md#method-getZoom)
- [sy-sunburst](https://chart.syidax.com/docs/components/sunburst.md#method-getZoom)
- [sy-icicle](https://chart.syidax.com/docs/components/icicle.md#method-getZoom)
- [sy-dendrogram](https://chart.syidax.com/docs/components/dendrogram.md#method-getZoom)
- [sy-sankey](https://chart.syidax.com/docs/components/sankey.md#method-getZoom)
- [sy-chord](https://chart.syidax.com/docs/components/chord.md#method-getZoom)
- [sy-network-graph](https://chart.syidax.com/docs/components/network-graph.md#method-getZoom)
- [sy-theme-river](https://chart.syidax.com/docs/components/theme-river.md#method-getZoom)
- [sy-parallel-coordinates](https://chart.syidax.com/docs/components/parallel-coordinates.md#method-getZoom)
- [sy-geo-map](https://chart.syidax.com/docs/components/geo-map.md#method-getZoom)
- [sy-flow-lines](https://chart.syidax.com/docs/components/flow-lines.md#method-getZoom)
- [sy-candlestick-chart](https://chart.syidax.com/docs/components/candlestick.md#method-getZoom)
- [sy-ohlc-chart](https://chart.syidax.com/docs/components/ohlc.md#method-getZoom)
- [sy-gantt-chart](https://chart.syidax.com/docs/components/gantt.md#method-getZoom)
- [sy-wafer-map](https://chart.syidax.com/docs/components/wafer-map.md#method-getZoom)