# brush

brush selection on the cartesian families (forwarded like `zoom`).

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

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

## Definition

| Item | Value |
| --- | --- |
| JavaScript property | `brush` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `CartesianBrushInput` |
| Default | `undefined` |
| Literals in the type | `auto`, `off`, `true`, `false`, `rect`, `lasso` |

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

- [CartesianBrushInput](https://chart.syidax.com/docs/types/CartesianBrushInput.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-brush)
- [sy-area-chart](https://chart.syidax.com/docs/components/area.md#property-brush)
- [sy-column-chart](https://chart.syidax.com/docs/components/column.md#property-brush)
- [sy-bar-chart](https://chart.syidax.com/docs/components/bar.md#property-brush)
- [sy-scatter-chart](https://chart.syidax.com/docs/components/scatter.md#property-brush)