# zoom

cartesian zoom (line / area / column / bar / scatter): `'x'` | `'y'` | `'xy'` | `true` enable the drag rectangle + keyboard on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Forwarded to the active family element.

Canonical: https://chart.syidax.com/docs/options/zoom/

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

## Definition

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

## Related documentation

A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below.

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