@univerjs/sheets 0.24.0 → 0.25.0-insiders.20260608-e4336f7

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

@@ -55,7 +55,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {Worksheet} The worksheet instance.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const sheet = fWorksheet.getSheet();
      * console.log(sheet);
      * ```
@@ -66,7 +67,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {Injector} The injector instance.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const injector = fWorksheet.getInject();
      * console.log(injector);
      * ```
@@ -77,7 +79,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {Workbook} The workbook instance.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const workbook = fWorksheet.getWorkbook();
      * console.log(workbook);
      * ```
@@ -88,7 +91,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {string} The id of the worksheet.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const sheetId = fWorksheet.getSheetId();
      * console.log(sheetId);
      * ```
@@ -99,7 +103,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {string} The name of the worksheet.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const sheetName = fWorksheet.getSheetName();
      * console.log(sheetName);
      * ```
@@ -110,7 +115,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FSelection} return the current selections of the worksheet or null if there is no selection.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const selection = fWorksheet.getSelection();
      * console.log(selection);
      * ```
@@ -121,7 +127,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {IStyleData} Default style of the worksheet.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const defaultStyle = fWorksheet.getDefaultStyle();
      * console.log(defaultStyle);
      * ```
@@ -134,7 +141,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {(Nullable<IStyleData> | string)} The default style of the worksheet row name or style data
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get default style for row 0 (1)
      * const rowStyle = fWorksheet.getRowDefaultStyle(0);
      * console.log(rowStyle);
@@ -151,7 +159,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {(Nullable<IStyleData> | string)} The default style of the worksheet column name or style data
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get default style for column 0 (A)
      * const colStyle = fWorksheet.getColumnDefaultStyle(0);
      * console.log(colStyle);
@@ -167,7 +176,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.setDefaultStyle('default');
      * // or
      * // fWorksheet.setDefaultStyle({fs: 12, ff: 'Arial'});
@@ -182,7 +192,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.setColumnDefaultStyle(0, 'default');
      * // or
      * // fWorksheet.setColumnDefaultStyle(0, {fs: 12, ff: 'Arial'});
@@ -197,7 +208,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.setRowDefaultStyle(0, 'default');
      * // or
      * // fWorksheet.setRowDefaultStyle(0, {fs: 12, ff: 'Arial'});
@@ -211,7 +223,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange} A Range object representing the specified cell.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get range for cell at row 0, column 0 (A1)
      * const range = fWorksheet.getRange(0, 0);
      * console.log(range);
@@ -235,7 +248,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange} A Range object representing the specified range.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get range for cells A1:C3
      * const range = fWorksheet.getRange(0, 0, 3, 3);
      * console.log(range);
@@ -248,7 +262,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange} A Range object representing the specified range.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get range for cells A1:C3
      * const range = fWorksheet.getRange("A1:C3");
      * console.log(range);
@@ -273,7 +288,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {number} The maximum columns count of the sheet
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const totalColumns = fWorksheet.getMaxColumns();
      * console.log(`Sheet has ${totalColumns} columns`);
      * ```
@@ -284,7 +300,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {number}The maximum rows count of the sheet
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const totalRows = fWorksheet.getMaxRows();
      * console.log(`Sheet has ${totalRows} rows`);
      * ```
@@ -296,7 +313,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert a row after the third row
      * fWorksheet.insertRowAfter(2);
      * // Insert a row after the first row
@@ -310,7 +328,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert a row before the third row
      * fWorksheet.insertRowBefore(2);
      * // Insert a row before the first row
@@ -325,7 +344,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert 3 rows before the third row
      * fWorksheet.insertRows(2, 3);
      * // Insert 1 row before the first row
@@ -340,7 +360,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert 3 rows after the third row
      * fWorksheet.insertRowsAfter(2, 3);
      * // Insert 1 row after the first row
@@ -355,7 +376,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert 3 rows before the third row
      * fWorksheet.insertRowsBefore(2, 3);
      * // Insert 1 row before the first row
@@ -369,7 +391,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Delete the third row
      * fWorksheet.deleteRow(2);
      * // Delete the first row
@@ -384,7 +407,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Delete 3 rows at row index 2 (rows 3-5)
      * fWorksheet.deleteRows(2, 3);
      * // Delete 1 row at row index 0 (first row)
@@ -398,7 +422,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Delete rows at index 2, and range from index 4 to 6 (rows 3, 5-7)
      * fWorksheet.deleteRowsByPoints([2, [4, 6]]);
      * ```
