@univerjs/sheets 0.6.0 → 0.6.1

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

@@ -33,69 +33,79 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     constructor(_fWorkbook: FWorkbook, _workbook: Workbook, _worksheet: Worksheet, _injector: Injector, _selectionManagerService: SheetsSelectionsService, _logService: ILogService, _commandService: ICommandService);
     /**
-     * Returns the worksheet
+     * Get the worksheet instance.
      * @returns {Worksheet} The worksheet instance.
      * @example
      * ```typescript
-     * const sheet = univerAPI.getActiveWorkbook().getActiveSheet().getSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const sheet = fWorksheet.getSheet();
+     * console.log(sheet);
      * ```
      */
     getSheet(): Worksheet;
     /**
-     * Returns the injector
-     * @returns {Injector} The injector
+     * Get the injector instance.
+     * @returns {Injector} The injector instance.
      * @example
      * ```typescript
-     * const injector = univerAPI.getActiveWorkbook().getActiveSheet().getInject();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const injector = fWorksheet.getInject();
+     * console.log(injector);
      * ```
      */
     getInject(): Injector;
     /**
-     * Returns the workbook
+     * Get the workbook instance.
      * @returns {Workbook} The workbook instance.
      * @example
      * ```typescript
-     * const workbook = univerAPI.getActiveWorkbook().getWorkbook();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const workbook = fWorksheet.getWorkbook();
+     * console.log(workbook);
      * ```
      */
     getWorkbook(): Workbook;
     /**
-     * Returns the worksheet id.
+     * Get the worksheet id.
      * @returns {string} The id of the worksheet.
      * @example
      * ```typescript
-     * const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const id = sheet.getSheetId();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const sheetId = fWorksheet.getSheetId();
+     * console.log(sheetId);
      * ```
      */
     getSheetId(): string;
     /**
-     * Returns the worksheet name.
+     * Get the worksheet name.
      * @returns {string} The name of the worksheet.
      * @example
      * ```typescript
-     * const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const name = sheet.getSheetName();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const sheetName = fWorksheet.getSheetName();
+     * console.log(sheetName);
      * ```
      */
     getSheetName(): string;
     /**
-     * Represents the selection ranges info of the worksheet.
+     * Get the current selection of the worksheet.
      * @returns {FSelection} return the current selections of the worksheet or null if there is no selection.
      * @example
      * ```typescript
-     * const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
-     * const selections = sheet.getSelection();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const selection = fWorksheet.getSelection();
+     * console.log(selection);
      * ```
      */
     getSelection(): FSelection | null;
     /**
-     * Get the default style of the worksheet
+     * Get the default style of the worksheet.
      * @returns {IStyleData} Default style of the worksheet.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * const defaultStyle = sheet.getDefaultStyle();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const defaultStyle = fWorksheet.getDefaultStyle();
+     * console.log(defaultStyle);
      * ```
      */
     getDefaultStyle(): Nullable<IStyleData> | string;
@@ -106,11 +116,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {(Nullable<IStyleData> | string)} The default style of the worksheet row name or style data
      * @example
      * ```typescript
-     * const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get default style for row 0 (1)
-     * const rowStyle = sheet.getRowDefaultStyle(0);
+     * const rowStyle = fWorksheet.getRowDefaultStyle(0);
+     * console.log(rowStyle);
      * // Get raw style data for row 0
-     * const rawRowStyle = sheet.getRowDefaultStyle(0, true);
+     * const rawRowStyle = fWorksheet.getRowDefaultStyle(0, true);
+     * console.log(rawRowStyle);
      * ```
      */
     getRowDefaultStyle(index: number, keepRaw?: boolean): Nullable<IStyleData> | string;
@@ -121,11 +133,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {(Nullable<IStyleData> | string)} The default style of the worksheet column name or style data
      * @example
      * ```typescript
-     * const sheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get default style for column 0 (A)
-     * const colStyle = sheet.getColumnDefaultStyle(0);
+     * const colStyle = fWorksheet.getColumnDefaultStyle(0);
+     * console.log(colStyle);
      * // Get raw style data for column 0
-     * const rawColStyle = sheet.getColumnDefaultStyle(0, true);
+     * const rawColStyle = fWorksheet.getColumnDefaultStyle(0, true);
+     * console.log(rawColStyle);
      * ```
      */
     getColumnDefaultStyle(index: number, keepRaw?: boolean): Nullable<IStyleData> | string;
