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

    Interface TextToColumnsOptions

    Options for ICellRange.textToColumns.

    interface TextToColumnsOptions {
        author?: Author;
        autoFit?: boolean | AutoFitOptions;
        autoSelect?: boolean | ICellRange.SelectOptions;
        autoSelectRestore?: boolean | ICellRange.SelectOptions;
        delimiter?: string;
        description?: string;
        destination?: ICellRange.Address;
        expectedCommitId?: string;
        preserveEmptyFields?: boolean;
        readOnly?: boolean;
        replaceExisting?: boolean;
        textQualifier?: string;
    }

    Hierarchy (View Summary)

    Index
    author? autoFit? autoSelect? autoSelectRestore? delimiter? description? destination? expectedCommitId? preserveEmptyFields? readOnly? replaceExisting? textQualifier?
    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.

    false - sizes 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 widths back.

    If set to true then autoFit will mimic the UI with the following options:

    {
    skipCustomSize: true,
    expandOnly: true,
    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.

    delimiter?: string

    The character used to split the text.

    System looks for string with one of the following.

    Common delimiters include , (comma), ; (semicolon), \t (tab), or (space).

    description?: string

    A human description.

    'determined by the set operation and locale'
    destination?: ICellRange.Address

    The destination range where the split columns will be placed.

    If not specified, the operation will start at the the original range top left.

    • If the destination range overlaps with the source range, the behavior will depend on the replaceExisting option:
      • If replaceExisting is true, the operation will proceed, and any existing data in the destination range will be overwritten.
      • If replaceExisting is false (default), and there is an overlap with non-empty cells, the operation will throw an error to prevent data loss.
    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).

    preserveEmptyFields?: boolean

    Determines how empty fields are split.

    false

      • If false (default): Consecutive delimiters are treated as a single break. Empty fields between delimiters are ignored/merged.
    • If true: Every delimiter creates a new column. Consecutive delimiters will result in empty strings ("") in the output.

    This is the inverse of Excel's "Treat consecutive delimiters as one" option. *

    // Input string: "Apple,,Banana" (Delimiter is comma)
    * // When preserveEmptyFields is false (Default):
    // Result: ["Apple", "Banana"]
    * // When preserveEmptyFields is true:
    // Result: ["Apple", "", "Banana"]
    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.

    replaceExisting?: boolean

    If true, the operation will overwrite existing data in the destination columns without warning.

    false

    • The source row will be split..
    • If this is false (default) and non-empty cells exist in the output range, the operation will throw an error to prevent data loss.
    textQualifier?: string

    The character used to enclose text strings that may contain the delimiter.

    " (double quote)

    Characters found inside the qualifier are treated as literal text rather than delimiters. For example, if the delimiter is a comma, "Doe, John" will remain one cell rather than splitting into two. Set this to an empty string to disable text qualification.

    Settings
    Member Visibility

    On This Page
    Properties