Interface IWorkbookView

View settings for a single workbook.

interface IWorkbookView {
    addListeners(listeners: IListeners, options?: IListener.Options): Remove;
    getActiveSheetId(): number;
    getTabRatio(): number;
    isShowFormulaBar(): boolean;
    isShowHorizontalScrollbar(): boolean;
    isShowStatusBar(): boolean;
    isShowTabs(): boolean;
    isShowVerticalScrollbar(): boolean;
    setActiveSheetId(newValue: number): this;
    setShowFormulaBar(newValue: boolean): this;
    setShowHorizontalScrollbar(newValue: boolean): this;
    setShowStatusBar(newValue: boolean): this;
    setShowTabs(newValue: boolean): this;
    setShowVerticalScrollbar(newValue: boolean): this;
    setTabRatio(newValue: number): this;
    toJSON(): JSON;
}

Implemented by

WorkbookView

Index

Methods

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

Methods

addListeners

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

getActiveSheetId

getActiveSheetId(): number
Returns number
See
IWorkbookView.setActiveSheetId

getTabRatio

getTabRatio(): number
Returns number
See
IWorkbookView.setTabRatio

isShowFormulaBar

isShowFormulaBar(): boolean
Returns boolean
See
IWorkbookView.setShowFormulaBar

isShowHorizontalScrollbar

isShowHorizontalScrollbar(): boolean
Returns boolean
See
IWorkbookView.setShowHorizontalScrollbar

isShowStatusBar

isShowStatusBar(): boolean
Returns boolean
See
IWorkbookView.setShowStatusBar

isShowTabs

isShowTabs(): boolean
Returns boolean
See
IWorkbookView.setShowTabs

isShowVerticalScrollbar

isShowVerticalScrollbar(): boolean
Returns boolean
See
IWorkbookView.setShowVerticalScrollbar

setActiveSheetId

setActiveSheetId(newValue: number): this
The id of of the activeSheet.
Parameters
- newValue: number
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.

setShowFormulaBar

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

setShowHorizontalScrollbar

setShowHorizontalScrollbar(newValue: boolean): this
show the horizontal scrollbar.
Parameters
- newValue: boolean
Returns this
Default Value
```
true
```

setShowStatusBar

setShowStatusBar(newValue: boolean): this
Show the status bar.
Parameters
- newValue: boolean
Returns this
Default Value
```
true
```

setShowTabs

setShowTabs(newValue: boolean): this
Shows the workbook tabs.
Parameters
- newValue: boolean
Returns this
Default Value
```
true;
```

setShowVerticalScrollbar

setShowVerticalScrollbar(newValue: boolean): this
Show the vertical scrollbar.
Parameters
- newValue: boolean
Returns this
Default Value
```
true
```

setTabRatio

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

toJSON

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

Returns JSON