Skip to content

SaveEventDetail

Detail of the save event when the element handles saving through events.

Property Type Description Inherited from
bytes Uint8Array - SavedWorkbook.bytes
changes CellChange[] Each change with its value when opened and now. SavedWorkbook.changes
editedCount number Changes since the workbook was opened: cells, plus any rows or columns inserted or deleted, or cells moved. SavedWorkbook.editedCount
fileName string - SavedWorkbook.fileName
history HistoryEntry[] What was done, by whom and when, oldest first; actions are in the editor’s language. SavedWorkbook.history
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. SavedWorkbook.outOfDate
schema? object The schema the workbook was checked against, and what it found, when one applied. SavedWorkbook.schema
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. SavedWorkbook.values
cell(sheet, ref): JsonValue;

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

Parameter Type
sheet string
ref string

JsonValue

SavedWorkbook.cell


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.

Parameter Type
sheet string
ref? string

JsonValue[][]

SavedWorkbook.range


waitUntil(promise): void;

Keep the save pending until promise settles; a rejection is shown as the error.

Parameter Type
promise Promise<unknown>

void