listSnapshots

What does this API do?

Reads metadata for retained data snapshots.

Exact input and result types

listSnapshots(): Promise<SnapshotMeta[]>

The return type is Promise<SnapshotMeta[]>.

Usage flow

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

Read related types

• SnapshotMeta

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.