@@ -135,8 +149,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * fWorksheet.setDefaultStyle('default');
      * // or
      * // fWorksheet.setDefaultStyle({fs: 12, ff: 'Arial'});
@@ -152,9 +165,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
-     * fWorksheet.setRowDefaultStyle(0, 'default');
+     * fWorksheet.setColumnDefaultStyle(0, 'default');
      * // or
-     * // fWorksheet.setRowDefaultStyle(0, {fs: 12, ff: 'Arial'});
+     * // fWorksheet.setColumnDefaultStyle(0, {fs: 12, ff: 'Arial'});
      * ```
      */
     setColumnDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet;
@@ -167,9 +180,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
-     * fWorksheet.setColumnDefaultStyle(0, 'default');
+     * fWorksheet.setRowDefaultStyle(0, 'default');
      * // or
-     * // fWorksheet.setColumnDefaultStyle(0, {fs: 12, ff: 'Arial'});
+     * // fWorksheet.setRowDefaultStyle(0, {fs: 12, ff: 'Arial'});
      * ```
      */
     setRowDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet;
@@ -180,9 +193,10 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange} A Range object representing the specified cell.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get range for cell at row 0, column 0 (A1)
-     * const range = sheet.getRange(0, 0);
+     * const range = fWorksheet.getRange(0, 0);
+     * console.log(range);
      * ```
      */
     getRange(row: number, column: number): FRange;
@@ -201,6 +215,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @param {number} numRows - The number of rows in the range.
      * @param {number} numColumns - The number of columns in the range.
      * @returns {FRange} A Range object representing the specified range.
+     * @example
+     * ```typescript
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Get range for cells A1:C3
+     * const range = fWorksheet.getRange(0, 0, 3, 3);
+     * console.log(range);
+     * ```
      */
     getRange(row: number, column: number, numRows: number, numColumns: number): FRange;
     /**
@@ -209,13 +230,17 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange} A Range object representing the specified range.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get range for cells A1:C3
-     * const range = sheet.getRange("A1:C3");
+     * const range = fWorksheet.getRange("A1:C3");
+     * console.log(range);
      * // Get range for a single cell
-     * const cell = sheet.getRange("B2");
+     * const cell = fWorksheet.getRange("B2");
+     * console.log(cell);
      * // Get range with sheet name
-     * const rangeWithSheet = sheet.getRange("Sheet1!A1:C3");
+     * const sheetName = fWorksheet.getSheetName();
+     * const rangeWithSheet = fWorksheet.getRange(`${sheetName}!A1:C3`);
+     * console.log(rangeWithSheet);
      * ```
      */
     getRange(a1Notation: string): FRange;
@@ -230,8 +255,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {number} The maximum columns count of the sheet
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * const totalColumns = sheet.getMaxColumns();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const totalColumns = fWorksheet.getMaxColumns();
      * console.log(`Sheet has ${totalColumns} columns`);
      * ```
      */
@@ -241,8 +266,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {number}The maximum rows count of the sheet
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * const totalRows = sheet.getMaxRows();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const totalRows = fWorksheet.getMaxRows();
      * console.log(`Sheet has ${totalRows} rows`);
      * ```
      */
