snapshotCaptured

What does this API do?

Emitted when a data snapshot is created. Display the saved point using its ID, name, and row count.

Exact input and result types

snapshotCaptured: { id: string; name: string; rowCount: number }

Usage flow

Subscribe with grid.addEventListener('snapshotCaptured', 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('snapshotCaptured', event => {
  console.log(event.detail);
}, { signal: controller.signal });
// On view disposal: controller.abort();

Feature explanations and examples

• Data snapshot

  Snapshots retain rowData at a point in time for comparison with current data or another snapshot. They differ from view-state APIs that save column widths, filters, and focus.