API REFERENCE
getWorkbookSnapshotReport
Reads the last published workbook cells, hashes, and generations. Do not assume all Grid data was published.
What does this API do?
Reads the last published workbook cells, hashes, and generations. Do not assume all Grid data was published.
API for Pro features: Built-in formulas, references, dependency recalculation and calculated columns
Exact input and result types
getWorkbookSnapshotReport(): Promise<SyGridWorkbookSnapshotReport>| Arguments | Required | Type |
|---|
The return type is Promise<SyGridWorkbookSnapshotReport>.
Usage flow
After registering and initializing the Grid element, call grid.getWorkbookSnapshotReport(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Read related types
Feature explanations and examples
- Formula calculation
Formulas evaluate strings beginning with = and display the result in a cell. For example, =SUM(A1:A3) references the first column in the original column definitions and the first three source rows.