API REFERENCE
startBatchEdit
Starts batch editing to collect multiple cell changes for a single commit.
What does this API do?
Starts batch editing to collect multiple cell changes for a single commit.
API for Pro features: Batch editing
Exact input and result types
startBatchEdit(options?: SyGridBatchStartOptions): Promise<boolean>| Arguments | Required | Type |
|---|---|---|
| options | Optional | SyGridBatchStartOptions |
The return type is Promise<boolean>.
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.
Read related types
Feature explanations and examples
- Batch editing
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.