# startBatchEdit

Starts batch editing to collect multiple cell changes for a single commit.

Canonical: https://grid.syidax.com/docs/methods/startBatchEdit/

<a id="meaning"></a>

## What does this API do?

Starts batch editing to collect multiple cell changes for a single commit.

API for Pro features: Batch editing

<a id="contract"></a>

## Exact input and result types

```typescript
startBatchEdit(options?: SyGridBatchStartOptions): Promise<boolean>
```

| Arguments | Required | Type |
| --- | --- | --- |
| options | Optional | SyGridBatchStartOptions |

The return type is `Promise<boolean>`.

<a id="usage"></a>

## Usage flow

After registering and initializing the Grid element, call grid.startBatchEdit(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

<a id="types"></a>

## Read related types

- [SyGridBatchStartOptions](https://grid.syidax.com/docs/types/SyGridBatchStartOptions.md)

<a id="recipes"></a>

## Feature explanations and examples

- [Batch editing](https://grid.syidax.com/docs/features/batch-editing.md) — Batch editing stages changes to multiple cells for a single commit or cancellation. Distinguish staged values from committed rowData to make the Save action clear.