API REFERENCE
captureSnapshot
Creates a named snapshot of current source data and returns its ID. Separate from saving column layouts.
What does this API do?
Creates a named snapshot of current source data and returns its ID. Separate from saving column layouts.
Exact input and result types
captureSnapshot(name?: string): Promise<string>| Arguments | Required | Type |
|---|---|---|
| name | Optional | string |
The return type is Promise<string>.
Usage flow
After registering and initializing the Grid element, call grid.captureSnapshot(…). 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.