API REFERENCE

diffSnapshots

Compares two snapshots or a snapshot with current data. Omit the second ID to compare against current data.

What does this API do?

Compares two snapshots or a snapshot with current data. Omit the second ID to compare against current data.

Exact input and result types

typescript

diffSnapshots(idA: string, idB?: string): Promise<SnapshotDiff<GridRow>>

Arguments	Required	Type
idA	Required	string
idB	Optional	string

The return type is Promise<SnapshotDiff<GridRow>>.

Usage flow

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

Read related types

SnapshotDiff
GridRow

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.