@@ -411,7 +436,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Move 3 rows at row index 2 (rows 3-5) to row index 0
      * const rowSpec1 = fWorksheet.getRange('3:5');
      * fWorksheet.moveRows(rowSpec1, 0);
@@ -427,7 +453,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Hide 3 rows starting from row index 1 (rows 2-4)
      * const row1 = fWorksheet.getRange('2:4');
      * fWorksheet.hideRow(row1);
@@ -444,7 +471,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Hide 3 rows starting from row index 1 (rows 2-4)
      * fWorksheet.hideRows(1, 3);
      * // Hide single row at index 0 (first row)
@@ -458,7 +486,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining.
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Unhide 3 rows starting from row index 1 (rows 2-4)
      * const row1 = fWorksheet.getRange('2:4');
      * fWorksheet.unhideRow(row1);
@@ -475,7 +504,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Show 3 rows starting from row index 1 (rows 2-4)
      * fWorksheet.showRows(1, 3);
      * // Show single row at index 0 (first row)
@@ -490,7 +520,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Set the height of the second row to 30 pixels
      * fWorksheet.setRowHeight(1, 30);
      * // Set the height of the first row to 20 pixels
@@ -505,7 +536,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.autoFitRow(24);
      * ```
      */
@@ -519,7 +551,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.setRowHeights(1, 10, 30);
      * ```
      */
@@ -531,7 +564,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Set the value of the cell A1 to 'Hello, Univer!', set the font size to 30 and font weight to bold
      * const fRange = fWorksheet.getRange('A1');
@@ -549,7 +583,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.setRowAutoHeight(1, 10);
      * ```
      */
@@ -560,7 +595,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const ranges = [
      * { startRow: 1, endRow: 10, startColumn: 0, endColumn: 10 },
      * { startRow: 11, endRow: 20, startColumn: 0, endColumn: 10 },
@@ -577,7 +613,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.setRowHeightsForced(1, 10, 30);
      * ```
      */
@@ -588,7 +625,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.setRowCustom({ 0: { key: 'value' } });
      * ```
      */
@@ -599,7 +637,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert a column after column C
      * fWorksheet.insertColumnAfter(2);
      * // Insert a column after column A
@@ -613,7 +652,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert a column before column C
      * fWorksheet.insertColumnBefore(2);
      * // Insert a column before column A
@@ -628,7 +668,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert 3 columns before column C
      * fWorksheet.insertColumns(2, 3);
      * // Insert 1 column before column A
@@ -643,7 +684,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert 3 columns after column C
      * fWorksheet.insertColumnsAfter(2, 3);
      * // Insert 1 column after column A
@@ -658,7 +700,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Insert 3 columns before column C
      * fWorksheet.insertColumnsBefore(2, 3);
      * // Insert 1 column before column A
@@ -672,7 +715,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Delete column C
      * fWorksheet.deleteColumn(2);
      * // Delete column A
@@ -687,7 +731,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Delete 3 columns at column index 2 (columns C, D, E)
      * fWorksheet.deleteColumns(2, 3);
      * // Delete 1 column at column index 0 (column A)
@@ -701,7 +746,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Delete columns at index 2, and range from index 4 to 6 (columns C, E-G)
      * fWorksheet.deleteColumnsByPoints([2, [4, 6]]);
      * ```
@@ -714,7 +760,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Move columns C, D, E to column index 2 (columns B, C, D)
      * const columnSpec1 = fWorksheet.getRange('C:E');
      * fWorksheet.moveColumns(columnSpec1, 1);
@@ -730,7 +777,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Hide columns C, D, E
      * const column1 = fWorksheet.getRange('C:E');
      * fWorksheet.hideColumn(column1);
@@ -747,7 +795,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Hide columns C, D, E
      * fWorksheet.hideColumns(2, 3);
      * // Hide column A
@@ -761,7 +810,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Unhide columns C, D, E
      * const column1 = fWorksheet.getRange('C:E');
      * fWorksheet.unhideColumn(column1);
@@ -778,7 +828,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Unhide columns C, D, E
      * fWorksheet.showColumns(2, 3);
      * // Unhide column A
