SavedWorkbook

The workbook as saved, handed to the host’s onSave callback (and the element’s save event): the file itself, what changed, and its values, so the host can store the file, the values, or both.

Extends

• WorkbookReaders

Extended by

• SaveEventDetail

Properties

Property	Type	Description
bytes	Uint8Array	-
changes	CellChange[]	Each change with its value when opened and now.
editedCount	number	Changes since the workbook was opened: cells, plus any rows or columns inserted or deleted, or cells moved.
fileName	string	-
history	HistoryEntry[]	What was done, by whom and when, oldest first; actions are in the editor’s language.
outOfDate	object[]	Formulas whose saved value may be out of date: this editor can’t calculate them, a cell they depend on changed, and they still hold Excel’s last result (as does any formula reading one). Excel recalculates them when the file is next opened; until then, don’t rely on their values.
schema?	object	The schema the workbook was checked against, and what it found, when one applied.
schema.errors	number	-
schema.id	string	-
schema.name	string	-
schema.version?	string	-
schema.warnings	number	-
values?	SchemaValues	The values in the shape of that schema: each table’s records by field, each single cell.

Methods

cell()

cell(sheet, ref): JsonValue;

Any cell’s value as JSON, e.g. cell(‘Data’, ‘B4’); dates come back as ISO text.

Parameters

Parameter	Type
sheet	string
ref	string

Returns

JsonValue

Inherited from

WorkbookReaders.cell

---

range()

range(sheet, ref?): JsonValue[][];

A range’s values row by row, e.g. range(‘Data’, ‘A1:F200’); without a range, the sheet’s used range.

Parameters

Parameter	Type
sheet	string
ref?	string

Returns

JsonValue[][]

Inherited from

WorkbookReaders.range