@univerjs/sheets 0.24.0 → 0.25.0

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

@@ -24,7 +24,8 @@ import { FWorksheet } from './f-worksheet';
  * @example
  * ```ts
  * const fWorkbook = univerAPI.getActiveWorkbook()
- * const fWorksheet = fWorkbook.getActiveSheet()
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1')
+ * if (!fWorksheet) return;
  * const fSelection = fWorksheet.getSelection();
  * const activeRange = fSelection.getActiveRange();
  * console.log(activeRange);
@@ -43,7 +44,8 @@ export declare class FSelection {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A10:B11');
      * fRange.activate();
      * const fSelection = fWorksheet.getSelection();
@@ -57,7 +59,8 @@ export declare class FSelection {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fSelection = fWorksheet.getSelection();
      * const activeRangeList = fSelection.getActiveRangeList();
      * activeRangeList.forEach((range) => {
@@ -72,7 +75,8 @@ export declare class FSelection {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A10:B11');
      * fRange.activate();
      * const fSelection = fWorksheet.getSelection();
@@ -89,10 +93,11 @@ export declare class FSelection {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fSelection = fWorksheet.getSelection();
      * const activeSheet = fSelection.getActiveSheet();
-     * console.log(activeSheet.equalTo(fWorksheet)); // true
+     * console.log(activeSheet.equalTo(fWorksheet));
      * ```
      */
     getActiveSheet(): FWorksheet;
@@ -103,7 +108,8 @@ export declare class FSelection {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A10:B11');
      * fRange.activate();
      * const cell = fWorksheet.getRange('B11');
@@ -127,7 +133,8 @@ export declare class FSelection {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * // make sure the active cell is A1 and selection is A1:B2
      * const fRange = fWorksheet.getRange('A1:B2');
      * fRange.activate();

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

@@ -122,6 +122,7 @@ export declare class FWorkbook extends FBaseInitialable {
      * // The code below gets the active sheet of the workbook
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const fWorksheet = fWorkbook.getActiveSheet();
+     * if (!fWorksheet) return;
      * console.log(fWorksheet);
      * ```
      */
@@ -374,7 +375,9 @@ export declare class FWorkbook extends FBaseInitialable {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const range = fWorkbook.getActiveSheet().getRange('A10:B10');
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
+     * const range = fWorksheet.getRange('A10:B10');
      * fWorkbook.setActiveRange(range);
      * ```
      */
@@ -418,7 +421,8 @@ export declare class FWorkbook extends FBaseInitialable {
      * ```ts
      * // The code below duplicates the given worksheet
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const activeSheet = fWorkbook.getActiveSheet();
+     * const activeSheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!activeSheet) return;
      * const duplicatedSheet = fWorkbook.duplicateSheet(activeSheet);
      * console.log(duplicatedSheet);
      * ```
@@ -496,7 +500,8 @@ export declare class FWorkbook extends FBaseInitialable {
      * ```ts
      * // The code below moves the sheet to the specified index
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const sheet = fWorkbook.getActiveSheet();
+     * const sheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!sheet) return;
      * fWorkbook.moveSheet(sheet, 1);
      * ```
      */
@@ -750,7 +755,8 @@ export declare class FWorkbook extends FBaseInitialable {
      * fWorkbook.addStyles(styles);
      *
      * // Set values with the new styles
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A1:B2');
      * fRange.setValues([
      *   [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
@@ -783,7 +789,8 @@ export declare class FWorkbook extends FBaseInitialable {
      * fWorkbook.addStyles(styles);
      *
      * // Set values with the new styles
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A1:B2');
      * fRange.setValues([
      *   [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],