@@ -793,7 +844,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Set width of column B to 100 pixels
      * fWorksheet.setColumnWidth(1, 100);
      * ```
@@ -807,7 +859,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Set width of columns B-D (index 1-3) to 100 pixels
      * fWorksheet.setColumnWidths(1, 3, 100);
      * ```
@@ -820,7 +873,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Set the long text value in cell A1
      * const fRange = fWorksheet.getRange('A1');
@@ -840,7 +894,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.setColumnCustom({ 0: { key: 'value' } });
      * ```
      */
@@ -850,7 +905,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange[]} All the merged cells in the worksheet
      * @example
      * ```ts
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get all merged ranges in the sheet
      * const mergedData = fWorksheet.getMergeData();
      * // Process each merged range
@@ -865,7 +921,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange[]} all merged cells
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get all merged ranges in the sheet
      * const mergedRanges = fWorksheet.getMergedRanges();
      * // Process each merged range
@@ -882,7 +939,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange|undefined} The merged cell data, or undefined if the cell is not merged
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * const merge = fWorkSheet.getCellMergeData(0, 0);
      * if (merge) {
      *   console.log('Merged range:', merge.getA1Notation());
@@ -895,7 +953,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange | null} the active range
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get the currently active range
      * const activeRange = fWorksheet.getActiveRange();
      * if (activeRange) {
@@ -910,7 +969,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This sheet, for chaining
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.setActiveRange(fWorkSheet.getRange('A10:B10'));
      * ```
      */
@@ -920,7 +980,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FRange | null} The active cell
      * @example
      * ```typescript
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * console.log(fWorkSheet.getActiveCell().getA1Notation());
      * ```
      */
@@ -931,7 +992,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns This sheet, for chaining
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.setActiveSelection(fWorkSheet.getRange('A10:B10'));
      * ```
      */
@@ -943,7 +1005,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Freeze first 3 rows and 2 columns
      * fWorksheet.setFreeze({
      *   startRow: 3,
@@ -959,7 +1022,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This worksheet instance for chaining
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Cancel freeze
      * fWorksheet.cancelFreeze();
      * ```
@@ -970,7 +1034,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {IFreeze} The freeze state of the current sheet
      * @example
      * ```typescript
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // Get the freeze state of the current sheet
      * const freeze = fWorksheet.getFreeze();
      * console.log(freeze);
@@ -984,7 +1049,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This FWorksheet instance.
      * @example
      * ```typescript
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // freeze the first 3 columns.
      * fWorkSheet.setFrozenColumns(3);
      * ```
@@ -999,7 +1065,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This FWorksheet instance.
      * @example
      * ```typescript
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // freeze the column B and C, and column A will be invisible.
      * fWorkSheet.setFrozenColumns(1, 2);
      * ```
@@ -1012,7 +1079,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This FWorksheet instance.
      * @example
      * ```typescript
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // freeze the first 3 rows.
      * fWorkSheet.setFrozenRows(3);
      * ```
@@ -1027,7 +1095,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} This FWorksheet instance.
      * @example
      * ```typescript
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // freeze the second and third rows, and the first row will be invisible.
      * fWorkSheet.setFrozenRows(1, 2);
      * ```
@@ -1038,7 +1107,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {number} The number of frozen columns, returns 0 if no columns are frozen.
      * @example
      * ```typescript
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // Get the number of frozen columns
      * const frozenColumns = fWorkSheet.getFrozenColumns();
      * console.log(frozenColumns);
@@ -1050,7 +1120,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {number} The number of frozen rows. returns 0 if no rows are frozen.
      * @example
      * ```typescript
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // Get the number of frozen rows
      * const frozenRows = fWorkSheet.getFrozenRows();
      * console.log(frozenRows);
@@ -1062,7 +1133,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {IRowRange} The range of the frozen rows.
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // Get the range of the frozen rows
      * const frozenRows = fWorkSheet.getFrozenRowRange();
      * console.log(frozenRows);
@@ -1074,7 +1146,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {IColumnRange} The range of the frozen columns.
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // Get the range of the frozen columns
      * const frozenColumns = fWorkSheet.getFrozenColumnRange();
      * console.log(frozenColumns);
@@ -1086,7 +1159,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {boolean} True if the sheet's gridlines are hidden; otherwise false.
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // check if the gridlines are hidden
      * if (fWorkSheet.hasHiddenGridLines()) {
      *    console.log('Gridlines are hidden');
@@ -1100,7 +1174,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ``` ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // hide the gridlines
      * fWorkSheet.setHiddenGridlines(true);
      * ```
@@ -1112,7 +1187,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
-     * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // set the gridlines color to red
      * fWorkSheet.setGridLinesColor('#ff0000');
      * ```
@@ -1124,7 +1200,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // get the gridlines color of the sheet
      * console.log(fWorkSheet.getGridLinesColor());
      * ```
@@ -1137,7 +1214,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // set the tab color to red
      * fWorkSheet.setTabColor('#ff0000');
      * ```
@@ -1150,7 +1228,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // get the tab color of the sheet
      * console.log(fWorkSheet.getTabColor());
      * ```
@@ -1162,7 +1241,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // hide the active sheet
      * fWorkSheet.hideSheet();
      * ```
@@ -1199,7 +1279,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // set the sheet name to 'Sheet1'
      * fWorkSheet.setName('NewSheet1');
      * ```
@@ -1223,7 +1304,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // get the position of the active sheet
      * const position = fWorkSheet.getIndex();
      * console.log(position);
@@ -1239,7 +1321,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // clear the sheet of content and formatting information
      * fWorkSheet.clear();
      * // clear the sheet of content only
@@ -1253,7 +1336,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // clear the sheet of content only
      * fWorkSheet.clearContents();
      * ```
@@ -1265,7 +1349,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // clear the sheet of formatting only
      * fWorkSheet.clearFormats();
      * ```
@@ -1278,7 +1363,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // Assume the sheet is a empty sheet
      * const cellRange = fWorkSheet.getRange('J50');
      * cellRange.setValue('Hello World');
@@ -1292,7 +1378,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // Assume the sheet is a empty sheet
      * const cellRange = fWorkSheet.getRange('J50');
      * cellRange.setValue('Hello World');
@@ -1306,7 +1393,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * // Assume the sheet is a empty sheet
      * const cellRange = fWorkSheet.getRange('J50');
      * cellRange.setValue('Hello World');
@@ -1322,7 +1410,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const sheets = fWorkbook.getSheets();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * console.log(fWorkSheet.equalTo(sheets[0])); // true, if the active sheet is the first sheet.
      * ```
      */
@@ -1334,7 +1423,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * // The code below inserts a defined name
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');
      * ```
      */
@@ -1345,7 +1435,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * // The code below gets all the defined names in the worksheet
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const definedNames = fWorksheet.getDefinedNames();
      * console.log(definedNames, definedNames[0]?.getFormulaOrRefString());
      * ```
@@ -1358,7 +1449,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.setCustomMetadata({ key: 'value' });
      * ```
      */
@@ -1369,7 +1461,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * const custom = fWorkSheet.getCustomMetadata();
      * console.log(custom);
      * ```
@@ -1383,7 +1476,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.setRowCustomMetadata(0, { key: 'value' });
      * ```
      */
@@ -1396,7 +1490,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.setColumnCustomMetadata(0, { key: 'value' });
      * ```
      */
@@ -1408,7 +1503,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * const custom = fWorkSheet.getRowCustomMetadata(0);
      * console.log(custom);
      * ```
@@ -1421,7 +1517,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * const custom = fWorkSheet.getColumnCustomMetadata(0);
      * console.log(custom);
      * ```
@@ -1436,7 +1533,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * // Appends a new row with 4 columns to the bottom of the current
      * // data region in the sheet containing the values in the array.
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      * fWorkSheet.appendRow([1, 'Hello Univer', true, '=A1']);
      * ```
      */
@@ -1448,7 +1546,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      *
      * // Set the number of rows in the worksheet to 40
      * fWorkSheet.setRowCount(40);
@@ -1462,7 +1561,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorkSheet) return;
      *
      * // Set the number of columns in the worksheet to 10
      * fWorkSheet.setColumnCount(10);
@@ -1475,7 +1575,8 @@ export declare class FWorksheet extends FBaseInitialable {
      * @returns {FWorksheetPermission} - The WorksheetPermission instance.
      * @example
      * ```ts
-     * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const permission = fWorksheet.getWorksheetPermission();
      *
      * // Set worksheet to read-only mode