SheetXL - v1.0.2
    Preparing search index...

    Interface GroupOptions

    Options for IMovableCollection.group.

    interface GroupOptions {
        author?: Author;
        autoSelect?: boolean | IMovable.SelectOptions;
        autoSelectRestore?: boolean;
        description?: string;
        expectedCommitId?: string;
        meta?: Record<string, string>;
        name?: string;
        readOnly?: boolean;
    }

    Hierarchy (View Summary)

    Index
    author? autoSelect? autoSelectRestore? description? expectedCommitId? meta? name? readOnly?
    author?: Author

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

    the store's author, else null (unattributed)

    autoSelect?: boolean | IMovable.SelectOptions

    Whether the group is selected once made.

    true
    autoSelectRestore?: boolean

    Select what the operation acted on when it is undone or redone: an undo lands on the selection it began with, a redo where it left the user.

    autoSelect

    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.

    name?: string

    The name of the group.

    A name made from the type, such as Group 3.

    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