SheetXL - v1.0.2
    Preparing search index...

    Interface JSON

    JSON representation of an IWorkbook used for serialization and deserialization.

    interface JSON {
        calc?: ICalculation.JSON;
        codeName?: string;
        date1904?: boolean;
        externalBooks?: (IExternalBook.JSON | null)[];
        hiddenPivotFieldList?: true;
        locale?: string;
        localeOverrides?: LocaleProfileOverrides;
        modules?: Record<string, CompiledModule>;
        names?: INamedCollection.JSON;
        people?: IPerson.JSON[];
        pivotCaches?: CacheJSON[];
        properties?: IDocumentProperties.JSON;
        protection?: IWorkbookProtection.JSON;
        resources?: IResource.JSON[];
        richData?: JSON[];
        richTypes?: JSON[];
        sheets: SheetRefJSON<IOpaqueSheet.JSON | IWorksheet.JSON>[];
        strings?: string[];
        styles?: IStyleCollection.JSON;
        theme?: ITheme.JSON;
        updateLinks?: UpdateLinks;
        view?: IWorkbookView.JSON;
    }
    Index
    calc? codeName? date1904? externalBooks? hiddenPivotFieldList? locale? localeOverrides? modules? names? people? pivotCaches? properties? protection? resources? richData? richTypes? sheets strings? styles? theme? updateLinks? view?
    calc?: ICalculation.JSON
    codeName?: string

    The workbook's VBA code name. Absent when it has none.

    IWorkbook.getCodeName

    date1904?: boolean
    externalBooks?: (IExternalBook.JSON | null)[]

    In [n] order (1-based) — index 0 of this array is [1]. An entry is null where the source's external link is a DDE/OLE link, or anything else this phase does not model — the position still counts, only the content does not.

    hiddenPivotFieldList?: true

    The PivotTable Fields pane does not open when a pivot table is selected; absent, it does.

    Carried, not obeyed: SheetXL has no fields pane yet. Round-trips as workbookPr@hidePivotFieldList.

    locale?: string

    The regional locale as a BCP 47 tag, e.g. de-DE.

    Omitted when the workbook uses the environment locale. Persisted so that a document renders and parses identically everywhere; there is no equivalent slot in xlsx so this is sxl only.

    localeOverrides?: LocaleProfileOverrides

    The regional-override patch over the derived locale profile. Omitted when there is no customization. Like locale, sxl only — xlsx has no slot for it.

    modules?: Record<string, CompiledModule>

    The workbook's own modules, keyed by module name.

    IWorkbook.getModules

    names?: INamedCollection.JSON
    people?: IPerson.JSON[]

    The people the workbook knows.

    IWorkbook.getPeople

    pivotCaches?: CacheJSON[]

    The workbook's pivot caches — the source snapshots its pivot tables summarize, each shared by every table that references its id.

    See IPivotTable.CacheJSON. A table names its cache by IPivotTable.getCacheId.

    properties?: IDocumentProperties.JSON

    IWorkbook.getProperties

    protection?: IWorkbookProtection.JSON
    resources?: IResource.JSON[]
    richData?: JSON[]

    The rich values cells name by id ({ t: 'r', v: id }).

    richTypes?: JSON[]

    The kinds richData names that are not registered in code (a kind read from a file).

    sheets: SheetRefJSON<IOpaqueSheet.JSON | IWorksheet.JSON>[]
    strings?: string[]
    styles?: IStyleCollection.JSON
    theme?: ITheme.JSON
    updateLinks?: UpdateLinks

    What should happen to the cached values of externalBooks when the workbook is opened.

    Carried, not obeyed: SheetXL never refreshes a link, so every mode behaves as never today. Absent when the source said nothing, which Excel reads as userSet.

    view?: IWorkbookView.JSON

    Settings
    Member Visibility

    On This Page
    Properties