@univerjs/sheets 0.6.0 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/lib/cjs/facade.js +1 -1
  2. package/lib/cjs/index.js +3 -3
  3. package/lib/es/facade.js +1184 -997
  4. package/lib/es/index.js +1017 -1012
  5. package/lib/types/commands/commands/set-border-command.d.ts +3 -1
  6. package/lib/types/commands/operations/scroll-to-cell.operation.d.ts +5 -1
  7. package/lib/types/controllers/permission/sheet-permission-init.controller.d.ts +1 -0
  8. package/lib/types/facade/f-defined-name.d.ts +67 -43
  9. package/lib/types/facade/f-enum.d.ts +6 -1
  10. package/lib/types/facade/f-event.d.ts +106 -37
  11. package/lib/types/facade/f-permission.d.ts +8 -7
  12. package/lib/types/facade/f-range.d.ts +349 -246
  13. package/lib/types/facade/f-selection.d.ts +37 -12
  14. package/lib/types/facade/f-univer.d.ts +31 -12
  15. package/lib/types/facade/f-workbook.d.ts +154 -84
  16. package/lib/types/facade/f-worksheet.d.ts +298 -262
  17. package/lib/types/index.d.ts +2 -3
  18. package/lib/types/model/range-themes/default.d.ts +1 -0
  19. package/lib/umd/facade.js +1 -1
  20. package/lib/umd/index.js +3 -3
  21. package/package.json +8 -8
