API REFERENCE

commitBatchEdit

Validates and commits staged changes, reporting per-cell results.

What does this API do?

Validates and commits staged changes, reporting per-cell results.

API for Pro features: Batch editing

Exact input and result types

typescript

commitBatchEdit(options?: SyGridBatchCommitOptions): Promise<SyGridBatchCommitReport>

Arguments	Required	Type
options	Optional	SyGridBatchCommitOptions

The return type is Promise<SyGridBatchCommitReport>.

Usage flow

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

Read related types

SyGridBatchCommitOptions
SyGridBatchCommitReport

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.