API REFERENCE
SyGridWorkbookSnapshotReport
Fields, allowed values, and APIs that use SyGridWorkbookSnapshotReport.
Type definition
A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.
export interface SyGridWorkbookSnapshotReport {
status: 'ok' | 'unpublished' | 'inactive';
reason: SyGridWorkbookInactiveReason | null;
workbookKey: number;
sheetId: number;
registrationId: number;
generation: number;
snapshotHash: string;
cells: ReadonlyArray<SyGridWorkbookSnapshotCell>;
issue: string;
}APIs using this type
- getWorkbookSnapshotReport
Reads the last published workbook cells, hashes, and generations. Do not assume all Grid data was published.