OptionalauthorWho authored this change. Recorded on the commit (ICommit.getAuthor).
OptionalautoFit the affected columns and rows to their content once the operation completes.
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 widths back.
If set to true then autoFit will mimic the UI with the following options:
{
skipCustomSize: true,
expandOnly: true,
minContent: true
}
OptionalautoSelect the affected range once the operation completes.
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.
OptionalautoSelect the affected range when the operation is undone or redone.
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.
OptionalaxisThe direction in which to shift existing cells.
Defaults to the axis where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall). See ICellRange.getDefaultShiftAxis
OptionaldescriptionA human description.
OptionalexpectedOptimistic concurrency guard. If set, the operation only begins if the store's current commit id matches; otherwise a TransactionConflictError is thrown.
OptionalreadDeclares the operation read-only: any state update within it throws.
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.
OptionalspanExpand the shifted range to the enclosing region's full extent across the shift axis before deleting: within a table, the table's width/height (a table row/column delete); otherwise the entire sheet (an entire row/column delete). See InsertOptions.span for the boundary and validity rules.
Options for
ICellRange.delete.