API REFERENCE
stageBatchCell
Stages a batch value by row and column ID. Does not immediately persist final data.
What does this API do?
Stages a batch value by row and column ID. Does not immediately persist final data.
API for Pro features: Batch editing
Exact input and result types
stageBatchCell(rowId: GridRowId, colId: string, value: unknown): Promise<boolean>| Arguments | Required | Type |
|---|---|---|
| rowId | Required | GridRowId |
| colId | Required | string |
| value | Required | unknown |
The return type is Promise<boolean>.
Usage flow
After registering and initializing the Grid element, call grid.stageBatchCell(…). 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.