SheetXL - v1.0.2
    Preparing search index...

    Interface RemoveDuplicatesOptions

    interface RemoveDuplicatesOptions {
        author?: Author;
        autoFit?: boolean | AutoFitOptions;
        autoSelect?: boolean | ICellRange.SelectOptions;
        autoSelectRestore?: boolean | ICellRange.SelectOptions;
        columns?: (string | number)[];
        description?: string;
        expectedCommitId?: string;
        hasHeader?: boolean;
        meta?: Record<string, string>;
        readOnly?: boolean;
    }

    Hierarchy (View Summary)

    Index
    author?: Author

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

    the store's author, else null (unattributed)

    autoFit?: boolean | AutoFitOptions

    Fit the affected columns and rows to their content once the operation completes.

    the rows only, as Excel sizes them: a row with no custom height fits its
    content (growing or shrinking); a custom height and every column width are left alone.

    The fit runs once, as the last write of the operation, so it measures the finished content and its sizes belong to the same undo entry - one undo puts both the content and the sizes back.

    Pass false to leave every size alone. Pass true to fit as the UI does - rows and columns:

    {
    skipCustomSize: true,
    expandOnly: 'column', // columns only grow; rows fit exactly
    minContent: true
    }
    autoSelect?: boolean | ICellRange.SelectOptions

    Select the affected range once the operation completes.

    false - the selection is left alone.

    The selection is applied once, after the whole operation - within a batch, the last operation to ask for one wins. It is applied only if the selection is still where it was when the operation began: a user who moved while it ran keeps where they went.

    Pass it for an edit the user made. A script that passes neither this nor autoSelectRestore never moves the user, whether it runs, is undone or is redone.

    autoSelectRestore?: boolean | ICellRange.SelectOptions

    Select the affected range when the operation is undone or redone.

    autoSelect

    An undo lands where the operation began - for most operations the range they affected, for an auto-fill the template it was dragged from - and a redo where it left the user. Within a batch an undo lands where the first operation to ask says, a redo where the last one does.

    For an edit made from where the user already is, pass this without autoSelect: a value typed into a cell of a selected block leaves the block selected, and undoing it selects the cell.

    columns?: (string | number)[]

    A list of columns to consider for duplicate removal.

    all columns
    

    If this is a number it will be a number relative to the range if a string it will be a column identifier that is resolved.

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

    hasHeader?: boolean

    Indicates if the range has a header row.

    false
    

    If true, the first row of the range will be treated as a header and excluded from duplicate removal.

    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.