SheetXL - v1.0.2
    Preparing search index...

    Interface RefreshOptions

    Options for IPivotTable.refresh.

    interface RefreshOptions {
        author?: Author;
        autoSelect?: boolean | ITypes.SelectOptions;
        description?: string;
        expectedCommitId?: string;
        meta?: Record<string, string>;
        readOnly?: boolean;
        source?: boolean;
    }

    Hierarchy (View Summary)

    Index
    author? autoSelect? description? expectedCommitId? meta? readOnly? source?
    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'
    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).

    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.

    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.

    source?: boolean

    Whether the cache is read again from the source first; false lays the table out from the cache as it is.

    true

    Settings
    Member Visibility

    On This Page
    Properties