@univerjs/sheets v0.5.4


Function: splitRangeText()

function splitRangeText(
   sheet, 
   range, 
   delimiter?, 
   customDelimiter?, 
   treatMultipleDelimitersAsOne?): ISplitRangeTextResult

Defined in: submodules/univer/packages/sheets/src/basics/split-range-text.ts:186

Split the text in the range into a two-dimensional array.

Parameters

ParameterTypeDefault valueDescription
sheetWorksheetundefinedThe worksheet which range belongs to.
rangeIRangeundefinedThe range to split.
delimiter?SplitDelimiterEnumundefinedThe delimiter to split the text.
customDelimiter?stringundefinedThe custom delimiter to split the text. An error will be thrown if customDelimiter is not a character.
treatMultipleDelimitersAsOne?booleanfalsesplit multiple delimiters as one.

Returns

ISplitRangeTextResult

The two-dimensional array of the split text and max column length.