package/lib/types/facade/f-range.d.ts CHANGED
@@ -25,10 +25,10 @@ export declare class FRange extends FBaseInitialable {
25
25
  * @returns {string} The unit ID of the workbook
26
26
  * @example
27
27
  * ```ts
28
- * univerAPI.getActiveWorkbook()
29
- * .getActiveSheet()
30
- * .getActiveRange()
31
- * .getUnitId()
28
+ * const fWorkbook = univerAPI.getActiveWorkbook();
29
+ * const fWorksheet = fWorkbook.getActiveSheet();
30
+ * const fRange = fWorksheet.getRange('A1:B2');
31
+ * console.log(fRange.getUnitId());
32
32
  * ```
33
33
  */
34
34
  getUnitId(): string;
@@ -37,10 +37,10 @@ export declare class FRange extends FBaseInitialable {
37
37
  * @returns {string} The name of the worksheet
38
38
  * @example
39
39
  * ```ts
40
- * univerAPI.getActiveWorkbook()
41
- * .getActiveSheet()
42
- * .getActiveRange()
43
- * .getSheetName()
40
+ * const fWorkbook = univerAPI.getActiveWorkbook();
41
+ * const fWorksheet = fWorkbook.getActiveSheet();
42
+ * const fRange = fWorksheet.getRange('A1:B2');
43
+ * console.log(fRange.getSheetName());
44
44
  * ```
45
45
  */
46
46
  getSheetName(): string;
@@ -49,10 +49,10 @@ export declare class FRange extends FBaseInitialable {
49
49
  * @returns {string} The ID of the worksheet
50
50
  * @example
51
51
  * ```ts
52
- * univerAPI.getActiveWorkbook()
53
- * .getActiveSheet()
54
- * .getActiveRange()
55
- * .getSheetId()
52
+ * const fWorkbook = univerAPI.getActiveWorkbook();
53
+ * const fWorksheet = fWorkbook.getActiveSheet();
54
+ * const fRange = fWorksheet.getRange('A1:B2');
55
+ * console.log(fRange.getSheetId());
56
56
  * ```
57
57
  */
58
58
  getSheetId(): string;
@@ -61,10 +61,12 @@ export declare class FRange extends FBaseInitialable {
61
61
  * @returns {IRange} The area where the statement is applied
62
62
  * @example
63
63
  * ```ts
64
- * univerAPI.getActiveWorkbook()
65
- * .getActiveSheet()
66
- * .getActiveRange()
67
- * .getRange()
64
+ * const fWorkbook = univerAPI.getActiveWorkbook();
65
+ * const fWorksheet = fWorkbook.getActiveSheet();
66
+ * const fRange = fWorksheet.getRange('A1:B2');
67
+ * const range = fRange.getRange();
68
+ * const { startRow, startColumn, endRow, endColumn } = range;
69
+ * console.log(range);
68
70
  * ```
69
71
  */
70
72
  getRange(): IRange;
@@ -73,10 +75,10 @@ export declare class FRange extends FBaseInitialable {
73
75
  * @returns {number} The starting row number of the area
74
76
  * @example
75
77
  * ```ts
76
- * univerAPI.getActiveWorkbook()
77
- * .getActiveSheet()
78
- * .getActiveRange()
79
- * .getRow()
78
+ * const fWorkbook = univerAPI.getActiveWorkbook();
79
+ * const fWorksheet = fWorkbook.getActiveSheet();
80
+ * const fRange = fWorksheet.getRange('A1:B2');
81
+ * console.log(fRange.getRow());
80
82
  * ```
81
83
  */
82
84
  getRow(): number;
@@ -85,10 +87,10 @@ export declare class FRange extends FBaseInitialable {
85
87
  * @returns {number} The starting column number of the area
86
88
  * @example
87
89
  * ```ts
88
- * univerAPI.getActiveWorkbook()
89
- * .getActiveSheet()
90
- * .getActiveRange()
91
- * .getColumn()
90
+ * const fWorkbook = univerAPI.getActiveWorkbook();
91
+ * const fWorksheet = fWorkbook.getActiveSheet();
92
+ * const fRange = fWorksheet.getRange('A1:B2');
93
+ * console.log(fRange.getColumn());
92
94
  * ```
93
95
  */
94
96
  getColumn(): number;
@@ -97,10 +99,10 @@ export declare class FRange extends FBaseInitialable {
97
99
  * @returns {number} The width of the area
98
100
  * @example
99
101
  * ```ts
100
- * univerAPI.getActiveWorkbook()
101
- * .getActiveSheet()
102
- * .getActiveRange()
103
- * .getWidth()
102
+ * const fWorkbook = univerAPI.getActiveWorkbook();
103
+ * const fWorksheet = fWorkbook.getActiveSheet();
104
+ * const fRange = fWorksheet.getRange('A1:B2');
105
+ * console.log(fRange.getWidth());
104
106
  * ```
105
107
  */
106
108
  getWidth(): number;
@@ -109,10 +111,10 @@ export declare class FRange extends FBaseInitialable {
109
111
  * @returns {number} The height of the area
110
112
  * @example
111
113
  * ```ts
112
- * univerAPI.getActiveWorkbook()
113
- * .getActiveSheet()
114
- * .getActiveRange()
115
- * .getHeight()
114
+ * const fWorkbook = univerAPI.getActiveWorkbook();
115
+ * const fWorksheet = fWorkbook.getActiveSheet();
116
+ * const fRange = fWorksheet.getRange('A1:B2');
117
+ * console.log(fRange.getHeight());
116
118
  * ```
117
119
  */
118
120
  getHeight(): number;
@@ -121,10 +123,13 @@ export declare class FRange extends FBaseInitialable {
121
123
  * @returns {boolean} if true is merged
122
124
  * @example
123
125
  * ```ts
124
- * univerAPI.getActiveWorkbook()
125
- * .getActiveSheet()
126
- * .getActiveRange()
127
- * .isMerged()
126
+ * const fWorkbook = univerAPI.getActiveWorkbook();
127
+ * const fWorksheet = fWorkbook.getActiveSheet();
128
+ * const fRange = fWorksheet.getRange('A1:B2');
129
+ * console.log(fRange.isMerged());
130
+ * // merge cells A1:B2
131
+ * fRange.merge();
132
+ * console.log(fRange.isMerged());
128
133
  * ```
129
134
  */
130
135
  isMerged(): boolean;
@@ -133,10 +138,10 @@ export declare class FRange extends FBaseInitialable {
133
138
  * @returns {IStyleData | null} The cell style data
134
139
  * @example
135
140
  * ```ts
136
- * univerAPI.getActiveWorkbook()
137
- * .getActiveSheet()
138
- * .getActiveRange()
139
- * .getCellStyleData()
141
+ * const fWorkbook = univerAPI.getActiveWorkbook();
142
+ * const fWorksheet = fWorkbook.getActiveSheet();
143
+ * const fRange = fWorksheet.getRange('A1:B2');
144
+ * console.log(fRange.getCellStyleData());
140
145
  * ```
141
146
  */
142
147
  getCellStyleData(): IStyleData | null;
@@ -145,10 +150,10 @@ export declare class FRange extends FBaseInitialable {
145
150
  * @returns {TextStyleValue | null} The cell style
146
151
  * @example
147
152
  * ```ts
148
- * univerAPI.getActiveWorkbook()
149
- * .getActiveSheet()
150
- * .getActiveRange()
151
- * .getCellStyle()
153
+ * const fWorkbook = univerAPI.getActiveWorkbook();
154
+ * const fWorksheet = fWorkbook.getActiveSheet();
155
+ * const fRange = fWorksheet.getRange('A1:B2');
156
+ * console.log(fRange.getCellStyle());
152
157
  * ```
153
158
  */
154
159
  getCellStyle(): TextStyleValue | null;
@@ -157,10 +162,10 @@ export declare class FRange extends FBaseInitialable {
157
162
  * @returns {Array<Array<TextStyleValue | null>>} A two-dimensional array of cell styles.
158
163
  * @example
159
164
  * ```ts
160
- * univerAPI.getActiveWorkbook()
161
- * .getActiveSheet()
162
- * .getActiveRange()
163
- * .getCellStyles()
165
+ * const fWorkbook = univerAPI.getActiveWorkbook();
166
+ * const fWorksheet = fWorkbook.getActiveSheet();
167
+ * const fRange = fWorksheet.getRange('A1:B2');
168
+ * console.log(fRange.getCellStyles());
164
169
  * ```
165
170
  */
166
171
  getCellStyles(): Array<Array<TextStyleValue | null>>;
@@ -169,10 +174,14 @@ export declare class FRange extends FBaseInitialable {
169
174
  * @returns {CellValue | null} The cell value
170
175
  * @example
171
176
  * ```ts
172
- * univerAPI.getActiveWorkbook()
173
- * .getActiveSheet()
174
- * .getActiveRange()
175
- * .getValue()
177
+ * const fWorkbook = univerAPI.getActiveWorkbook();
178
+ * const fWorksheet = fWorkbook.getActiveSheet();
179
+ * const fRange = fWorksheet.getRange('A1:B2');
180
+ * console.log(fRange.getValue());
181
+ *
182
+ * // set the first cell value to 123
183
+ * fRange.setValueForCell(123);
184
+ * console.log(fRange.getValue()); // 123
176
185
  * ```
177
186
  */
178
187
  getValue(): CellValue | null;
@@ -182,10 +191,17 @@ export declare class FRange extends FBaseInitialable {
182
191
  * @returns {CellValue | RichTextValue | null} The cell value
183
192
  * @example
184
193
  * ```ts
185
- * univerAPI.getActiveWorkbook()
186
- * .getActiveSheet()
187
- * .getActiveRange()
188
- * .getValue(true)
194
+ * const fWorkbook = univerAPI.getActiveWorkbook();
195
+ * const fWorksheet = fWorkbook.getActiveSheet();
196
+ * const fRange = fWorksheet.getRange('A1:B2');
197
+ * console.log(fRange.getValue(true));
198
+ *
199
+ * // set the first cell value to 123
200
+ * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } })
201
+ * .setStyle(0, 1, { bl: 1, cl: { rgb: '#c81e1e' } })
202
+ * .setStyle(6, 7, { bl: 1, cl: { rgb: '#c81e1e' } });
203
+ * fRange.setRichTextValueForCell(richText);
204
+ * console.log(fRange.getValue(true).toPlainText()); // Hello World
189
205
  * ```
190
206
  */
191
207
  getValue(includeRichText: true): Nullable<CellValue | RichTextValue>;
@@ -195,7 +211,10 @@ export declare class FRange extends FBaseInitialable {
195
211
  * @example
196
212
  * ```ts
197
213
  * // Get plain values
198
- * const values = range.getValues();
214
+ * const fWorkbook = univerAPI.getActiveWorkbook();
215
+ * const fWorksheet = fWorkbook.getActiveSheet();
216
+ * const fRange = fWorksheet.getRange('A1:B2');
217
+ * console.log(fRange.getValues());
199
218
  * ```
200
219
  */
201
220
  getValues(): Nullable<CellValue>[][];
@@ -206,10 +225,10 @@ export declare class FRange extends FBaseInitialable {
206
225
  * @example
207
226
  * ```ts
208
227
  * // Get values with rich text if available
209
- * const richTextValues = univerAPI.getActiveWorkbook()
210
- * .getActiveSheet()
211
- * .getActiveRange()
212
- * .getValues(true)
228
+ * const fWorkbook = univerAPI.getActiveWorkbook();
229
+ * const fWorksheet = fWorkbook.getActiveSheet();
230
+ * const fRange = fWorksheet.getRange('A1:B2');
231
+ * console.log(fRange.getValues(true));
213
232
  * ```
214
233
  */
215
234
  getValues(includeRichText: true): (Nullable<RichTextValue | CellValue>)[][];
@@ -218,10 +237,10 @@ export declare class FRange extends FBaseInitialable {
218
237
  * @returns {ICellData | null} The cell model data
219
238
  * @example
220
239
  * ```ts
221
- * univerAPI.getActiveWorkbook()
222
- * .getActiveSheet()
223
- * .getActiveRange()
224
- * .getCellData()
240
+ * const fWorkbook = univerAPI.getActiveWorkbook();
241
+ * const fWorksheet = fWorkbook.getActiveSheet();
242
+ * const fRange = fWorksheet.getRange('A1:B2');
243
+ * console.log(fRange.getCellData());
225
244
  * ```
226
245
  */
227
246
  getCellData(): ICellData | null;
@@ -230,10 +249,10 @@ export declare class FRange extends FBaseInitialable {
230
249
  * @returns {Nullable<ICellData>[][]} A two-dimensional array of cell data.
231
250
  * @example
232
251
  * ```ts
233
- * univerAPI.getActiveWorkbook()
234
- * .getActiveSheet()
235
- * .getActiveRange()
236
- * .getCellDatas()
252
+ * const fWorkbook = univerAPI.getActiveWorkbook();
253
+ * const fWorksheet = fWorkbook.getActiveSheet();
254
+ * const fRange = fWorksheet.getRange('A1:B2');
255
+ * console.log(fRange.getCellDatas());
237
256
  * ```
238
257
  */
239
258
  getCellDatas(): Nullable<ICellData>[][];
@@ -242,10 +261,10 @@ export declare class FRange extends FBaseInitialable {
242
261
  * @returns {Nullable<ICellData>[][]} A two-dimensional array of cell data.
243
262
  * @example
244
263
  * ```ts
245
- * univerAPI.getActiveWorkbook()
246
- * .getActiveSheet()
247
- * .getActiveRange()
248
- * .getCellDataGrid()
264
+ * const fWorkbook = univerAPI.getActiveWorkbook();
265
+ * const fWorksheet = fWorkbook.getActiveSheet();
266
+ * const fRange = fWorksheet.getRange('A1:B2');
267
+ * console.log(fRange.getCellDataGrid());
249
268
  * ```
250
269
  */
251
270
  getCellDataGrid(): Nullable<ICellData>[][];
@@ -256,10 +275,10 @@ export declare class FRange extends FBaseInitialable {
256
275
  * @beta
257
276
  * @example
258
277
  * ```ts
259
- * univerAPI.getActiveWorkbook()
260
- * .getActiveSheet()
261
- * .getActiveRange()
262
- * .getRichTextValue()
278
+ * const fWorkbook = univerAPI.getActiveWorkbook();
279
+ * const fWorksheet = fWorkbook.getActiveSheet();
280
+ * const fRange = fWorksheet.getRange('A1:B2');
281
+ * console.log(fRange.getRichTextValue());
263
282
  * ```
264
283
  */
265
284
  private getRichTextValue;
@@ -270,10 +289,10 @@ export declare class FRange extends FBaseInitialable {
270
289
  * @beta
271
290
  * @example
272
291
  * ```ts
273
- * univerAPI.getActiveWorkbook()
274
- * .getActiveSheet()
275
- * .getActiveRange()
276
- * .getRichTextValues()
292
+ * const fWorkbook = univerAPI.getActiveWorkbook();
293
+ * const fWorksheet = fWorkbook.getActiveSheet();
294
+ * const fRange = fWorksheet.getRange('A1:B2');
295
+ * console.log(fRange.getRichTextValues());
277
296
  * ```
278
297
  */
279
298
  private getRichTextValues;
@@ -284,10 +303,10 @@ export declare class FRange extends FBaseInitialable {
284
303
  * @beta
285
304
  * @example
286
305
  * ```ts
287
- * univerAPI.getActiveWorkbook()
288
- * .getActiveSheet()
289
- * .getActiveRange()
290
- * .getValueAndRichTextValue()
306
+ * const fWorkbook = univerAPI.getActiveWorkbook();
307
+ * const fWorksheet = fWorkbook.getActiveSheet();
308
+ * const fRange = fWorksheet.getRange('A1:B2');
309
+ * console.log(fRange.getValueAndRichTextValue());
291
310
  * ```
292
311
  */
293
312
  private getValueAndRichTextValue;
@@ -296,10 +315,10 @@ export declare class FRange extends FBaseInitialable {
296
315
  * @returns {Nullable<CellValue | RichTextValue>[][]} A two-dimensional array of value and rich text value
297
316
  * @example
298
317
  * ```ts
299
- * univerAPI.getActiveWorkbook()
300
- * .getActiveSheet()
301
- * .getActiveRange()
302
- * .getValueAndRichTextValues()
318
+ * const fWorkbook = univerAPI.getActiveWorkbook();
319
+ * const fWorksheet = fWorkbook.getActiveSheet();
320
+ * const fRange = fWorksheet.getRange('A1:B2');
321
+ * console.log(fRange.getValueAndRichTextValues());
303
322
  * ```
304
323
  */
305
324
  getValueAndRichTextValues(): Nullable<CellValue | RichTextValue>[][];
@@ -308,22 +327,22 @@ export declare class FRange extends FBaseInitialable {
308
327
  * @returns {string[][]} A two-dimensional array of formulas in string format.
309
328
  * @example
310
329
  * ```ts
311
- * univerAPI.getActiveWorkbook()
312
- * .getActiveSheet()
313
- * .getActiveRange()
314
- * .getFormulas()
330
+ * const fWorkbook = univerAPI.getActiveWorkbook();
331
+ * const fWorksheet = fWorkbook.getActiveSheet();
332
+ * const fRange = fWorksheet.getRange('A1:B2');
333
+ * console.log(fRange.getFormulas());
315
334
  * ```
316
335
  */
317
336
  getFormulas(): string[][];
318
337
  /**
319
- * Returns true if the cell wrap is enabled
338
+ * Returns true if the cell wrap is enabled for the top left cell of the range.
320
339
  * @returns {boolean} True if the cell wrap is enabled
321
340
  * @example
322
341
  * ```ts
323
- * univerAPI.getActiveWorkbook()
324
- * .getActiveSheet()
325
- * .getActiveRange()
326
- * .getWrap()
342
+ * const fWorkbook = univerAPI.getActiveWorkbook();
343
+ * const fWorksheet = fWorkbook.getActiveSheet();
344
+ * const fRange = fWorksheet.getRange('A1:B2');
345
+ * console.log(fRange.getWrap());
327
346
  * ```
328
347
  */
329
348
  getWrap(): boolean;
@@ -332,10 +351,10 @@ export declare class FRange extends FBaseInitialable {
332
351
  * @returns {WrapStrategy} The text wrapping strategy
333
352
  * @example
334
353
  * ```ts
335
- * univerAPI.getActiveWorkbook()
336
- * .getActiveSheet()
337
- * .getActiveRange()
338
- * .getWrapStrategy()
354
+ * const fWorkbook = univerAPI.getActiveWorkbook();
355
+ * const fWorksheet = fWorkbook.getActiveSheet();
356
+ * const fRange = fWorksheet.getRange('A1:B2');
357
+ * console.log(fRange.getWrapStrategy());
339
358
  * ```
340
359
  */
341
360
  getWrapStrategy(): WrapStrategy;
@@ -344,10 +363,10 @@ export declare class FRange extends FBaseInitialable {
344
363
  * @returns {string} The horizontal alignment
345
364
  * @example
346
365
  * ```ts
347
- * univerAPI.getActiveWorkbook()
348
- * .getActiveSheet()
349
- * .getActiveRange()
350
- * .getHorizontalAlignment()
366
+ * const fWorkbook = univerAPI.getActiveWorkbook();
367
+ * const fWorksheet = fWorkbook.getActiveSheet();
368
+ * const fRange = fWorksheet.getRange('A1:B2');
369
+ * console.log(fRange.getHorizontalAlignment());
351
370
  * ```
352
371
  */
353
372
  getHorizontalAlignment(): string;
@@ -356,10 +375,10 @@ export declare class FRange extends FBaseInitialable {
356
375
  * @returns {string} The vertical alignment
357
376
  * @example
358
377
  * ```ts
359
- * univerAPI.getActiveWorkbook()
360
- * .getActiveSheet()
361
- * .getActiveRange()
362
- * .getVerticalAlignment()
378
+ * const fWorkbook = univerAPI.getActiveWorkbook();
379
+ * const fWorksheet = fWorkbook.getActiveSheet();
380
+ * const fRange = fWorksheet.getRange('A1:B2');
381
+ * console.log(fRange.getVerticalAlignment());
363
382
  * ```
364
383
  */
365
384
  getVerticalAlignment(): string;
@@ -368,10 +387,11 @@ export declare class FRange extends FBaseInitialable {
368
387
  * @param {CustomData} data The custom meta data
369
388
  * @returns {FRange} This range, for chaining
370
389
  * ```ts
371
- * univerAPI.getActiveWorkbook()
372
- * .getActiveSheet()
373
- * .getActiveRange()
374
- * .setCustomMetaData({ key: 'value' });
390
+ * const fWorkbook = univerAPI.getActiveWorkbook();
391
+ * const fWorksheet = fWorkbook.getActiveSheet();
392
+ * const fRange = fWorksheet.getRange('A1:B2');
393
+ * fRange.setCustomMetaData({ key: 'value' });
394
+ * console.log(fRange.getCustomMetaData());
375
395
  * ```
376
396
  */
377
397
  setCustomMetaData(data: CustomData): FRange;
@@ -380,10 +400,14 @@ export declare class FRange extends FBaseInitialable {
380
400
  * @param {CustomData[][]} datas The custom meta data
381
401
  * @returns {FRange} This range, for chaining
382
402
  * ```ts
383
- * univerAPI.getActiveWorkbook()
384
- * .getActiveSheet()
385
- * .getActiveRange()
386
- * .setCustomMetaDatas([[{ key: 'value' }]]);
403
+ * const fWorkbook = univerAPI.getActiveWorkbook();
404
+ * const fWorksheet = fWorkbook.getActiveSheet();
405
+ * const fRange = fWorksheet.getRange('A1:B2');
406
+ * fRange.setCustomMetaDatas([
407
+ * [{ key: 'value' }, { key: 'value2' }],
408
+ * [{ key: 'value3' }, { key: 'value4' }],
409
+ * ]);
410
+ * console.log(fRange.getCustomMetaDatas());
387
411
  * ```
388
412
  */
389
413
  setCustomMetaDatas(datas: CustomData[][]): FRange;
@@ -392,10 +416,10 @@ export declare class FRange extends FBaseInitialable {
392
416
  * @returns {CustomData | null} The custom meta data
393
417
  * @example
394
418
  * ```
395
- * univerAPI.getActiveWorkbook()
396
- * .getActiveSheet()
397
- * .getActiveRange()
398
- * .getCustomMetaData()
419
+ * const fWorkbook = univerAPI.getActiveWorkbook();
420
+ * const fWorksheet = fWorkbook.getActiveSheet();
421
+ * const fRange = fWorksheet.getRange('A1:B2');
422
+ * console.log(fRange.getCustomMetaData());
399
423
  * ```
400
424
  */
401
425
  getCustomMetaData(): CustomData | null;
@@ -404,10 +428,10 @@ export declare class FRange extends FBaseInitialable {
404
428
  * @returns {CustomData[][]} A two-dimensional array of custom meta data
405
429
  * @example
406
430
  * ```
407
- * univerAPI.getActiveWorkbook()
408
- * .getActiveSheet()
409
- * .getActiveRange()
410
- * .getCustomMetaDatas()
431
+ * const fWorkbook = univerAPI.getActiveWorkbook();
432
+ * const fWorksheet = fWorkbook.getActiveSheet();
433
+ * const fRange = fWorksheet.getRange('A1:B2');
434
+ * console.log(fRange.getCustomMetaDatas());
411
435
  * ```
412
436
  */
413
437
  getCustomMetaDatas(): Nullable<CustomData>[][];
@@ -419,10 +443,10 @@ export declare class FRange extends FBaseInitialable {
419
443
  * @returns {FRange} This range, for chaining
420
444
  * @example
421
445
  * ```ts
422
- * univerAPI.getActiveWorkbook()
423
- * .getActiveSheet()
424
- * .getActiveRange()
425
- * .setBorder(BorderType.ALL, BorderStyleType.THIN, '#ff0000');
446
+ * const fWorkbook = univerAPI.getActiveWorkbook();
447
+ * const fWorksheet = fWorkbook.getActiveSheet();
448
+ * const fRange = fWorksheet.getRange('A1:B2');
449
+ * fRange.setBorder(univerAPI.Enum.BorderType.ALL, univerAPI.Enum.BorderStyleTypes.THIN, '#ff0000');
426
450
  * ```
427
451
  */
428
452
  setBorder(type: BorderType, style: BorderStyleTypes, color?: string): FRange;
@@ -432,10 +456,10 @@ export declare class FRange extends FBaseInitialable {
432
456
  * @returns {FRange} This range, for chaining
433
457
  * @example
434
458
  * ```ts
435
- * univerAPI.getActiveWorkbook()
436
- * .getActiveSheet()
437
- * .getActiveRange()
438
- * .setBackgroundColor('red')
459
+ * const fWorkbook = univerAPI.getActiveWorkbook();
460
+ * const fWorksheet = fWorkbook.getActiveSheet();
461
+ * const fRange = fWorksheet.getRange('A1:B2');
462
+ * fRange.setBackgroundColor('red');
439
463
  * ```
440
464
  */
441
465
  setBackgroundColor(color: string): FRange;
@@ -445,19 +469,25 @@ export declare class FRange extends FBaseInitialable {
445
469
  * @returns {FRange} This range, for chaining
446
470
  * @example
447
471
  * ```typescript
448
- * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')
472
+ * const fWorkbook = univerAPI.getActiveWorkbook();
473
+ * const fWorksheet = fWorkbook.getActiveSheet();
474
+ * const fRange = fWorksheet.getRange('A1:B2');
475
+ * fRange.setBackground('red');
449
476
  * ```
450
477
  */
451
478
  setBackground(color: string): FRange;
452
479
  /**
453
- * Set new value for current cell, first cell in this range.
480
+ * Sets the value of the range.
454
481
  * @param {CellValue | ICellData} value The value can be a number, string, boolean, or standard cell format. If it begins with `=`, it is interpreted as a formula. The value is tiled to all cells in the range.
455
482
  * @returns {FRange} This range, for chaining
456
483
  * ```ts
457
- * univerAPI.getActiveWorkbook()
458
- * .getActiveSheet()
459
- * .getActiveRange()
460
- * .setValue(1);
484
+ * const fWorkbook = univerAPI.getActiveWorkbook();
485
+ * const fWorksheet = fWorkbook.getActiveSheet();
486
+ * const fRange = fWorksheet.getRange('B2');
487
+ * fRange.setValue(123);
488
+ *
489
+ * // or
490
+ * fRange.setValue({ v: 234, s: { bg: { rgb: '#ff0000' } } });
461
491
  * ```
462
492
  */
463
493
  setValue(value: CellValue | ICellData): FRange;
@@ -466,10 +496,13 @@ export declare class FRange extends FBaseInitialable {
466
496
  * @param {CellValue | ICellData} value The value can be a number, string, boolean, or standard cell format. If it begins with `=`, it is interpreted as a formula. The value is tiled to all cells in the range.
467
497
  * @returns {FRange} This range, for chaining
468
498
  * ```ts
469
- * univerAPI.getActiveWorkbook()
470
- * .getActiveSheet()
471
- * .getActiveRange()
472
- * .setValueForCell(1);
499
+ * const fWorkbook = univerAPI.getActiveWorkbook();
500
+ * const fWorksheet = fWorkbook.getActiveSheet();
501
+ * const fRange = fWorksheet.getRange('A1:B2');
502
+ * fRange.setValueForCell(123);
503
+ *
504
+ * // or
505
+ * fRange.setValueForCell({ v: 234, s: { bg: { rgb: '#ff0000' } } });
473
506
  * ```
474
507
  */
475
508
  setValueForCell(value: CellValue | ICellData): FRange;
@@ -479,10 +512,17 @@ export declare class FRange extends FBaseInitialable {
479
512
  * @returns {FRange} The range
480
513
  * @example
481
514
  * ```
482
- * univerAPI.getActiveWorkbook()
483
- * .getActiveSheet()
484
- * .getActiveRange()
485
- * .setRichTextValueForCell(new RichTextValue().insertText('Hello'));
515
+ * const fWorkbook = univerAPI.getActiveWorkbook();
516
+ * const fWorksheet = fWorkbook.getActiveSheet();
517
+ * const fRange = fWorksheet.getRange('A1:B2');
518
+ * console.log(fRange.getValue(true));
519
+ *
520
+ * // set the first cell value to 123
521
+ * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } })
522
+ * .setStyle(0, 1, { bl: 1, cl: { rgb: '#c81e1e' } })
523
+ * .setStyle(6, 7, { bl: 1, cl: { rgb: '#c81e1e' } });
524
+ * fRange.setRichTextValueForCell(richText);
525
+ * console.log(fRange.getValue(true).toPlainText()); // Hello World
486
526
  * ```
487
527
  */
488
528
  setRichTextValueForCell(value: RichTextValue | IDocumentData): FRange;
@@ -492,11 +532,20 @@ export declare class FRange extends FBaseInitialable {
492
532
  * @returns {FRange} The range
493
533
  * @example
494
534
  * ```ts
495
- * univerAPI
496
- * .getActiveWorkbook()
497
- * .getActiveSheet()
498
- * .getActiveRange()
499
- * .setRichTextValues([[new RichTextValue().insertText('Hello')]]);
535
+ * const fWorkbook = univerAPI.getActiveWorkbook();
536
+ * const fWorksheet = fWorkbook.getActiveSheet();
537
+ * const fRange = fWorksheet.getRange('A1:B2');
538
+ * console.log(fRange.getValue(true));
539
+ *
540
+ * // set the first cell value to 123
541
+ * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } })
542
+ * .setStyle(0, 1, { bl: 1, cl: { rgb: '#c81e1e' } })
543
+ * .setStyle(6, 7, { bl: 1, cl: { rgb: '#c81e1e' } });
544
+ * fRange.setRichTextValues([
545
+ * [richText, richText],
546
+ * [null, null]
547
+ * ]);
548
+ * console.log(fRange.getValue(true).toPlainText()); // Hello World
500
549
  * ```
501
550
  */
502
551
  setRichTextValues(values: (RichTextValue | IDocumentData)[][]): FRange;
@@ -507,10 +556,11 @@ export declare class FRange extends FBaseInitialable {
507
556
  * @returns {FRange} this range, for chaining
508
557
  * @example
509
558
  * ```ts
510
- * univerAPI.getActiveWorkbook()
511
- * .getActiveSheet()
512
- * .getActiveRange()
513
- * .setWrap(true);
559
+ * const fWorkbook = univerAPI.getActiveWorkbook();
560
+ * const fWorksheet = fWorkbook.getActiveSheet();
561
+ * const fRange = fWorksheet.getRange('A1:B2');
562
+ * fRange.setWrap(true);
563
+ * console.log(fRange.getWrap());
514
564
  * ```
515
565
  */
516
566
  setWrap(isWrapEnabled: boolean): FRange;
@@ -520,10 +570,11 @@ export declare class FRange extends FBaseInitialable {
520
570
  * @returns {FRange} this range, for chaining
521
571
  * @example
522
572
  * ```ts
523
- * univerAPI.getActiveWorkbook()
524
- * .getActiveSheet()
525
- * .getActiveRange()
526
- * .setWrapStrategy(WrapStrategy.WRAP);
573
+ * const fWorkbook = univerAPI.getActiveWorkbook();
574
+ * const fWorksheet = fWorkbook.getActiveSheet();
575
+ * const fRange = fWorksheet.getRange('A1:B2');
576
+ * fRange.setWrapStrategy(univerAPI.Enum.WrapStrategy.WRAP);
577
+ * console.log(fRange.getWrapStrategy());
527
578
  * ```
528
579
  */
529
580
  setWrapStrategy(strategy: WrapStrategy): FRange;
@@ -533,10 +584,10 @@ export declare class FRange extends FBaseInitialable {
533
584
  * @returns {FRange} this range, for chaining
534
585
  * @example
535
586
  * ```ts
536
- * univerAPI.getActiveWorkbook()
537
- * .getActiveSheet()
538
- * .getActiveRange()
539
- * .setVerticalAlignment('top');
587
+ * const fWorkbook = univerAPI.getActiveWorkbook();
588
+ * const fWorksheet = fWorkbook.getActiveSheet();
589
+ * const fRange = fWorksheet.getRange('A1:B2');
590
+ * fRange.setVerticalAlignment('top');
540
591
  * ```
541
592
  */
542
593
  setVerticalAlignment(alignment: FVerticalAlignment): FRange;
@@ -546,10 +597,10 @@ export declare class FRange extends FBaseInitialable {
546
597
  * @returns {FRange} this range, for chaining
547
598
  * @example
548
599
  * ```ts
549
- * univerAPI.getActiveWorkbook()
550
- * .getActiveSheet()
551
- * .getActiveRange()
552
- * .setHorizontalAlignment('left');
600
+ * const fWorkbook = univerAPI.getActiveWorkbook();
601
+ * const fWorksheet = fWorkbook.getActiveSheet();
602
+ * const fRange = fWorksheet.getRange('A1:B2');
603
+ * fRange.setHorizontalAlignment('left');
553
604
  * ```
554
605
  */
555
606
  setHorizontalAlignment(alignment: FHorizontalAlignment): FRange;
@@ -559,10 +610,13 @@ export declare class FRange extends FBaseInitialable {
559
610
  * @returns {FRange} This range, for chaining
560
611
  * @example
561
612
  * ```ts
562
- * univerAPI.getActiveWorkbook()
563
- * .getActiveSheet()
564
- * .getActiveRange()
565
- * .setValues([[1, 2], [3, 4]]);
613
+ * const fWorkbook = univerAPI.getActiveWorkbook();
614
+ * const fWorksheet = fWorkbook.getActiveSheet();
615
+ * const fRange = fWorksheet.getRange('A1:B2');
616
+ * fRange.setValues([
617
+ * [1, { v: 2, s: { bg: { rgb: '#ff0000' } } }],
618
+ * [3, 4]
619
+ * ]);
566
620
  * ```
567
621
  */
568
622
  setValues(value: CellValue[][] | IObjectMatrixPrimitiveType<CellValue> | ICellData[][] | IObjectMatrixPrimitiveType<ICellData>): FRange;
@@ -572,10 +626,10 @@ export declare class FRange extends FBaseInitialable {
572
626
  * @returns {FRange} This range, for chaining
573
627
  * @example
574
628
  * ```ts
575
- * univerAPI.getActiveWorkbook()
576
- * .getActiveSheet()
577
- * .getActiveRange()
578
- * .setFontWeight('bold');
629
+ * const fWorkbook = univerAPI.getActiveWorkbook();
630
+ * const fWorksheet = fWorkbook.getActiveSheet();
631
+ * const fRange = fWorksheet.getRange('A1:B2');
632
+ * fRange.setFontWeight('bold');
579
633
  * ```
580
634
  */
581
635
  setFontWeight(fontWeight: FontWeight | null): this;
@@ -585,10 +639,10 @@ export declare class FRange extends FBaseInitialable {
585
639
  * @returns {FRange} This range, for chaining
586
640
  * @example
587
641
  * ```ts
588
- * univerAPI.getActiveWorkbook()
589
- * .getActiveSheet()
590
- * .getActiveRange()
591
- * .setFontStyle('italic');
642
+ * const fWorkbook = univerAPI.getActiveWorkbook();
643
+ * const fWorksheet = fWorkbook.getActiveSheet();
644
+ * const fRange = fWorksheet.getRange('A1:B2');
645
+ * fRange.setFontStyle('italic');
592
646
  * ```
593
647
  */
594
648
  setFontStyle(fontStyle: FontStyle | null): this;
@@ -598,10 +652,10 @@ export declare class FRange extends FBaseInitialable {
598
652
  * @returns {FRange} This range, for chaining
599
653
  * @example
600
654
  * ```ts
601
- * univerAPI.getActiveWorkbook()
602
- * .getActiveSheet()
603
- * .getActiveRange()
604
- * .setFontLine('underline');
655
+ * const fWorkbook = univerAPI.getActiveWorkbook();
656
+ * const fWorksheet = fWorkbook.getActiveSheet();
657
+ * const fRange = fWorksheet.getRange('A1:B2');
658
+ * fRange.setFontLine('underline');
605
659
  * ```
606
660
  */
607
661
  setFontLine(fontLine: FontLine | null): this;
@@ -609,13 +663,6 @@ export declare class FRange extends FBaseInitialable {
609
663
  * Sets the font underline style of the given ITextDecoration
610
664
  * @param {ITextDecoration|null} value The font underline style of the given ITextDecoration; a null value resets the font underline style
611
665
  * @returns {void}
612
- * @example
613
- * ```ts
614
- * univerAPI.getActiveWorkbook()
615
- * .getActiveSheet()
616
- * .getActiveRange()
617
- * .setFontLine('underline');
618
- * ```
619
666
  */
620
667
  private _setFontUnderline;
621
668
  /**
@@ -630,10 +677,10 @@ export declare class FRange extends FBaseInitialable {
630
677
  * @returns {FRange} This range, for chaining
631
678
  * @example
632
679
  * ```ts
633
- * univerAPI.getActiveWorkbook()
634
- * .getActiveSheet()
635
- * .getActiveRange()
636
- * .setFontFamily('Arial');
680
+ * const fWorkbook = univerAPI.getActiveWorkbook();
681
+ * const fWorksheet = fWorkbook.getActiveSheet();
682
+ * const fRange = fWorksheet.getRange('A1:B2');
683
+ * fRange.setFontFamily('Arial');
637
684
  * ```
638
685
  */
639
686
  setFontFamily(fontFamily: string | null): this;
@@ -643,10 +690,10 @@ export declare class FRange extends FBaseInitialable {
643
690
  * @returns {FRange} This range, for chaining
644
691
  * @example
645
692
  * ```ts
646
- * univerAPI.getActiveWorkbook()
647
- * .getActiveSheet()
648
- * .getActiveRange()
649
- * .setFontSize(12);
693
+ * const fWorkbook = univerAPI.getActiveWorkbook();
694
+ * const fWorksheet = fWorkbook.getActiveSheet();
695
+ * const fRange = fWorksheet.getRange('A1:B2');
696
+ * fRange.setFontSize(24);
650
697
  * ```
651
698
  */
652
699
  setFontSize(size: number | null): this;
@@ -656,10 +703,10 @@ export declare class FRange extends FBaseInitialable {
656
703
  * @returns {FRange} This range, for chaining
657
704
  * @example
658
705
  * ```ts
659
- * univerAPI.getActiveWorkbook()
660
- * .getActiveSheet()
661
- * .getActiveRange()
662
- * .setFontColor('#ff0000');
706
+ * const fWorkbook = univerAPI.getActiveWorkbook();
707
+ * const fWorksheet = fWorkbook.getActiveSheet();
708
+ * const fRange = fWorksheet.getRange('A1:B2');
709
+ * fRange.setFontColor('#ff0000');
663
710
  * ```
664
711
  */
665
712
  setFontColor(color: string | null): this;
@@ -669,12 +716,11 @@ export declare class FRange extends FBaseInitialable {
669
716
  * @returns {FRange} This range, for chaining
670
717
  * @example
671
718
  * ```ts
672
- * const workbook = univerAPI.getActiveWorkbook();
673
- * const worksheet = workbook.getActiveSheet();
674
- * const range = worksheet.getRange(0, 0, 2, 2);
675
- * const merge = range.merge();
676
- * const isMerged = merge.isMerged();
677
- * console.log('debugger', isMerged);
719
+ * const fWorkbook = univerAPI.getActiveWorkbook();
720
+ * const fWorksheet = fWorkbook.getActiveSheet();
721
+ * const fRange = fWorksheet.getRange('A1:B2');
722
+ * fRange.merge();
723
+ * console.log(fRange.isMerged());
678
724
  * ```
679
725
  */
680
726
  merge(defaultMerge?: boolean): FRange;
@@ -684,12 +730,16 @@ export declare class FRange extends FBaseInitialable {
684
730
  * @returns {FRange} This range, for chaining
685
731
  * @example
686
732
  * ```ts
687
- * const workbook = univerAPI.getActiveWorkbook();
688
- * const worksheet = workbook.getActiveSheet();
689
- * const range = worksheet.getRange(2, 2, 2, 2);
690
- * const merge = range.mergeAcross();
691
- * const allMerge = worksheet.getMergeData();
692
- * console.log(allMerge.length); // There will be two merged cells.
733
+ * // Assume the active sheet is a new sheet with no merged cells.
734
+ * const fWorkbook = univerAPI.getActiveWorkbook();
735
+ * const fWorksheet = fWorkbook.getActiveSheet();
736
+ * const fRange = fWorksheet.getRange('A1:B2');
737
+ * fRange.mergeAcross();
738
+ * // There will be two merged cells. A1:B1 and A2:B2.
739
+ * const mergeData = fWorksheet.getMergeData();
740
+ * mergeData.forEach((item) => {
741
+ * console.log(item.getA1Notation());
742
+ * });
693
743
  * ```
694
744
  */
695
745
  mergeAcross(defaultMerge?: boolean): FRange;
@@ -699,12 +749,16 @@ export declare class FRange extends FBaseInitialable {
699
749
  * @returns {FRange} This range, for chaining
700
750
  * @example
701
751
  * ```ts
702
- * const workbook = univerAPI.getActiveWorkbook();
703
- * const worksheet = workbook.getActiveSheet();
704
- * const range = worksheet.getRange(4, 4, 2, 2);
705
- * const merge = range.mergeVertically();
706
- * const allMerge = worksheet.getMergeData();
707
- * console.log(allMerge.length); // There will be two merged cells.
752
+ * // Assume the active sheet is a new sheet with no merged cells.
753
+ * const fWorkbook = univerAPI.getActiveWorkbook();
754
+ * const fWorksheet = fWorkbook.getActiveSheet();
755
+ * const fRange = fWorksheet.getRange('A1:B2');
756
+ * fRange.mergeVertically();
757
+ * // There will be two merged cells. A1:A2 and B1:B2.
758
+ * const mergeData = fWorksheet.getMergeData();
759
+ * mergeData.forEach((item) => {
760
+ * console.log(item.getA1Notation());
761
+ * });
708
762
  * ```
709
763
  */
710
764
  mergeVertically(defaultMerge?: boolean): FRange;
@@ -713,13 +767,12 @@ export declare class FRange extends FBaseInitialable {
713
767
  * @returns {boolean} is overlap with a merged cell
714
768
  * @example
715
769
  * ```ts
716
- * const workbook = univerAPI.getActiveWorkbook();
717
- * const worksheet = workbook.getActiveSheet();
718
- * const range = worksheet.getRange(0,0,2,2);
719
- * const merge = range.merge();
720
- * const anchor = worksheet.getRange(0,0);
721
- * const isPartOfMerge = anchor.isPartOfMerge();
722
- * console.log('debugger', isPartOfMerge); // true
770
+ * const fWorkbook = univerAPI.getActiveWorkbook();
771
+ * const fWorksheet = fWorkbook.getActiveSheet();
772
+ * const fRange = fWorksheet.getRange('A1:B2');
773
+ * fRange.merge();
774
+ * const anchor = fWorksheet.getRange('A1');
775
+ * console.log(anchor.isPartOfMerge()); // true
723
776
  * ```
724
777
  */
725
778
  isPartOfMerge(): boolean;
@@ -728,16 +781,14 @@ export declare class FRange extends FBaseInitialable {
728
781
  * @returns {FRange} This range, for chaining
729
782
  * @example
730
783
  * ```ts
731
- * const workbook = univerAPI.getActiveWorkbook();
732
- * const worksheet = workbook.getActiveSheet();
733
- * const range = worksheet.getRange(0,0,2,2);
734
- * const merge = range.merge();
735
- * const anchor = worksheet.getRange(0,0);
736
- * const isPartOfMergeFirst = anchor.isPartOfMerge();
737
- * console.log('debugger' isPartOfMergeFirst) // true
738
- * range.breakApart();
739
- * const isPartOfMergeSecond = anchor.isPartOfMerge();
740
- * console.log('debugger' isPartOfMergeSecond) // false
784
+ * const fWorkbook = univerAPI.getActiveWorkbook();
785
+ * const fWorksheet = fWorkbook.getActiveSheet();
786
+ * const fRange = fWorksheet.getRange('A1:B2');
787
+ * fRange.merge();
788
+ * const anchor = fWorksheet.getRange('A1');
789
+ * console.log(anchor.isPartOfMerge()); // true
790
+ * fRange.breakApart();
791
+ * console.log(anchor.isPartOfMerge()); // false
741
792
  * ```
742
793
  */
743
794
  breakApart(): FRange;
@@ -787,31 +838,83 @@ export declare class FRange extends FBaseInitialable {
787
838
  * If the specified cell is not part of an existing range, then a new range is created with the cell as the active range and the current cell.
788
839
  * @returns {FRange} This range, for chaining.
789
840
  * @description If the range is not a single cell, an error will be thrown.
841
+ * @example
842
+ * ```ts
843
+ * const fWorkbook = univerAPI.getActiveWorkbook();
844
+ * const fWorksheet = fWorkbook.getActiveSheet();
845
+ * const fRange = fWorksheet.getRange('A1:B2');
846
+ * fRange.activate();
847
+ * const cell = fWorksheet.getRange('B2');
848
+ * cell.activateAsCurrentCell(); // the active cell will be B2
849
+ * console.log(fWorksheet.getActiveRange().getA1Notation()); // B2
850
+ * ```
790
851
  */
791
852
  activateAsCurrentCell(): FRange;
792
853
  /**
793
854
  * Splits a column of text into multiple columns based on an auto-detected delimiter.
794
855
  * @param {boolean} [treatMultipleDelimitersAsOne] Whether to treat multiple continuous delimiters as one. The default value is false.
795
856
  * @example
857
+ * ```ts
858
+ * const fWorkbook = univerAPI.getActiveWorkbook();
859
+ * const fWorksheet = fWorkbook.getActiveSheet();
860
+ *
796
861
  * // A1:A3 has following values:
797
- * // A | B | C
798
- * // 1,2,3 | |
862
+ * // A | B | C
863
+ * // 1,2,3 | |
799
864
  * // 4,,5,6 | |
865
+ * const fRange = fWorksheet.getRange('A1:A3');
866
+ * fRange.setValues([
867
+ * ['A', 'B', 'C'],
868
+ * ['1,2,3', null, null],
869
+ * ['4,,5,6', null, null]
870
+ * ]);
871
+ *
800
872
  * // After calling splitTextToColumns(true), the range will be:
801
- * // A | B | C
873
+ * // A | |
802
874
  * // 1 | 2 | 3
803
875
  * // 4 | 5 | 6
876
+ * fRange.splitTextToColumns(true);
877
+ *
804
878
  * // After calling splitTextToColumns(false), the range will be:
805
- * // A | B | C | D
879
+ * // A | | |
806
880
  * // 1 | 2 | 3 |
807
881
  * // 4 | | 5 | 6
882
+ * fRange.splitTextToColumns(false);
883
+ * ```
808
884
  */
809
885
  splitTextToColumns(treatMultipleDelimitersAsOne?: boolean): void;
810
886
  /**
811
887
  * Splits a column of text into multiple columns based on a specified delimiter.
812
888
  * @param {boolean} [treatMultipleDelimitersAsOne] Whether to treat multiple continuous delimiters as one. The default value is false.
813
889
  * @param {SplitDelimiterEnum} [delimiter] The delimiter to use to split the text. The default delimiter is Tab(1)、Comma(2)、Semicolon(4)、Space(8)、Custom(16).A delimiter like 6 (SplitDelimiterEnum.Comma|SplitDelimiterEnum.Semicolon) means using Comma and Semicolon to split the text.
814
- * @returns {void}
890
+ * @example Show how to split text to columns with combined delimiter. The bit operations are used to combine the delimiters.
891
+ * ```ts
892
+ * const fWorkbook = univerAPI.getActiveWorkbook();
893
+ * const fWorksheet = fWorkbook.getActiveSheet();
894
+ *
895
+ * // A1:A3 has following values:
896
+ * // A | B | C
897
+ * // 1;;2;3 | |
898
+ * // 1;,2;3 | |
899
+ * const fRange = fWorksheet.getRange('A1:A3');
900
+ * fRange.setValues([
901
+ * ['A', 'B', 'C'],
902
+ * ['1;;2;3', null, null],
903
+ * ['1;,2;3', null, null]
904
+ * ]);
905
+ *
906
+ * // After calling splitTextToColumns(false, univerAPI.Enum.SplitDelimiterType.Semicolon|univerAPI.Enum.SplitDelimiterType.Comma), the range will be:
907
+ * // A | | |
908
+ * // 1 | | 2 | 3
909
+ * // 1 | | 2 | 3
910
+ * fRange.splitTextToColumns(false, univerAPI.Enum.SplitDelimiterType.Semicolon|univerAPI.Enum.SplitDelimiterType.Comma);
911
+ *
912
+ * // After calling splitTextToColumns(true, univerAPI.Enum.SplitDelimiterType.Semicolon|univerAPI.Enum.SplitDelimiterType.Comma), the range will be:
913
+ * // A | |
914
+ * // 1 | 2 | 3
915
+ * // 1 | 2 | 3
916
+ * fRange.splitTextToColumns(true, univerAPI.Enum.SplitDelimiterType.Semicolon|univerAPI.Enum.SplitDelimiterType.Comma);
917
+ * ```
815
918
  */
816
919
  splitTextToColumns(treatMultipleDelimitersAsOne?: boolean, delimiter?: SplitDelimiterEnum): void;
817
920
  /**
@@ -846,9 +949,9 @@ export declare class FRange extends FBaseInitialable {
846
949
  * const fWorkbook = univerAPI.getActiveWorkbook();
847
950
  * const fWorksheet = fWorkbook.getActiveSheet();
848
951
  * const fRange = fWorksheet.getRange('A1:E20');
952
+ * console.log(fRange.getUsedThemeStyle()); // undefined
849
953
  * fRange.useThemeStyle('default');
850
- * const themeStyle = fRange.getUsedThemeStyle();
851
- * console.log(themeStyle); // 'default'
954
+ * console.log(fRange.getUsedThemeStyle()); // 'default'
852
955
  * ```
853
956
  */
854
957
  getUsedThemeStyle(): string | undefined;