SheetXL - v1.0.2
    Preparing search index...

    Interface AddOptions

    Options for IPivotTableCollection.add.

    interface AddOptions {
        author?: Author;
        autoSelect?: boolean | ITypes.SelectOptions;
        columns?: readonly string[];
        description?: string;
        discardValues?: boolean;
        expectedCommitId?: string;
        form?: "compact" | PivotForm;
        meta?: Record<string, string>;
        name?: string;
        pages?: readonly string[];
        readOnly?: boolean;
        rows?: readonly string[];
        style?: string;
        values?: readonly (string | IPivotTable.IDataField.Input)[];
    }

    Hierarchy (View Summary)

    Index
    author? autoSelect? columns? description? discardValues? expectedCommitId? form? meta? name? pages? readOnly? rows? style? values?
    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.

    columns?: readonly string[]

    The fields across the columns, outermost first.

    description?: string

    A human description.

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

    Whether values in the cells the table needs are cleared; false refuses the table instead.

    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).

    form?: "compact" | PivotForm

    Absent, compact.

    meta?: Record<string, string>

    Stored with the commit (ICommit.getMeta) — for what a view of the history wants to know beyond the description, such as the command that made the change.

    name?: string

    Absent, PivotTable and one past the highest number the workbook's tables have.

    pages?: readonly string[]

    The fields above the table, each filtering it by an item.

    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.

    rows?: readonly string[]

    The fields down the rows, outermost first.

    style?: string

    A pivot table style by name; absent, PivotStyleLight16.

    values?: readonly (string | IPivotTable.IDataField.Input)[]

    The values. A field's name alone sums a column of numbers, blanks among them, and counts any other.

    Settings
    Member Visibility

    On This Page
    Properties