SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ToJSONOptions

    interface ToJSONOptions {
        ignoreData?: boolean;
        ignoreFormulas?: boolean;
        ignoreStyles?: boolean;
        includeHeaderStyles?: boolean;
        resources?: Writer | "embed" | "ignore";
        splitDirectBorders?: boolean;
    }
    Index
    ignoreData? ignoreFormulas? ignoreStyles? includeHeaderStyles? resources? splitDirectBorders?
    ignoreData?: boolean

    If true the raw values will not be included in the JSON.

    When ignoring Data the strings will also not be included in the JSON.

    ignoreFormulas?: boolean

    If true the formulas will not be included in the JSON.

    ignoreStyles?: boolean

    If true the resources will not include formatting.

    This will also ignore merges and hyperlinks styles

    includeHeaderStyles?: boolean

    If true header styles will be included in the JSON.

    This is useful when exporting to formats such as ooxml that do not support ranged direct styles.

    • If ignoreStyles is true this is ignored
    resources?: Writer | "embed" | "ignore"

    How resources — images and the other binaries the sheet references — are written.

    • 'embed' serializes each one into the JSON, base64 encoded.
    • 'ignore' writes every id as 0 and no resources.
    • An IResource.Writer puts each one wherever the caller wants and records what it returns, so resources can be stored outside the JSON — uploaded and referenced by uri, or emitted as parts of another format and referenced by id alone.
    'embed'
    splitDirectBorders?: boolean

    If true styled borders will be split into individual border elements in the JSON.

    This is useful when exporting to formats such as ooxml that do not support ranged border elements.

    Ignored if ignoreStyles is true.

    Settings
    Member Visibility

    On This Page
    Properties