batchEditStart

What does this API do?

Emitted when batch editing starts. Open a staged-changes UI if needed.

API for Pro features: Batch editing

Exact input and result types

batchEditStart: SyGridBatchEditStartEventDetail

Usage flow

Subscribe with grid.addEventListener('batchEditStart', handler). The result is in event.detail, and event names are case-sensitive. Remove subscriptions when disposing of the view.

const controller = new AbortController();
grid.addEventListener('batchEditStart', event => {
  console.log(event.detail);
}, { signal: controller.signal });
// On view disposal: controller.abort();

Read related types

• SyGridBatchEditStartEventDetail

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.