deleteSnapshot

What does this API do?

Deletes a data snapshot and returns success without changing current data.

Exact input and result types

deleteSnapshot(id: string): Promise<boolean>

The return type is Promise<boolean>.

Usage flow

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

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.