@jsfkit/types
    Preparing search index...

    Type Alias Workbook

    A workbook is a collection of worksheets, styles, defined names, and other metadata. It's what's commonly known as a spreadsheet.

    type Workbook = {
        calculationProperties?: CalcProps;
        externals?: External[];
        formulas?: string[];
        images?: Record<string, string>;
        meta?: {
            app?: {
                confidence?: number;
                name?: string;
                variant?: string;
                version?: string;
            };
        };
        name: string;
        names?: DefinedName[];
        people?: Person[];
        pivotTables?: PivotTable[];
        sheets: Worksheet[];
        styles?: Style[];
        tables?: Table[];
        theme?: Theme;
        views?: WorkbookView[];
    }
    Index

    Properties

    calculationProperties? externals? formulas? images? meta? name names? people? pivotTables? sheets styles? tables? theme? views?

    Properties

    calculationProperties?: CalcProps

    Directions on how formulas should be recalculated in the workbook.

    externals?: External[]

    External cells referenced by the workbook. An external cell is a cell in another workbook.

    formulas?: string[]

    Deduplicated formulas used in the workbook. Stored in R1C1 notation. Two formulas are considered to be the same when their respective representations in R1C1 notation, are identical.

    images?: Record<string, string>

    A simple dictionary of binary images used by this workbook.

    The keys should be the file paths of the images used to refer to them, commonly these will be the mediaId properties on drawing objects. The values should be data URI encoded binaries.

    The following is a table of formats you may be expected to encounter:

    Extension MIME type Common name
    .png image/png Portable Network Graphics
    .jpg, .jpeg image/jpeg JPEG
    .gif image/gif Graphics Interchange Format
    .emf image/emf Enhanced Metafile
    .wmf image/wmf Windows Metafile
    .wdp, .jxr, .hdp image/vnd.ms-photo Windows Media Photo / JPEG XR
    .bmp image/bmp Bitmap
    .tif, .tiff image/tiff Tagged Image File Format
    .svg image/svg+xml Scalable Vector Graphics
    meta?: {
        app?: {
            confidence?: number;
            name?: string;
            variant?: string;
            version?: string;
        };
    }

    Optional metadata about this workbook.

    Type Declaration

    • Optionalapp?: { confidence?: number; name?: string; variant?: string; version?: string }

      Information about the application that originated this workbook. Converters should populate this from file metadata and/or by heuristic detection (in which case they should set confidence to a value less than 1).

      • Optionalconfidence?: number

        How confident the converter is in the identification. A value of 1 means the app information came directly from the metadata in the source file. Values less than 1 indicate heuristic detection, with lower values representing less certainty.

        1
      • Optionalname?: string

        The plain application name, without platform qualifiers or version suffixes (e.g. "Microsoft Excel", "LibreOffice Calc").

      • Optionalvariant?: string

        Operating system or other variant of the application (e.g. "Macintosh"). Present when the application name in the source file includes a platform qualifier that was separated out from name.

      • Optionalversion?: string

        The application version string, if known (e.g. "16.0300").

    An XLSX file with metadata explicitly marking it as saved by Excel for Macintosh might have
    `meta: { app: { name: 'Microsoft Excel', version: '16.0300', variant: 'Macintosh' } }`.

    An XLSX file lacking app metadata but recognized heuristically as being a Google Sheets
    export might have `meta: { app: { name: 'Google Sheets', confidence: 0.8 } }`.
    name: string

    Name of the workbook. In the case of a .xlsx file it will be the filename.

    names?: DefinedName[]

    An array of the workbook's defined names.

    people?: Person[]

    Individuals who have written a threaded comment in this workbook, or who have been mentioned in one.

    ThreadedComment

    pivotTables?: PivotTable[]

    Metadata on the workbook's pivot tables.

    sheets: Worksheet[]

    An ordered array of the worksheets in the workbook.

    styles?: Style[]

    Styles for cells in the workbook.

    tables?: Table[]

    Metadata on the workbook's tables.

    theme?: Theme

    The workbook theme. Specifies the colour scheme and fonts referenced throughout the workbook in order to create a consistent visual presentation.

    views?: WorkbookView[]

    The different display configurations saved for the workbook.

    Settings

    Member Visibility

    On This Page

    Properties