@univerjs/sheets 0.6.4 → 0.6.5

package/lib/es/facade.js

@@ -1754,8 +1754,9 @@ let m = class extends le {
    * const fRange = fWorksheet.getRange('A1:B2');
    * console.log(fRange.getValue(true));
    *
-   * // set the first cell value to 123
-   * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } })
+   * // Set A1 cell value to rich text
+   * const richText = univerAPI.newRichText()
+   *   .insertText('Hello World')
    *   .setStyle(0, 1, { bl: 1, cl: { rgb: '#c81e1e' } })
    *   .setStyle(6, 7, { bl: 1, cl: { rgb: '#c81e1e' } });
    * fRange.setRichTextValueForCell(richText);
@@ -1787,8 +1788,9 @@ let m = class extends le {
    * const fRange = fWorksheet.getRange('A1:B2');
    * console.log(fRange.getValue(true));
    *
-   * // set the first cell value to 123
-   * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } })
+   * // Set A1:B2 cell value to rich text
+   * const richText = univerAPI.newRichText()
+   *   .insertText('Hello World')
    *   .setStyle(0, 1, { bl: 1, cl: { rgb: '#c81e1e' } })
    *   .setStyle(6, 7, { bl: 1, cl: { rgb: '#c81e1e' } });
    * fRange.setRichTextValues([
@@ -2334,14 +2336,14 @@ let m = class extends le {
    * const fWorksheet = fWorkbook.getActiveSheet();
    *
    * // A1:A3 has following values:
-   * //     A   | B | C
-   * //  1#2#3  |   |
-   * //  4##5#6 |   |
+   * //     A   |
+   * //  1#2#3  |
+   * //  4##5#6 |
    * const fRange = fWorksheet.getRange('A1:A3');
    * fRange.setValues([
-   *   ['A', 'B', 'C'],
-   *   ['1#2#3', null, null],
-   *   ['4##5#6', null, null]
+   *   ['A'],
+   *   ['1#2#3'],
+   *   ['4##5#6']
    * ]);
    *
    * // After calling splitTextToColumns(false, univerAPI.Enum.SplitDelimiterType.Custom, '#'), the range will be:
@@ -2873,8 +2875,7 @@ let Y = class {
    * const cell = fWorksheet.getRange('B11');
    *
    * let fSelection = fWorksheet.getSelection();
-   * fSelection.updatePrimaryCell(cell);
-   * fSelection = fWorksheet.getSelection();
+   * fSelection = fSelection.updatePrimaryCell(cell);
    *
    * const currentCell = fSelection.getCurrentCell();
    * const { actualRow, actualColumn } = currentCell;
@@ -5084,7 +5085,7 @@ let S = class extends le {
   }
   /**
    * Sets the given worksheet to be the active worksheet in the workbook.
-   * @param {FWorksheet | string} sheet The worksheet to set as the active worksheet.
+   * @param {FWorksheet | string} sheet The instance or id of the worksheet to set as active.
    * @returns {FWorksheet} The active worksheet
    * @example
    * ```ts
@@ -5130,7 +5131,7 @@ let S = class extends le {
   }
   /**
    * Deletes the specified worksheet.
-   * @param {FWorksheet | string} sheet The worksheet to delete.
+   * @param {FWorksheet | string} sheet The instance or id of the worksheet to delete.
    * @returns {boolean} True if the worksheet was deleted, false otherwise.
    * @example
    * ```ts
@@ -5138,6 +5139,9 @@ let S = class extends le {
    * const fWorkbook = univerAPI.getActiveWorkbook();
    * const sheet = fWorkbook.getSheets()[1];
    * fWorkbook.deleteSheet(sheet);
+   *
+   * // The code below deletes the specified worksheet by id
+   * // fWorkbook.deleteSheet(sheet.getSheetId());
    * ```
    */
   deleteSheet(e) {
@@ -5595,7 +5599,6 @@ let S = class extends le {
    * @returns {void}
    * @example
    * ```ts
-   * // import {RangeThemeStyle} from '@univerjs/sheets';
    * const fWorkbook = univerAPI.getActiveWorkbook();
    * const rangeThemeStyle = fWorkbook.createRangeThemeStyle('MyTheme', {
    *   secondRowStyle: {