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

    Interface AddOptions

    Options for adding a table to the collection.

    interface AddOptions {
        author?: Author;
        autoSelect?: boolean | ITypes.SelectOptions;
        description?: string;
        disabledAutofit?: boolean;
        expectedCommitId?: string;
        hasHeader?: boolean;
        hasTotals?: boolean;
        properties?: ITable.Properties;
        readOnly?: boolean;
    }

    Hierarchy (View Summary)

    Index
    author? autoSelect? description? disabledAutofit? expectedCommitId? hasHeader? hasTotals? properties? readOnly?
    author?: Author

    Who authored this change. Recorded on the commit (ICommit.getAuthor).

    the store's author, else null (unattributed)

    autoSelect?: boolean | ITypes.SelectOptions

    If true or set then this will select the affect item after the transaction is complete.

    If this is set to true then any restore will also select.

    description?: string

    A human description.

    'determined by the set operation and locale'
    disabledAutofit?: boolean

    Disabled autoFit on add.

    false;
    expectedCommitId?: string

    Optimistic concurrency guard. If set, the operation only begins if the store's current commit id matches; otherwise a TransactionConflictError is thrown.

    The check happens atomically as the root transaction begins — there is no window between check and commit. If any transaction is already open the check fails with reason open (the head could move beneath the operation).

    hasHeader?: boolean

    If not specified then the header status will be determined from the range data.

    'based on initial data set'

    A default value of false will create a new row.

    hasTotals?: boolean

    Whether the range already ends with the totals row the properties ask for. The table then takes those cells as its totals row rather than adding one below the range.

    false
    properties?: ITable.Properties

    Properties to set on the table when created.

    With headerRowCount: 0 the range has no header row: all of it is data.

    readOnly?: boolean

    Declares the operation read-only: any state update within it throws.

    false

    Writes are tracked automatically — a batch that performs no updates never creates a commit (no new commit id, no events, no undo entry) whether or not this is set. The flag is purely an assertion for callers that want the guarantee enforced. Nested transactions inherit it; they cannot opt back out.

    Settings
    Member Visibility

    On This Page
    Properties