@univerjs/sheets 0.6.4 → 0.6.5

package/lib/types/facade/f-range.d.ts

@@ -752,8 +752,9 @@ export declare class FRange extends FBaseInitialable {
      * 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);
@@ -772,8 +773,9 @@ export declare class FRange extends FBaseInitialable {
      * 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([
@@ -1109,14 +1111,14 @@ export declare class FRange extends FBaseInitialable {
      * 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(true), the range will be:
@@ -1143,14 +1145,14 @@ export declare class FRange extends FBaseInitialable {
      * const fWorksheet = fWorkbook.getActiveSheet();
      *
      * // A1:A3 has following values:
-     * //     A   | B | C
-     * //  1;;2;3 |   |
-     * //  1;,2;3 |   |
+     * //     A   |
+     * //  1;;2;3 |
+     * //  1;,2;3 |
      * const fRange = fWorksheet.getRange('A1:A3');
      * fRange.setValues([
-     *   ['A', 'B', 'C'],
-     *   ['1;;2;3', null, null],
-     *   ['1;,2;3', null, null]
+     *   ['A'],
+     *   ['1;;2;3'],
+     *   ['1;,2;3']
      * ]);
      *
      * // After calling splitTextToColumns(false, univerAPI.Enum.SplitDelimiterType.Semicolon|univerAPI.Enum.SplitDelimiterType.Comma), the range will be:

package/lib/types/facade/f-selection.d.ts

@@ -93,8 +93,7 @@ export declare class FSelection {
      * 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;

package/lib/types/facade/f-workbook.d.ts

@@ -161,7 +161,7 @@ export declare class FWorkbook extends FBaseInitialable {
     getSheetByName(name: string): FWorksheet | null;
     /**
      * 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
@@ -191,7 +191,7 @@ export declare class FWorkbook extends FBaseInitialable {
     insertSheet(sheetName?: string): FWorksheet;
     /**
      * 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
@@ -199,6 +199,9 @@ export declare class FWorkbook extends FBaseInitialable {
      * 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(sheet: FWorksheet | string): boolean;
@@ -551,7 +554,6 @@ export declare class FWorkbook extends FBaseInitialable {
      * @returns {void}
      * @example
      * ```ts
-     * // import {RangeThemeStyle} from '@univerjs/sheets';
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const rangeThemeStyle = fWorkbook.createRangeThemeStyle('MyTheme', {
      *   secondRowStyle: {

package/lib/types/model/range-theme-model.d.ts

@@ -58,7 +58,7 @@ export declare class SheetRangeThemeModel extends Disposable {
     getCellStyle(unitId: string, subUnitId: string, row: number, col: number): Nullable<IRangeThemeStyleItem>;
     private _registerIntercept;
     toJson(unitId: string): string;
-    fromJSON(json: ISheetRangeThemeModelJSON): void;
+    fromJSON(unitId: string, json: ISheetRangeThemeModelJSON): void;
     deleteUnitId(unitId: string): void;
     private _initSnapshot;
     dispose(): void;