API REFERENCE

cancelBatchEdit

Cancels pending batch edits and returns the cancelled item count.

What does this API do?

Cancels pending batch edits and returns the cancelled item count.

API for Pro features: Batch editing

Exact input and result types

typescript
cancelBatchEdit(): Promise<number>
ArgumentsRequiredType

The return type is Promise<number>.

Usage flow

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

Feature explanations and examples