SheetXL - v1.0.2
    Preparing search index...

    Interface IOpaqueSheet

    A sheet whose content is carried but not modeled: a chart sheet, an Excel 4.0 macro sheet or an Excel 5 dialog sheet.

    It is a tab like any other: it can be renamed, moved, hidden, colored, selected and deleted, and it counts in SHEETS(), SHEET() and 3-D references. What it holds is kept as it was read and written back unchanged. It has no cells, so a reference to one (Chart1!A1) is #REF!; for a macro sheet that differs from Excel, which reads its cells.

    Renames and moves are not followed inside it: a chart's series formulas and a macro sheet's formulas keep the names they were written with.

    interface IOpaqueSheet {
        isIOpaqueSheet: true;
        isISheet: true;
        addListeners(
            listeners: ISheet.IListeners,
            options?: IListener.Options,
        ): Remove;
        close(): void;
        delete(): void;
        getId(): string;
        getIndex(): number;
        getKind(): IOpaqueSheet.Kind;
        getName(): string;
        getTabColor(): IColor;
        getVisibility(): ISheet.Visibility;
        getWorkbook(): IWorkbook | null;
        isClosed(): boolean;
        isDeleted(): boolean;
        select(options?: ITypes.SelectOptions): Promise<IOpaqueSheet>;
        setIndex(index: number): this;
        setName(name: string, options?: ITransaction.OperationOptions): this;
        setTabColor(color: string | IColor | null): this;
        setVisibility(
            visibility?: boolean | ISheet.Visibility,
            options?: ITransaction.OperationOptions,
        ): ISheet;
    }

    Hierarchy (View Summary)

    Index
    isIOpaqueSheet isISheet
    addListeners close delete getId getIndex getKind getName getTabColor getVisibility getWorkbook isClosed isDeleted select setIndex setName setTabColor setVisibility
    isIOpaqueSheet: true

    For runtime type checking.

    isISheet: true

    For runtime type checking.

    • Free all resources associated with the sheet.

      Returns void

      Called by the workbook when it is closed. This is different than delete, which removes the sheet from the workbook.

    • Removes the sheet from its workbook.

      Returns void

    • The sheet's id: what formulas and operations identify it by. Unique among all in-memory sheets.

      Returns string

    • Returns the position of the sheet among every sheet in its workbook, hidden ones and every kind included.

      Returns number

      Will return -1 if not in a workbook.

    • Returns the display name for the sheet.

      Returns string

    • Return a custom color or null if no custom color has been set.

      Returns IColor

      null

    • Returns true if the sheet has been closed.

      Returns boolean

    • Returns if the sheet has been deleted from its workbook.

      Returns boolean

    • Moves the sheet in the tab order.

      Parameters

      • index: number

      Returns this

      This is zero-based.

    • Set the tab color for the sheet.

      Parameters

      • color: string | IColor | null

        The color

      Returns this

      If set to null the color will revert to the default.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods