# setBrush

replace the brush areas of the active cartesian family (`null` clears).

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

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

## Definition

```typescript
setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>
```

| Arguments | Type | Required |
| --- | --- | --- |
| `areas` | `ReadonlyArray<CartesianBrushAreaInput> \| null` | Required |

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

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

<a id="related"></a>

## Related charts

- [sy-line-chart](https://chart.syidax.com/docs/components/line.md#method-setBrush)
- [sy-area-chart](https://chart.syidax.com/docs/components/area.md#method-setBrush)
- [sy-column-chart](https://chart.syidax.com/docs/components/column.md#method-setBrush)
- [sy-bar-chart](https://chart.syidax.com/docs/components/bar.md#method-setBrush)
- [sy-scatter-chart](https://chart.syidax.com/docs/components/scatter.md#method-setBrush)