Class WorkbookModel

Used for runtime reflection.

This returns any custom workbook options that are provided in constructor.

This will activate the next sheet unless there is only one. This is a convenience method for

See

setActiveSheet.

This will activate the previous sheet unless there is only one. This is a convenience method for

See

setActiveSheet.

Add a listener for workbook events

Add a listener for a specific range.

Remarks

By default insert/remove of headers or sheets will alter the range listener. To see the actual bounds use the range in the callback.

See

• IWorkbookRangeListener
• RangeListenerOptions

Adds a sheet at the given index with the given name. This will throw an exception if the sheetName is invalid or already used.

Close the workbook and release any resources. No further operations are allowed after a close

Return an array of cell ranges for the given address.

Delete the sheet.

Will create a duplicate of the the specified sheet or the current active sheet if no sheet is specified.

Returns a single value for the found result or null if not found.

Given the name return a valid name that closely matches.

Load the state from a JSON

Return the active address as a SheetCellCoords

Returns the active cell as an A1 style reference

Returns the currently active sheet within the workbook

Return the getCell for the given address or the active cell if no address is specified.

Remarks

This will never return null.

Return the names of the ranges. These are sorted/filtered by type then by name.

If null then there is no protection

Default Value

null
Copy

Returns all cells bounded with the specified range. These allow for interaction with the cells.

Remarks

If empty will return all the cells

See

ISheetRange

Returns the current shared resources

Return the sheet for the given key. If no key is specified then the current active sheet is returned.

Ordered list of sheetNames. This will only return SheetVisibility.Visible

Get the sheet reference.

See

SheetRef Will return null if not available ether because it was not found or did not match the visibility

Return a sheetRef by it's unique id.

Get all of the Sheet handles within the workbook for a given SheetVisibility. By default this will only return the visible sheets

Get the current theme

Return the current transaction store for the workbook.

Remarks

Custom transaction stores must be provided via the constructor.

The view specific properties.

Is date resolution 1904 instead of 1900 based.

See

https://support.microsoft.com/en-us/office/date-systems-in-excel-e7fe7167-48a9-4b96-bb53-5612a800b487

Indicates if the model has been closed

Begins a transaction but puts it onto a global stack. This will batch all 'transactional' changes until they have all be committed or rolled back.

Remarks

Any changes that are made to this object will be reflected in the local sheet but not committed to the transactional store until the batch is popped.

Replaces all options that match.

Determine if dates should be 1904 instead of 1900 based

Default Value

false
Copy

Set the sheet to active. If this sheet was not Visible it will be made visible Fires onWorkbookSelectionChange

Set a single value. This is a convenience method that wraps setCellPairs to provide a simpler interface. For higher performance use

See

• ISheetRange.update or
• ISheetModel.setCellPairs directly.

Remarks

This operation also runs synchronously.

Set the protection for the workbook.

Remarks

Pass null to clear all protections.

Fires onSheetRefsChange

Fires onSheetRefsChange

Set the current theme

Remarks

If null sets back to the default theme. This will not fire theme updated event.

Views have their own lifecycle because in a collaborative environment each user can have their own view.

Returns the current sheet style associated with this Workbook.

Serialize the workbook to a JSON.