WorkbookView
A single workbook view, bound to its index in workbook.views. Provides
access to the active sheet and per-sheet view state (selection, layout,
zoom, frozen panes).
Obtain via workbook.views.get(index) / .require(index); do not
construct directly.
All methods throw if the view has been removed from the workbook.
Example
Section titled “Example”const view = workbook.views.require();view.setActiveSheetName('Inputs');view.setSelection('Inputs', { activeCell: 'B5', activeRanges: ['B5:D10', 'F1'],});Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WorkbookView(workbook, index): WorkbookView;Parameters
Section titled “Parameters”workbook
Section titled “workbook”number
Returns
Section titled “Returns”WorkbookView
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get index(): number;The zero-based index of this workbook view.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”freezePanes()
Section titled “freezePanes()”freezePanes(sheetName, panes): void;Freezes panes for one particular sheet in this workbook view.
Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
Name of the sheet whose panes should be frozen
Omit<WorksheetViewFrozenPanes, "type"> & object
Details of how the sheet view’s panes should be frozen
Returns
Section titled “Returns”void
Throws
Section titled “Throws”If a sheet with the given name doesn’t exist
Throws
Section titled “Throws”If this view has been orphaned from its workbook
Throws
Section titled “Throws”If the frozen panes are invalid (see validateFrozenPanes)
getActiveSheetIndex()
Section titled “getActiveSheetIndex()”getActiveSheetIndex(): number;Index of the active sheet. Returns 0 when not explicitly set (OOXML default).
Returns
Section titled “Returns”number
getActiveSheetName()
Section titled “getActiveSheetName()”getActiveSheetName(): string | null;Name of the active sheet, or null if the stored index does not resolve to a sheet. Returns the first sheet when not explicitly set (OOXML default).
Note: deleting a sheet does not update the stored activeSheet index, so this may return null or the wrong sheet after a deletion.
Returns
Section titled “Returns”string | null
getFrozenPanes()
Section titled “getFrozenPanes()”getFrozenPanes(sheetName): WorksheetViewFrozenPanes | null;Return the frozen panes for a given sheet in this workbook view, if the sheet has them.
Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
Name of the sheet whose frozen panes you want
Returns
Section titled “Returns”WorksheetViewFrozenPanes | null
A copy of the JSF frozen panes, or null if the sheet has none
Throws
Section titled “Throws”If a sheet with the given name doesn’t exist
Throws
Section titled “Throws”If this view has been orphaned from its workbook
getSelection()
Section titled “getSelection()”getSelection(sheetName): ViewSelection;Returns the active cell and active ranges for a sheet.
Unlike getSheetView, activeCell is always present and defaults to 'A1'.
Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
Returns
Section titled “Returns”Throws
Section titled “Throws”if sheetName does not exist
getSheetView()
Section titled “getSheetView()”getSheetView(sheetName): WorksheetView | null;Returns the raw stored sheet view, or null if no view entry exists.
Unlike getSelection, this doesn’t include activeCell if it’s not set on the view
explicitly.
Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
Returns
Section titled “Returns”WorksheetView | null
Throws
Section titled “Throws”if sheetName does not exist
hasFrozenPanes()
Section titled “hasFrozenPanes()”hasFrozenPanes(sheetName): boolean;Returns true if the given sheet has frozen panes in this workbook view, false otherwise.
Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
Name of the sheet you want to check for frozen panes
Returns
Section titled “Returns”boolean
Throws
Section titled “Throws”If a sheet with the given name doesn’t exist
Throws
Section titled “Throws”If this view has been orphaned from its workbook
setActiveSheetName()
Section titled “setActiveSheetName()”setActiveSheetName(sheetName): void;Set the active sheet by name.
Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
Returns
Section titled “Returns”void
Throws
Section titled “Throws”if sheetName is empty or does not exist
setSelection()
Section titled “setSelection()”setSelection(sheetName, options?): void;Sets the active cell and active ranges for a sheet. This replaces the
full selection state --- any field you omit is cleared, not preserved.
Passing activeCell: 'A1' (or omitting it) with no activeRanges
resets the selection to default.
Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
options?
Section titled “options?”activeCell?
Section titled “activeCell?”string
activeRanges?
Section titled “activeRanges?”string[]
Returns
Section titled “Returns”void
Throws
Section titled “Throws”if the sheet is not found
Throws
Section titled “Throws”if activeCell is not a valid cell reference
Throws
Section titled “Throws”if activeRanges contains an invalid range reference
Throws
Section titled “Throws”if activeCell is not contained within any of activeRanges
unfreezePanes()
Section titled “unfreezePanes()”unfreezePanes(sheetName): void;Unfreezes panes for one particular sheet in this workbook view.
If a sheet with the given name exists but doesn’t have frozen panes, this is a no-op.
Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
Name of the sheet whose frozen panes should be removed
Returns
Section titled “Returns”void
Throws
Section titled “Throws”If a sheet with the given name doesn’t exist
Throws
Section titled “Throws”If this view has been orphaned from its workbook