Workbook

Properties

Property	Modifier	Type	Description
sheets	readonly	readonly string[]	The sheets’ names, in order.

Methods

addSheet()

addSheet(name, rows?): CellChange[];

Adds a sheet after the others; formulas that named it already read it now.

Parameters

Parameter	Type
name	string
rows?	CellInput[][]

Returns

CellChange[]

---

evaluate()

evaluate(formula, sheet?): EngineValue | EngineValue[][];

Works out a formula without putting it in a cell; references without a sheet are to sheet, or the first.

Parameters

Parameter	Type
formula	string
sheet?	string

Returns

EngineValue | EngineValue[][]

---

formula()

formula(cell): string | undefined;

The formula in a cell as it was given (“=SUM(B2:B10)”), or undefined when it holds none.

Parameters

Parameter	Type
cell	string

Returns

string | undefined

---

get()

get(cell): EngineValue;

A cell’s value: “Prices!B2”, or “B2” on the first sheet.

Parameters

Parameter	Type
cell	string

Returns

EngineValue

---

getRange()

getRange(range): EngineValue[][];

A range’s values, as rows: “Prices!A1:C10”.

Parameters

Parameter	Type
range	string

Returns

EngineValue[][]

---

set()

Call Signature

set(cell, input): CellChange[];

Puts a value or formula in a cell, or rows of them from that cell; returns every value that changed as a result.

Parameters

Parameter	Type
cell	string
input	| CellInput | CellInput[][]

Returns

CellChange[]

Call Signature

set(cells): CellChange[];

Puts values and formulas in several cells at once.

Parameters

Parameter	Type
cells	Record<string, CellInput>

Returns

CellChange[]

---

setName()

setName(name, formula): CellChange[];

Defines or changes a name, or removes it with null.

Parameters

Parameter	Type
name	string
formula	string | null

Returns

CellChange[]