SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IWorkbookView

    View settings for a single workbook.

    interface IWorkbookView {
        isIWorkbookView: true;
        addListeners(
            listeners: IWorkbookView.IListeners,
            options?: IListener.Options,
        ): Remove;
        getActiveSheetId(): number | null;
        getId(): string;
        getTabRatio(): number;
        isShowFormulaBar(): boolean;
        isShowHorizontalScrollbar(): boolean;
        isShowStatusBar(): boolean;
        isShowTabs(): boolean;
        isShowVerticalScrollbar(): boolean;
        setActiveSheetId(newValue: number | null): 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(): IWorkbookView.JSON | null;
    }

    Implemented by

    Index
    isIWorkbookView
    addListeners getActiveSheetId getId getTabRatio isShowFormulaBar isShowHorizontalScrollbar isShowStatusBar isShowTabs isShowVerticalScrollbar setActiveSheetId setShowFormulaBar setShowHorizontalScrollbar setShowStatusBar setShowTabs setShowVerticalScrollbar setTabRatio toJSON
    isIWorkbookView: true

    For runtime type checking.

    • Identifies this view.

      Returns string

      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.

    • The id of of the activeSheet.

      Parameters

      • newValue: number | null

      Returns this

      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.

    • Shows the visibility of the formula bar.

      Parameters

      • newValue: boolean

      Returns this

    • show the horizontal scrollbar.

      Parameters

      • newValue: boolean

      Returns this

      true

    • Show the status bar.

      Parameters

      • newValue: boolean

      Returns this

      true

    • Shows the workbook tabs.

      Parameters

      • newValue: boolean

      Returns this

      true;

    • Show the vertical scrollbar.

      Parameters

      • newValue: boolean

      Returns this

      true

    • Specifies ratio between the workbook tabs and the horizontal scroll bar.

      Parameters

      • newValue: number

      Returns this

      600

      This is expressed as a percent * 1000.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods