SheetXL - v0.3.20
    Preparing search index...

    Interface JSON

    A JSON representation useful for persistence.

    interface JSON {
        columns?: Column[];
        description?: string;
        filter?: JSON;
        headerRowCount?: number;
        name?: string;
        ref: string | IRange.Coords;
        sort?: JSON;
        styleOptions?: StyleOptions;
        totalsRowCount?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    columns? description? filter? headerRowCount? name? ref sort? styleOptions? totalsRowCount?

    Properties

    columns?: Column[]

    Table column definitions.

    description?: string

    A string representing the name of the table. This is the name that shall be used in formula references, and displayed in the UI to the spreadsheet user. This name shall not have any spaces in it, and it must be unique amongst all other displayNames and definedNames in the names. The character lengths and restrictions are the same as for definedNames.

    See SpreadsheetML Reference - Workbook definedNames section for details.

    filter?: JSON

    If missing than no auto filter enabled

    headerRowCount?: number

    An integer representing the number of header rows showing at the top of the table. 0 means that the header row is not shown

    1
    name?: string

    The unique name of the table

    ref: string | IRange.Coords

    An A1 representation of a range that is the bounding area for the table.

    The reference shall include the totals row if it is shown

    sort?: JSON

    This is available on both the filter and the table so that the sort state can be restored if the filter was removed and re-added.

    styleOptions?: StyleOptions

    If not specified then the default table style is used If the style name isn't valid then uses a 'none' style.

    totalsRowCount?: number

    An integer representing the number of totals rows that shall be shown at the bottom of the table.

    0

    Settings

    Member Visibility

    On This Page

    Properties