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

    Interface ReplaceOptions

    Options for the replace operation.

    interface ReplaceOptions {
        author?: Author;
        autoSelect?: boolean | ITypes.SelectOptions;
        axis?: Axis;
        description?: string;
        expectedCommitId?: string;
        maxCount?: number;
        readOnly?: boolean;
    }

    Hierarchy (View Summary)

    Index
    author? autoSelect? axis? description? expectedCommitId? maxCount? 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.

    axis?: Axis

    The axis to replace.

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

    maxCount?: number

    The maximum number of cells to replace.

    false
    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