Class WorkbookView

Default Workbook View.

Implements

IWorkbookView

Constructors

constructor

new WorkbookView(options?: IWorkbookView.ConstructorOptions): WorkbookView
Parameters
- Optionaloptions: IWorkbookView.ConstructorOptions
Returns WorkbookView

Accessors

[toStringTag]

get "[toStringTag]"(): string

Returns string

isIWorkbookView

get isIWorkbookView(): true

For runtime type checking.

Returns true

Implementation of IWorkbookView.isIWorkbookView

Methods

addListeners

addListeners(
listeners: IWorkbookView.IListeners,
options?: IListener.Options,
): Remove
Add Listeners.
Parameters
- listeners: IWorkbookView.IListeners
- Optionaloptions: IListener.Options
Returns Remove

Implementation of IWorkbookView.addListeners

getActiveSheetId

getActiveSheetId(): number | null

Returns number | null

See
IWorkbookView.setActiveSheetId

Implementation of IWorkbookView.getActiveSheetId

getFirstTab

getFirstTab(): number

Returns number

See
IWorkbookView.setFirstTab

Implementation of IWorkbookView.getFirstTab

getId

getId(): string

Identifies this view.

Returns string

Remarks
Stable for the life of the view. A workbook can be shown through more than one view — each user in a shared workbook has their own — so anything recorded against a view (the active sheet an undo returns to, for example) names it by this id rather than holding the view itself.

Implementation of IWorkbookView.getId

getTabRatio

getTabRatio(): number

Returns number

See
IWorkbookView.setTabRatio

Implementation of IWorkbookView.getTabRatio

getVisibility

getVisibility(): IWorkbookView.Visibility

Returns IWorkbookView.Visibility

See
IWorkbookView.setVisibility

Implementation of IWorkbookView.getVisibility

getWindowBounds

getWindowBounds(): WindowBounds | null

Returns WindowBounds | null

See
IWorkbookView.setWindowBounds

Implementation of IWorkbookView.getWindowBounds

isAutoFilterDateGrouping

isAutoFilterDateGrouping(): boolean

Returns boolean

See
IWorkbookView.setAutoFilterDateGrouping

Implementation of IWorkbookView.isAutoFilterDateGrouping

isMinimized

isMinimized(): boolean

Returns boolean

See
IWorkbookView.setMinimized

Implementation of IWorkbookView.isMinimized

isShowFormulaBar

isShowFormulaBar(): boolean

Returns boolean

See
IWorkbookView.setShowFormulaBar

Implementation of IWorkbookView.isShowFormulaBar

isShowHorizontalScrollbar

isShowHorizontalScrollbar(): boolean

Returns boolean

See
IWorkbookView.setShowHorizontalScrollbar

Implementation of IWorkbookView.isShowHorizontalScrollbar

isShowStatusBar

isShowStatusBar(): boolean

Returns boolean

See
IWorkbookView.setShowStatusBar

Implementation of IWorkbookView.isShowStatusBar

isShowTabs

isShowTabs(): boolean

Returns boolean

See
IWorkbookView.setShowTabs

Implementation of IWorkbookView.isShowTabs

isShowVerticalScrollbar

isShowVerticalScrollbar(): boolean

Returns boolean

See
IWorkbookView.setShowVerticalScrollbar

Implementation of IWorkbookView.isShowVerticalScrollbar

setActiveSheetId

setActiveSheetId(newValue: number | null): this
The id of of the activeSheet.
Parameters
- newValue: number | null
Returns this

Remarks
This is NOT the index of the sheet but instead the id (1 based) If the sheets have been reordered then these won't match.

Implementation of IWorkbookView.setActiveSheetId

setAutoFilterDateGrouping

setAutoFilterDateGrouping(newValue: boolean): this
Whether a filter's list groups dates by year, month and day.
Parameters
- newValue: boolean
Returns this

Implementation of IWorkbookView.setAutoFilterDateGrouping

setFirstTab

setFirstTab(newValue: number): this
The first sheet tab shown in the tab strip, by sheet index: how far the tabs are scrolled.
Parameters
- newValue: number
Returns this

Implementation of IWorkbookView.setFirstTab

setMinimized

setMinimized(newValue: boolean): this
Whether the workbook's window is minimized.
Parameters
- newValue: boolean
Returns this

Implementation of IWorkbookView.setMinimized

setShowFormulaBar

setShowFormulaBar(newValue: boolean): this
Shows the visibility of the formula bar.
Parameters
- newValue: boolean
Returns this

Implementation of IWorkbookView.setShowFormulaBar

setShowHorizontalScrollbar

setShowHorizontalScrollbar(newValue: boolean): this
show the horizontal scrollbar.
Parameters
- newValue: boolean
Returns this

Implementation of IWorkbookView.setShowHorizontalScrollbar

setShowStatusBar

setShowStatusBar(newValue: boolean): this
Show the status bar.
Parameters
- newValue: boolean
Returns this

Implementation of IWorkbookView.setShowStatusBar

setShowTabs

setShowTabs(newValue: boolean): this
Shows the workbook tabs.
Parameters
- newValue: boolean
Returns this

Implementation of IWorkbookView.setShowTabs

setShowVerticalScrollbar

setShowVerticalScrollbar(newValue: boolean): this
Show the vertical scrollbar.
Parameters
- newValue: boolean
Returns this

Implementation of IWorkbookView.setShowVerticalScrollbar

setTabRatio

setTabRatio(newValue: number): this
Specifies ratio between the workbook tabs and the horizontal scroll bar.
Parameters
- newValue: number
Returns this

Remarks
This is expressed as a percent * 1000.

Implementation of IWorkbookView.setTabRatio

setVisibility

setVisibility(newValue: IWorkbookView.Visibility): this
Whether the workbook's window is shown. A hidden window is how Excel keeps a workbook open out of sight, as its personal macro workbook does.
Parameters
- newValue: IWorkbookView.Visibility
Returns this

Implementation of IWorkbookView.setVisibility

setWindowBounds

setWindowBounds(newValue: WindowBounds | null): this
Where the workbook's window sits on the screen, in twips (a twentieth of a point).
Parameters
- newValue: WindowBounds | null
Returns this

Implementation of IWorkbookView.setWindowBounds

toJSON

toJSON(): IWorkbookView.JSON | null

Saves the current state to JSON.

Returns IWorkbookView.JSON | null

Implementation of IWorkbookView.toJSON

toString

toString(): string

Returns a string representation of an object.

Returns string

update

update(view: Partial<IWorkbookView.Properties>, notify?: boolean): void
{@inheritDoc IWorkbookView.update}
Parameters
- view: Partial<IWorkbookView.Properties>
- notify: boolean = true
Returns void