Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

chore: update facade examples to use Sheet1 lookup (#6972)

wpxp123456b93e1685e4b3
diff --git a/packages/core/src/facade/f-univer.ts b/packages/core/src/facade/f-univer.ts
index c3dbed102f..c5b81a5d5e 100644
--- a/packages/core/src/facade/f-univer.ts
+++ b/packages/core/src/facade/f-univer.ts
@@ -530,7 +530,9 @@ export class FUniver extends Disposable {
* @example
* ```ts
* const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
- * const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
+ * const range = fWorksheet.getRange('A1');
* range.setRichTextValueForCell(richText);
* ```
*/
@@ -545,7 +547,9 @@ export class FUniver extends Disposable {
* @example
* ```ts
* const richTextValue = univerAPI.newRichTextValue({ body: { dataStream: 'Hello World\r\n' } });
- * const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
+ * const range = fWorksheet.getRange('A1');
* range.setRichTextValueForCell(richTextValue);
* ```
*/
@@ -562,7 +566,9 @@ export class FUniver extends Disposable {
* const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
* const paragraphStyle = univerAPI.newParagraphStyle({ textStyle: { ff: 'Arial', fs: 12, it: univerAPI.Enum.BooleanNumber.TRUE, bl: univerAPI.Enum.BooleanNumber.TRUE } });
* richText.insertParagraph(paragraphStyle);
- * const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
+ * const range = fWorksheet.getRange('A1');
* range.setRichTextValueForCell(richText);
* ```
*/
diff --git a/packages/sheets-conditional-formatting/src/facade/f-conditional-formatting-builder.ts b/packages/sheets-conditional-formatting/src/facade/f-conditional-formatting-builder.ts
index 7f6f86bd1f..94778ba1f5 100644
--- a/packages/sheets-conditional-formatting/src/facade/f-conditional-formatting-builder.ts
+++ b/packages/sheets-conditional-formatting/src/facade/f-conditional-formatting-builder.ts
@@ -122,7 +122,8 @@ class ConditionalFormatRuleBaseBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -159,7 +160,8 @@ class ConditionalFormatRuleBaseBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -216,7 +218,8 @@ class ConditionalFormatRuleBaseBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -249,7 +252,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -282,7 +286,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with greater than average values in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -308,7 +313,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with unique values in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -333,7 +339,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with duplicate values in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -362,7 +369,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights the bottom 10% of values in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -391,7 +399,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -423,7 +432,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that bolds the text for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -451,7 +461,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that changes the font color to red for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -483,7 +494,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that italicizes the text for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -510,7 +522,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that set text strikethrough for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -537,7 +550,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that underlines the text for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -563,7 +577,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -590,7 +605,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that changes the font color to red for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -618,7 +634,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with dates in the last 7 days in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -645,7 +662,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -673,7 +691,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values between 10 and 20 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -703,7 +722,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values equal to 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -731,7 +751,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -759,7 +780,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values greater than or equal to 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -787,7 +809,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values less than 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -815,7 +838,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values less than or equal to 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -844,7 +868,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values not between 10 and 20 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -874,7 +899,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values not equal to 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -902,7 +928,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text containing 'apple' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -930,7 +957,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text not containing 'apple' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -958,7 +986,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text ending with '.ai' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -986,7 +1015,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text equal to 'apple' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1014,7 +1044,8 @@ class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBui
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text starting with 'https://' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1043,7 +1074,8 @@ class ConditionalFormatDataBarRuleBuilder extends ConditionalFormatRuleBaseBuild
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that adds a data bar to cells with values between -100 and 100 in the range A1:D10.
* // positive values are green and negative values are red.
@@ -1094,7 +1126,8 @@ class ConditionalFormatDataBarRuleBuilder extends ConditionalFormatRuleBaseBuild
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that adds a data bar to cells with values between -100 and 100 in the range A1:D10.
* // positive values are green and negative values are red.
@@ -1141,7 +1174,8 @@ class ConditionalFormatColorScaleRuleBuilder extends ConditionalFormatRuleBaseBu
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that adds a color scale to cells with values between 0 and 100 in the range A1:D10.
* // The color scale is green for 0, yellow for 50, and red for 100.
@@ -1180,7 +1214,8 @@ class ConditionalFormatColorScaleRuleBuilder extends ConditionalFormatRuleBaseBu
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that adds a color scale to cells with values between 0 and 100 in the range A1:D10.
* // The color scale is green for 0, yellow for 50, and red for 100.
@@ -1211,7 +1246,8 @@ class ConditionalFormatIconSetRuleBuilder extends ConditionalFormatRuleBaseBuild
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a 3-arrow icon set conditional formatting rule in the range A1:D10.
* // The first arrow is green for values greater than 20.
@@ -1278,7 +1314,8 @@ class ConditionalFormatIconSetRuleBuilder extends ConditionalFormatRuleBaseBuild
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a 3-arrow icon set conditional formatting rule in the range A1:D10.
* // The first arrow is green for values greater than 20.
@@ -1347,7 +1384,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1370,7 +1408,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with greater than average values in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1392,7 +1431,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with unique values in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1414,7 +1454,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with duplicate values in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1440,7 +1481,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights the bottom 10% of values in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1462,7 +1504,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* console.log(fWorksheet.newConditionalFormattingRule().getIconMap()); // icons key-value map
* ```
*/
@@ -1479,7 +1522,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a 3-arrow icon set conditional formatting rule in the range A1:D10.
* // The first arrow is green for values greater than 20.
@@ -1539,7 +1583,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that adds a color scale to cells with values between 0 and 100 in the range A1:D10.
* // The color scale is green for 0, yellow for 50, and red for 100.
@@ -1579,7 +1624,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that adds a data bar to cells with values between -100 and 100 in the range A1:D10.
* // positive values are green and negative values are red.
@@ -1615,7 +1661,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1638,7 +1685,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that bolds the text for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1661,7 +1709,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that changes the font color to red for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1684,7 +1733,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that italicizes the text for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1707,7 +1757,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that set text strikethrough for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1730,7 +1781,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that underlines the text for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1752,7 +1804,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1774,7 +1827,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that changes the font color to red for cells with not empty content in the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1797,7 +1851,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with dates in the last 7 days in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1820,7 +1875,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1844,7 +1900,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values between 10 and 20 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1867,7 +1924,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values equal to 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1890,7 +1948,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1913,7 +1972,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values greater than or equal to 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1936,7 +1996,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values less than 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1959,7 +2020,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values less than or equal to 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -1983,7 +2045,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values not between 10 and 20 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -2006,7 +2069,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with values not equal to 10 in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -2029,7 +2093,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text containing 'apple' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -2052,7 +2117,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text not containing 'apple' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -2075,7 +2141,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text ending with '.ai' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -2098,7 +2165,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text equal to 'apple' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
@@ -2121,7 +2189,8 @@ export class FConditionalFormattingBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that highlights cells with text starting with 'https://' in red for the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
diff --git a/packages/sheets-conditional-formatting/src/facade/f-range.ts b/packages/sheets-conditional-formatting/src/facade/f-range.ts
index 94ea7fe34a..e2acba3272 100644
--- a/packages/sheets-conditional-formatting/src/facade/f-range.ts
+++ b/packages/sheets-conditional-formatting/src/facade/f-range.ts
@@ -46,7 +46,8 @@ export interface IFRangeSheetsConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that sets the cell format to italic, red background, and green font color when the cell is not empty.
* const fRange = fWorksheet.getRange('A1:T100');
@@ -73,7 +74,8 @@ export interface IFRangeSheetsConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that sets the cell format to italic, red background, and green font color when the cell is not empty.
* const fRange = fWorksheet.getRange('A1:T100');
@@ -135,7 +137,8 @@ export interface IFRangeSheetsConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:T100');
*
* // Clear all conditional format rules for the range
diff --git a/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts b/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
index 5d06cbaef6..493fcead90 100644
--- a/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
+++ b/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
@@ -45,7 +45,8 @@ export interface IFWorksheetConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getConditionalFormattingRules();
* console.log(rules);
* ```
@@ -67,7 +68,8 @@ export interface IFWorksheetConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that sets the cell format to italic, red background, and green font color when the cell is not empty.
* const fRange = fWorksheet.getRange('A1:T100');
@@ -91,7 +93,8 @@ export interface IFWorksheetConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that sets the cell format to italic, red background, and green font color when the cell is not empty.
* const fRange = fWorksheet.getRange('A1:T100');
@@ -115,7 +118,8 @@ export interface IFWorksheetConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getConditionalFormattingRules();
*
* // Delete the first rule
@@ -134,7 +138,8 @@ export interface IFWorksheetConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getConditionalFormattingRules();
*
* // Move the third rule before the first rule
@@ -154,7 +159,8 @@ export interface IFWorksheetConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a conditional formatting rule that sets the cell format to italic, red background, and green font color when the cell is not empty.
* const fRange = fWorksheet.getRange('A1:T100');
@@ -182,7 +188,8 @@ export interface IFWorksheetConditionalFormattingMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* fWorksheet.clearConditionalFormatRules();
* console.log(fWorksheet.getConditionalFormattingRules()); // []
* ```
diff --git a/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts b/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
index dcdcb3ee4b..69b0d5ead2 100644
--- a/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
+++ b/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
@@ -27,7 +27,8 @@ import { FDataValidation } from './f-data-validation';
* ```typescript
* // Set the data validation for cell A1 to require a value from B1:B10
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('B1:B2');
* fRange.setValues([
* ['Yes'],
@@ -64,7 +65,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number between 1 and 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -89,7 +91,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number between 1 and 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -188,7 +191,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the data validation for cell A1:A10 to require a checkbox with default 1 and 0 values
* const fRange = fWorksheet.getRange('A1:A10');
@@ -220,7 +224,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some date values in the range A1:B2
* const fRange = fWorksheet.getRange('A1:B2');
@@ -255,7 +260,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some date values in the range A1:B2
* const fRange = fWorksheet.getRange('A1:B2');
@@ -292,7 +298,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some date values in the range A1:B2
* const fRange = fWorksheet.getRange('A1:B2');
@@ -328,7 +335,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some date values in the range A1:B2
* const fRange = fWorksheet.getRange('A1:B2');
@@ -369,7 +377,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some date values in the range A1:B2
* const fRange = fWorksheet.getRange('A1:B2');
@@ -405,7 +414,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some date values in the range A1:B2
* const fRange = fWorksheet.getRange('A1:B2');
@@ -441,7 +451,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some date values in the range A1:B2
* const fRange = fWorksheet.getRange('A1:B2');
@@ -477,7 +488,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some values in the range A1:B2 and C1:D2
* const cell = fWorksheet.getRange('A1:B2');
@@ -522,7 +534,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number between 1 and 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -554,7 +567,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number equal to 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -585,7 +599,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number greater than 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -616,7 +631,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number greater than 10 or equal to 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -647,7 +663,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number less than 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -678,7 +695,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number less than 10 or equal to 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -710,7 +728,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number not between 1 and 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -742,7 +761,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number not equal to 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -775,7 +795,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires the user to enter a value from the list ['Yes', 'No'] for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -809,7 +830,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the values in the range B1:B2
* const fRange = fWorksheet.getRange('B1:B2');
@@ -853,7 +875,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the data validation for cell A1:B2 to allow invalid data, so A1:B2 will display a warning when invalid data is entered
* const fRange = fWorksheet.getRange('A1:B2');
@@ -885,7 +908,8 @@ export class FDataValidationBuilder {
* ```typescript
* // Assume current sheet is empty data
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the data validation for cell A1:B2 to allow blank values
* const fRange = fWorksheet.getRange('A1:B2');
@@ -916,7 +940,8 @@ export class FDataValidationBuilder {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires the user to enter a value from the list ['Yes', 'No'] for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
diff --git a/packages/sheets-data-validation/src/facade/f-data-validation.ts b/packages/sheets-data-validation/src/facade/f-data-validation.ts
index a437d864bb..757de14c1c 100644
--- a/packages/sheets-data-validation/src/facade/f-data-validation.ts
+++ b/packages/sheets-data-validation/src/facade/f-data-validation.ts
@@ -42,7 +42,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getDataValidations();
* rules.forEach((rule) => {
* console.log(rule, rule.getAllowInvalid());
@@ -59,7 +60,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getDataValidations();
* rules.forEach((rule) => {
* console.log(rule, rule.getCriteriaType());
@@ -76,7 +78,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getDataValidations();
* rules.forEach((rule) => {
* console.log(rule);
@@ -96,7 +99,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B10');
* const rule = univerAPI.newDataValidation()
* .requireNumberBetween(1, 10)
@@ -120,7 +124,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B10');
* const rule = univerAPI.newDataValidation()
* .requireNumberBetween(1, 10)
@@ -152,7 +157,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getDataValidations();
* rules.forEach((rule) => {
* console.log(rule, rule.getApplied());
@@ -182,7 +188,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getDataValidations();
* rules.forEach((rule) => {
* console.log(rule);
@@ -208,7 +215,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B10');
* console.log(fRange.getDataValidation().getUnitId());
* ```
@@ -223,7 +231,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B10');
* console.log(fRange.getDataValidation().getSheetId());
* ```
@@ -241,7 +250,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number equal to 20 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -294,7 +304,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number equal to 20 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -340,7 +351,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number equal to 20 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -379,7 +391,8 @@ export class FDataValidation {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number equal to 20 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
diff --git a/packages/sheets-data-validation/src/facade/f-range.ts b/packages/sheets-data-validation/src/facade/f-range.ts
index c4c256d94b..b48cde5159 100644
--- a/packages/sheets-data-validation/src/facade/f-range.ts
+++ b/packages/sheets-data-validation/src/facade/f-range.ts
@@ -33,7 +33,8 @@ export interface IFRangeSheetsDataValidationMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a data validation rule that requires a number between 1 and 10 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -56,7 +57,8 @@ export interface IFRangeSheetsDataValidationMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a data validation rule that requires a number equal to 20 for the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -84,7 +86,8 @@ export interface IFRangeSheetsDataValidationMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a data validation rule that requires a number equal to 20 for the range A1:B10
* const fRange1 = fWorksheet.getRange('A1:B10');
@@ -114,7 +117,8 @@ export interface IFRangeSheetsDataValidationMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some values in the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
@@ -153,7 +157,8 @@ export interface IFRangeSheetsDataValidationMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B10');
* const errors = await fRange.getDataValidationErrorAsync();
*
diff --git a/packages/sheets-data-validation/src/facade/f-univer.ts b/packages/sheets-data-validation/src/facade/f-univer.ts
index 5bf69dc4ba..94eb69b322 100644
--- a/packages/sheets-data-validation/src/facade/f-univer.ts
+++ b/packages/sheets-data-validation/src/facade/f-univer.ts
@@ -57,7 +57,8 @@ export interface IFUniverSheetsDataValidationMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new data validation rule that requires a number between 1 and 10 fot the range A1:B10
* const fRange = fWorksheet.getRange('A1:B10');
diff --git a/packages/sheets-data-validation/src/facade/f-worksheet.ts b/packages/sheets-data-validation/src/facade/f-worksheet.ts
index dce0ca78cc..fe49abf4da 100644
--- a/packages/sheets-data-validation/src/facade/f-worksheet.ts
+++ b/packages/sheets-data-validation/src/facade/f-worksheet.ts
@@ -31,7 +31,8 @@ export interface IFWorksheetDataValidationMixin {
* @returns {FDataValidation[]} All data validation rules
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getDataValidations();
* console.log(rules);
* ```
@@ -43,7 +44,8 @@ export interface IFWorksheetDataValidationMixin {
* @returns {Promise<ObjectMatrix<Nullable<DataValidationStatus>>>} matrix of validator status
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const status = await fWorksheet.getValidatorStatusAsync();
* console.log(status);
* ```
@@ -56,7 +58,8 @@ export interface IFWorksheetDataValidationMixin {
* @returns {Nullable<FDataValidation>} data validation rule
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = fWorksheet.getDataValidations();
* console.log(fWorksheet.getDataValidation(rules[0]?.rule.uid));
* ```
@@ -69,7 +72,8 @@ export interface IFWorksheetDataValidationMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const errors = await fWorksheet.getAllDataValidationError();
* console.log(errors);
* ```
diff --git a/packages/sheets-drawing-ui/src/facade/f-range.ts b/packages/sheets-drawing-ui/src/facade/f-range.ts
index 3f93e621d2..96df56621a 100644
--- a/packages/sheets-drawing-ui/src/facade/f-range.ts
+++ b/packages/sheets-drawing-ui/src/facade/f-range.ts
@@ -44,7 +44,8 @@ export interface IFRangeSheetsDrawingUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert an image into the cell A10
* const fRange = fWorksheet.getRange('A10');
@@ -63,7 +64,8 @@ export interface IFRangeSheetsDrawingUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Save all cell images in range A1:D10
* const fRange = fWorksheet.getRange('A1:D10');
diff --git a/packages/sheets-drawing-ui/src/facade/f-worksheet.ts b/packages/sheets-drawing-ui/src/facade/f-worksheet.ts
index 45b8000dea..a4cfd09837 100644
--- a/packages/sheets-drawing-ui/src/facade/f-worksheet.ts
+++ b/packages/sheets-drawing-ui/src/facade/f-worksheet.ts
@@ -47,7 +47,8 @@ export interface IFWorksheetDrawingUIMixin {
* @returns {IFCanvasFloatDomResult | null} float dom info or null if not found
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const floatDom = fWorksheet.getFloatDomById('myFloatDomId');
* if (floatDom) {
* console.log('Float dom position:', floatDom.position);
@@ -63,7 +64,8 @@ export interface IFWorksheetDrawingUIMixin {
* @returns {IFCanvasFloatDomResult[]} array of float dom info
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const allFloatDoms = fWorksheet.getAllFloatDoms();
* allFloatDoms.forEach(floatDom => {
* console.log('Float dom ID:', floatDom.id);
@@ -80,7 +82,8 @@ export interface IFWorksheetDrawingUIMixin {
* @returns {FWorksheet} The worksheet instance for chaining
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const firstFloatDom = fWorksheet.getAllFloatDoms()[0];
*
* if (!firstFloatDom) return;
@@ -118,7 +121,8 @@ export interface IFWorksheetDrawingUIMixin {
* @returns {FWorksheet} The worksheet instance for chaining
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Update multiple float doms at once
* const allFloatDoms = fWorksheet.getAllFloatDoms();
@@ -158,7 +162,8 @@ export interface IFWorksheetDrawingUIMixin {
* @returns {FWorksheet} The worksheet instance for chaining
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const firstFloatDom = fWorksheet.getAllFloatDoms()[0];
*
* if (!firstFloatDom) return;
@@ -176,7 +181,8 @@ export interface IFWorksheetDrawingUIMixin {
* @returns float dom id and dispose function
* @example
* ```tsx
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // You should register components at an appropriate time (e.g., when Univer is loaded)
* // This is a React component. For Vue3 components, the third parameter should be `{ framework: 'vue3' }`
@@ -229,7 +235,8 @@ export interface IFWorksheetDrawingUIMixin {
* @returns float dom id and dispose function
* @example
* ```tsx
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Register a range loading component
* const RangeLoading = () => {
@@ -324,7 +331,8 @@ export interface IFWorksheetDrawingUIMixin {
* @returns float dom id and dispose function
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Register a float button component
* const FloatButton = () => {
@@ -392,7 +400,8 @@ export interface IFWorksheetDrawingUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Save cell images from multiple ranges
* const range1 = fWorksheet.getRange('A1:B10');
diff --git a/packages/sheets-drawing/src/facade/f-over-grid-image.ts b/packages/sheets-drawing/src/facade/f-over-grid-image.ts
index f091fea0d9..93388af853 100644
--- a/packages/sheets-drawing/src/facade/f-over-grid-image.ts
+++ b/packages/sheets-drawing/src/facade/f-over-grid-image.ts
@@ -161,7 +161,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set initial image configuration.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setImage({
* drawingId: '123456',
@@ -231,7 +232,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -255,7 +257,8 @@ export class FOverGridImageBuilder {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const images = fWorksheet.getImages();
* images.forEach((image) => {
* console.log(image, image.toBuilder().getSource());
@@ -272,7 +275,8 @@ export class FOverGridImageBuilder {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const images = fWorksheet.getImages();
* images.forEach((image) => {
* console.log(image, image.toBuilder().getSourceType());
@@ -292,7 +296,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -315,7 +320,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -338,7 +344,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell and horizontal offset is 10px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -362,7 +369,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell and vertical offset is 10px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -386,7 +394,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, width is 120px and height is 50px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -411,7 +420,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, width is 120px and height is 50px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -434,7 +444,8 @@ export class FOverGridImageBuilder {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // image1 position is start from A6 cell, anchor type is Position.
* // Only the position of the drawing follows the cell changes. When rows or columns are inserted or deleted, the position of the drawing changes, but the size remains the same.
@@ -487,7 +498,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, top crop is 10px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -512,7 +524,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, left crop is 10px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -537,7 +550,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, bottom crop is 10px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -562,7 +576,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, right crop is 10px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -598,7 +613,8 @@ export class FOverGridImageBuilder {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, rotate 90 degrees.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -662,7 +678,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const images = fWorksheet.getImages();
* images.forEach((image) => {
* console.log(image, image.getId());
@@ -679,7 +696,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const images = fWorksheet.getImages();
* images.forEach((image) => {
* console.log(image, image.getType());
@@ -696,7 +714,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.remove();
* console.log(result);
@@ -712,7 +731,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const images = fWorksheet.getImages();
* images.forEach((image) => {
* console.log(image, image.toBuilder().getSource());
@@ -732,7 +752,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4');
* console.log(result);
@@ -747,7 +768,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL);
* console.log(result);
@@ -770,7 +792,8 @@ export class FOverGridImage extends FBase {
* ```ts
* // set the position of the image, the start position is F6 cell.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setPositionAsync(5, 5);
* console.log(result);
@@ -787,7 +810,8 @@ export class FOverGridImage extends FBase {
* ```ts
* // set the position of the image, the start position is F6 cell, and the offset is 10px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setPositionAsync(5, 5, 10, 10);
* console.log(result);
@@ -817,7 +841,8 @@ export class FOverGridImage extends FBase {
* ```ts
* // set the image width 120px and height 50px
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setSizeAsync(120, 50);
* console.log(result);
@@ -842,7 +867,8 @@ export class FOverGridImage extends FBase {
* ```ts
* // set the crop of the image, top 10px, left 10px, bottom 10px, right 10px.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setCrop(10, 10, 10, 10);
* console.log(result);
@@ -885,7 +911,8 @@ export class FOverGridImage extends FBase {
* ```ts
* // set 90 degrees rotation of the image
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setRotate(90);
* console.log(result);
@@ -913,7 +940,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setForward();
* console.log(result);
@@ -934,7 +962,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setBackward();
* console.log(result);
@@ -955,7 +984,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setBack();
* console.log(result);
@@ -976,7 +1006,8 @@ export class FOverGridImage extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
* const result = image?.setFront();
* console.log(result);
diff --git a/packages/sheets-drawing/src/facade/f-worksheet.ts b/packages/sheets-drawing/src/facade/f-worksheet.ts
index 5b68b8df77..cc994e6f58 100644
--- a/packages/sheets-drawing/src/facade/f-worksheet.ts
+++ b/packages/sheets-drawing/src/facade/f-worksheet.ts
@@ -32,7 +32,8 @@ export interface IFWorksheetDrawingMixin {
* @example
* ```ts
* // Insert an image to the sheet, default position is A1
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const result = await fWorksheet.insertImage('https://avatars.githubusercontent.com/u/61444807?s=48&v=4');
* console.log(result);
* ```
@@ -46,7 +47,8 @@ export interface IFWorksheetDrawingMixin {
* @example
* ```ts
* // Insert an image to the sheet, position is F6
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const result = await fWorksheet.insertImage('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', 5, 5);
* console.log(result);
* ```
@@ -62,7 +64,8 @@ export interface IFWorksheetDrawingMixin {
* @example
* ```ts
* // Insert an image to the sheet, position is F6, offset is 10px
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const result = await fWorksheet.insertImage('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', 5, 5, 10, 10);
* console.log(result);
* ```
@@ -82,7 +85,8 @@ export interface IFWorksheetDrawingMixin {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, width is 500px, height is 300px
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -107,7 +111,8 @@ export interface IFWorksheetDrawingMixin {
* @returns {FOverGridImage[]} The FOverGridImage instances
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const images = fWorksheet.getImages();
* images.forEach((image) => {
* console.log(image, image.getId());
@@ -122,7 +127,8 @@ export interface IFWorksheetDrawingMixin {
* @returns {FOverGridImage | null} The FOverGridImage instance
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImageById('xxxx');
* console.log(image);
* ```
@@ -135,7 +141,8 @@ export interface IFWorksheetDrawingMixin {
* @returns {FWorksheet} The FWorksheet instance for chaining
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = fWorksheet.getImages()[0];
*
* // Delete the first image of the sheet
@@ -153,7 +160,8 @@ export interface IFWorksheetDrawingMixin {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, width is 500px, height is 300px
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
@@ -178,7 +186,8 @@ export interface IFWorksheetDrawingMixin {
* @returns {FOverGridImage[]} The FOverGridImage instances
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const images = fWorksheet.getActiveImages();
* images.forEach((image) => {
* console.log(image, image.getId());
@@ -195,7 +204,8 @@ export interface IFWorksheetDrawingMixin {
* // create a new image builder and set image source.
* // then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, width is 500px, height is 300px
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const image = await fWorksheet.newOverGridImage()
* .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
* .setColumn(5)
diff --git a/packages/sheets-filter/src/facade/f-filter.ts b/packages/sheets-filter/src/facade/f-filter.ts
index 4fa972aee3..0854a109cf 100644
--- a/packages/sheets-filter/src/facade/f-filter.ts
+++ b/packages/sheets-filter/src/facade/f-filter.ts
@@ -43,7 +43,8 @@ export class FFilter {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some values of the range C1:F10
* const fRange = fWorksheet.getRange('C1:F10');
@@ -93,7 +94,8 @@ export class FFilter {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some values of the range C1:F10
* const fRange = fWorksheet.getRange('C1:F10');
@@ -144,7 +146,8 @@ export class FFilter {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some values of the range C1:F10
* const fRange = fWorksheet.getRange('C1:F10');
@@ -203,7 +206,8 @@ export class FFilter {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some values of the range C1:F10
* const fRange = fWorksheet.getRange('C1:F10');
@@ -255,7 +259,8 @@ export class FFilter {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fFilter = fWorksheet.getFilter();
* console.log(fFilter?.getRange().getA1Notation());
* ```
@@ -271,7 +276,8 @@ export class FFilter {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some values of the range C1:F10
* const fRange = fWorksheet.getRange('C1:F10');
@@ -323,7 +329,8 @@ export class FFilter {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D14');
* let fFilter = fRange.createFilter();
*
diff --git a/packages/sheets-filter/src/facade/f-range.ts b/packages/sheets-filter/src/facade/f-range.ts
index d7da079c25..ee88c6098d 100644
--- a/packages/sheets-filter/src/facade/f-range.ts
+++ b/packages/sheets-filter/src/facade/f-range.ts
@@ -32,7 +32,8 @@ export interface IFRangeSheetsFilterMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D14');
* let fFilter = fRange.createFilter();
*
@@ -53,7 +54,8 @@ export interface IFRangeSheetsFilterMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D14');
* let fFilter = fRange.getFilter();
*
diff --git a/packages/sheets-filter/src/facade/f-worksheet.ts b/packages/sheets-filter/src/facade/f-worksheet.ts
index 8737a5b640..2646ed02d0 100644
--- a/packages/sheets-filter/src/facade/f-worksheet.ts
+++ b/packages/sheets-filter/src/facade/f-worksheet.ts
@@ -31,7 +31,8 @@ export interface IFWorksheetFilterMixin {
* @example
* ```typescript
* const workbook = univerAPI.getActiveWorkbook();
- * const worksheet = workbook.getActiveSheet();
+ * const worksheet = workbook.getSheetByName('Sheet1');
+ * if (!worksheet) return;
* const filter = worksheet.getFilter();
* console.log(filter, filter?.getRange().getA1Notation());
* ```
diff --git a/packages/sheets-find-replace/src/facade/f-text-finder.ts b/packages/sheets-find-replace/src/facade/f-text-finder.ts
index 0ddc5b5129..3f97e9b801 100644
--- a/packages/sheets-find-replace/src/facade/f-text-finder.ts
+++ b/packages/sheets-find-replace/src/facade/f-text-finder.ts
@@ -34,7 +34,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D10');
* fRange.setValues([
* [1, 2, 3, 4],
@@ -70,7 +71,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D10');
* fRange.setValues([
* [1, 2, 3, 4],
@@ -106,7 +108,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D10');
* fRange.setValues([
* [1, 2, 3, 4],
@@ -142,7 +145,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D10');
* fRange.setValues([
* [1, 2, 3, 4],
@@ -176,7 +180,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D1');
* fRange.setValues([
* ['hello univer', 'hello UNIVER', 'HELLO UNIVER', 'HELLO univer'],
@@ -208,7 +213,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D1');
* fRange.setValues([
* ['hello univer', 'hello univer 1', 'hello univer 2', 'hello univer 3'],
@@ -240,7 +246,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D1');
* fRange.setValues([
* ['sum', '1', '=SUM(2)', '3'],
@@ -273,7 +280,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D1');
* fRange.setValues([
* ['hello', 'hello', 'hello', 'hello'],
@@ -300,7 +308,8 @@ export interface IFTextFinder {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('B1:E1');
* fRange.setValues([
* ['hello', 'hello', 'hello', 'hello'],
diff --git a/packages/sheets-find-replace/src/facade/f-univer.ts b/packages/sheets-find-replace/src/facade/f-univer.ts
index e084e63150..ea5754f879 100644
--- a/packages/sheets-find-replace/src/facade/f-univer.ts
+++ b/packages/sheets-find-replace/src/facade/f-univer.ts
@@ -30,7 +30,8 @@ export interface IFUniverSheetsFindReplaceMixin {
* ```typescript
* // Assume the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set some values to the range A1:D10.
* const fRange = fWorksheet.getRange('A1:D10');
diff --git a/packages/sheets-formula-ui/src/facade/f-univer.ts b/packages/sheets-formula-ui/src/facade/f-univer.ts
index 489df3f326..fa7ca69622 100644
--- a/packages/sheets-formula-ui/src/facade/f-univer.ts
+++ b/packages/sheets-formula-ui/src/facade/f-univer.ts
@@ -28,7 +28,8 @@ export interface IFUniverSheetsFormulaUIMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const unitId = fWorkbook.getId();
*
* await univerAPI.showRangeSelectorDialog({
diff --git a/packages/sheets-formula/src/facade/f-formula.ts b/packages/sheets-formula/src/facade/f-formula.ts
index 301b461e1c..af5d63e08a 100644
--- a/packages/sheets-formula/src/facade/f-formula.ts
+++ b/packages/sheets-formula/src/facade/f-formula.ts
@@ -56,7 +56,8 @@ export interface IFFormulaSheetsMixin {
*
* // Use the function in a cell
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cellA1 = fWorksheet.getRange('A1');
* cellA1.setValue('World');
* const cellA2 = fWorksheet.getRange('A2');
@@ -81,7 +82,8 @@ export interface IFFormulaSheetsMixin {
*
* // Use the function in a cell
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cellA1 = fWorksheet.getRange('A1');
* cellA1.setValue(100);
* const cellA2 = fWorksheet.getRange('A2');
@@ -121,7 +123,8 @@ export interface IFFormulaSheetsMixin {
*
* // Use the function in a cell
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cellA1 = fWorksheet.getRange('A1');
* cellA1.setValue(1);
* const cellA2 = fWorksheet.getRange('A2');
@@ -176,7 +179,8 @@ export interface IFFormulaSheetsMixin {
*
* // Use the function in a cell
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cellA1 = fWorksheet.getRange('A1');
* cellA1.setValue('World');
* const cellA2 = fWorksheet.getRange('A2');
@@ -212,7 +216,8 @@ export interface IFFormulaSheetsMixin {
*
* // Use the function in a cell
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cellA1 = fWorksheet.getRange('A1');
* cellA1.setValue({ f: '=RANDOM_DELAYED()' });
*
@@ -262,7 +267,8 @@ export interface IFFormulaSheetsMixin {
*
* // Use the function in a cell
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cellA1 = fWorksheet.getRange('A1');
* cellA1.setValue({ f: '=FETCH_USER_SCORE(42)' });
*
diff --git a/packages/sheets-formula/src/facade/f-range.ts b/packages/sheets-formula/src/facade/f-range.ts
index 3d81a6c37c..8749f9f48c 100644
--- a/packages/sheets-formula/src/facade/f-range.ts
+++ b/packages/sheets-formula/src/facade/f-range.ts
@@ -27,9 +27,9 @@ export interface IFRangeEngineFormulaMixin {
* @returns {ISheetFormulaError[]} Array of formula errors in the range
* @example
* ```typescript
- * const range = univerAPI.getActiveWorkbook()
- * .getActiveSheet()
- * .getRange('A1:B10');
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
+ * const range = fWorksheet.getRange('A1:B10');
* const errors = range.getFormulaError();
* console.log('Formula errors in range:', errors);
* ```
diff --git a/packages/sheets-hyper-link/src/facade/f-range.ts b/packages/sheets-hyper-link/src/facade/f-range.ts
index bcbffe8010..0ac75dd55d 100644
--- a/packages/sheets-hyper-link/src/facade/f-range.ts
+++ b/packages/sheets-hyper-link/src/facade/f-range.ts
@@ -42,7 +42,8 @@ export interface IFRangeSheetsHyperlinkMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a hyperlink to Univer on cell A1
* const fRange = fWorksheet.getRange('A1');
@@ -76,7 +77,8 @@ export interface IFRangeSheetsHyperlinkMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* console.log(fWorksheet.getRange('A1:T100').getHyperLinks());
* ```
*/
@@ -90,7 +92,8 @@ export interface IFRangeSheetsHyperlinkMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a hyperlink to Univer on cell A1
* const fRange = fWorksheet.getRange('A1');
@@ -113,7 +116,8 @@ export interface IFRangeSheetsHyperlinkMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Cancel the hyperlink in cell A1
* const fRange = fWorksheet.getRange('A1');
@@ -140,7 +144,8 @@ export interface IFRangeSheetsHyperlinkMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1');
* const url = fRange.getUrl();
* console.log(url);
diff --git a/packages/sheets-hyper-link/src/facade/f-workbook.ts b/packages/sheets-hyper-link/src/facade/f-workbook.ts
index d4ba4504ec..a417727656 100644
--- a/packages/sheets-hyper-link/src/facade/f-workbook.ts
+++ b/packages/sheets-hyper-link/src/facade/f-workbook.ts
@@ -32,7 +32,8 @@ export interface IFWorkbookHyperlinkMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a defined name "TestRange" for the range A1:B10 of the active sheet
* const definedNameParam = fWorkbook.newDefinedNameBuilder()
@@ -67,7 +68,8 @@ export interface IFWorkbookHyperlinkMixin {
* ``` ts
* // Create a hyperlink to the range A1:D10 of the current sheet
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D10');
* const hyperlink = fRange.getUrl();
*
diff --git a/packages/sheets-hyper-link/src/facade/f-worksheet.ts b/packages/sheets-hyper-link/src/facade/f-worksheet.ts
index 633159b4bb..67de104045 100644
--- a/packages/sheets-hyper-link/src/facade/f-worksheet.ts
+++ b/packages/sheets-hyper-link/src/facade/f-worksheet.ts
@@ -27,7 +27,8 @@ export interface IFWorksheetHyperlinkMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const url = fWorksheet.getUrl();
* console.log(url);
* ```
diff --git a/packages/sheets-note/src/facade/f-range.ts b/packages/sheets-note/src/facade/f-range.ts
index 2b757cf8e8..498b98ee58 100644
--- a/packages/sheets-note/src/facade/f-range.ts
+++ b/packages/sheets-note/src/facade/f-range.ts
@@ -29,7 +29,8 @@ export interface IFRangeSheetsNoteMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:D10');
* const note = fRange.getNote();
* console.log(note);
@@ -43,7 +44,8 @@ export interface IFRangeSheetsNoteMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1');
* fRange.createOrUpdateNote({
* note: 'This is a note',
@@ -60,7 +62,8 @@ export interface IFRangeSheetsNoteMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const notes = fWorksheet.getNotes();
* console.log(notes);
*
diff --git a/packages/sheets-note/src/facade/f-worksheet.ts b/packages/sheets-note/src/facade/f-worksheet.ts
index 012f9e46dd..f71992a256 100644
--- a/packages/sheets-note/src/facade/f-worksheet.ts
+++ b/packages/sheets-note/src/facade/f-worksheet.ts
@@ -28,7 +28,8 @@ export interface IFWorksheetNoteMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const notes = fWorksheet.getNotes();
* console.log(notes);
*
diff --git a/packages/sheets-numfmt/src/facade/f-range.ts b/packages/sheets-numfmt/src/facade/f-range.ts
index e2428440d7..e0a81c752d 100644
--- a/packages/sheets-numfmt/src/facade/f-range.ts
+++ b/packages/sheets-numfmt/src/facade/f-range.ts
@@ -31,7 +31,8 @@ export interface IFRangeSheetsNumfmtMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the number format of the A1 cell to '#,##0.00'.
* const fRange = fWorksheet.getRange('A1');
@@ -48,7 +49,8 @@ export interface IFRangeSheetsNumfmtMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the number formats of the A1:B2 range.
* const fRange = fWorksheet.getRange('A1:B2');
@@ -70,7 +72,8 @@ export interface IFRangeSheetsNumfmtMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Get the number format of the top-left cell of the A1:B2 range.
* const fRange = fWorksheet.getRange('A1:B2');
@@ -85,7 +88,8 @@ export interface IFRangeSheetsNumfmtMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Get the number formats of the A1:B2 range.
* const fRange = fWorksheet.getRange('A1:B2');
diff --git a/packages/sheets-numfmt/src/facade/f-workbook.ts b/packages/sheets-numfmt/src/facade/f-workbook.ts
index d51efab78d..8626846d8c 100644
--- a/packages/sheets-numfmt/src/facade/f-workbook.ts
+++ b/packages/sheets-numfmt/src/facade/f-workbook.ts
@@ -27,7 +27,8 @@ export interface IFWorkbookSheetsNumfmtMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1');
* fRange.setValue(1234.567).setNumberFormat('#,##0.00');
*
diff --git a/packages/sheets-sort/src/facade/f-range.ts b/packages/sheets-sort/src/facade/f-range.ts
index b3e4e7ae74..8a1007a152 100644
--- a/packages/sheets-sort/src/facade/f-range.ts
+++ b/packages/sheets-sort/src/facade/f-range.ts
@@ -31,7 +31,8 @@ export interface IFRangeSheetsSortMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('D1:G10');
*
* // Sorts the range by the first column in ascending order.
diff --git a/packages/sheets-sort/src/facade/f-worksheet.ts b/packages/sheets-sort/src/facade/f-worksheet.ts
index 0bf1ac1ca0..8ae9966c86 100644
--- a/packages/sheets-sort/src/facade/f-worksheet.ts
+++ b/packages/sheets-sort/src/facade/f-worksheet.ts
@@ -32,7 +32,8 @@ export interface IFWorksheetSortMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Sorts the worksheet by the column A in ascending order.
* fWorksheet.sort(0);
diff --git a/packages/sheets-table/src/facade/f-workbook.ts b/packages/sheets-table/src/facade/f-workbook.ts
index 4e2bdbdf5c..ea94689731 100644
--- a/packages/sheets-table/src/facade/f-workbook.ts
+++ b/packages/sheets-table/src/facade/f-workbook.ts
@@ -31,7 +31,8 @@ export interface IFWorkbookSheetsTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
@@ -59,7 +60,8 @@ export interface IFWorkbookSheetsTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
@@ -103,7 +105,8 @@ export interface IFWorkbookSheetsTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
@@ -134,7 +137,8 @@ export interface IFWorkbookSheetsTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
diff --git a/packages/sheets-table/src/facade/f-worksheet.ts b/packages/sheets-table/src/facade/f-worksheet.ts
index da7406efd1..556e0e1bc5 100644
--- a/packages/sheets-table/src/facade/f-worksheet.ts
+++ b/packages/sheets-table/src/facade/f-worksheet.ts
@@ -51,7 +51,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
@@ -94,7 +95,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
@@ -132,7 +134,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const tableInfo = fWorkbook.getTableInfo('id-1');
* console.log('debugger tableInfo', tableInfo);
*
@@ -152,7 +155,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
@@ -187,7 +191,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
@@ -219,7 +224,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const tables = fWorksheet.getSubTableInfos();
* console.log('debugger tables', tables);
* ```
@@ -234,7 +240,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
@@ -278,7 +285,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* const cellB2 = fWorksheet.getRange('B2');
* const row = cellB2.getRow();
@@ -308,7 +316,8 @@ export interface IFWorksheetTableMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Insert a table in the range B2:F11
* const fRange = fWorksheet.getRange('B2:F11');
diff --git a/packages/sheets-thread-comment/src/facade/f-range.ts b/packages/sheets-thread-comment/src/facade/f-range.ts
index 894abd1c6c..fb054613ba 100644
--- a/packages/sheets-thread-comment/src/facade/f-range.ts
+++ b/packages/sheets-thread-comment/src/facade/f-range.ts
@@ -31,9 +31,9 @@ export interface IFRangeSheetsThreadCommentMixin {
* @returns {FThreadComment | null} The comment of the start cell in the current range. If the cell does not have a comment, return `null`.
* @example
* ```ts
- * const range = univerAPI.getActiveWorkbook()
- * .getActiveSheet()
- * .getActiveRange();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
+ * const range = fWorksheet.getActiveRange();
* const comment = range.getComment();
* ```
*/
@@ -44,9 +44,9 @@ export interface IFRangeSheetsThreadCommentMixin {
* @returns {FThreadComment[]} The comments in the current range.
* @example
* ```ts
- * const range = univerAPI.getActiveWorkbook()
- * .getActiveSheet()
- * .getActiveRange();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
+ * const range = fWorksheet.getActiveRange();
* const comments = range.getComments();
* comments.forEach((comment) => {
* console.log(comment.getContent());
@@ -74,7 +74,8 @@ export interface IFRangeSheetsThreadCommentMixin {
*
* // Add the comment to the cell A1
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cell = fWorksheet.getRange('A1');
* const result = await cell.addCommentAsync(commentBuilder);
* console.log(result);
@@ -103,9 +104,9 @@ export interface IFRangeSheetsThreadCommentMixin {
* @returns Whether the comments are cleared successfully.
* @example
* ```ts
- * const range = univerAPI.getActiveWorkbook()
- * .getActiveSheet()
- * .getActiveRange();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
+ * const range = fWorksheet.getActiveRange();
* const success = await range.clearCommentsAsync();
* ```
*/
diff --git a/packages/sheets-thread-comment/src/facade/f-thread-comment.ts b/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
index f13e33374a..9e11a1f939 100644
--- a/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
+++ b/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
@@ -161,7 +161,8 @@ export class FTheadCommentBuilder extends FTheadCommentItem {
*
* // Add the comment to the cell A1
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cell = fWorksheet.getRange('A1');
* const result = await cell.addCommentAsync(commentBuilder);
* console.log(result);
@@ -191,7 +192,8 @@ export class FTheadCommentBuilder extends FTheadCommentItem {
*
* // Add the comment to the cell A1
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cell = fWorksheet.getRange('A1');
* const result = await cell.addCommentAsync(commentBuilder);
* console.log(result);
@@ -217,7 +219,8 @@ export class FTheadCommentBuilder extends FTheadCommentItem {
*
* // Add the comment to the cell A1
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cell = fWorksheet.getRange('A1');
* const result = await cell.addCommentAsync(commentBuilder);
* console.log(result);
@@ -243,7 +246,8 @@ export class FTheadCommentBuilder extends FTheadCommentItem {
*
* // Add the comment to the cell A1
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cell = fWorksheet.getRange('A1');
* const result = await cell.addCommentAsync(commentBuilder);
* console.log(result);
@@ -269,7 +273,8 @@ export class FTheadCommentBuilder extends FTheadCommentItem {
*
* // Add the comment to the cell A1
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cell = fWorksheet.getRange('A1');
* const result = await cell.addCommentAsync(commentBuilder);
* console.log(result);
@@ -332,7 +337,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const comments = fWorksheet.getComments();
* comments.forEach((comment) => {
* console.log(comment.getIsRoot());
@@ -349,7 +355,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const comments = fWorksheet.getComments();
* comments.forEach((comment) => {
* console.log(comment.getCommentData());
@@ -367,7 +374,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const comments = fWorksheet.getComments();
* comments.forEach((comment) => {
* if (comment.getIsRoot()) {
@@ -392,7 +400,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const comments = fWorksheet.getComments();
* comments.forEach((comment) => {
* console.log(comment.getRange().getA1Notation());
@@ -425,7 +434,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const comments = fWorksheet.getComments();
* comments.forEach((comment) => {
* console.log(comment.getRichText());
@@ -443,7 +453,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const comments = fWorksheet.getComments();
*
* // Delete the first comment
@@ -483,7 +494,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new comment
* const richText = univerAPI.newRichText().insertText('hello univer');
@@ -536,7 +548,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new comment
* const richText = univerAPI.newRichText().insertText('hello univer');
@@ -573,7 +586,8 @@ export class FThreadComment {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new comment
* const richText = univerAPI.newRichText().insertText('hello univer');
diff --git a/packages/sheets-thread-comment/src/facade/f-univer.ts b/packages/sheets-thread-comment/src/facade/f-univer.ts
index ae8b26d09f..8dc5aa0bf8 100644
--- a/packages/sheets-thread-comment/src/facade/f-univer.ts
+++ b/packages/sheets-thread-comment/src/facade/f-univer.ts
@@ -52,7 +52,8 @@ export interface IFUniverSheetsThreadCommentMixin {
*
* // Add the comment to the cell A1
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const cell = fWorksheet.getRange('A1');
* const result = await cell.addCommentAsync(commentBuilder);
* console.log(result);
diff --git a/packages/sheets-thread-comment/src/facade/f-worksheet.ts b/packages/sheets-thread-comment/src/facade/f-worksheet.ts
index 653862ee56..5f056c86da 100644
--- a/packages/sheets-thread-comment/src/facade/f-worksheet.ts
+++ b/packages/sheets-thread-comment/src/facade/f-worksheet.ts
@@ -32,7 +32,8 @@ export interface IFWorksheetCommentMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const comments = fWorksheet.getComments();
* comments.forEach((comment) => {
* const isRoot = comment.getIsRoot();
@@ -56,7 +57,8 @@ export interface IFWorksheetCommentMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const result = await fWorksheet.clearComments();
* console.log(result);
* ```
@@ -68,7 +70,8 @@ export interface IFWorksheetCommentMixin {
* @param {string} commentId comment id
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Create a new comment
* const richText = univerAPI.newRichText().insertText('hello univer');
diff --git a/packages/sheets-ui/src/facade/f-range.ts b/packages/sheets-ui/src/facade/f-range.ts
index 7470381830..b476ffb1f0 100644
--- a/packages/sheets-ui/src/facade/f-range.ts
+++ b/packages/sheets-ui/src/facade/f-range.ts
@@ -49,7 +49,8 @@ interface IFRangeSheetsUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('H6');
* console.log(fRange.getCell());
* ```
@@ -62,7 +63,8 @@ interface IFRangeSheetsUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('H6');
* console.log(fRange.getCellRect());
* ```
@@ -75,7 +77,8 @@ interface IFRangeSheetsUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setValues([
* [1, 2],
@@ -107,7 +110,8 @@ interface IFRangeSheetsUIMixin {
*
* // Attach the popup to the start cell of range C3:E5
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('C3:E5');
* const disposable = fRange.attachPopup({
* componentKey: 'myPopup'
@@ -129,7 +133,8 @@ interface IFRangeSheetsUIMixin {
* ```ts
* // Attach an alert popup to the start cell of range C3:E5
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('C3:E5');
*
* const disposable = fRange.attachAlertPopup({
@@ -165,7 +170,8 @@ interface IFRangeSheetsUIMixin {
*
* // Attach the popup to the range C3:E5
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('C3:E5');
* const disposable = fRange.attachRangePopup({
* componentKey: 'myPopup',
@@ -183,7 +189,8 @@ interface IFRangeSheetsUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Highlight the range C3:E5 with default style
* const fRange = fWorksheet.getRange('C3:E5');
@@ -219,7 +226,8 @@ interface IFRangeSheetsUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('C3:E5');
* fRange.showDropdown({ type: 'list', props: { options: [{ label: 'Option 1', value: 'option1' }, { label: 'Option 2', value: 'option2' }] } });
* ```
@@ -311,8 +319,9 @@ class FRangeSheetsUIMixin extends FRange implements IFRangeSheetsUIMixin {
* @returns {IDisposable} disposable
* @example
* ```typescript
- * let sheet = univerAPI.getActiveWorkbook().getActiveSheet();
- * let range = sheet.getRange(2, 2, 3, 3);
+ * let fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
+ * let range = fWorksheet.getRange(2, 2, 3, 3);
* univerAPI.getActiveWorkbook().setActiveRange(range);
* let disposable = range.attachRangePopup({
* componentKey: 'univer.sheet.single-dom-popup',
diff --git a/packages/sheets-ui/src/facade/f-workbook.ts b/packages/sheets-ui/src/facade/f-workbook.ts
index 43662cbeb4..6d08dbb04e 100644
--- a/packages/sheets-ui/src/facade/f-workbook.ts
+++ b/packages/sheets-ui/src/facade/f-workbook.ts
@@ -237,7 +237,8 @@ export interface IFWorkbookSheetsUIMixin {
* @example
* ``` ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // scroll to cell D10
* fWorksheet.scrollToCell(9, 3);
diff --git a/packages/sheets-ui/src/facade/f-worksheet.ts b/packages/sheets-ui/src/facade/f-worksheet.ts
index 3e6cde00e1..2cff9b514e 100644
--- a/packages/sheets-ui/src/facade/f-worksheet.ts
+++ b/packages/sheets-ui/src/facade/f-worksheet.ts
@@ -36,7 +36,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* fWorksheet.refreshCanvas();
* ```
*/
@@ -51,7 +52,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const ranges = [fWorksheet.getRange('A1:B2'), fWorksheet.getRange('D4:E5')];
* const disposable = fWorksheet.highlightRanges(ranges, { fill: 'yellow' });
*
@@ -68,7 +70,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set zoom ratio to 200%
* fWorksheet.zoom(2);
@@ -84,7 +87,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const zoomRatio = fWorksheet.getZoom();
* console.log(zoomRatio);
* ```
@@ -97,7 +101,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const visibleRange = fWorksheet.getVisibleRange();
* console.log(visibleRange);
* console.log(fWorksheet.getRange(visibleRange).getA1Notation());
@@ -111,7 +116,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const visibleRanges = fWorksheet.getVisibleRangesOfAllViewports();
* console.log(visibleRanges);
* const mainLeftTopViewportRange = visibleRanges?.get(univerAPI.Enum.SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT_TOP);
@@ -130,7 +136,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Scroll to cell D10
* const fRange = fWorksheet.getRange('D10');
@@ -147,7 +154,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Scroll to cell D10
* const fRange = fWorksheet.getRange('D10');
@@ -169,7 +177,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const skeleton = fWorksheet.getSkeleton();
* console.log(skeleton);
* ```
@@ -183,7 +192,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* 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');
@@ -203,7 +213,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the A:C columns to a width that fits their text.
* fWorksheet.autoResizeColumns(0, 3);
@@ -228,7 +239,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the first 3 rows to a height that fits their text.
* fWorksheet.autoResizeRows(0, 3);
@@ -242,7 +254,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* fWorksheet.customizeColumnHeader({
* headerStyle: {
* fontColor: '#fff',
@@ -272,7 +285,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* fWorksheet.customizeRowHeader({
* headerStyle: {
* backgroundColor: 'pink',
@@ -297,7 +311,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* fWorksheet.setColumnHeaderHeight(100);
* ```
*/
@@ -310,7 +325,8 @@ export interface IFWorksheetUIMixin {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* fWorksheet.setRowHeaderWidth(100);
* ```
*/
diff --git a/packages/sheets/src/facade/f-range.ts b/packages/sheets/src/facade/f-range.ts
index 78f4ed8347..e7df92288c 100644
--- a/packages/sheets/src/facade/f-range.ts
+++ b/packages/sheets/src/facade/f-range.ts
@@ -126,7 +126,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getUnitId());
* ```
@@ -141,7 +142,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getSheetName());
* ```
@@ -156,7 +158,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getSheetId());
* ```
@@ -171,7 +174,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* const range = fRange.getRange();
* const { startRow, startColumn, endRow, endColumn } = range;
@@ -188,7 +192,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getRow()); // 0
* ```
@@ -203,7 +208,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getLastRow()); // 1
* ```
@@ -218,7 +224,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getColumn()); // 0
* ```
@@ -233,7 +240,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getLastColumn()); // 1
* ```
@@ -248,7 +256,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getWidth());
* ```
@@ -263,7 +272,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getHeight());
* ```
@@ -278,7 +288,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.isMerged());
* // merge cells A1:B2
@@ -305,7 +316,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getCellStyleData());
* ```
@@ -330,7 +342,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getFontFamily());
* ```
@@ -351,7 +364,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getFontSize());
* ```
@@ -372,7 +386,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getCellStyle());
* ```
@@ -394,7 +409,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getCellStyles());
* ```
@@ -418,7 +434,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getValue());
*
@@ -435,7 +452,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getValue(true));
*
@@ -462,7 +480,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setValueForCell({
* v: 0.2,
@@ -487,7 +506,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setValueForCell({
* v: 0.2,
@@ -513,7 +533,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Get plain values
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getValues());
* ```
@@ -527,7 +548,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Get values with rich text if available
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getValues(true));
* ```
@@ -559,7 +581,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setValues([
* [
@@ -624,7 +647,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setValues([
* [
@@ -689,7 +713,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getCellData());
* ```
@@ -704,7 +729,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getCellDatas());
* ```
@@ -719,7 +745,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getCellDataGrid());
* ```
@@ -746,7 +773,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getRichTextValue());
* ```
@@ -768,7 +796,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getRichTextValues());
* ```
@@ -786,7 +815,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getValueAndRichTextValue());
* ```
@@ -802,7 +832,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getValueAndRichTextValues());
* ```
@@ -818,7 +849,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getFormula());
* ```
@@ -838,7 +870,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getFormulas());
* ```
@@ -870,7 +903,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getWrap());
* ```
@@ -885,7 +919,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getWraps());
*/
@@ -901,7 +936,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getWrapStrategy());
* ```
@@ -916,7 +952,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getHorizontalAlignment());
* ```
@@ -932,7 +969,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getHorizontalAlignments());
* ```
@@ -948,7 +986,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getVerticalAlignment());
* ```
@@ -963,7 +1002,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getVerticalAlignments());
* ```
@@ -979,7 +1019,8 @@ export class FRange extends FBaseInitialable {
* @returns {FRange} This range, for chaining
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setCustomMetaData({ key: 'value' });
* console.log(fRange.getCustomMetaData());
@@ -1006,7 +1047,8 @@ export class FRange extends FBaseInitialable {
* @returns {FRange} This range, for chaining
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setCustomMetaDatas([
* [{ key: 'value' }, { key: 'value2' }],
@@ -1034,7 +1076,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getCustomMetaData());
* ```
@@ -1050,7 +1093,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getCustomMetaDatas());
* ```
@@ -1069,7 +1113,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setBorder(univerAPI.Enum.BorderType.ALL, univerAPI.Enum.BorderStyleTypes.THIN, '#ff0000');
* ```
@@ -1096,7 +1141,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getBackground());
* ```
@@ -1112,7 +1158,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getBackgrounds());
* ```
@@ -1129,7 +1176,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setBackgroundColor('red');
* ```
@@ -1156,7 +1204,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setBackground('red');
* ```
@@ -1173,7 +1222,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setTextRotation(45);
* ```
@@ -1194,7 +1244,8 @@ export class FRange extends FBaseInitialable {
* @returns {FRange} This range, for chaining
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('B2');
* fRange.setValue(123);
*
@@ -1225,7 +1276,8 @@ export class FRange extends FBaseInitialable {
* @returns {FRange} This range, for chaining
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setValueForCell(123);
*
@@ -1262,7 +1314,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getValue(true));
*
@@ -1299,7 +1352,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getValue(true));
*
@@ -1337,7 +1391,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setWrap(true);
* console.log(fRange.getWrap());
@@ -1361,7 +1416,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setWrapStrategy(univerAPI.Enum.WrapStrategy.WRAP);
* console.log(fRange.getWrapStrategy());
@@ -1385,7 +1441,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setVerticalAlignment('top');
* ```
@@ -1408,7 +1465,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setHorizontalAlignment('left');
* ```
@@ -1431,7 +1489,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setValues([
* [1, { v: 2, s: { bg: { rgb: '#ff0000' } } }],
@@ -1465,7 +1524,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setFontWeight('bold');
* ```
@@ -1506,7 +1566,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setFontStyle('italic');
* ```
@@ -1547,7 +1608,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setFontLine('underline');
* ```
@@ -1624,7 +1686,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setFontFamily('Arial');
* ```
@@ -1653,7 +1716,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setFontSize(24);
* ```
@@ -1682,7 +1746,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setFontColor('#ff0000');
* ```
@@ -1719,7 +1784,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.merge();
* console.log(fRange.isMerged());
@@ -1727,7 +1793,8 @@ export class FRange extends FBaseInitialable {
*
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('B1:C2');
* // Assume A1:B2 is already merged.
* fRange.merge({ isForceMerge: true });
@@ -1752,7 +1819,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Assume the active sheet is a new sheet with no merged cells.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.mergeAcross();
* // There will be two merged cells. A1:B1 and A2:B2.
@@ -1764,7 +1832,8 @@ export class FRange extends FBaseInitialable {
*
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('B1:C2');
* // Assume A1:B2 is already merged.
* fRange.mergeAcross({ isForceMerge: true });
@@ -1790,7 +1859,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Assume the active sheet is a new sheet with no merged cells.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.mergeVertically();
* // There will be two merged cells. A1:A2 and B1:B2.
@@ -1802,7 +1872,8 @@ export class FRange extends FBaseInitialable {
*
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('B1:C2');
* // Assume A1:B2 is already merged.
* fRange.mergeVertically({ isForceMerge: true });
@@ -1824,7 +1895,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.merge();
* const anchor = fWorksheet.getRange('A1');
@@ -1842,7 +1914,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.merge();
* const anchor = fWorksheet.getRange('A1');
@@ -1870,7 +1943,8 @@ export class FRange extends FBaseInitialable {
* @param {ICellData} callback.cell the cell data
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.forEach((row, col, cell) => {
* console.log(row, col, cell);
@@ -1895,7 +1969,8 @@ export class FRange extends FBaseInitialable {
* @returns {string} The A1 notation of the range.
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // By default, the A1 notation is returned without the sheet name and without absolute reference types.
* const fRange = fWorksheet.getRange('A1:B2');
@@ -1935,7 +2010,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.activate(); // the active cell will be A1
* ```
@@ -1955,7 +2031,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the range A1:B2 as the active range, default active cell is A1
* const fRange = fWorksheet.getRange('A1:B2');
@@ -2022,7 +2099,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // A1:A3 has following values:
* // A |
@@ -2056,7 +2134,8 @@ export class FRange extends FBaseInitialable {
* @example Show how to split text to columns with combined delimiter. The bit operations are used to combine the delimiters.
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // A1:A3 has following values:
* // A |
@@ -2091,7 +2170,8 @@ export class FRange extends FBaseInitialable {
* @example Show how to split text to columns with custom delimiter
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // A1:A3 has following values:
* // A |
@@ -2134,7 +2214,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:E20');
* fRange.useThemeStyle('default');
* ```
@@ -2161,7 +2242,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:E20');
* fRange.removeThemeStyle('default');
* ```
@@ -2181,7 +2263,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:E20');
* console.log(fRange.getUsedThemeStyle()); // undefined
* fRange.useThemeStyle('default');
@@ -2205,7 +2288,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorkSheet = fWorkbook.getActiveSheet();
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorkSheet) return;
* const fRange = fWorkSheet.getRange('A1:D10');
*
* // clear the content and format of the range A1:D10
@@ -2239,7 +2323,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorkSheet = fWorkbook.getActiveSheet();
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorkSheet) return;
* const fRange = fWorkSheet.getRange('A1:D10');
*
* // clear the content only of the range A1:D10
@@ -2261,7 +2346,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```typescript
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorkSheet = fWorkbook.getActiveSheet();
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorkSheet) return;
* const fRange = fWorkSheet.getRange('A1:D10');
* // clear the format only of the range A1:D10
* fRange.clearFormat();
@@ -2283,7 +2369,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Assume the active sheet empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const values = [
* [1, 2, 3, 4],
* [2, 3, 4, 5],
@@ -2350,7 +2437,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Assume the active sheet empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const values = [
* [1, 2, 3, 4],
* [2, 3, 4, 5],
@@ -2421,7 +2509,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Assume the active sheet is a new sheet with no data.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Set the range A1:D4 with some values, the range A1:D4 will be:
* // | | |
@@ -2530,7 +2619,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Assume the active sheet is a new sheet with no data.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.isBlank()); // true
*
@@ -2570,7 +2660,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getA1Notation()); // A1:B2
*
@@ -2589,7 +2680,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getA1Notation()); // A1:B2
*
@@ -2609,7 +2701,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* console.log(fRange.getA1Notation()); // A1:B2
*
@@ -2645,7 +2738,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1');
* fRange.setFormula('=SUM(A2:A5)');
* console.log(fRange.getFormula()); // '=SUM(A2:A5)'
@@ -2664,7 +2758,8 @@ export class FRange extends FBaseInitialable {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* fRange.setFormulas([
* ['=SUM(A2:A5)', '=SUM(B2:B5)'],
@@ -2683,7 +2778,8 @@ export class FRange extends FBaseInitialable {
* @returns {FRangePermission} - The RangePermission instance.
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B10');
* const permission = fRange.getRangePermission();
*
@@ -2726,7 +2822,8 @@ export class FRange extends FBaseInitialable {
* ```ts
* // Auto-fill the range D1:D10 based on the data in the range C1:C2
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:A4');
*
* // Auto-fill without specifying applyType (default behavior)
diff --git a/packages/sheets/src/facade/f-selection.ts b/packages/sheets/src/facade/f-selection.ts
index 8d318d4199..cb949ec79d 100644
--- a/packages/sheets/src/facade/f-selection.ts
+++ b/packages/sheets/src/facade/f-selection.ts
@@ -29,7 +29,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);
@@ -52,7 +53,8 @@ export 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();
@@ -74,7 +76,8 @@ export 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) => {
@@ -94,7 +97,8 @@ export 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();
@@ -119,10 +123,11 @@ export 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 {
@@ -137,7 +142,8 @@ export 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');
@@ -200,7 +206,8 @@ export 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();
diff --git a/packages/sheets/src/facade/f-workbook.ts b/packages/sheets/src/facade/f-workbook.ts
index 985e88c994..ff82f7cdc5 100644
--- a/packages/sheets/src/facade/f-workbook.ts
+++ b/packages/sheets/src/facade/f-workbook.ts
@@ -193,6 +193,7 @@ export 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);
* ```
*/
@@ -594,7 +595,9 @@ export 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);
* ```
*/
@@ -694,7 +697,8 @@ export 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);
* ```
@@ -800,7 +804,8 @@ export 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);
* ```
*/
@@ -1144,7 +1149,8 @@ export 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' }],
@@ -1180,7 +1186,8 @@ export 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' }],
diff --git a/packages/sheets/src/facade/f-worksheet.ts b/packages/sheets/src/facade/f-worksheet.ts
index 77e0e97f7d..5b5bea3d3d 100644
--- a/packages/sheets/src/facade/f-worksheet.ts
+++ b/packages/sheets/src/facade/f-worksheet.ts
@@ -75,7 +75,8 @@ export 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);
* ```
@@ -89,7 +90,8 @@ export 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);
* ```
@@ -103,7 +105,8 @@ export 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);
* ```
@@ -117,7 +120,8 @@ export 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);
* ```
@@ -131,7 +135,8 @@ export 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);
* ```
@@ -145,7 +150,8 @@ export 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);
* ```
@@ -168,7 +174,8 @@ export 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);
* ```
@@ -184,7 +191,8 @@ export 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);
@@ -205,7 +213,8 @@ export 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);
@@ -225,7 +234,8 @@ export 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'});
@@ -251,7 +261,8 @@ export 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'});
@@ -283,7 +294,8 @@ export 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'});
@@ -316,7 +328,8 @@ export 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);
@@ -340,7 +353,8 @@ export 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);
@@ -353,7 +367,8 @@ export 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);
@@ -425,7 +440,8 @@ export 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`);
* ```
@@ -439,7 +455,8 @@ export 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`);
* ```
@@ -454,7 +471,8 @@ export 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
@@ -471,7 +489,8 @@ export 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
@@ -489,7 +508,8 @@ export 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
@@ -507,7 +527,8 @@ export 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
@@ -550,7 +571,8 @@ export 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
@@ -592,7 +614,8 @@ export 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
@@ -610,7 +633,8 @@ export 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)
@@ -640,7 +664,8 @@ export 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]]);
* ```
@@ -660,7 +685,8 @@ export 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);
@@ -698,7 +724,8 @@ export 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);
@@ -728,7 +755,8 @@ export 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)
@@ -760,7 +788,8 @@ export 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);
@@ -790,7 +819,8 @@ export 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)
@@ -824,7 +854,8 @@ export 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
@@ -842,7 +873,8 @@ export 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);
* ```
*/
@@ -879,7 +911,8 @@ export 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);
* ```
*/
@@ -935,7 +968,8 @@ export 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');
@@ -956,7 +990,8 @@ export 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);
* ```
*/
@@ -987,7 +1022,8 @@ export 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 },
@@ -1015,7 +1051,8 @@ export 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);
* ```
*/
@@ -1049,7 +1086,8 @@ export 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' } });
* ```
*/
@@ -1083,7 +1121,8 @@ export 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
@@ -1100,7 +1139,8 @@ export 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
@@ -1118,7 +1158,8 @@ export 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
@@ -1136,7 +1177,8 @@ export 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
@@ -1179,7 +1221,8 @@ export 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
@@ -1221,7 +1264,8 @@ export 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
@@ -1239,7 +1283,8 @@ export 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)
@@ -1269,7 +1314,8 @@ export 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]]);
* ```
@@ -1289,7 +1335,8 @@ export 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);
@@ -1327,7 +1374,8 @@ export 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);
@@ -1357,7 +1405,8 @@ export 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
@@ -1390,7 +1439,8 @@ export 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);
@@ -1420,7 +1470,8 @@ export 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
@@ -1454,7 +1505,8 @@ export 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);
* ```
@@ -1471,7 +1523,8 @@ export 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);
* ```
@@ -1505,7 +1558,8 @@ export 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');
@@ -1530,7 +1584,8 @@ export 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' } });
* ```
*/
@@ -1563,7 +1618,8 @@ export 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
@@ -1581,7 +1637,8 @@ export 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
@@ -1602,7 +1659,8 @@ export 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());
@@ -1624,7 +1682,8 @@ export 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) {
@@ -1642,7 +1701,8 @@ export 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'));
* ```
*/
@@ -1662,7 +1722,8 @@ export 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());
* ```
*/
@@ -1676,7 +1737,8 @@ export 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'));
* ```
*/
@@ -1689,7 +1751,8 @@ export 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,
@@ -1713,7 +1776,8 @@ export 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();
* ```
@@ -1732,7 +1796,8 @@ export 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);
@@ -1749,7 +1814,8 @@ export 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);
* ```
@@ -1765,7 +1831,8 @@ export 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);
* ```
@@ -1804,7 +1871,8 @@ export 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);
* ```
@@ -1820,7 +1888,8 @@ export 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);
* ```
@@ -1857,7 +1926,8 @@ export 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);
@@ -1876,7 +1946,8 @@ export 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);
@@ -1895,7 +1966,8 @@ export 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);
@@ -1914,7 +1986,8 @@ export 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);
@@ -1933,7 +2006,8 @@ export 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');
@@ -1950,7 +2024,8 @@ export 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);
* ```
@@ -1970,7 +2045,8 @@ export 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');
* ```
@@ -1990,7 +2066,8 @@ export 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());
* ```
@@ -2006,7 +2083,8 @@ export 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');
* ```
@@ -2027,7 +2105,8 @@ export 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());
* ```
@@ -2042,7 +2121,8 @@ export 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();
* ```
@@ -2106,7 +2186,8 @@ export 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');
* ```
@@ -2143,7 +2224,8 @@ export 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);
@@ -2162,7 +2244,8 @@ export 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
@@ -2204,7 +2287,8 @@ export 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();
* ```
@@ -2235,7 +2319,8 @@ export 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();
* ```
@@ -2268,7 +2353,8 @@ export 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');
@@ -2286,7 +2372,8 @@ export 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');
@@ -2303,7 +2390,8 @@ export 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');
@@ -2322,7 +2410,8 @@ export 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.
* ```
*/
@@ -2340,7 +2429,8 @@ export 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');
* ```
*/
@@ -2360,7 +2450,8 @@ export 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());
* ```
@@ -2377,7 +2468,8 @@ export 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' });
* ```
*/
@@ -2392,7 +2484,8 @@ export 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);
* ```
@@ -2409,7 +2502,8 @@ export 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' });
* ```
*/
@@ -2426,7 +2520,8 @@ export 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' });
* ```
*/
@@ -2442,7 +2537,8 @@ export 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);
* ```
@@ -2458,7 +2554,8 @@ export 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);
* ```
@@ -2476,7 +2573,8 @@ export 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']);
* ```
*/
@@ -2512,7 +2610,8 @@ export 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);
@@ -2534,7 +2633,8 @@ export 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);
@@ -2555,7 +2655,8 @@ export 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
diff --git a/packages/sheets/src/facade/permission/f-range-permission.ts b/packages/sheets/src/facade/permission/f-range-permission.ts
index f8440e776d..cbd387a709 100644
--- a/packages/sheets/src/facade/permission/f-range-permission.ts
+++ b/packages/sheets/src/facade/permission/f-range-permission.ts
@@ -52,7 +52,8 @@ export class FRangePermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* // Check if the A1:B2 range is protected
* const isProtected = fRange.getRangePermission().isProtected();
@@ -77,7 +78,8 @@ export class FRangePermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* const rule = await fRange.getRangePermission().protect({
* name: 'My protected range',
@@ -172,7 +174,8 @@ export class FRangePermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* const result = await fRange.getRangePermission().unprotect();
* console.log(result);
@@ -200,7 +203,8 @@ export class FRangePermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* const rules = await fRange.getRangePermission().listRules();
* console.log(rules);
diff --git a/packages/sheets/src/facade/permission/f-range-protection-rule.ts b/packages/sheets/src/facade/permission/f-range-protection-rule.ts
index f3e95461c1..6105d778e7 100644
--- a/packages/sheets/src/facade/permission/f-range-protection-rule.ts
+++ b/packages/sheets/src/facade/permission/f-range-protection-rule.ts
@@ -80,7 +80,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* // Update the ranges to A1:C3 for the first rule
* if (rules.length > 0) {
@@ -141,7 +142,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* // Remove the first protection rule
* if (rules.length > 0) {
@@ -185,7 +187,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1:B2');
* // First, create a protection rule
* const rule = await fRange.getRangePermission().protect({ name: 'My Range', allowEdit: true });
@@ -235,7 +238,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* // Check if the first rule allows editing
* if (rules.length > 0) {
@@ -267,7 +271,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* // Check if the first rule allows editing
* const rule = rules[0];
@@ -288,7 +293,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* // Check if the first rule allows viewing
* const rule = rules[0];
@@ -309,7 +315,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* // Check if the first rule allows managing collaborators
* const rule = rules[0];
@@ -330,7 +337,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* // Check if the first rule allows deleting the rule
* const rule = rules[0];
@@ -351,7 +359,8 @@ export class FRangeProtectionRule {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* // Get the permission snapshot of the first rule
* if (rules.length > 0) {
diff --git a/packages/sheets/src/facade/permission/f-worksheet-permission.ts b/packages/sheets/src/facade/permission/f-worksheet-permission.ts
index 1d5c4ca797..cd54fd3916 100644
--- a/packages/sheets/src/facade/permission/f-worksheet-permission.ts
+++ b/packages/sheets/src/facade/permission/f-worksheet-permission.ts
@@ -87,7 +87,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* if (fWorksheet.getWorksheetPermission().isProtected()) {
* console.log('Worksheet is protected');
* }
@@ -106,7 +107,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const permission = fWorksheet.getWorksheetPermission();
*
* // Create worksheet protection with collaborators
@@ -194,7 +196,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* await fWorksheet.getWorksheetPermission().unprotect();
* ```
*/
@@ -225,7 +228,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* await fWorksheet.getWorksheetPermission().setMode('readOnly');
* ```
*/
@@ -278,7 +282,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* await fWorksheet.getWorksheetPermission().setReadOnly();
* ```
*/
@@ -292,7 +297,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* await fWorksheet.getWorksheetPermission().setEditable();
* ```
*/
@@ -309,7 +315,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const permission = fWorksheet.getWorksheetPermission();
* await permission.setPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow, false);
* ```
@@ -359,7 +366,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* if (fWorksheet.getWorksheetPermission().canEdit()) {
* console.log('Worksheet is editable');
* }
@@ -377,7 +385,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* // Check if cell C3 can be edited
* const fRange = fWorksheet.getRange('C3');
* const canEdit = fWorksheet.getWorksheetPermission().canEditCell(fRange.getRow(), fRange.getColumn());
@@ -421,7 +430,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* if (fWorksheet.getWorksheetPermission().canView()) {
* console.log('Worksheet is viewable');
* }
@@ -438,7 +448,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* // Check if cell C3 can be viewed
* const fRange = fWorksheet.getRange('C3');
* const canView = fWorksheet.getWorksheetPermission().canViewCell(fRange.getRow(), fRange.getColumn());
@@ -483,7 +494,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const permission = fWorksheet.getWorksheetPermission();
* const canInsertRow = permission.getPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow);
* console.log(canInsertRow);
@@ -507,7 +519,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const snapshot = fWorksheet.getWorksheetPermission().getSnapshot();
* console.log(snapshot);
* ```
@@ -527,7 +540,8 @@ export class FWorksheetPermission extends FBase {
* @returns {Promise<void>} A promise that resolves when the configuration is applied.
* @example
* ```ts
- * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
+ * const worksheet = univerAPI.getActiveWorkbook()?.getSheetByName('Sheet1');
+ * if (!worksheet) return;
* const permission = worksheet?.getWorksheetPermission();
* await permission?.applyConfig({
* mode: 'readOnly',
@@ -570,7 +584,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().protectRanges([
* {
* ranges: [fWorksheet.getRange('A1:B2')],
@@ -708,7 +723,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const worksheetPermission = fWorksheet.getWorksheetPermission();
* const rules = await worksheetPermission.listRangeProtectionRules();
* // Unprotect the first rule as an example
@@ -742,7 +758,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
* console.log(rules);
* ```
@@ -771,7 +788,8 @@ export class FWorksheetPermission extends FBase {
* @example
* ```ts
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* // Get debug info for cell C3
* const fRange = fWorksheet.getRange('C3');
* const debugInfo = await fWorksheet.getWorksheetPermission().debugCellPermission(fRange.getRow(), fRange.getColumn());
diff --git a/packages/ui/src/facade/f-shortcut.ts b/packages/ui/src/facade/f-shortcut.ts
index 9f96927dff..6e4b46b99c 100644
--- a/packages/ui/src/facade/f-shortcut.ts
+++ b/packages/ui/src/facade/f-shortcut.ts
@@ -79,7 +79,8 @@ export class FShortcut extends FBase {
* ```typescript
* // Assum the current sheet is empty sheet.
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1');
*
* // Set A1 cell active and set value to 'Hello Univer'.
diff --git a/packages/ui/src/facade/f-univer.ts b/packages/ui/src/facade/f-univer.ts
index 75af40604b..c305d50a4a 100644
--- a/packages/ui/src/facade/f-univer.ts
+++ b/packages/ui/src/facade/f-univer.ts
@@ -53,7 +53,8 @@ export interface IFUniverUIMixin {
*
* // Trigger a shortcut
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
* const fRange = fWorksheet.getRange('A1');
* fRange.activate();
* fRange.setValue('Hello Univer');
@@ -81,7 +82,8 @@ export interface IFUniverUIMixin {
* // this example listens for the cell click event and executes the copy and paste code.
* univerAPI.addEvent(univerAPI.Event.CellClicked, async (params) => {
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Copy the range A1:B2 to the clipboard
* const fRange = fWorksheet.getRange('A1:B2');
@@ -112,7 +114,8 @@ export interface IFUniverUIMixin {
* // this example listens for the cell click event and executes the copy and paste code.
* univerAPI.addEvent(univerAPI.Event.CellClicked, async (params) => {
* const fWorkbook = univerAPI.getActiveWorkbook();
- * const fWorksheet = fWorkbook.getActiveSheet();
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Copy the range A1:B2 to the clipboard
* const fRange = fWorksheet.getRange('A1:B2');
@@ -366,7 +369,8 @@ export interface IFUniverUIMixin {
* @returns {IDisposable} The disposable object.
* @example
* ```ts
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
+ * if (!fWorksheet) return;
*
* // Register a range loading component
* const RangeLoading = () => {