@univerjs/sheets 0.5.2 → 0.5.3-experimental.20250106-e3b7a39

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

@@ -1,4 +1,4 @@
-import { CustomData, ICellData, IDisposable, IFreeze, IObjectArrayPrimitiveType, IStyleData, Nullable, Workbook, Worksheet, FBase, ICommandService, ILogService, Injector, ObjectMatrix } from '@univerjs/core';
+import { CustomData, ICellData, IColumnRange, IDisposable, IFreeze, IObjectArrayPrimitiveType, IRowRange, IStyleData, Nullable, Workbook, Worksheet, FBaseInitialable, ICommandService, ILogService, Injector, ObjectMatrix } from '@univerjs/core';
 import { FDefinedName } from './f-defined-name';
 import { FWorkbook } from './f-workbook';
 import { SheetsSelectionsService } from '@univerjs/sheets';
@@ -11,7 +11,7 @@ interface IFacadeClearOptions {
 /**
  * Represents a worksheet facade api instance. Which provides a set of methods to interact with the worksheet.
  */
-export declare class FWorksheet extends FBase {
+export declare class FWorksheet extends FBaseInitialable {
     protected readonly _fWorkbook: FWorkbook;
     protected readonly _workbook: Workbook;
     protected readonly _worksheet: Worksheet;
@@ -60,30 +60,30 @@ export declare class FWorksheet extends FBase {
     /**
      * Get the default style of the worksheet column
      * @param {number} index The column index
-     * @param  {boolean} [keepRaw] If true, return the raw style data maybe the style name or style data, otherwise return the data from col manager
+     * @param {boolean} [keepRaw] If true, return the raw style data maybe the style name or style data, otherwise return the data from col manager
      * @returns {Nullable<IStyleData> | string} The default style of the worksheet column name or style data
      */
     getColumnDefaultStyle(index: number, keepRaw?: boolean): Nullable<IStyleData> | string;
     /**
      * Set the default style of the worksheet
      * @param {StyleDataInfo} style default style
-     * @returns {Promise<FWorksheet>} This sheet, for chaining.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setDefaultStyle(style: string): Promise<FWorksheet>;
+    setDefaultStyle(style: string): FWorksheet;
     /**
      * Set the default style of the worksheet row
      * @param {number} index The row index
      * @param {string | Nullable<IStyleData>} style The style name or style data
-     * @returns {Promise<FWorksheet>} This sheet, for chaining.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setColumnDefaultStyle(index: number, style: string | Nullable<IStyleData>): Promise<FWorksheet>;
+    setColumnDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet;
     /**
      * Set the default style of the worksheet column
      * @param {number} index The column index
      * @param {string | Nullable<IStyleData>} style The style name or style data
-     * @returns {Promise<FWorksheet>} This sheet, for chaining.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setRowDefaultStyle(index: number, style: string | Nullable<IStyleData>): Promise<FWorksheet>;
+    setRowDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet;
     /**
      * Returns a Range object representing a single cell at the specified row and column.
      * @param row The row index of the cell.
@@ -116,208 +116,209 @@ export declare class FWorksheet extends FBase {
     getRange(a1Notation: string): FRange;
     /**
      * Returns the current number of columns in the sheet, regardless of content.
-     * @return The maximum columns count of the sheet
+     * @returns {number} The maximum columns count of the sheet
      */
     getMaxColumns(): number;
     /**
      * Returns the current number of rows in the sheet, regardless of content.
-     * @return The maximum rows count of the sheet
+     * @returns {number}The maximum rows count of the sheet
      */
     getMaxRows(): number;
     /**
      * Inserts a row after the given row position.
-     * @param afterPosition The row after which the new row should be added, starting at 0 for the first row.
-     * @returns This sheet, for chaining.
+     * @param {number} afterPosition The row after which the new row should be added, starting at 0 for the first row.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    insertRowAfter(afterPosition: number): Promise<FWorksheet>;
+    insertRowAfter(afterPosition: number): FWorksheet;
     /**
      * Inserts a row before the given row position.
-     * @param beforePosition The row before which the new row should be added, starting at 0 for the first row.
-     * @returns This sheet, for chaining.
+     * @param {number} beforePosition The row before which the new row should be added, starting at 0 for the first row.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    insertRowBefore(beforePosition: number): Promise<FWorksheet>;
+    insertRowBefore(beforePosition: number): FWorksheet;
     /**
      * Inserts one or more consecutive blank rows in a sheet starting at the specified location.
      * @param rowIndex The index indicating where to insert a row, starting at 0 for the first row.
      * @param numRows The number of rows to insert.
      * @returns This sheet, for chaining.
      */
-    insertRows(rowIndex: number, numRows?: number): Promise<FWorksheet>;
+    insertRows(rowIndex: number, numRows?: number): FWorksheet;
     /**
      * Inserts a number of rows after the given row position.
      * @param afterPosition The row after which the new rows should be added, starting at 0 for the first row.
      * @param howMany The number of rows to insert.
      * @returns This sheet, for chaining.
      */
-    insertRowsAfter(afterPosition: number, howMany: number): Promise<FWorksheet>;
+    insertRowsAfter(afterPosition: number, howMany: number): FWorksheet;
     /**
      * Inserts a number of rows before the given row position.
      * @param beforePosition The row before which the new rows should be added, starting at 0 for the first row.
      * @param howMany The number of rows to insert.
      * @returns This sheet, for chaining.
      */
-    insertRowsBefore(beforePosition: number, howMany: number): Promise<FWorksheet>;
+    insertRowsBefore(beforePosition: number, howMany: number): FWorksheet;
     /**
      * Deletes the row at the given row position.
      * @param rowPosition The position of the row, starting at 0 for the first row.
      * @returns This sheet, for chaining.
      */
-    deleteRow(rowPosition: number): Promise<FWorksheet>;
+    deleteRow(rowPosition: number): FWorksheet;
     /**
      * Deletes a number of rows starting at the given row position.
      * @param rowPosition The position of the first row to delete, starting at 0 for the first row.
      * @param howMany The number of rows to delete.
      * @returns This sheet, for chaining.
      */
-    deleteRows(rowPosition: number, howMany: number): Promise<FWorksheet>;
+    deleteRows(rowPosition: number, howMany: number): FWorksheet;
     /**
      * Moves the rows selected by the given range to the position indicated by the destinationIndex. The rowSpec itself does not have to exactly represent an entire row or group of rows to move—it selects all rows that the range spans.
      * @param rowSpec A range spanning the rows that should be moved.
      * @param destinationIndex The index that the rows should be moved to. Note that this index is based on the coordinates before the rows are moved. Existing data is shifted down to make room for the moved rows while the source rows are removed from the grid. Therefore, the data may end up at a different index than originally specified. Use 0-index for this method.
      * @returns This sheet, for chaining.
      */
-    moveRows(rowSpec: FRange, destinationIndex: number): Promise<FWorksheet>;
+    moveRows(rowSpec: FRange, destinationIndex: number): FWorksheet;
     /**
      * Hides the rows in the given range.
      * @param row The row range to hide.
      * @returns This sheet, for chaining.
      */
-    hideRow(row: FRange): Promise<FWorksheet>;
+    hideRow(row: FRange): FWorksheet;
     /**
      * Hides one or more consecutive rows starting at the given index. Use 0-index for this method.
-     * @param rowIndex The starting index of the rows to hide.
-     * @param numRows The number of rows to hide.
-     * @returns This sheet, for chaining.
+     * @param {number} rowIndex The starting index of the rows to hide.
+     * @param {number} numRows The number of rows to hide.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    hideRows(rowIndex: number, numRows?: number): Promise<FWorksheet>;
+    hideRows(rowIndex: number, numRows?: number): FWorksheet;
     /**
-     * Unhides the row in the given range.
-     * @param row The range to unhide, if hidden.
-     * @returns This sheet, for chaining.
+     * Make the row in the given range visible.
+     * @param {FRange} row The range to unhide, if hidden.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    unhideRow(row: FRange): Promise<FWorksheet>;
+    unhideRow(row: FRange): FWorksheet;
     /**
-     * Unhides one or more consecutive rows starting at the given index. Use 0-index for this method.
-     * @param rowIndex The starting index of the rows to unhide.
-     * @param numRows The number of rows to unhide.
-     * @returns This sheet, for chaining.
+     * Scrolling sheet to make specific rows visible.
+     * @param {number} rowIndex The starting index of the rows
+     * @param {number} numRows The number of rows
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    showRows(rowIndex: number, numRows?: number): Promise<FWorksheet>;
+    showRows(rowIndex: number, numRows?: number): FWorksheet;
     /**
      * Sets the row height of the given row in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use setRowHeightsForced(startRow, numRows, height).
-     * @param rowPosition The row position to change.
-     * @param height The height in pixels to set it to.
-     * @returns This sheet, for chaining.
+     * @param {number} rowPosition The row position to change.
+     * @param {number} height The height in pixels to set it to.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setRowHeight(rowPosition: number, height: number): Promise<FWorksheet>;
+    setRowHeight(rowPosition: number, height: number): FWorksheet;
     /**
-     * Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use setRowHeightsForced(startRow, numRows, height).
-     * @param startRow The starting row position to change.
-     * @param numRows The number of rows to change.
-     * @param height The height in pixels to set it to.
-     * @returns This sheet, for chaining.
+     * Sets the height of the given rows in pixels.
+     * By default, rows grow to fit cell contents. If you want to force rows to a specified height, use setRowHeightsForced(startRow, numRows, height).
+     * @param {number} startRow The starting row position to change.
+     * @param {number} numRows The number of rows to change.
+     * @param {number} height The height in pixels to set it to.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setRowHeights(startRow: number, numRows: number, height: number): Promise<FWorksheet>;
+    setRowHeights(startRow: number, numRows: number, height: number): FWorksheet;
     /**
      * Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. When you use setRowHeightsForced, rows are forced to the specified height even if the cell contents are taller than the row height.
-     * @param startRow The starting row position to change.
-     * @param numRows The number of rows to change.
-     * @param height The height in pixels to set it to.
-     * @returns This sheet, for chaining.
+     * @param {number} startRow The starting row position to change.
+     * @param {number} numRows The number of rows to change.
+     * @param {number} height The height in pixels to set it to.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setRowHeightsForced(startRow: number, numRows: number, height: number): Promise<FWorksheet>;
+    setRowHeightsForced(startRow: number, numRows: number, height: number): FWorksheet;
     /**
      * Set custom properties for given rows.
      * @param custom The custom properties to set.
      * @returns This sheet, for chaining.
      */
-    setRowCustom(custom: IObjectArrayPrimitiveType<CustomData>): Promise<FWorksheet>;
+    setRowCustom(custom: IObjectArrayPrimitiveType<CustomData>): FWorksheet;
     /**
      * Inserts a column after the given column position.
      * @param afterPosition The column after which the new column should be added, starting at 0 for the first column.
      * @returns This sheet, for chaining.
      */
-    insertColumnAfter(afterPosition: number): Promise<FWorksheet>;
+    insertColumnAfter(afterPosition: number): FWorksheet;
     /**
      * Inserts a column before the given column position.
      * @param beforePosition The column before which the new column should be added, starting at 0 for the first column.
      * @returns This sheet, for chaining.
      */
-    insertColumnBefore(beforePosition: number): Promise<FWorksheet>;
+    insertColumnBefore(beforePosition: number): FWorksheet;
     /**
      * Inserts one or more consecutive blank columns in a sheet starting at the specified location.
      * @param columnIndex The index indicating where to insert a column, starting at 0 for the first column.
      * @param numColumns The number of columns to insert.
      * @returns This sheet, for chaining.
      */
-    insertColumns(columnIndex: number, numColumns?: number): Promise<FWorksheet>;
+    insertColumns(columnIndex: number, numColumns?: number): FWorksheet;
     /**
      * Inserts a given number of columns after the given column position.
      * @param afterPosition The column after which the new column should be added, starting at 0 for the first column.
      * @param howMany The number of columns to insert.
      * @returns This sheet, for chaining.
      */
-    insertColumnsAfter(afterPosition: number, howMany: number): Promise<FWorksheet>;
+    insertColumnsAfter(afterPosition: number, howMany: number): FWorksheet;
     /**
      * Inserts a number of columns before the given column position.
      * @param beforePosition The column before which the new column should be added, starting at 0 for the first column.
      * @param howMany The number of columns to insert.
      * @returns This sheet, for chaining.
      */
-    insertColumnsBefore(beforePosition: number, howMany: number): Promise<FWorksheet>;
+    insertColumnsBefore(beforePosition: number, howMany: number): FWorksheet;
     /**
      * Deletes the column at the given column position.
      * @param columnPosition The position of the column, starting at 0 for the first column.
      * @returns This sheet, for chaining.
      */
-    deleteColumn(columnPosition: number): Promise<FWorksheet>;
+    deleteColumn(columnPosition: number): FWorksheet;
     /**
      * Deletes a number of columns starting at the given column position.
      * @param columnPosition The position of the first column to delete, starting at 0 for the first column.
      * @param howMany The number of columns to delete.
      * @returns This sheet, for chaining.
      */
-    deleteColumns(columnPosition: number, howMany: number): Promise<FWorksheet>;
+    deleteColumns(columnPosition: number, howMany: number): FWorksheet;
     /**
      * Moves the columns selected by the given range to the position indicated by the destinationIndex. The columnSpec itself does not have to exactly represent an entire column or group of columns to move—it selects all columns that the range spans.
      * @param columnSpec A range spanning the columns that should be moved.
      * @param destinationIndex The index that the columns should be moved to. Note that this index is based on the coordinates before the columns are moved. Existing data is shifted right to make room for the moved columns while the source columns are removed from the grid. Therefore, the data may end up at a different index than originally specified. Use 0-index for this method.
      * @returns This sheet, for chaining.
      */
-    moveColumns(columnSpec: FRange, destinationIndex: number): Promise<FWorksheet>;
+    moveColumns(columnSpec: FRange, destinationIndex: number): FWorksheet;
     /**
      * Hides the column or columns in the given range.
      * @param column The column range to hide.
      * @returns This sheet, for chaining.
      */
-    hideColumn(column: FRange): Promise<FWorksheet>;
+    hideColumn(column: FRange): FWorksheet;
     /**
      * Hides one or more consecutive columns starting at the given index. Use 0-index for this method.
      * @param columnIndex The starting index of the columns to hide.
      * @param numColumns The number of columns to hide.
      * @returns This sheet, for chaining.
      */
-    hideColumns(columnIndex: number, numColumns?: number): Promise<FWorksheet>;
+    hideColumns(columnIndex: number, numColumns?: number): FWorksheet;
     /**
-     * Unhides the column in the given range.
+     * Show the column in the given range.
      * @param column The range to unhide, if hidden.
      * @returns This sheet, for chaining.
      */
-    unhideColumn(column: FRange): Promise<FWorksheet>;
+    unhideColumn(column: FRange): FWorksheet;
     /**
-     * Unhides one or more consecutive columns starting at the given index. Use 0-index for this method.
+     * Show one or more consecutive columns starting at the given index. Use 0-index for this method.
      * @param columnIndex The starting index of the columns to unhide.
      * @param numColumns The number of columns to unhide.
      * @returns This sheet, for chaining.
      */
-    showColumns(columnIndex: number, numColumns?: number): Promise<FWorksheet>;
+    showColumns(columnIndex: number, numColumns?: number): FWorksheet;
     /**
      * Sets the width of the given column in pixels.
      * @param columnPosition The position of the given column to set.
      * @param width The width in pixels to set it to.
      * @returns This sheet, for chaining.
      */
-    setColumnWidth(columnPosition: number, width: number): Promise<FWorksheet>;
+    setColumnWidth(columnPosition: number, width: number): FWorksheet;
     /**
      * Sets the width of the given columns in pixels.
      * @param startColumn The starting column position to change.
@@ -325,13 +326,13 @@ export declare class FWorksheet extends FBase {
      * @param width The width in pixels to set it to.
      * @returns This sheet, for chaining.
      */
-    setColumnWidths(startColumn: number, numColumns: number, width: number): Promise<FWorksheet>;
+    setColumnWidths(startColumn: number, numColumns: number, width: number): FWorksheet;
     /**
      * Set custom properties for given columns.
      * @param custom The custom properties to set.
      * @returns This sheet, for chaining.
      */
-    setColumnCustom(custom: IObjectArrayPrimitiveType<CustomData>): Promise<FWorksheet>;
+    setColumnCustom(custom: IObjectArrayPrimitiveType<CustomData>): FWorksheet;
     /**
      * Get all merged cells in the current sheet
      * @returns all merged cells
@@ -351,32 +352,31 @@ export declare class FWorksheet extends FBase {
     getActiveRange(): FRange | null;
     /**
      * Sets the active selection region for this sheet.
-     * @param range The range to set as the active selection.
+     * @param {FRange} range The range to set as the active selection.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setActiveRange(range: FRange): void;
+    setActiveRange(range: FRange): FWorksheet;
     /**
      * Sets the active selection region for this sheet.
      * @param range The range to set as the active selection.
      */
-    setActiveSelection: (range: FRange) => void;
+    setActiveSelection: (range: FRange) => FWorksheet;
     /**
      * Sets the frozen state of the current sheet.
      * @param freeze - the scrolling viewport start range and count of freezed rows and columns.
      * that means if you want to freeze the first 3 rows and 2 columns, you should set freeze as { startRow: 3, startColumn: 2, xSplit: 2, ySplit: 3 }
-     *
      * @deprecated use `setFrozenRows` and `setFrozenColumns` instead.
      * @returns True if the command was successful, false otherwise.
      */
-    setFreeze(freeze: IFreeze): boolean;
+    setFreeze(freeze: IFreeze): FWorksheet;
     /**
      * Cancels the frozen state of the current sheet.
      * @returns True if the command was successful, false otherwise.
      */
-    cancelFreeze(): boolean;
+    cancelFreeze(): FWorksheet;
     /**
      * Get the freeze state of the current sheet.
      * @returns The freeze state of the current sheet.
-     *
      * @deprecated use `getRowFreezeStatus` and `getColumnFreezeStatus` instead.
      */
     getFreeze(): IFreeze;
@@ -385,36 +385,35 @@ export declare class FWorksheet extends FBase {
      * @param columns The number of columns to freeze.
      * To unfreeze all columns, set this value to 0.
      */
-    setFrozenColumns(columns: number): void;
+    setFrozenColumns(columns: number): FWorksheet;
     /**
      * Set freeze column, then the range from startColumn to endColumn will be fixed.
      * e.g. setFrozenColumns(0, 2) will fix the column range from 0 to 2.
      * e.g. setFrozenColumns(2, 3) will fix the column range from 2 to 3, And column from 0 to 1 will be invisible.
-     *
      * @example
-     * ``` ts
+     * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorkSheet = fWorkbook.getActiveSheet();
      * // freeze the first too columns.
      * fWorkSheet.setFrozenColumns(0, 2);
      * ```
-     * @param startColumn
-     * @param endColumn
+     * @param startColumn - The start column of the range to freeze.
+     * @param endColumn - The end column of the range to freeze.
+     * @returns {FWorksheet} This FWorksheet instance.
      */
-    setFrozenColumns(startColumn: number, endColumn: number): void;
+    setFrozenColumns(startColumn: number, endColumn: number): FWorksheet;
     /**
      * Set the number of frozen rows.
      * @param rows The number of rows to freeze.
      * To unfreeze all rows, set this value to 0.
      */
-    setFrozenRows(rows: number): void;
+    setFrozenRows(rows: number): FWorksheet;
     /**
      * Set freeze row, then the range from startRow to endRow will be fixed.
      * e.g. setFrozenRows(0, 2) will fix the row range from 0 to 2.
      * e.g. setFrozenRows(2, 3) will fix the row range from 2 to 3, And row from 0 to 1 will be invisible.
-     * @param startRow
-     * @param endRow
-     *
+     * @param startRow - The start row of the range to freeze.
+     * @param endRow - The end row of the range to freeze.
      * @example
      * ``` ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -423,33 +422,27 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setFrozenRows(0, 2);
      * ```
      */
-    setFrozenRows(startColumn: number, endColumn: number): void;
+    setFrozenRows(startColumn: number, endColumn: number): FWorksheet;
     /**
      * Get the number of frozen columns.
-     * @returns The number of frozen columns.
-     * Returns 0 if no columns are frozen.
+     * @returns The number of frozen columns, returns 0 if no columns are frozen.
      */
     getFrozenColumns(): number;
     /**
      * Get the number of frozen rows.
-     * @returns The number of frozen rows.
-     * Returns 0 if no rows are frozen.
+     * @returns The number of frozen rows. returns 0 if no rows are frozen.
      */
     getFrozenRows(): number;
     /**
      * Get freezed rows.
+     * @returns {IRowRange} The range of the frozen rows.
      */
-    getFrozenRowRange(): {
-        startRow: number;
-        endRow: number;
-    };
+    getFrozenRowRange(): IRowRange;
     /**
      * Get freezed columns
+     * @returns {IColumnRange} The range of the frozen columns.
      */
-    getFrozenColumnRange(): {
-        startColumn: number;
-        endColumn: number;
-    };
+    getFrozenColumnRange(): IColumnRange;
     /**
      * Returns true if the sheet's gridlines are hidden; otherwise returns false. Gridlines are visible by default.
      * @returns {boolean} True if the sheet's gridlines are hidden; otherwise false.
@@ -467,6 +460,7 @@ export declare class FWorksheet extends FBase {
     /**
      * Hides or reveals the sheet gridlines.
      * @param {boolean} hidden If `true`, hide gridlines in this sheet; otherwise show the gridlines.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ``` ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -475,11 +469,11 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setHiddenGridlines(true);
      * ```
      */
-    setHiddenGridlines(hidden: boolean): Promise<boolean>;
+    setHiddenGridlines(hidden: boolean): FWorksheet;
     /**
      * Set the color of the gridlines in the sheet.
      * @param {string|undefined} color The color to set for the gridlines.Undefined or null to reset to the default color.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -488,7 +482,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setGridLinesColor('#ff0000');
      * ```
      */
-    setGridLinesColor(color: string | undefined): Promise<boolean>;
+    setGridLinesColor(color: string | undefined): FWorksheet;
     /**
      * Get the color of the gridlines in the sheet.
      * @returns {string | undefined} The color of the gridlines in the sheet or undefined. The default color is 'rgb(214, 216, 219)'.
@@ -497,7 +491,7 @@ export declare class FWorksheet extends FBase {
     /**
      * Sets the sheet tab color.
      * @param {string|null|undefined} color A color code in CSS notation (like '#ffffff' or 'white'), or null to reset the tab color.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -506,7 +500,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setTabColor('#ff0000');
      * ```
      */
-    setTabColor(color: string): Promise<boolean>;
+    setTabColor(color: string): FWorksheet;
     /**
      * Get the tab color of the sheet.
      * @returns {string} The tab color of the sheet or undefined.
@@ -556,18 +550,19 @@ export declare class FWorksheet extends FBase {
     onBeforeCellDataChange(callback: (cellValue: ObjectMatrix<Nullable<ICellData>>) => void): IDisposable;
     /**
      * Hides this sheet. Has no effect if the sheet is already hidden. If this method is called on the only visible sheet, it throws an exception.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorkSheet = fWorkbook.getActiveSheet();
      * // hide the active sheet
      * fWorkSheet.hideSheet();
-     * ``
+     * ```
      */
-    hideSheet(): void;
+    hideSheet(): FWorksheet;
     /**
      * Shows this sheet. Has no effect if the sheet is already visible.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -576,7 +571,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheets[fWorkSheets.length - 1].showSheet();
      * ```
      */
-    showSheet(): Promise<boolean>;
+    showSheet(): FWorksheet;
     /**
      * Returns true if the sheet is currently hidden.
      * @returns {boolean} True if the sheet is hidden; otherwise, false.
@@ -585,7 +580,7 @@ export declare class FWorksheet extends FBase {
     /**
      * Sets the sheet name.
      * @param {string} name The new name for the sheet.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -594,7 +589,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setName('Sheet1');
      * ```
      */
-    setName(name: string): Promise<boolean>;
+    setName(name: string): FWorksheet;
     /**
      * Activates this sheet. Does not alter the sheet itself, only the parent's notion of the active sheet.
      * @returns Current sheet, for chaining.
@@ -618,7 +613,7 @@ export declare class FWorksheet extends FBase {
      * @param {IFacadeClearOptions} [options] Options for clearing the sheet. If not provided, the contents and formatting are cleared both.
      * @param {boolean} [options.contentsOnly] If true, the contents of the sheet are cleared. If false, the contents and formatting are cleared. Default is false.
      * @param {boolean} [options.formatOnly] If true, the formatting of the sheet is cleared. If false, the contents and formatting are cleared. Default is false.
-     * @returns  {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -629,10 +624,10 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.clear({ contentsOnly: true });
      * ```
      */
-    clear(options?: IFacadeClearOptions): Promise<boolean>;
+    clear(options?: IFacadeClearOptions): FWorksheet;
     /**
      * Clears the sheet of contents, while preserving formatting information.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -641,10 +636,10 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.clearContents();
      * ```
      */
-    clearContents(): Promise<boolean>;
+    clearContents(): FWorksheet;
     /**
      * Clears the sheet of formatting, while preserving contents.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -653,7 +648,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.clearFormats();
      * ```
      */
-    clearFormats(): Promise<boolean>;
+    clearFormats(): FWorksheet;
     /**
      * Returns a Range corresponding to the dimensions in which data is present.
      * This is functionally equivalent to creating a Range bounded by A1 and (Sheet.getLastColumns(), Sheet.getLastRows()).
@@ -682,6 +677,7 @@ export declare class FWorksheet extends FBase {
      */
     getLastColumns(): number;
     /**
+     * @deprecated use getLastColumn instead.
      * Returns the position of the last column that has content. Same as getLastColumns.
      * @returns {number} the last column of the sheet that contains content.
      * @example
@@ -694,6 +690,7 @@ export declare class FWorksheet extends FBase {
      */
     getLastColumn(): number;
     /**
+     * @deprecated use getLastRow instead.
      * Returns the position of the last row that has content.
      * @returns {number} the last row of the sheet that contains content.
      * @example
@@ -743,5 +740,21 @@ export declare class FWorksheet extends FBase {
      * ```
      */
     getDefinedNames(): FDefinedName[];
+    /**
+     * Get all merged cells in the current worksheet
+     * @returns {FRange[]} All the merged cells in the worksheet
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const rangeFirst = worksheet.getRange(0, 0, 2, 2);
+     * const mergeFirst = rangeFirst.merge();
+     * const rangeSecond = worksheet.getRange(5, 0, 2, 2);
+     * const mergeSecond = rangeSecond.merge();
+     * const mergeData = worksheet.getMergeData();
+     * console.log('debugger', mergeData);
+     * ```
+     */
+    getMergeData(): FRange[];
 }
 export {};

package/lib/types/facade/index.d.ts

@@ -14,11 +14,12 @@
  * limitations under the License.
  */
 import './f-univer';
+export * from './f-event';
 export { FPermission } from './f-permission';
 export { FRange } from './f-range';
 export type { FontLine, FontStyle, FontWeight } from './f-range';
 export { FSelection } from './f-selection';
 export { FSheetHooks } from './f-sheet-hooks';
 export { FWorkbook } from './f-workbook';
-export { FWorksheet } from './f-worksheet';
 export type * from './f-univer';
+export { FWorksheet } from './f-worksheet';