easy-spreadsheet-write
    Preparing search index...

    Interface ESWOptions

    The all-in-one options object that can be passed to any function

    interface ESWOptions {
        bookSST?: boolean;
        bookType?: BookType;
        bookVBA?: boolean;
        cellDates?: boolean;
        cellPadding?: number;
        cellStyles?: boolean;
        codepage?: number;
        compression?: boolean;
        fileName?: string;
        FS?: string;
        ignoreEC?: boolean;
        numbers?: string;
        password?: string;
        Props?: Properties;
        RS?: string;
        RTL?: boolean;
        sheet?: string | number;
        sheetStubs?: boolean;
        themeXLSX?: string;
        type?: "string" | "base64" | "binary" | "buffer" | "file" | "array";
        WTF?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bookSST? bookType? bookVBA? cellDates? cellPadding? cellStyles? codepage? compression? fileName? FS? ignoreEC? numbers? password? Props? RS? RTL? sheet? sheetStubs? themeXLSX? type? WTF?

    Properties

    bookSST?: boolean

    Generate Shared String Table

    false
    bookType?: BookType

    File format of generated workbook

    'xlsx'
    bookVBA?: boolean

    When reading a file with VBA macros, expose CFB blob to vbaraw field When writing BIFF8/XLSB/XLSM, reseat vbaraw and export to file

    false
    cellDates?: boolean

    When reading a file, store dates as type d (default is n) When writing XLSX/XLSM file, use native date (default uses date codes)

    false
    cellPadding?: number

    When writing, in formats that support styling, this increases the padding between the cell content and the cell border. (a.k.a: extra cell width)

    cellStyles?: boolean

    When reading a file, save style/theme info to the .s field When writing a file, export style/theme info

    false
    codepage?: number

    Desired codepage for legacy file formats

    This requires encoding support to be loaded. It is automatically loaded in xlsx.full.min.js and in CommonJS / Extendscript, but an extra step is required in React / Angular / Webpack / ESM deployments.

    Check the relevant guide https://docs.sheetjs.com/docs/getting-started/

    compression?: boolean

    Use ZIP compression for ZIP-based formats

    false
    fileName?: string
    FS?: string

    Field Separator ("delimiter") for CSV / Text output

    ignoreEC?: boolean

    Suppress "number stored as text" errors in generated files

    true
    numbers?: string

    Base64 encoding of NUMBERS base for exports

    password?: string

    If defined and file is encrypted, use password

    ''
    Props?: Properties

    Override workbook properties on save

    RS?: string

    Record Separator ("row separator") for CSV / Text output

    RTL?: boolean

    Right-to-left (RTL) mode

    sheet?: string | number

    For single-sheet formats, export the specified worksheet.

    The property must be a string (sheet name) or number (SheetNames index).

    If this option is omitted, the first worksheet will be exported.

    sheetStubs?: boolean

    Create cell objects for stub cells

    false
    themeXLSX?: string

    Override theme XML when exporting to XLSX/XLSM/XLSB

    type?: "string" | "base64" | "binary" | "buffer" | "file" | "array"

    Output data encoding

    WTF?: boolean

    If true, throw errors when features are not understood

    false

    Settings

    Member Visibility

    On This Page

    Properties