SheetXL - v1.0.2
    Preparing search index...

    Interface SheetRefJSON<T>

    Used for persisting an ISheet: its tab, and its body as SheetRefJSON.kind says.

    interface SheetRefJSON<
        T extends ISheet.JSON = IWorksheet.JSON
        | IOpaqueSheet.JSON,
    > {
        kind?: ISheet.Kind;
        name: string;
        sheet?: T;
        sheetId?: number;
        visibility?: ISheet.Visibility;
    }

    Type Parameters

    Index
    kind?: ISheet.Kind

    What the sheet holds, and so what sheet is.

    ISheet.Kind.Worksheet
    
    name: string

    A unique name for the sheet.

    sheet?: T

    The sheet's body.

    sheetId?: number

    The origin format's own identifier for this sheet, preserved so a round trip does not renumber it.

    Interop only — nothing in the model reads it and nothing references it by value. It is arbitrary and sparse (a workbook's edit history leaves gaps, so Jan=3, Feb=28, Mar=29 is ordinary) and is not the sheet's position: localSheetId on a defined name is a position and is resolved separately. Absent for a sheet that was never loaded from a file; a writer assigns one in that case.

    visibility?: ISheet.Visibility
    ISheet.Visibility.Visible