WorkbookOptions

type WorkbookOptions = object;

Extended by

• AddWorkbookOptions

Properties

assumeArrayFormulas?

optional assumeArrayFormulas?: boolean;

Whether formulas should be assumed to be of array type even if not accompanied by an F property. Set this to true in tests specs, unless specifically testing implicit intersection and the like.

Default

false

---

filename?

optional filename?: string;

Filename to associate with the workbook. Used by fromXLSX methods when loading from binary data, since the filename cannot be inferred. Should not include path, just filename with extension.

---

isExternal?

optional isExternal?: boolean;

Whether this workbook was loaded as an external reference from another workbook. External workbooks can be replaced by “real” workbooks with the same name.

Default

false

---

iterativeCalculation?

optional iterativeCalculation?: IterativeCalculationOptions;

Settings for iterative calculations (nullish to disable; that’s the default)

---

mode?

optional mode?: WorkbookMode;

Spreadsheet-engine compatibility mode, governing formula evaluation and other behaviors that differ between Excel, Google Sheets, and Grid Sheets (e.g. coercion of formula results, number-format propagation, spill extents). Defaults to the mode mapped from the workbook’s source format (XLSX → Excel, etc.), falling back to MODE_GRID_SHEET when no mapping applies.

---

readOnly?

optional readOnly?: boolean;

When true, skip formula validation and the initial-recalc scheduling during workbook construction. Useful when loading a workbook only to inspect its structure (saved values stay as-is) without paying the recalc cost. Defaults to false.