Class WorkbookView

Default Workbook View.

Implements

IWorkbookView

Index

Constructors

Methods

addListeners getActiveSheetId getTabRatio isShowFormulaBar isShowHorizontalScrollbar isShowStatusBar isShowTabs isShowVerticalScrollbar setActiveSheetId setShowFormulaBar setShowHorizontalScrollbar setShowStatusBar setShowTabs setShowVerticalScrollbar setTabRatio toJSON update

Constructors

constructor

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

Methods

addListeners

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

getActiveSheetId

getActiveSheetId(): number
Returns number
See
IWorkbookView.setActiveSheetId

Implementation of IWorkbookView.getActiveSheetId

getTabRatio

getTabRatio(): number
Returns number
See
IWorkbookView.setTabRatio

Implementation of IWorkbookView.getTabRatio

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): WorkbookView
The id of of the activeSheet.
Parameters
- newValue: number
Returns WorkbookView
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

setShowFormulaBar

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

setShowHorizontalScrollbar

setShowHorizontalScrollbar(newValue: boolean): WorkbookView
show the horizontal scrollbar.
Parameters
- newValue: boolean
Returns WorkbookView
Default Value
```
true
```
Implementation of IWorkbookView.setShowHorizontalScrollbar

setShowStatusBar

setShowStatusBar(newValue: boolean): WorkbookView
Show the status bar.
Parameters
- newValue: boolean
Returns WorkbookView
Default Value
```
true
```
Implementation of IWorkbookView.setShowStatusBar

setShowTabs

setShowTabs(newValue: boolean): WorkbookView
Shows the workbook tabs.
Parameters
- newValue: boolean
Returns WorkbookView
Default Value
```
true;
```
Implementation of IWorkbookView.setShowTabs

setShowVerticalScrollbar

setShowVerticalScrollbar(newValue: boolean): WorkbookView
Show the vertical scrollbar.
Parameters
- newValue: boolean
Returns WorkbookView
Default Value
```
true
```
Implementation of IWorkbookView.setShowVerticalScrollbar

setTabRatio

setTabRatio(newValue: number): WorkbookView
Specifies ratio between the workbook tabs and the horizontal scroll bar.
Parameters
- newValue: number
Returns WorkbookView
Default Value
```
600
```
Remarks
This is expressed as a percent * 1000.
Implementation of IWorkbookView.setTabRatio

toJSON

toJSON(): JSON
Saves the current state to JSON.

Returns JSON
Implementation of IWorkbookView.toJSON

update

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