@@ -253,11 +278,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 rows at row index 2 (before the third row)
-     * sheet.insertRowAfter(2);
-     * // Insert 1 row at row index 0 (before the first row)
-     * sheet.insertRowAfter(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert a row after the third row
+     * fWorksheet.insertRowAfter(2);
+     * // Insert a row after the first row
+     * fWorksheet.insertRowAfter(0);
      * ```
      */
     insertRowAfter(afterPosition: number): FWorksheet;
@@ -267,11 +292,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 rows at row index 2 (before the third row)
-     * sheet.insertRowBefore(2);
-     * // Insert 1 row at row index 0 (before the first row)
-     * sheet.insertRowBefore(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert a row before the third row
+     * fWorksheet.insertRowBefore(2);
+     * // Insert a row before the first row
+     * fWorksheet.insertRowBefore(0);
      * ```
      */
     insertRowBefore(beforePosition: number): FWorksheet;
@@ -282,11 +307,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 rows at row index 2 (before the third row)
-     * sheet.insertRows(2, 3);
-     * // Insert 1 row at row index 0 (before the first row)
-     * sheet.insertRows(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert 3 rows before the third row
+     * fWorksheet.insertRows(2, 3);
+     * // Insert 1 row before the first row
+     * fWorksheet.insertRows(0);
      * ```
      */
     insertRows(rowIndex: number, numRows?: number): FWorksheet;
@@ -297,11 +322,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 rows at row index 2 (before the third row)
-     * sheet.insertRowsAfter(2, 3);
-     * // Insert 1 row at row index 0 (before the first row)
-     * sheet.insertRowsAfter(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert 3 rows after the third row
+     * fWorksheet.insertRowsAfter(2, 3);
+     * // Insert 1 row after the first row
+     * fWorksheet.insertRowsAfter(0, 1);
      * ```
      */
     insertRowsAfter(afterPosition: number, howMany: number): FWorksheet;
@@ -312,11 +337,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 rows at row index 2 (before the third row)
-     * sheet.insertRowsBefore(2, 3);
-     * // Insert 1 row at row index 0 (before the first row)
-     * sheet.insertRowsBefore(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert 3 rows before the third row
+     * fWorksheet.insertRowsBefore(2, 3);
+     * // Insert 1 row before the first row
+     * fWorksheet.insertRowsBefore(0, 1);
      * ```
      */
     insertRowsBefore(beforePosition: number, howMany: number): FWorksheet;
@@ -326,11 +351,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Delete 3 rows at row index 2 (rows 3-5)
-     * sheet.deleteRow(2);
-     * // Delete 1 row at row index 0 (first row)
-     * sheet.deleteRow(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Delete the third row
+     * fWorksheet.deleteRow(2);
+     * // Delete the first row
+     * fWorksheet.deleteRow(0);
      * ```
      */
     deleteRow(rowPosition: number): FWorksheet;
@@ -341,11 +366,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Delete 3 rows at row index 2 (rows 3-5)
-     * sheet.deleteRows(2, 3);
+     * fWorksheet.deleteRows(2, 3);
      * // Delete 1 row at row index 0 (first row)
-     * sheet.deleteRows(0);
+     * fWorksheet.deleteRows(0, 1);
      * ```
      */
     deleteRows(rowPosition: number, howMany: number): FWorksheet;
@@ -356,11 +381,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Move 3 rows at row index 2 (rows 3-5) to row index 0
-     * sheet.moveRows(rowSpec, 0);
+     * const rowSpec1 = fWorksheet.getRange('3:5');
+     * fWorksheet.moveRows(rowSpec1, 0);
      * // Move 1 row at row index 0 (first row) to row index 2
-     * sheet.moveRows(rowSpec, 2);
+     * const rowSpec2 = fWorksheet.getRange('1:1');
+     * fWorksheet.moveRows(rowSpec2, 2);
      * ```
      */
     moveRows(rowSpec: FRange, destinationIndex: number): FWorksheet;
@@ -370,11 +397,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Hide 3 rows starting from row index 1 (rows 2-4)
-     * sheet.hideRow(1);
+     * const row1 = fWorksheet.getRange('2:4');
+     * fWorksheet.hideRow(row1);
      * // Hide single row at index 0 (first row)
-     * sheet.hideRow(0);
+     * const row2 = fWorksheet.getRange('1:1');
+     * fWorksheet.hideRow(row2);
      * ```
      */
     hideRow(row: FRange): FWorksheet;
@@ -385,11 +414,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Hide 3 rows starting from row index 1 (rows 2-4)
-     * sheet.hideRows(1, 3);
+     * fWorksheet.hideRows(1, 3);
      * // Hide single row at index 0 (first row)
-     * sheet.hideRows(0);
+     * fWorksheet.hideRows(0);
      * ```
      */
     hideRows(rowIndex: number, numRow?: number): FWorksheet;
@@ -399,11 +428,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Unhide 3 rows starting from row index 1 (rows 2-4)
-     * sheet.unhideRow(1);
+     * const row1 = fWorksheet.getRange('2:4');
+     * fWorksheet.unhideRow(row1);
      * // Unhide single row at index 0 (first row)
-     * sheet.unhideRow(0);
+     * const row2 = fWorksheet.getRange('1:1');
+     * fWorksheet.unhideRow(row2);
      * ```
      */
     unhideRow(row: FRange): FWorksheet;
@@ -414,11 +445,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Show 3 rows starting from row index 1 (rows 2-4)
-     * sheet.showRows(1);
+     * fWorksheet.showRows(1, 3);
      * // Show single row at index 0 (first row)
-     * sheet.showRows(0);
+     * fWorksheet.showRows(0);
      * ```
      */
     showRows(rowIndex: number, numRow?: number): FWorksheet;
@@ -429,24 +460,23 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Set the height of the second row to 30 pixels
-     * sheet.setRowHeight(1, 30);
+     * fWorksheet.setRowHeight(1, 30);
      * // Set the height of the first row to 20 pixels
-     * sheet.setRowHeight(0, 20);
+     * fWorksheet.setRowHeight(0, 20);
      * ```
      */
     setRowHeight(rowPosition: number, height: number): FWorksheet;
     /**
      * Make certain row wrap and auto height.
-     * @param rowPosition
-     * @param auto
-     * @returns {FWorksheet} this
+     * @param {number} rowPosition - The row position to change.
+     * @param {BooleanNumber} auto - Whether to auto fit the row height.
+     * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```ts
-     const fWorkbook = univerAPI.getActiveWorkbook();
-     const fWorkSheet = fWorkbook.getActiveSheet();
-     fWorkSheet.autoFitRow(24);
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * fWorkSheet.autoFitRow(24);
      * ```
      */
     autoFitRow(rowPosition: number, auto?: BooleanNumber): FWorksheet;
@@ -459,8 +489,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * sheet.setRowHeights(1, 10, 30);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * fWorksheet.setRowHeights(1, 10, 30);
      * ```
      */
     setRowHeights(startRow: number, numRows: number, height: number): FWorksheet;
@@ -471,8 +501,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * sheet.setRowAutoHeight(1, 10);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * fWorksheet.setRowAutoHeight(1, 10);
      * ```
      */
     setRowAutoHeight(startRow: number, numRows: number): FWorksheet;
@@ -484,8 +514,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * sheet.setRowHeightsForced(1, 10, 30);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * fWorksheet.setRowHeightsForced(1, 10, 30);
      * ```
      */
     setRowHeightsForced(startRow: number, numRows: number, height: number): FWorksheet;
@@ -495,9 +525,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
-     * fWorkSheet.setRowCustom({ key: 'value' });
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * fWorkSheet.setRowCustom({ 0: { key: 'value' } });
      * ```
      */
     setRowCustom(custom: IObjectArrayPrimitiveType<CustomData>): FWorksheet;
@@ -507,11 +536,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 columns at column index 2 (before column C)
-     * sheet.insertColumnAfter(2);
-     * // Insert 1 column at column index 0 (before column A)
-     * sheet.insertColumnAfter(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert a column after column C
+     * fWorksheet.insertColumnAfter(2);
+     * // Insert a column after column A
+     * fWorksheet.insertColumnAfter(0);
      * ```
      */
     insertColumnAfter(afterPosition: number): FWorksheet;
@@ -521,11 +550,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 columns at column index 2 (before column C)
-     * sheet.insertColumnBefore(2);
-     * // Insert 1 column at column index 0 (before column A)
-     * sheet.insertColumnBefore(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert a column before column C
+     * fWorksheet.insertColumnBefore(2);
+     * // Insert a column before column A
+     * fWorksheet.insertColumnBefore(0);
      * ```
      */
     insertColumnBefore(beforePosition: number): FWorksheet;
@@ -536,11 +565,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 columns at column index 2 (before column C)
-     * sheet.insertColumns(2, 3);
-     * // Insert 1 column at column index 0 (before column A)
-     * sheet.insertColumns(0);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert 3 columns before column C
+     * fWorksheet.insertColumns(2, 3);
+     * // Insert 1 column before column A
+     * fWorksheet.insertColumns(0);
      * ```
      */
     insertColumns(columnIndex: number, numColumns?: number): FWorksheet;
@@ -551,11 +580,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 columns at column index 2 (before column C)
-     * sheet.insertColumnsAfter(2, 3);
-     * // Insert 1 column at column index 0 (before column A)
-     * sheet.insertColumnsAfter(0, 1);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert 3 columns after column C
+     * fWorksheet.insertColumnsAfter(2, 3);
+     * // Insert 1 column after column A
+     * fWorksheet.insertColumnsAfter(0, 1);
      * ```
      */
     insertColumnsAfter(afterPosition: number, howMany: number): FWorksheet;
@@ -566,11 +595,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
-     * // Insert 3 columns at column index 2 (before column C)
-     * sheet.insertColumnsBefore(2, 3);
-     * // Insert 1 column at column index 0 (before column A)
-     * sheet.insertColumnsBefore(0, 1);
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Insert 3 columns before column C
+     * fWorksheet.insertColumnsBefore(2, 3);
+     * // Insert 1 column before column A
+     * fWorksheet.insertColumnsBefore(0, 1);
      * ```
      */
     insertColumnsBefore(beforePosition: number, howMany: number): FWorksheet;
@@ -580,11 +609,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Delete column C
-     * sheet.deleteColumn(2);
+     * fWorksheet.deleteColumn(2);
      * // Delete column A
-     * sheet.deleteColumn(0);
+     * fWorksheet.deleteColumn(0);
      * ```
      */
     deleteColumn(columnPosition: number): FWorksheet;
@@ -595,11 +624,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Delete 3 columns at column index 2 (columns C, D, E)
-     * sheet.deleteColumns(2, 3);
+     * fWorksheet.deleteColumns(2, 3);
      * // Delete 1 column at column index 0 (column A)
-     * sheet.deleteColumns(0, 1);
+     * fWorksheet.deleteColumns(0, 1);
      * ```
      */
     deleteColumns(columnPosition: number, howMany: number): FWorksheet;
@@ -610,11 +639,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Move columns C, D, E to column index 2 (columns B, C, D)
-     * sheet.moveColumns({ startColumn: 2, endColumn: 4 }, 1);
-     * // Move column A to column index 0 (column A)
-     * sheet.moveColumns({ startColumn: 0, endColumn: 0 }, 0);
+     * const columnSpec1 = fWorksheet.getRange('C:E');
+     * fWorksheet.moveColumns(columnSpec1, 1);
+     * // Move column F to column index 0 (column A)
+     * const columnSpec2 = fWorksheet.getRange('F:F');
+     * fWorksheet.moveColumns(columnSpec2, 0);
      * ```
      */
     moveColumns(columnSpec: FRange, destinationIndex: number): FWorksheet;
@@ -624,11 +655,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Hide columns C, D, E
-     * sheet.hideColumn({ startColumn: 2, endColumn: 4 });
+     * const column1 = fWorksheet.getRange('C:E');
+     * fWorksheet.hideColumn(column1);
      * // Hide column A
-     * sheet.hideColumn({ startColumn: 0, endColumn: 0 });
+     * const column2 = fWorksheet.getRange('A:A');
+     * fWorksheet.hideColumn(column2);
      * ```
      */
     hideColumn(column: FRange): FWorksheet;
@@ -639,11 +672,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Hide columns C, D, E
-     * sheet.hideColumns(2, 3);
+     * fWorksheet.hideColumns(2, 3);
      * // Hide column A
-     * sheet.hideColumns(0, 1);
+     * fWorksheet.hideColumns(0, 1);
      * ```
      */
     hideColumns(columnIndex: number, numColumn?: number): FWorksheet;
@@ -653,11 +686,13 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Unhide columns C, D, E
-     * sheet.unhideColumn({ startColumn: 2, endColumn: 4 });
+     * const column1 = fWorksheet.getRange('C:E');
+     * fWorksheet.unhideColumn(column1);
      * // Unhide column A
-     * sheet.unhideColumn({ startColumn: 0, endColumn: 0 });
+     * const column2 = fWorksheet.getRange('A:A');
+     * fWorksheet.unhideColumn(column2);
      * ```
      */
     unhideColumn(column: FRange): FWorksheet;
@@ -668,11 +703,11 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Unhide columns C, D, E
-     * sheet.unhideColumns(2, 3);
+     * fWorksheet.showColumns(2, 3);
      * // Unhide column A
-     * sheet.unhideColumns(0, 1);
+     * fWorksheet.showColumns(0, 1);
      * ```
      */
     showColumns(columnIndex: number, numColumn?: number): FWorksheet;
@@ -683,9 +718,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Set width of column B to 100 pixels
-     * sheet.setColumnWidth(1, 100);
+     * fWorksheet.setColumnWidth(1, 100);
      * ```
      */
     setColumnWidth(columnPosition: number, width: number): FWorksheet;
@@ -697,9 +732,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Set width of columns B-D (index 1-3) to 100 pixels
-     * sheet.setColumnWidths(1, 3, 100);
+     * fWorksheet.setColumnWidths(1, 3, 100);
      * ```
      */
     setColumnWidths(startColumn: number, numColumn: number, width: number): FWorksheet;
@@ -709,20 +744,34 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * fWorkSheet.setColumnCustom({ 0: { key: 'value' } });
      * ```
      */
     setColumnCustom(custom: IObjectArrayPrimitiveType<CustomData>): FWorksheet;
+    /**
+     * Get all merged cells in the current worksheet
+     * @returns {FRange[]} All the merged cells in the worksheet
+     * @example
+     * ```ts
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // Get all merged ranges in the sheet
+     * const mergedData = fWorksheet.getMergeData();
+     * // Process each merged range
+     * mergedData.forEach(range => {
+     *   console.log(range.getA1Notation());
+     * });
+     * ```
+     */
+    getMergeData(): FRange[];
     /**
      * Get all merged cells in the current sheet
      * @returns {FRange[]} all merged cells
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get all merged ranges in the sheet
-     * const mergedRanges = sheet.getMergedRanges();
+     * const mergedRanges = fWorksheet.getMergedRanges();
      * // Process each merged range
      * mergedRanges.forEach(range => {
      *   console.log(range.getA1Notation());
@@ -737,8 +786,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange|undefined} The merged cell data, or undefined if the cell is not merged
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * const merge = fWorkSheet.getCellMergeData(0, 0);
      * if (merge) {
      *   console.log('Merged range:', merge.getA1Notation());
@@ -751,9 +799,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange | null} the active range
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get the currently active range
-     * const activeRange = sheet.getActiveRange();
+     * const activeRange = fWorksheet.getActiveRange();
      * if (activeRange) {
      *   console.log('Active range:', activeRange.getA1Notation());
      * }
@@ -766,9 +814,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
-     * fWorkSheet.setActiveRange(fWorkSheet.getRange('A1'));
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * fWorkSheet.setActiveRange(fWorkSheet.getRange('A10:B10'));
      * ```
      */
     setActiveRange(range: FRange): FWorksheet;
@@ -778,9 +825,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns This sheet, for chaining
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
-     * fWorkSheet.setActiveRange(fWorkSheet.getRange('A1'));
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * fWorkSheet.setActiveSelection(fWorkSheet.getRange('A10:B10'));
      * ```
      */
     setActiveSelection: (range: FRange) => FWorksheet;
@@ -792,9 +838,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Freeze first 3 rows and 2 columns
-     * sheet.setFreeze({
+     * fWorksheet.setFreeze({
      *   startRow: 3,
      *   startColumn: 2,
      *   xSplit: 2,
@@ -808,9 +854,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Cancel freeze
-     * sheet.cancelFreeze();
+     * fWorksheet.cancelFreeze();
      * ```
      */
     cancelFreeze(): FWorksheet;
@@ -819,9 +865,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {IFreeze} The freeze state of the current sheet
      * @example
      * ```typescript
-     * const sheet = workbook.getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get the freeze state of the current sheet
-     * const freeze = sheet.getFreeze();
+     * const freeze = fWorksheet.getFreeze();
      * console.log(freeze);
      * ```
      */
@@ -833,8 +879,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This FWorksheet instance.
      * @example
      * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // freeze the first 3 columns.
      * fWorkSheet.setFrozenColumns(3);
      * ```
@@ -849,10 +894,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This FWorksheet instance.
      * @example
      * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
-     * // freeze the first too columns.
-     * fWorkSheet.setFrozenColumns(0, 2);
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // freeze the column B and C, and column A will be invisible.
+     * fWorkSheet.setFrozenColumns(1, 2);
      * ```
      */
     setFrozenColumns(startColumn: number, endColumn: number): FWorksheet;
@@ -863,8 +907,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This FWorksheet instance.
      * @example
      * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // freeze the first 3 rows.
      * fWorkSheet.setFrozenRows(3);
      * ```
@@ -879,10 +922,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This FWorksheet instance.
      * @example
      * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
-     * // freeze the first too rows.
-     * fWorkSheet.setFrozenRows(0, 2);
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * // freeze the second and third rows, and the first row will be invisible.
+     * fWorkSheet.setFrozenRows(1, 2);
      * ```
      */
     setFrozenRows(startRow: number, endRow: number): FWorksheet;
@@ -891,8 +933,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {number} The number of frozen columns, returns 0 if no columns are frozen.
      * @example
      * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get the number of frozen columns
      * const frozenColumns = fWorkSheet.getFrozenColumns();
      * console.log(frozenColumns);
@@ -904,8 +945,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {number} The number of frozen rows. returns 0 if no rows are frozen.
      * @example
      * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get the number of frozen rows
      * const frozenRows = fWorkSheet.getFrozenRows();
      * console.log(frozenRows);
@@ -917,8 +957,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {IRowRange} The range of the frozen rows.
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get the range of the frozen rows
      * const frozenRows = fWorkSheet.getFrozenRowRange();
      * console.log(frozenRows);
@@ -930,8 +969,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {IColumnRange} The range of the frozen columns.
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // Get the range of the frozen columns
      * const frozenColumns = fWorkSheet.getFrozenColumnRange();
      * console.log(frozenColumns);
@@ -943,8 +981,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {boolean} True if the sheet's gridlines are hidden; otherwise false.
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // check if the gridlines are hidden
      * if (fWorkSheet.hasHiddenGridLines()) {
      *    console.log('Gridlines are hidden');
@@ -958,8 +995,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ``` ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // hide the gridlines
      * fWorkSheet.setHiddenGridlines(true);
      * ```
@@ -971,8 +1007,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
      * // set the gridlines color to red
      * fWorkSheet.setGridLinesColor('#ff0000');
      * ```
@@ -1017,11 +1052,11 @@ export declare class FWorksheet extends FBaseInitialable {
      */
     getTabColor(): string | undefined;
     /**
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.SheetValueChanged, callback)` instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.SheetValueChanged, (params) => {})` instead
      */
     onCellDataChange(callback: (cellValue: ObjectMatrix<Nullable<ICellData>>) => void): IDisposable;
     /**
-     * @deprecated use `univerAPI.addEvent(univerAPI.Event.SheetValueChanged, callback)` instead
+     * @deprecated use `univerAPI.addEvent(univerAPI.Event.SheetValueChanged, (params) => {})` instead
      */
     onBeforeCellDataChange(callback: (cellValue: ObjectMatrix<Nullable<ICellData>>) => void): IDisposable;
     /**
@@ -1051,6 +1086,13 @@ export declare class FWorksheet extends FBaseInitialable {
     /**
      * Returns true if the sheet is currently hidden.
      * @returns {boolean} True if the sheet is hidden; otherwise, false.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorkSheets = fWorkbook.getSheets();
+     * // check if the last sheet is hidden
+     * console.log(fWorkSheets[fWorkSheets.length - 1].isSheetHidden());
+     * ```
      */
     isSheetHidden(): boolean;
     /**
@@ -1062,13 +1104,20 @@ export declare class FWorksheet extends FBaseInitialable {
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorkSheet = fWorkbook.getActiveSheet();
      * // set the sheet name to 'Sheet1'
-     * fWorkSheet.setName('Sheet1');
+     * fWorkSheet.setName('NewSheet1');
      * ```
      */
     setName(name: string): FWorksheet;
     /**
      * Activates this sheet. Does not alter the sheet itself, only the parent's notion of the active sheet.
      * @returns {FWorksheet} Current sheet, for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorkSheets = fWorkbook.getSheets();
+     * // activate the last sheet
+     * fWorkSheets[fWorkSheets.length - 1].activate();
+     * ```
      */
     activate(): FWorksheet;
     /**
@@ -1080,7 +1129,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * const fWorkSheet = fWorkbook.getActiveSheet();
      * // get the position of the active sheet
      * const position = fWorkSheet.getIndex();
-     * console.log(position); // 0
+     * console.log(position);
      * ```
      */
     getIndex(): number;
@@ -1133,61 +1182,51 @@ export declare class FWorksheet extends FBaseInitialable {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorkSheet = fWorkbook.getActiveSheet();
-     * // the sheet is a empty sheet
-     * const cellRange = fWorkSheet.getRange(200, 10, 1, 1);
+     * // Assume the sheet is a empty sheet
+     * const cellRange = fWorkSheet.getRange('J50');
      * cellRange.setValue('Hello World');
-     * console.log(fWorkSheet.getDataRange().getA1Notation()); // A1:J200
+     * console.log(fWorkSheet.getDataRange().getA1Notation()); // A1:J50
      * ```
      */
     getDataRange(): FRange;
     /**
-     * Returns the position of the last column that has content.
-     * @returns {number} the last column of the sheet that contains content.
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
-     * const fRange = fWorkSheet.getRange(100, 20, 1, 1);
-     * console.log(fWorkSheet.getLastColumns()); // 20
-     * ```
+     * @deprecated use `getLastColumn` instead.
+     * Returns the column index of the last column that contains content.
+     * @returns {number} the column index of the last column that contains content.
      */
     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.
+     * Returns the column index of the last column that contains content.
+     * @returns {number} the column index of the last column that contains content.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorkSheet = fWorkbook.getActiveSheet();
-     * const fRange = fWorkSheet.getRange(100, 20, 1, 1);
-     * console.log(fWorkSheet.getLastColumn());
+     * // Assume the sheet is a empty sheet
+     * const cellRange = fWorkSheet.getRange('J50');
+     * cellRange.setValue('Hello World');
+     * console.log(fWorkSheet.getLastColumn()); // 9
      * ```
      */
     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
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
-     * const fRange = fWorkSheet.getRange(100,1,1,1);
-     * fRange.setValue('Hello World');
-     * console.log(fWorkSheet.getLastRows()); // 100
+     * @deprecated use `getLastRow` instead.
+     * Returns the row index of the last row that contains content.
+     * @returns {number} the row index of the last row that contains content.
      */
     getLastRows(): number;
     /**
-     * Returns the position of the last row that has content, same as getLastRows().
-     * @returns {number} the last row of the sheet that contains content.
+     * Returns the row index of the last row that contains content.
+     * @returns {number} the row index of the last row that contains content.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorkSheet = fWorkbook.getActiveSheet();
-     * const fRange = fWorkSheet.getRange(100,1,1,1);
-     * fRange.setValue('Hello World');
-     * console.log(fWorkSheet.getLastRow());
+     * // Assume the sheet is a empty sheet
+     * const cellRange = fWorkSheet.getRange('J50');
+     * cellRange.setValue('Hello World');
+     * console.log(fWorkSheet.getLastRow()); // 49
+     * ```
      */
     getLastRow(): number;
     /**
@@ -1197,12 +1236,23 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const sheets = fWorkbook.getSheets();
      * const fWorkSheet = fWorkbook.getActiveSheet();
-     * const fWorkSheet2 = fWorkbook.getSheetByName('Sheet1');
-     * console.log(fWorkSheet.equals(fWorkSheet2)); // true, if the active sheet is 'Sheet1'
+     * console.log(fWorkSheet.equalTo(sheets[0])); // true, if the active sheet is the first sheet.
      * ```
      */
     equalTo(other: FWorksheet): boolean;
+    /**
+     * Insert a defined name for worksheet.
+     * @param {string} name - The name of the defined name to insert
+     * @param {string} formulaOrRefString - The formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert
+     * @example
+     * ```ts
+     * // The code below inserts a defined name
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * fWorksheet.insertDefinedName('MyDefinedName', 'Sheet1!A1');
+     * ```
+     */
     insertDefinedName(name: string, formulaOrRefString: string): void;
     /**
      * Get all the defined names in the worksheet.
@@ -1210,16 +1260,16 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * // The code below gets all the defined names in the worksheet
-     * const activeSpreadsheet = univerAPI.getActiveWorkbook();
-     * const sheet1 = activeSpreadsheet.getSheetByName('Sheet1');
-     * const definedNames = sheet1.getDefinedNames();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const definedNames = fWorksheet.getDefinedNames();
+     * console.log(definedNames);
      * ```
      */
     getDefinedNames(): FDefinedName[];
     /**
      * Set custom metadata of worksheet
      * @param {CustomData | undefined} custom - custom metadata
-     * @returns {FWorksheet}
+     * @returns {FWorksheet} Current worksheet, for chaining.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -1263,6 +1313,7 @@ export declare class FWorksheet extends FBaseInitialable {
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorkSheet = fWorkbook.getActiveSheet();
      * const custom = fWorkSheet.getRowCustomMetadata(0);
+     * console.log(custom);
      * ```
      */
     getRowCustomMetadata(index: number): CustomData | undefined;
@@ -1275,24 +1326,9 @@ export declare class FWorksheet extends FBaseInitialable {
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorkSheet = fWorkbook.getActiveSheet();
      * const custom = fWorkSheet.getColumnCustomMetadata(0);
+     * console.log(custom);
      * ```
      */
     getColumnCustomMetadata(index: number): CustomData | undefined;
-    /**
-     * 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 {};