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

    Interface JSON

    A JSON representation useful for persistence.

    interface JSON {
        altText?: string;
        altTextSummary?: string;
        autoExpand?: ITable.AutoExpand;
        columns?: (string | ColumnProperties)[];
        description?: string;
        disabledColumnFill?: boolean;
        filter?: IFilter.JSON;
        formulaBelow?: ITable.FormulaBelow;
        headerRowCount?: number;
        hiddenButtons?: boolean | number[];
        id?: string;
        name?: string;
        showButtons?: boolean | number[];
        sort?: ISort.JSON;
        style?: StyleOptions;
        totalsRowCount?: number;
        totalsRowShown?: boolean;
    }

    Hierarchy

    Index
    altText? altTextSummary? autoExpand? columns? description? disabledColumnFill? filter? formulaBelow? headerRowCount? hiddenButtons? id? name? showButtons? sort? style? totalsRowCount? totalsRowShown?
    altText?: string

    Accessibility alt text for the table.

    altTextSummary?: string

    Accessibility alt text summary for the table.

    autoExpand?: ITable.AutoExpand

    Which edges of the table grow when something is entered just beside it.

    ITable.AutoExpand.Both

    columns?: (string | ColumnProperties)[]

    Table column definitions.

    All tables must have columns.

    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.

    disabledColumnFill?: boolean

    If true a formula entered into a column is not filled down it.

    filter?: IFilter.JSON

    The criterial for the filter field. If this is empty or null then this is treated as not having any criteria.

    formulaBelow?: ITable.FormulaBelow

    Where a formula entered in the row just below the table goes.

    ITable.FormulaBelow.TotalsRow

    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
    hiddenButtons?: boolean | number[]

    If the button is hidden.

    The button may be hidden for other reasons like there is no filter.

    id?: string

    A unique id for all tables in the workbook.

    This will never change.

    name?: string

    The unique name of the table.

    showButtons?: boolean | number[]

    OOXML - Not sure what it is used for.

    sort?: ISort.JSON

    The criterial for the filter field. If this is empty or null then this is treated as not having any criteria.

    style?: 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
    totalsRowShown?: boolean

    Whether the table has ever shown a totals row.

    The first time a totals row is shown the last column is given a total - a sum when the column holds only numbers, a count otherwise. A table that has already shown one keeps whatever its columns had when the row was hidden, including nothing.

    false

    Settings
    Member Visibility

    On This Page
    Properties