@univerjs/sheets 0.24.0 → 0.25.0-insiders.20260604-29ebbff

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/lib/cjs/facade.js +604 -464
  2. package/lib/cjs/index.js +146 -128
  3. package/lib/cjs/locale/ar-SA.js +52 -0
  4. package/lib/cjs/locale/ca-ES.js +36 -1
  5. package/lib/cjs/locale/de-DE.js +52 -0
  6. package/lib/cjs/locale/en-US.js +36 -1
  7. package/lib/cjs/locale/es-ES.js +36 -1
  8. package/lib/cjs/locale/fa-IR.js +36 -1
  9. package/lib/cjs/locale/fr-FR.js +36 -1
  10. package/lib/cjs/locale/id-ID.js +52 -0
  11. package/lib/cjs/locale/it-IT.js +52 -0
  12. package/lib/cjs/locale/ja-JP.js +36 -1
  13. package/lib/cjs/locale/ko-KR.js +36 -1
  14. package/lib/cjs/locale/pl-PL.js +52 -0
  15. package/lib/cjs/locale/pt-BR.js +52 -0
  16. package/lib/cjs/locale/ru-RU.js +36 -1
  17. package/lib/cjs/locale/sk-SK.js +36 -1
  18. package/lib/cjs/locale/vi-VN.js +36 -1
  19. package/lib/cjs/locale/zh-CN.js +36 -1
  20. package/lib/cjs/locale/zh-HK.js +52 -0
  21. package/lib/cjs/locale/zh-TW.js +36 -1
  22. package/lib/es/facade.js +605 -459
  23. package/lib/es/index.js +139 -129
  24. package/lib/es/locale/ar-SA.js +51 -0
  25. package/lib/es/locale/ca-ES.js +36 -1
  26. package/lib/es/locale/de-DE.js +51 -0
  27. package/lib/es/locale/en-US.js +36 -1
  28. package/lib/es/locale/es-ES.js +36 -1
  29. package/lib/es/locale/fa-IR.js +36 -1
  30. package/lib/es/locale/fr-FR.js +36 -1
  31. package/lib/es/locale/id-ID.js +51 -0
  32. package/lib/es/locale/it-IT.js +51 -0
  33. package/lib/es/locale/ja-JP.js +36 -1
  34. package/lib/es/locale/ko-KR.js +36 -1
  35. package/lib/es/locale/pl-PL.js +51 -0
  36. package/lib/es/locale/pt-BR.js +51 -0
  37. package/lib/es/locale/ru-RU.js +36 -1
  38. package/lib/es/locale/sk-SK.js +36 -1
  39. package/lib/es/locale/vi-VN.js +36 -1
  40. package/lib/es/locale/zh-CN.js +36 -1
  41. package/lib/es/locale/zh-HK.js +51 -0
  42. package/lib/es/locale/zh-TW.js +36 -1
  43. package/lib/facade.js +605 -459
  44. package/lib/index.js +139 -129
  45. package/lib/locale/ar-SA.js +51 -0
  46. package/lib/locale/ca-ES.js +36 -1
  47. package/lib/locale/de-DE.js +51 -0
  48. package/lib/locale/en-US.js +36 -1
  49. package/lib/locale/es-ES.js +36 -1
  50. package/lib/locale/fa-IR.js +36 -1
  51. package/lib/locale/fr-FR.js +36 -1
  52. package/lib/locale/id-ID.js +51 -0
  53. package/lib/locale/it-IT.js +51 -0
  54. package/lib/locale/ja-JP.js +36 -1
  55. package/lib/locale/ko-KR.js +36 -1
  56. package/lib/locale/pl-PL.js +51 -0
  57. package/lib/locale/pt-BR.js +51 -0
  58. package/lib/locale/ru-RU.js +36 -1
  59. package/lib/locale/sk-SK.js +36 -1
  60. package/lib/locale/vi-VN.js +36 -1
  61. package/lib/locale/zh-CN.js +36 -1
  62. package/lib/locale/zh-HK.js +51 -0
  63. package/lib/locale/zh-TW.js +36 -1
  64. package/lib/types/basics/utils.d.ts +2 -0
  65. package/lib/types/commands/commands/add-range-protection.command.d.ts +1 -1
  66. package/lib/types/commands/commands/delete-range-protection.command.d.ts +1 -1
  67. package/lib/types/commands/commands/register-range-theme.command.d.ts +1 -1
  68. package/lib/types/commands/commands/set-protection.command.d.ts +1 -1
  69. package/lib/types/commands/mutations/add-range-protection.mutation.d.ts +1 -1
  70. package/lib/types/commands/mutations/add-range-theme.mutation.d.ts +1 -1
  71. package/lib/types/commands/mutations/register-range-theme.mutation.d.ts +1 -1
  72. package/lib/types/commands/mutations/set-range-protection.mutation.d.ts +1 -1
  73. package/lib/types/commands/mutations/set-range-theme.mutation.d.ts +1 -1
  74. package/lib/types/controllers/permission/sheet-permission-check.controller.d.ts +1 -1
  75. package/lib/types/controllers/permission/sheet-permission-init.controller.d.ts +1 -1
  76. package/lib/types/controllers/permission/sheet-permission-view-model.controller.d.ts +1 -1
  77. package/lib/types/controllers/zebar-crossing.controller.d.ts +1 -1
  78. package/lib/types/facade/f-range.d.ts +184 -92
  79. package/lib/types/facade/f-selection.d.ts +15 -8
  80. package/lib/types/facade/f-univer.d.ts +33 -64
  81. package/lib/types/facade/f-workbook.d.ts +15 -50
  82. package/lib/types/facade/f-worksheet.d.ts +202 -101
  83. package/lib/types/facade/index.d.ts +0 -1
  84. package/lib/types/facade/permission/f-range-permission.d.ts +8 -4
  85. package/lib/types/facade/permission/f-range-protection-rule.d.ts +18 -9
  86. package/lib/types/facade/permission/f-worksheet-permission.d.ts +36 -18
  87. package/lib/types/index.d.ts +9 -8
  88. package/lib/types/{facade/f-sheet-hooks.d.ts → locale/ar-SA.d.ts} +3 -9
  89. package/lib/types/locale/de-DE.d.ts +18 -0
  90. package/lib/types/locale/en-US.d.ts +39 -0
  91. package/lib/types/locale/id-ID.d.ts +18 -0
  92. package/lib/types/locale/it-IT.d.ts +18 -0
  93. package/lib/types/locale/pl-PL.d.ts +18 -0
  94. package/lib/types/locale/pt-BR.d.ts +18 -0
  95. package/lib/types/locale/zh-HK.d.ts +18 -0
  96. package/lib/types/services/permission/range-permission/range-protection.ref-range.d.ts +3 -3
  97. package/lib/types/services/permission/range-permission/range-protection.service.d.ts +2 -2
  98. package/lib/types/services/permission/type.d.ts +1 -1
  99. package/lib/types/services/permission/workbook-permission/workbook-permission.service.d.ts +1 -1
  100. package/lib/types/services/permission/worksheet-permission/worksheet-permission.service.d.ts +1 -1
  101. package/lib/types/services/range-theme.service.d.ts +3 -3
  102. package/lib/umd/facade.js +1 -1
  103. package/lib/umd/index.js +2 -2
  104. package/lib/umd/locale/ar-SA.js +1 -0
  105. package/lib/umd/locale/ca-ES.js +1 -1
  106. package/lib/umd/locale/de-DE.js +1 -0
  107. package/lib/umd/locale/en-US.js +1 -1
  108. package/lib/umd/locale/es-ES.js +1 -1
  109. package/lib/umd/locale/fa-IR.js +1 -1
  110. package/lib/umd/locale/fr-FR.js +1 -1
  111. package/lib/umd/locale/id-ID.js +1 -0
  112. package/lib/umd/locale/it-IT.js +1 -0
  113. package/lib/umd/locale/ja-JP.js +1 -1
  114. package/lib/umd/locale/ko-KR.js +1 -1
  115. package/lib/umd/locale/pl-PL.js +1 -0
  116. package/lib/umd/locale/pt-BR.js +1 -0
  117. package/lib/umd/locale/ru-RU.js +1 -1
  118. package/lib/umd/locale/sk-SK.js +1 -1
  119. package/lib/umd/locale/vi-VN.js +1 -1
  120. package/lib/umd/locale/zh-CN.js +1 -1
  121. package/lib/umd/locale/zh-HK.js +1 -0
  122. package/lib/umd/locale/zh-TW.js +1 -1
  123. package/package.json +9 -9
  124. package/LICENSE +0 -176
  125. /package/lib/types/{model → models}/range-protection-render.model.d.ts +0 -0
  126. /package/lib/types/{model → models}/range-protection-rule.model.d.ts +0 -0
  127. /package/lib/types/{model → models}/range-protection.cache.d.ts +0 -0
  128. /package/lib/types/{model → models}/range-theme-model.d.ts +0 -0
  129. /package/lib/types/{model → models}/range-theme-util.d.ts +0 -0
  130. /package/lib/types/{model → models}/range-themes/build-in-theme.factory.d.ts +0 -0
  131. /package/lib/types/{model → models}/range-themes/default.d.ts +0 -0
  132. /package/lib/types/{model → models}/zebra-crossing-cache.d.ts +0 -0
package/lib/cjs/facade.js CHANGED
@@ -5,7 +5,7 @@ let _univerjs_sheets = require("@univerjs/sheets");
5
5
  let _univerjs_engine_formula = require("@univerjs/engine-formula");
6
6
  let _univerjs_protocol = require("@univerjs/protocol");
7
7
 
8
- //#region \0@oxc-project+runtime@0.129.0/helpers/typeof.js
8
+ //#region \0@oxc-project+runtime@0.133.0/helpers/esm/typeof.js
9
9
  function _typeof(o) {
10
10
  "@babel/helpers - typeof";
11
11
  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -16,7 +16,7 @@ function _typeof(o) {
16
16
  }
17
17
 
18
18
  //#endregion
19
- //#region \0@oxc-project+runtime@0.129.0/helpers/toPrimitive.js
19
+ //#region \0@oxc-project+runtime@0.133.0/helpers/esm/toPrimitive.js
20
20
  function toPrimitive(t, r) {
21
21
  if ("object" != _typeof(t) || !t) return t;
22
22
  var e = t[Symbol.toPrimitive];
@@ -29,14 +29,14 @@ function toPrimitive(t, r) {
29
29
  }
30
30
 
31
31
  //#endregion
32
- //#region \0@oxc-project+runtime@0.129.0/helpers/toPropertyKey.js
32
+ //#region \0@oxc-project+runtime@0.133.0/helpers/esm/toPropertyKey.js
33
33
  function toPropertyKey(t) {
34
34
  var i = toPrimitive(t, "string");
35
35
  return "symbol" == _typeof(i) ? i : i + "";
36
36
  }
37
37
 
38
38
  //#endregion
39
- //#region \0@oxc-project+runtime@0.129.0/helpers/defineProperty.js
39
+ //#region \0@oxc-project+runtime@0.133.0/helpers/esm/defineProperty.js
40
40
  function _defineProperty(e, r, t) {
41
41
  return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
42
42
  value: t,
@@ -47,7 +47,7 @@ function _defineProperty(e, r, t) {
47
47
  }
48
48
 
49
49
  //#endregion
50
- //#region \0@oxc-project+runtime@0.129.0/helpers/decorateParam.js
50
+ //#region \0@oxc-project+runtime@0.133.0/helpers/esm/decorateParam.js
51
51
  function __decorateParam(paramIndex, decorator) {
52
52
  return function(target, key) {
53
53
  decorator(target, key, paramIndex);
@@ -55,7 +55,7 @@ function __decorateParam(paramIndex, decorator) {
55
55
  }
56
56
 
57
57
  //#endregion
58
- //#region \0@oxc-project+runtime@0.129.0/helpers/decorate.js
58
+ //#region \0@oxc-project+runtime@0.133.0/helpers/esm/decorate.js
59
59
  function __decorate(decorators, target, key, desc) {
60
60
  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
61
61
  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -74,13 +74,13 @@ function __decorate(decorators, target, key, desc) {
74
74
  */
75
75
  function getDefinedNameFieldName(unitId, localeService, definedNamesService) {
76
76
  const definedNameMap = definedNamesService.getDefinedNameMap(unitId);
77
- if (definedNameMap == null) return localeService.t("definedName.defaultName") + 1;
77
+ if (definedNameMap == null) return localeService.t("sheets.definedName.defaultName") + 1;
78
78
  const count = Array.from(Object.values(definedNameMap)).length + 1;
79
- const name = localeService.t("definedName.defaultName") + count;
79
+ const name = localeService.t("sheets.definedName.defaultName") + count;
80
80
  if (definedNamesService.getValueByName(unitId, name) == null) return name;
81
81
  let i = count + 1;
82
82
  while (true) {
83
- const newName = localeService.t("definedName.defaultName") + i;
83
+ const newName = localeService.t("sheets.definedName.defaultName") + i;
84
84
  if (definedNamesService.getValueByName(unitId, newName) == null) return newName;
85
85
  i++;
86
86
  }
@@ -580,7 +580,8 @@ let FSelection = _FSelection = class FSelection {
580
580
  * @example
581
581
  * ```ts
582
582
  * const fWorkbook = univerAPI.getActiveWorkbook();
583
- * const fWorksheet = fWorkbook.getActiveSheet();
583
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
584
+ * if (!fWorksheet) return;
584
585
  * const fRange = fWorksheet.getRange('A10:B11');
585
586
  * fRange.activate();
586
587
  * const fSelection = fWorksheet.getSelection();
@@ -598,7 +599,8 @@ let FSelection = _FSelection = class FSelection {
598
599
  * @example
599
600
  * ```ts
600
601
  * const fWorkbook = univerAPI.getActiveWorkbook();
601
- * const fWorksheet = fWorkbook.getActiveSheet();
602
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
603
+ * if (!fWorksheet) return;
602
604
  * const fSelection = fWorksheet.getSelection();
603
605
  * const activeRangeList = fSelection.getActiveRangeList();
604
606
  * activeRangeList.forEach((range) => {
@@ -617,7 +619,8 @@ let FSelection = _FSelection = class FSelection {
617
619
  * @example
618
620
  * ```ts
619
621
  * const fWorkbook = univerAPI.getActiveWorkbook();
620
- * const fWorksheet = fWorkbook.getActiveSheet();
622
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
623
+ * if (!fWorksheet) return;
621
624
  * const fRange = fWorksheet.getRange('A10:B11');
622
625
  * fRange.activate();
623
626
  * const fSelection = fWorksheet.getSelection();
@@ -638,10 +641,11 @@ let FSelection = _FSelection = class FSelection {
638
641
  * @example
639
642
  * ```ts
640
643
  * const fWorkbook = univerAPI.getActiveWorkbook();
641
- * const fWorksheet = fWorkbook.getActiveSheet();
644
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
645
+ * if (!fWorksheet) return;
642
646
  * const fSelection = fWorksheet.getSelection();
643
647
  * const activeSheet = fSelection.getActiveSheet();
644
- * console.log(activeSheet.equalTo(fWorksheet)); // true
648
+ * console.log(activeSheet.equalTo(fWorksheet));
645
649
  * ```
646
650
  */
647
651
  getActiveSheet() {
@@ -655,7 +659,8 @@ let FSelection = _FSelection = class FSelection {
655
659
  * @example
656
660
  * ```ts
657
661
  * const fWorkbook = univerAPI.getActiveWorkbook();
658
- * const fWorksheet = fWorkbook.getActiveSheet();
662
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
663
+ * if (!fWorksheet) return;
659
664
  * const fRange = fWorksheet.getRange('A10:B11');
660
665
  * fRange.activate();
661
666
  * const cell = fWorksheet.getRange('B11');
@@ -706,7 +711,8 @@ let FSelection = _FSelection = class FSelection {
706
711
  * @example
707
712
  * ```ts
708
713
  * const fWorkbook = univerAPI.getActiveWorkbook();
709
- * const fWorksheet = fWorkbook.getActiveSheet();
714
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
715
+ * if (!fWorksheet) return;
710
716
  * // make sure the active cell is A1 and selection is A1:B2
711
717
  * const fRange = fWorksheet.getRange('A1:B2');
712
718
  * fRange.activate();
@@ -1051,7 +1057,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1051
1057
  * @example
1052
1058
  * ```ts
1053
1059
  * const fWorkbook = univerAPI.getActiveWorkbook();
1054
- * const fWorksheet = fWorkbook.getActiveSheet();
1060
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1061
+ * if (!fWorksheet) return;
1055
1062
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1056
1063
  * // Update the ranges to A1:C3 for the first rule
1057
1064
  * if (rules.length > 0) {
@@ -1087,7 +1094,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1087
1094
  * @example
1088
1095
  * ```ts
1089
1096
  * const fWorkbook = univerAPI.getActiveWorkbook();
1090
- * const fWorksheet = fWorkbook.getActiveSheet();
1097
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1098
+ * if (!fWorksheet) return;
1091
1099
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1092
1100
  * // Remove the first protection rule
1093
1101
  * if (rules.length > 0) {
@@ -1126,7 +1134,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1126
1134
  * @example
1127
1135
  * ```ts
1128
1136
  * const fWorkbook = univerAPI.getActiveWorkbook();
1129
- * const fWorksheet = fWorkbook.getActiveSheet();
1137
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1138
+ * if (!fWorksheet) return;
1130
1139
  * const fRange = fWorksheet.getRange('A1:B2');
1131
1140
  * // First, create a protection rule
1132
1141
  * const rule = await fRange.getRangePermission().protect({ name: 'My Range', allowEdit: true });
@@ -1164,7 +1173,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1164
1173
  * @example
1165
1174
  * ```ts
1166
1175
  * const fWorkbook = univerAPI.getActiveWorkbook();
1167
- * const fWorksheet = fWorkbook.getActiveSheet();
1176
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1177
+ * if (!fWorksheet) return;
1168
1178
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1169
1179
  * // Check if the first rule allows editing
1170
1180
  * if (rules.length > 0) {
@@ -1191,7 +1201,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1191
1201
  * @example
1192
1202
  * ```ts
1193
1203
  * const fWorkbook = univerAPI.getActiveWorkbook();
1194
- * const fWorksheet = fWorkbook.getActiveSheet();
1204
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1205
+ * if (!fWorksheet) return;
1195
1206
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1196
1207
  * // Check if the first rule allows editing
1197
1208
  * const rule = rules[0];
@@ -1209,7 +1220,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1209
1220
  * @example
1210
1221
  * ```ts
1211
1222
  * const fWorkbook = univerAPI.getActiveWorkbook();
1212
- * const fWorksheet = fWorkbook.getActiveSheet();
1223
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1224
+ * if (!fWorksheet) return;
1213
1225
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1214
1226
  * // Check if the first rule allows viewing
1215
1227
  * const rule = rules[0];
@@ -1227,7 +1239,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1227
1239
  * @example
1228
1240
  * ```ts
1229
1241
  * const fWorkbook = univerAPI.getActiveWorkbook();
1230
- * const fWorksheet = fWorkbook.getActiveSheet();
1242
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1243
+ * if (!fWorksheet) return;
1231
1244
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1232
1245
  * // Check if the first rule allows managing collaborators
1233
1246
  * const rule = rules[0];
@@ -1245,7 +1258,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1245
1258
  * @example
1246
1259
  * ```ts
1247
1260
  * const fWorkbook = univerAPI.getActiveWorkbook();
1248
- * const fWorksheet = fWorkbook.getActiveSheet();
1261
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1262
+ * if (!fWorksheet) return;
1249
1263
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1250
1264
  * // Check if the first rule allows deleting the rule
1251
1265
  * const rule = rules[0];
@@ -1263,7 +1277,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
1263
1277
  * @example
1264
1278
  * ```ts
1265
1279
  * const fWorkbook = univerAPI.getActiveWorkbook();
1266
- * const fWorksheet = fWorkbook.getActiveSheet();
1280
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1281
+ * if (!fWorksheet) return;
1267
1282
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1268
1283
  * // Get the permission snapshot of the first rule
1269
1284
  * if (rules.length > 0) {
@@ -1313,7 +1328,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1313
1328
  * @example
1314
1329
  * ```ts
1315
1330
  * const fWorkbook = univerAPI.getActiveWorkbook();
1316
- * const fWorksheet = fWorkbook.getActiveSheet();
1331
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1332
+ * if (!fWorksheet) return;
1317
1333
  * if (fWorksheet.getWorksheetPermission().isProtected()) {
1318
1334
  * console.log('Worksheet is protected');
1319
1335
  * }
@@ -1330,7 +1346,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1330
1346
  * @example
1331
1347
  * ```ts
1332
1348
  * const fWorkbook = univerAPI.getActiveWorkbook();
1333
- * const fWorksheet = fWorkbook.getActiveSheet();
1349
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1350
+ * if (!fWorksheet) return;
1334
1351
  * const permission = fWorksheet.getWorksheetPermission();
1335
1352
  *
1336
1353
  * // Create worksheet protection with collaborators
@@ -1408,7 +1425,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1408
1425
  * @example
1409
1426
  * ```ts
1410
1427
  * const fWorkbook = univerAPI.getActiveWorkbook();
1411
- * const fWorksheet = fWorkbook.getActiveSheet();
1428
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1429
+ * if (!fWorksheet) return;
1412
1430
  * await fWorksheet.getWorksheetPermission().unprotect();
1413
1431
  * ```
1414
1432
  */
@@ -1433,7 +1451,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1433
1451
  * @example
1434
1452
  * ```ts
1435
1453
  * const fWorkbook = univerAPI.getActiveWorkbook();
1436
- * const fWorksheet = fWorkbook.getActiveSheet();
1454
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1455
+ * if (!fWorksheet) return;
1437
1456
  * await fWorksheet.getWorksheetPermission().setMode('readOnly');
1438
1457
  * ```
1439
1458
  */
@@ -1473,7 +1492,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1473
1492
  * @example
1474
1493
  * ```ts
1475
1494
  * const fWorkbook = univerAPI.getActiveWorkbook();
1476
- * const fWorksheet = fWorkbook.getActiveSheet();
1495
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1496
+ * if (!fWorksheet) return;
1477
1497
  * await fWorksheet.getWorksheetPermission().setReadOnly();
1478
1498
  * ```
1479
1499
  */
@@ -1486,7 +1506,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1486
1506
  * @example
1487
1507
  * ```ts
1488
1508
  * const fWorkbook = univerAPI.getActiveWorkbook();
1489
- * const fWorksheet = fWorkbook.getActiveSheet();
1509
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1510
+ * if (!fWorksheet) return;
1490
1511
  * await fWorksheet.getWorksheetPermission().setEditable();
1491
1512
  * ```
1492
1513
  */
@@ -1502,7 +1523,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1502
1523
  * @example
1503
1524
  * ```ts
1504
1525
  * const fWorkbook = univerAPI.getActiveWorkbook();
1505
- * const fWorksheet = fWorkbook.getActiveSheet();
1526
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1527
+ * if (!fWorksheet) return;
1506
1528
  * const permission = fWorksheet.getWorksheetPermission();
1507
1529
  * await permission.setPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow, false);
1508
1530
  * ```
@@ -1537,7 +1559,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1537
1559
  * @example
1538
1560
  * ```ts
1539
1561
  * const fWorkbook = univerAPI.getActiveWorkbook();
1540
- * const fWorksheet = fWorkbook.getActiveSheet();
1562
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1563
+ * if (!fWorksheet) return;
1541
1564
  * if (fWorksheet.getWorksheetPermission().canEdit()) {
1542
1565
  * console.log('Worksheet is editable');
1543
1566
  * }
@@ -1554,7 +1577,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1554
1577
  * @example
1555
1578
  * ```ts
1556
1579
  * const fWorkbook = univerAPI.getActiveWorkbook();
1557
- * const fWorksheet = fWorkbook.getActiveSheet();
1580
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1581
+ * if (!fWorksheet) return;
1558
1582
  * // Check if cell C3 can be edited
1559
1583
  * const fRange = fWorksheet.getRange('C3');
1560
1584
  * const canEdit = fWorksheet.getWorksheetPermission().canEditCell(fRange.getRow(), fRange.getColumn());
@@ -1578,7 +1602,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1578
1602
  * @example
1579
1603
  * ```ts
1580
1604
  * const fWorkbook = univerAPI.getActiveWorkbook();
1581
- * const fWorksheet = fWorkbook.getActiveSheet();
1605
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1606
+ * if (!fWorksheet) return;
1582
1607
  * if (fWorksheet.getWorksheetPermission().canView()) {
1583
1608
  * console.log('Worksheet is viewable');
1584
1609
  * }
@@ -1594,7 +1619,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1594
1619
  * @example
1595
1620
  * ```ts
1596
1621
  * const fWorkbook = univerAPI.getActiveWorkbook();
1597
- * const fWorksheet = fWorkbook.getActiveSheet();
1622
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1623
+ * if (!fWorksheet) return;
1598
1624
  * // Check if cell C3 can be viewed
1599
1625
  * const fRange = fWorksheet.getRange('C3');
1600
1626
  * const canView = fWorksheet.getWorksheetPermission().canViewCell(fRange.getRow(), fRange.getColumn());
@@ -1619,7 +1645,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1619
1645
  * @example
1620
1646
  * ```ts
1621
1647
  * const fWorkbook = univerAPI.getActiveWorkbook();
1622
- * const fWorksheet = fWorkbook.getActiveSheet();
1648
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1649
+ * if (!fWorksheet) return;
1623
1650
  * const permission = fWorksheet.getWorksheetPermission();
1624
1651
  * const canInsertRow = permission.getPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow);
1625
1652
  * console.log(canInsertRow);
@@ -1639,7 +1666,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1639
1666
  * @example
1640
1667
  * ```ts
1641
1668
  * const fWorkbook = univerAPI.getActiveWorkbook();
1642
- * const fWorksheet = fWorkbook.getActiveSheet();
1669
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1670
+ * if (!fWorksheet) return;
1643
1671
  * const snapshot = fWorksheet.getWorksheetPermission().getSnapshot();
1644
1672
  * console.log(snapshot);
1645
1673
  * ```
@@ -1658,7 +1686,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1658
1686
  * @returns {Promise<void>} A promise that resolves when the configuration is applied.
1659
1687
  * @example
1660
1688
  * ```ts
1661
- * const worksheet = univerAPI.getActiveWorkbook()?.getActiveSheet();
1689
+ * const worksheet = univerAPI.getActiveWorkbook()?.getSheetByName('Sheet1');
1690
+ * if (!worksheet) return;
1662
1691
  * const permission = worksheet?.getWorksheetPermission();
1663
1692
  * await permission?.applyConfig({
1664
1693
  * mode: 'readOnly',
@@ -1689,7 +1718,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1689
1718
  * @example
1690
1719
  * ```ts
1691
1720
  * const fWorkbook = univerAPI.getActiveWorkbook();
1692
- * const fWorksheet = fWorkbook.getActiveSheet();
1721
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1722
+ * if (!fWorksheet) return;
1693
1723
  * const rules = await fWorksheet.getWorksheetPermission().protectRanges([
1694
1724
  * {
1695
1725
  * ranges: [fWorksheet.getRange('A1:B2')],
@@ -1778,7 +1808,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1778
1808
  * @example
1779
1809
  * ```ts
1780
1810
  * const fWorkbook = univerAPI.getActiveWorkbook();
1781
- * const fWorksheet = fWorkbook.getActiveSheet();
1811
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1812
+ * if (!fWorksheet) return;
1782
1813
  * const worksheetPermission = fWorksheet.getWorksheetPermission();
1783
1814
  * const rules = await worksheetPermission.listRangeProtectionRules();
1784
1815
  * // Unprotect the first rule as an example
@@ -1804,7 +1835,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1804
1835
  * @example
1805
1836
  * ```ts
1806
1837
  * const fWorkbook = univerAPI.getActiveWorkbook();
1807
- * const fWorksheet = fWorkbook.getActiveSheet();
1838
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1839
+ * if (!fWorksheet) return;
1808
1840
  * const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
1809
1841
  * console.log(rules);
1810
1842
  * ```
@@ -1823,7 +1855,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
1823
1855
  * @example
1824
1856
  * ```ts
1825
1857
  * const fWorkbook = univerAPI.getActiveWorkbook();
1826
- * const fWorksheet = fWorkbook.getActiveSheet();
1858
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
1859
+ * if (!fWorksheet) return;
1827
1860
  * // Get debug info for cell C3
1828
1861
  * const fRange = fWorksheet.getRange('C3');
1829
1862
  * const debugInfo = await fWorksheet.getWorksheetPermission().debugCellPermission(fRange.getRow(), fRange.getColumn());
@@ -1983,7 +2016,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
1983
2016
  * @returns This sheet, for chaining
1984
2017
  * @example
1985
2018
  * ```ts
1986
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
2019
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2020
+ * if (!fWorkSheet) return;
1987
2021
  * fWorkSheet.setActiveSelection(fWorkSheet.getRange('A10:B10'));
1988
2022
  * ```
1989
2023
  */
@@ -2002,7 +2036,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2002
2036
  * @returns {Worksheet} The worksheet instance.
2003
2037
  * @example
2004
2038
  * ```typescript
2005
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2039
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2040
+ * if (!fWorksheet) return;
2006
2041
  * const sheet = fWorksheet.getSheet();
2007
2042
  * console.log(sheet);
2008
2043
  * ```
@@ -2015,7 +2050,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2015
2050
  * @returns {Injector} The injector instance.
2016
2051
  * @example
2017
2052
  * ```typescript
2018
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2053
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2054
+ * if (!fWorksheet) return;
2019
2055
  * const injector = fWorksheet.getInject();
2020
2056
  * console.log(injector);
2021
2057
  * ```
@@ -2028,7 +2064,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2028
2064
  * @returns {Workbook} The workbook instance.
2029
2065
  * @example
2030
2066
  * ```typescript
2031
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2067
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2068
+ * if (!fWorksheet) return;
2032
2069
  * const workbook = fWorksheet.getWorkbook();
2033
2070
  * console.log(workbook);
2034
2071
  * ```
@@ -2041,7 +2078,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2041
2078
  * @returns {string} The id of the worksheet.
2042
2079
  * @example
2043
2080
  * ```typescript
2044
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2081
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2082
+ * if (!fWorksheet) return;
2045
2083
  * const sheetId = fWorksheet.getSheetId();
2046
2084
  * console.log(sheetId);
2047
2085
  * ```
@@ -2054,7 +2092,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2054
2092
  * @returns {string} The name of the worksheet.
2055
2093
  * @example
2056
2094
  * ```typescript
2057
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2095
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2096
+ * if (!fWorksheet) return;
2058
2097
  * const sheetName = fWorksheet.getSheetName();
2059
2098
  * console.log(sheetName);
2060
2099
  * ```
@@ -2067,7 +2106,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2067
2106
  * @returns {FSelection} return the current selections of the worksheet or null if there is no selection.
2068
2107
  * @example
2069
2108
  * ```typescript
2070
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2109
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2110
+ * if (!fWorksheet) return;
2071
2111
  * const selection = fWorksheet.getSelection();
2072
2112
  * console.log(selection);
2073
2113
  * ```
@@ -2082,7 +2122,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2082
2122
  * @returns {IStyleData} Default style of the worksheet.
2083
2123
  * @example
2084
2124
  * ```typescript
2085
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2125
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2126
+ * if (!fWorksheet) return;
2086
2127
  * const defaultStyle = fWorksheet.getDefaultStyle();
2087
2128
  * console.log(defaultStyle);
2088
2129
  * ```
@@ -2097,7 +2138,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2097
2138
  * @returns {(Nullable<IStyleData> | string)} The default style of the worksheet row name or style data
2098
2139
  * @example
2099
2140
  * ```typescript
2100
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2141
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2142
+ * if (!fWorksheet) return;
2101
2143
  * // Get default style for row 0 (1)
2102
2144
  * const rowStyle = fWorksheet.getRowDefaultStyle(0);
2103
2145
  * console.log(rowStyle);
@@ -2116,7 +2158,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2116
2158
  * @returns {(Nullable<IStyleData> | string)} The default style of the worksheet column name or style data
2117
2159
  * @example
2118
2160
  * ```typescript
2119
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2161
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2162
+ * if (!fWorksheet) return;
2120
2163
  * // Get default style for column 0 (A)
2121
2164
  * const colStyle = fWorksheet.getColumnDefaultStyle(0);
2122
2165
  * console.log(colStyle);
@@ -2134,7 +2177,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2134
2177
  * @returns {FWorksheet} This worksheet instance for chaining
2135
2178
  * @example
2136
2179
  * ```typescript
2137
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2180
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2181
+ * if (!fWorksheet) return;
2138
2182
  * fWorksheet.setDefaultStyle('default');
2139
2183
  * // or
2140
2184
  * // fWorksheet.setDefaultStyle({fs: 12, ff: 'Arial'});
@@ -2159,7 +2203,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2159
2203
  * @example
2160
2204
  * ```ts
2161
2205
  * const fWorkbook = univerAPI.getActiveWorkbook();
2162
- * const fWorksheet = fWorkbook.getActiveSheet();
2206
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
2207
+ * if (!fWorksheet) return;
2163
2208
  * fWorksheet.setColumnDefaultStyle(0, 'default');
2164
2209
  * // or
2165
2210
  * // fWorksheet.setColumnDefaultStyle(0, {fs: 12, ff: 'Arial'});
@@ -2182,7 +2227,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2182
2227
  * @example
2183
2228
  * ```ts
2184
2229
  * const fWorkbook = univerAPI.getActiveWorkbook();
2185
- * const fWorksheet = fWorkbook.getActiveSheet();
2230
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
2231
+ * if (!fWorksheet) return;
2186
2232
  * fWorksheet.setRowDefaultStyle(0, 'default');
2187
2233
  * // or
2188
2234
  * // fWorksheet.setRowDefaultStyle(0, {fs: 12, ff: 'Arial'});
@@ -2236,7 +2282,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2236
2282
  * @returns {number} The maximum columns count of the sheet
2237
2283
  * @example
2238
2284
  * ```typescript
2239
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2285
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2286
+ * if (!fWorksheet) return;
2240
2287
  * const totalColumns = fWorksheet.getMaxColumns();
2241
2288
  * console.log(`Sheet has ${totalColumns} columns`);
2242
2289
  * ```
@@ -2249,7 +2296,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2249
2296
  * @returns {number}The maximum rows count of the sheet
2250
2297
  * @example
2251
2298
  * ```typescript
2252
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2299
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2300
+ * if (!fWorksheet) return;
2253
2301
  * const totalRows = fWorksheet.getMaxRows();
2254
2302
  * console.log(`Sheet has ${totalRows} rows`);
2255
2303
  * ```
@@ -2263,7 +2311,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2263
2311
  * @returns {FWorksheet} This sheet, for chaining.
2264
2312
  * @example
2265
2313
  * ```typescript
2266
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2314
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2315
+ * if (!fWorksheet) return;
2267
2316
  * // Insert a row after the third row
2268
2317
  * fWorksheet.insertRowAfter(2);
2269
2318
  * // Insert a row after the first row
@@ -2279,7 +2328,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2279
2328
  * @returns {FWorksheet} This sheet, for chaining.
2280
2329
  * @example
2281
2330
  * ```typescript
2282
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2331
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2332
+ * if (!fWorksheet) return;
2283
2333
  * // Insert a row before the third row
2284
2334
  * fWorksheet.insertRowBefore(2);
2285
2335
  * // Insert a row before the first row
@@ -2296,7 +2346,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2296
2346
  * @returns {FWorksheet} This sheet, for chaining.
2297
2347
  * @example
2298
2348
  * ```typescript
2299
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2349
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2350
+ * if (!fWorksheet) return;
2300
2351
  * // Insert 3 rows before the third row
2301
2352
  * fWorksheet.insertRows(2, 3);
2302
2353
  * // Insert 1 row before the first row
@@ -2313,7 +2364,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2313
2364
  * @returns {FWorksheet} This sheet, for chaining.
2314
2365
  * @example
2315
2366
  * ```typescript
2316
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2367
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2368
+ * if (!fWorksheet) return;
2317
2369
  * // Insert 3 rows after the third row
2318
2370
  * fWorksheet.insertRowsAfter(2, 3);
2319
2371
  * // Insert 1 row after the first row
@@ -2350,7 +2402,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2350
2402
  * @returns {FWorksheet} This sheet, for chaining.
2351
2403
  * @example
2352
2404
  * ```typescript
2353
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2405
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2406
+ * if (!fWorksheet) return;
2354
2407
  * // Insert 3 rows before the third row
2355
2408
  * fWorksheet.insertRowsBefore(2, 3);
2356
2409
  * // Insert 1 row before the first row
@@ -2386,7 +2439,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2386
2439
  * @returns {FWorksheet} This sheet, for chaining.
2387
2440
  * @example
2388
2441
  * ```typescript
2389
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2442
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2443
+ * if (!fWorksheet) return;
2390
2444
  * // Delete the third row
2391
2445
  * fWorksheet.deleteRow(2);
2392
2446
  * // Delete the first row
@@ -2403,7 +2457,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2403
2457
  * @returns {FWorksheet} This sheet, for chaining.
2404
2458
  * @example
2405
2459
  * ```typescript
2406
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2460
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2461
+ * if (!fWorksheet) return;
2407
2462
  * // Delete 3 rows at row index 2 (rows 3-5)
2408
2463
  * fWorksheet.deleteRows(2, 3);
2409
2464
  * // Delete 1 row at row index 0 (first row)
@@ -2430,7 +2485,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2430
2485
  * @returns {FWorksheet} This sheet, for chaining.
2431
2486
  * @example
2432
2487
  * ```typescript
2433
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2488
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2489
+ * if (!fWorksheet) return;
2434
2490
  * // Delete rows at index 2, and range from index 4 to 6 (rows 3, 5-7)
2435
2491
  * fWorksheet.deleteRowsByPoints([2, [4, 6]]);
2436
2492
  * ```
@@ -2448,7 +2504,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2448
2504
  * @returns {FWorksheet} This sheet, for chaining.
2449
2505
  * @example
2450
2506
  * ```typescript
2451
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2507
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2508
+ * if (!fWorksheet) return;
2452
2509
  * // Move 3 rows at row index 2 (rows 3-5) to row index 0
2453
2510
  * const rowSpec1 = fWorksheet.getRange('3:5');
2454
2511
  * fWorksheet.moveRows(rowSpec1, 0);
@@ -2483,7 +2540,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2483
2540
  * @returns {FWorksheet} This sheet, for chaining.
2484
2541
  * @example
2485
2542
  * ```typescript
2486
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2543
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2544
+ * if (!fWorksheet) return;
2487
2545
  * // Hide 3 rows starting from row index 1 (rows 2-4)
2488
2546
  * const row1 = fWorksheet.getRange('2:4');
2489
2547
  * fWorksheet.hideRow(row1);
@@ -2510,7 +2568,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2510
2568
  * @returns {FWorksheet} This sheet, for chaining.
2511
2569
  * @example
2512
2570
  * ```typescript
2513
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2571
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2572
+ * if (!fWorksheet) return;
2514
2573
  * // Hide 3 rows starting from row index 1 (rows 2-4)
2515
2574
  * fWorksheet.hideRows(1, 3);
2516
2575
  * // Hide single row at index 0 (first row)
@@ -2540,7 +2599,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2540
2599
  * @returns {FWorksheet} This sheet, for chaining.
2541
2600
  * @example
2542
2601
  * ```typescript
2543
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2602
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2603
+ * if (!fWorksheet) return;
2544
2604
  * // Unhide 3 rows starting from row index 1 (rows 2-4)
2545
2605
  * const row1 = fWorksheet.getRange('2:4');
2546
2606
  * fWorksheet.unhideRow(row1);
@@ -2567,7 +2627,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2567
2627
  * @returns {FWorksheet} This worksheet instance for chaining
2568
2628
  * @example
2569
2629
  * ```typescript
2570
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2630
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2631
+ * if (!fWorksheet) return;
2571
2632
  * // Show 3 rows starting from row index 1 (rows 2-4)
2572
2633
  * fWorksheet.showRows(1, 3);
2573
2634
  * // Show single row at index 0 (first row)
@@ -2598,7 +2659,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2598
2659
  * @returns {FWorksheet} This worksheet instance for chaining
2599
2660
  * @example
2600
2661
  * ```typescript
2601
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2662
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2663
+ * if (!fWorksheet) return;
2602
2664
  * // Set the height of the second row to 30 pixels
2603
2665
  * fWorksheet.setRowHeight(1, 30);
2604
2666
  * // Set the height of the first row to 20 pixels
@@ -2615,7 +2677,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2615
2677
  * @returns {FWorksheet} This worksheet instance for chaining
2616
2678
  * @example
2617
2679
  * ```ts
2618
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
2680
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2681
+ * if (!fWorkSheet) return;
2619
2682
  * fWorkSheet.autoFitRow(24);
2620
2683
  * ```
2621
2684
  */
@@ -2651,7 +2714,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2651
2714
  * @returns {FWorksheet} This worksheet instance for chaining
2652
2715
  * @example
2653
2716
  * ```typescript
2654
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2717
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2718
+ * if (!fWorksheet) return;
2655
2719
  * fWorksheet.setRowHeights(1, 10, 30);
2656
2720
  * ```
2657
2721
  */
@@ -2693,7 +2757,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2693
2757
  * @example
2694
2758
  * ```typescript
2695
2759
  * const fWorkbook = univerAPI.getActiveWorkbook();
2696
- * const fWorksheet = fWorkbook.getActiveSheet();
2760
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
2761
+ * if (!fWorksheet) return;
2697
2762
  *
2698
2763
  * // Set the value of the cell A1 to 'Hello, Univer!', set the font size to 30 and font weight to bold
2699
2764
  * const fRange = fWorksheet.getRange('A1');
@@ -2713,7 +2778,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2713
2778
  * @returns {FWorksheet} This worksheet instance for chaining
2714
2779
  * @example
2715
2780
  * ```typescript
2716
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2781
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2782
+ * if (!fWorksheet) return;
2717
2783
  * fWorksheet.setRowAutoHeight(1, 10);
2718
2784
  * ```
2719
2785
  */
@@ -2739,7 +2805,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2739
2805
  * @returns {FWorksheet} This worksheet instance for chaining
2740
2806
  * @example
2741
2807
  * ```typescript
2742
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2808
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2809
+ * if (!fWorksheet) return;
2743
2810
  * const ranges = [
2744
2811
  * { startRow: 1, endRow: 10, startColumn: 0, endColumn: 10 },
2745
2812
  * { startRow: 11, endRow: 20, startColumn: 0, endColumn: 10 },
@@ -2765,7 +2832,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2765
2832
  * @returns {FWorksheet} This worksheet instance for chaining
2766
2833
  * @example
2767
2834
  * ```typescript
2768
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2835
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2836
+ * if (!fWorksheet) return;
2769
2837
  * fWorksheet.setRowHeightsForced(1, 10, 30);
2770
2838
  * ```
2771
2839
  */
@@ -2792,7 +2860,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2792
2860
  * @returns {FWorksheet} This worksheet instance for chaining
2793
2861
  * @example
2794
2862
  * ```typescript
2795
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
2863
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2864
+ * if (!fWorkSheet) return;
2796
2865
  * fWorkSheet.setRowCustom({ 0: { key: 'value' } });
2797
2866
  * ```
2798
2867
  */
@@ -2815,7 +2884,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2815
2884
  * @returns {FWorksheet} This worksheet instance for chaining
2816
2885
  * @example
2817
2886
  * ```typescript
2818
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2887
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2888
+ * if (!fWorksheet) return;
2819
2889
  * // Insert a column after column C
2820
2890
  * fWorksheet.insertColumnAfter(2);
2821
2891
  * // Insert a column after column A
@@ -2831,7 +2901,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2831
2901
  * @returns {FWorksheet} This worksheet instance for chaining
2832
2902
  * @example
2833
2903
  * ```typescript
2834
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2904
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2905
+ * if (!fWorksheet) return;
2835
2906
  * // Insert a column before column C
2836
2907
  * fWorksheet.insertColumnBefore(2);
2837
2908
  * // Insert a column before column A
@@ -2848,7 +2919,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2848
2919
  * @returns {FWorksheet} This sheet, for chaining
2849
2920
  * @example
2850
2921
  * ```typescript
2851
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2922
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2923
+ * if (!fWorksheet) return;
2852
2924
  * // Insert 3 columns before column C
2853
2925
  * fWorksheet.insertColumns(2, 3);
2854
2926
  * // Insert 1 column before column A
@@ -2865,7 +2937,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2865
2937
  * @returns {FWorksheet} This sheet, for chaining
2866
2938
  * @example
2867
2939
  * ```typescript
2868
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2940
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2941
+ * if (!fWorksheet) return;
2869
2942
  * // Insert 3 columns after column C
2870
2943
  * fWorksheet.insertColumnsAfter(2, 3);
2871
2944
  * // Insert 1 column after column A
@@ -2902,7 +2975,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2902
2975
  * @returns {FWorksheet} This sheet, for chaining
2903
2976
  * @example
2904
2977
  * ```typescript
2905
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
2978
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
2979
+ * if (!fWorksheet) return;
2906
2980
  * // Insert 3 columns before column C
2907
2981
  * fWorksheet.insertColumnsBefore(2, 3);
2908
2982
  * // Insert 1 column before column A
@@ -2938,7 +3012,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2938
3012
  * @returns {FWorksheet} This sheet, for chaining
2939
3013
  * @example
2940
3014
  * ```typescript
2941
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3015
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3016
+ * if (!fWorksheet) return;
2942
3017
  * // Delete column C
2943
3018
  * fWorksheet.deleteColumn(2);
2944
3019
  * // Delete column A
@@ -2955,7 +3030,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2955
3030
  * @returns {FWorksheet} This sheet, for chaining
2956
3031
  * @example
2957
3032
  * ```typescript
2958
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3033
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3034
+ * if (!fWorksheet) return;
2959
3035
  * // Delete 3 columns at column index 2 (columns C, D, E)
2960
3036
  * fWorksheet.deleteColumns(2, 3);
2961
3037
  * // Delete 1 column at column index 0 (column A)
@@ -2982,7 +3058,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
2982
3058
  * @returns {FWorksheet} This sheet, for chaining
2983
3059
  * @example
2984
3060
  * ```typescript
2985
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3061
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3062
+ * if (!fWorksheet) return;
2986
3063
  * // Delete columns at index 2, and range from index 4 to 6 (columns C, E-G)
2987
3064
  * fWorksheet.deleteColumnsByPoints([2, [4, 6]]);
2988
3065
  * ```
@@ -3000,7 +3077,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3000
3077
  * @returns {FWorksheet} This sheet, for chaining
3001
3078
  * @example
3002
3079
  * ```typescript
3003
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3080
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3081
+ * if (!fWorksheet) return;
3004
3082
  * // Move columns C, D, E to column index 2 (columns B, C, D)
3005
3083
  * const columnSpec1 = fWorksheet.getRange('C:E');
3006
3084
  * fWorksheet.moveColumns(columnSpec1, 1);
@@ -3035,7 +3113,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3035
3113
  * @returns {FWorksheet} This sheet, for chaining
3036
3114
  * @example
3037
3115
  * ```typescript
3038
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3116
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3117
+ * if (!fWorksheet) return;
3039
3118
  * // Hide columns C, D, E
3040
3119
  * const column1 = fWorksheet.getRange('C:E');
3041
3120
  * fWorksheet.hideColumn(column1);
@@ -3062,7 +3141,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3062
3141
  * @returns {FWorksheet} This sheet, for chaining
3063
3142
  * @example
3064
3143
  * ```typescript
3065
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3144
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3145
+ * if (!fWorksheet) return;
3066
3146
  * // Hide columns C, D, E
3067
3147
  * fWorksheet.hideColumns(2, 3);
3068
3148
  * // Hide column A
@@ -3092,7 +3172,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3092
3172
  * @returns {FWorksheet} This sheet, for chaining
3093
3173
  * @example
3094
3174
  * ```typescript
3095
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3175
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3176
+ * if (!fWorksheet) return;
3096
3177
  * // Unhide columns C, D, E
3097
3178
  * const column1 = fWorksheet.getRange('C:E');
3098
3179
  * fWorksheet.unhideColumn(column1);
@@ -3119,7 +3200,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3119
3200
  * @returns {FWorksheet} This sheet, for chaining
3120
3201
  * @example
3121
3202
  * ```typescript
3122
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3203
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3204
+ * if (!fWorksheet) return;
3123
3205
  * // Unhide columns C, D, E
3124
3206
  * fWorksheet.showColumns(2, 3);
3125
3207
  * // Unhide column A
@@ -3150,7 +3232,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3150
3232
  * @returns {FWorksheet} This sheet, for chaining
3151
3233
  * @example
3152
3234
  * ```typescript
3153
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3235
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3236
+ * if (!fWorksheet) return;
3154
3237
  * // Set width of column B to 100 pixels
3155
3238
  * fWorksheet.setColumnWidth(1, 100);
3156
3239
  * ```
@@ -3166,7 +3249,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3166
3249
  * @returns {FWorksheet} This sheet, for chaining
3167
3250
  * @example
3168
3251
  * ```typescript
3169
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3252
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3253
+ * if (!fWorksheet) return;
3170
3254
  * // Set width of columns B-D (index 1-3) to 100 pixels
3171
3255
  * fWorksheet.setColumnWidths(1, 3, 100);
3172
3256
  * ```
@@ -3195,7 +3279,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3195
3279
  * @example
3196
3280
  * ```typescript
3197
3281
  * const fWorkbook = univerAPI.getActiveWorkbook();
3198
- * const fWorksheet = fWorkbook.getActiveSheet();
3282
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
3283
+ * if (!fWorksheet) return;
3199
3284
  *
3200
3285
  * // Set the long text value in cell A1
3201
3286
  * const fRange = fWorksheet.getRange('A1');
@@ -3217,7 +3302,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3217
3302
  * @returns {FWorksheet} This worksheet instance for chaining
3218
3303
  * @example
3219
3304
  * ```ts
3220
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3305
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3306
+ * if (!fWorkSheet) return;
3221
3307
  * fWorkSheet.setColumnCustom({ 0: { key: 'value' } });
3222
3308
  * ```
3223
3309
  */
@@ -3239,7 +3325,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3239
3325
  * @returns {FRange[]} All the merged cells in the worksheet
3240
3326
  * @example
3241
3327
  * ```ts
3242
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3328
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3329
+ * if (!fWorksheet) return;
3243
3330
  * // Get all merged ranges in the sheet
3244
3331
  * const mergedData = fWorksheet.getMergeData();
3245
3332
  * // Process each merged range
@@ -3256,7 +3343,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3256
3343
  * @returns {FRange[]} all merged cells
3257
3344
  * @example
3258
3345
  * ```typescript
3259
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3346
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3347
+ * if (!fWorksheet) return;
3260
3348
  * // Get all merged ranges in the sheet
3261
3349
  * const mergedRanges = fWorksheet.getMergedRanges();
3262
3350
  * // Process each merged range
@@ -3275,7 +3363,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3275
3363
  * @returns {FRange|undefined} The merged cell data, or undefined if the cell is not merged
3276
3364
  * @example
3277
3365
  * ```ts
3278
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3366
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3367
+ * if (!fWorkSheet) return;
3279
3368
  * const merge = fWorkSheet.getCellMergeData(0, 0);
3280
3369
  * if (merge) {
3281
3370
  * console.log('Merged range:', merge.getA1Notation());
@@ -3291,7 +3380,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3291
3380
  * @returns {FRange | null} the active range
3292
3381
  * @example
3293
3382
  * ```typescript
3294
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3383
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3384
+ * if (!fWorksheet) return;
3295
3385
  * // Get the currently active range
3296
3386
  * const activeRange = fWorksheet.getActiveRange();
3297
3387
  * if (activeRange) {
@@ -3308,7 +3398,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3308
3398
  * @returns {FWorksheet} This sheet, for chaining
3309
3399
  * @example
3310
3400
  * ```ts
3311
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3401
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3402
+ * if (!fWorkSheet) return;
3312
3403
  * fWorkSheet.setActiveRange(fWorkSheet.getRange('A10:B10'));
3313
3404
  * ```
3314
3405
  */
@@ -3323,7 +3414,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3323
3414
  * @returns {FRange | null} The active cell
3324
3415
  * @example
3325
3416
  * ```typescript
3326
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3417
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3418
+ * if (!fWorkSheet) return;
3327
3419
  * console.log(fWorkSheet.getActiveCell().getA1Notation());
3328
3420
  * ```
3329
3421
  */
@@ -3337,7 +3429,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3337
3429
  * @returns {FWorksheet} This worksheet instance for chaining
3338
3430
  * @example
3339
3431
  * ```typescript
3340
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3432
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3433
+ * if (!fWorksheet) return;
3341
3434
  * // Freeze first 3 rows and 2 columns
3342
3435
  * fWorksheet.setFreeze({
3343
3436
  * startRow: 3,
@@ -3360,7 +3453,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3360
3453
  * @returns {FWorksheet} This worksheet instance for chaining
3361
3454
  * @example
3362
3455
  * ```typescript
3363
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3456
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3457
+ * if (!fWorksheet) return;
3364
3458
  * // Cancel freeze
3365
3459
  * fWorksheet.cancelFreeze();
3366
3460
  * ```
@@ -3377,7 +3471,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3377
3471
  * @returns {IFreeze} The freeze state of the current sheet
3378
3472
  * @example
3379
3473
  * ```typescript
3380
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3474
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3475
+ * if (!fWorksheet) return;
3381
3476
  * // Get the freeze state of the current sheet
3382
3477
  * const freeze = fWorksheet.getFreeze();
3383
3478
  * console.log(freeze);
@@ -3437,7 +3532,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3437
3532
  * @returns {number} The number of frozen columns, returns 0 if no columns are frozen.
3438
3533
  * @example
3439
3534
  * ```typescript
3440
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3535
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3536
+ * if (!fWorkSheet) return;
3441
3537
  * // Get the number of frozen columns
3442
3538
  * const frozenColumns = fWorkSheet.getFrozenColumns();
3443
3539
  * console.log(frozenColumns);
@@ -3453,7 +3549,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3453
3549
  * @returns {number} The number of frozen rows. returns 0 if no rows are frozen.
3454
3550
  * @example
3455
3551
  * ```typescript
3456
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3552
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3553
+ * if (!fWorkSheet) return;
3457
3554
  * // Get the number of frozen rows
3458
3555
  * const frozenRows = fWorkSheet.getFrozenRows();
3459
3556
  * console.log(frozenRows);
@@ -3469,7 +3566,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3469
3566
  * @returns {IRowRange} The range of the frozen rows.
3470
3567
  * @example
3471
3568
  * ```ts
3472
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3569
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3570
+ * if (!fWorkSheet) return;
3473
3571
  * // Get the range of the frozen rows
3474
3572
  * const frozenRows = fWorkSheet.getFrozenRowRange();
3475
3573
  * console.log(frozenRows);
@@ -3487,7 +3585,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3487
3585
  * @returns {IColumnRange} The range of the frozen columns.
3488
3586
  * @example
3489
3587
  * ```ts
3490
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3588
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3589
+ * if (!fWorkSheet) return;
3491
3590
  * // Get the range of the frozen columns
3492
3591
  * const frozenColumns = fWorkSheet.getFrozenColumnRange();
3493
3592
  * console.log(frozenColumns);
@@ -3505,7 +3604,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3505
3604
  * @returns {boolean} True if the sheet's gridlines are hidden; otherwise false.
3506
3605
  * @example
3507
3606
  * ```ts
3508
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3607
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3608
+ * if (!fWorkSheet) return;
3509
3609
  * // check if the gridlines are hidden
3510
3610
  * if (fWorkSheet.hasHiddenGridLines()) {
3511
3611
  * console.log('Gridlines are hidden');
@@ -3521,7 +3621,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3521
3621
  * @returns {FWorksheet} Returns the current worksheet instance for method chaining
3522
3622
  * @example
3523
3623
  * ``` ts
3524
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3624
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3625
+ * if (!fWorkSheet) return;
3525
3626
  * // hide the gridlines
3526
3627
  * fWorkSheet.setHiddenGridlines(true);
3527
3628
  * ```
@@ -3540,7 +3641,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3540
3641
  * @returns {FWorksheet} Returns the current worksheet instance for method chaining
3541
3642
  * @example
3542
3643
  * ```ts
3543
- * const fWorkSheet = univerAPI.getActiveWorkbook().getActiveSheet();
3644
+ * const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3645
+ * if (!fWorkSheet) return;
3544
3646
  * // set the gridlines color to red
3545
3647
  * fWorkSheet.setGridLinesColor('#ff0000');
3546
3648
  * ```
@@ -3559,7 +3661,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3559
3661
  * @example
3560
3662
  * ```ts
3561
3663
  * const fWorkbook = univerAPI.getActiveWorkbook();
3562
- * const fWorkSheet = fWorkbook.getActiveSheet();
3664
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3665
+ * if (!fWorkSheet) return;
3563
3666
  * // get the gridlines color of the sheet
3564
3667
  * console.log(fWorkSheet.getGridLinesColor());
3565
3668
  * ```
@@ -3574,7 +3677,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3574
3677
  * @example
3575
3678
  * ```ts
3576
3679
  * const fWorkbook = univerAPI.getActiveWorkbook();
3577
- * const fWorkSheet = fWorkbook.getActiveSheet();
3680
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3681
+ * if (!fWorkSheet) return;
3578
3682
  * // set the tab color to red
3579
3683
  * fWorkSheet.setTabColor('#ff0000');
3580
3684
  * ```
@@ -3594,7 +3698,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3594
3698
  * @example
3595
3699
  * ```ts
3596
3700
  * const fWorkbook = univerAPI.getActiveWorkbook();
3597
- * const fWorkSheet = fWorkbook.getActiveSheet();
3701
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3702
+ * if (!fWorkSheet) return;
3598
3703
  * // get the tab color of the sheet
3599
3704
  * console.log(fWorkSheet.getTabColor());
3600
3705
  * ```
@@ -3608,7 +3713,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3608
3713
  * @example
3609
3714
  * ```ts
3610
3715
  * const fWorkbook = univerAPI.getActiveWorkbook();
3611
- * const fWorkSheet = fWorkbook.getActiveSheet();
3716
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3717
+ * if (!fWorkSheet) return;
3612
3718
  * // hide the active sheet
3613
3719
  * fWorkSheet.hideSheet();
3614
3720
  * ```
@@ -3661,7 +3767,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3661
3767
  * @example
3662
3768
  * ```ts
3663
3769
  * const fWorkbook = univerAPI.getActiveWorkbook();
3664
- * const fWorkSheet = fWorkbook.getActiveSheet();
3770
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3771
+ * if (!fWorkSheet) return;
3665
3772
  * // set the sheet name to 'Sheet1'
3666
3773
  * fWorkSheet.setName('NewSheet1');
3667
3774
  * ```
@@ -3695,7 +3802,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3695
3802
  * @example
3696
3803
  * ```ts
3697
3804
  * const fWorkbook = univerAPI.getActiveWorkbook();
3698
- * const fWorkSheet = fWorkbook.getActiveSheet();
3805
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3806
+ * if (!fWorkSheet) return;
3699
3807
  * // get the position of the active sheet
3700
3808
  * const position = fWorkSheet.getIndex();
3701
3809
  * console.log(position);
@@ -3713,7 +3821,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3713
3821
  * @example
3714
3822
  * ```ts
3715
3823
  * const fWorkbook = univerAPI.getActiveWorkbook();
3716
- * const fWorkSheet = fWorkbook.getActiveSheet();
3824
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3825
+ * if (!fWorkSheet) return;
3717
3826
  * // clear the sheet of content and formatting information
3718
3827
  * fWorkSheet.clear();
3719
3828
  * // clear the sheet of content only
@@ -3746,7 +3855,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3746
3855
  * @example
3747
3856
  * ```typescript
3748
3857
  * const fWorkbook = univerAPI.getActiveWorkbook();
3749
- * const fWorkSheet = fWorkbook.getActiveSheet();
3858
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3859
+ * if (!fWorkSheet) return;
3750
3860
  * // clear the sheet of content only
3751
3861
  * fWorkSheet.clearContents();
3752
3862
  * ```
@@ -3774,7 +3884,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3774
3884
  * @example
3775
3885
  * ```typescript
3776
3886
  * const fWorkbook = univerAPI.getActiveWorkbook();
3777
- * const fWorkSheet = fWorkbook.getActiveSheet();
3887
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3888
+ * if (!fWorkSheet) return;
3778
3889
  * // clear the sheet of formatting only
3779
3890
  * fWorkSheet.clearFormats();
3780
3891
  * ```
@@ -3803,7 +3914,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3803
3914
  * @example
3804
3915
  * ```ts
3805
3916
  * const fWorkbook = univerAPI.getActiveWorkbook();
3806
- * const fWorkSheet = fWorkbook.getActiveSheet();
3917
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3918
+ * if (!fWorkSheet) return;
3807
3919
  * // Assume the sheet is a empty sheet
3808
3920
  * const cellRange = fWorkSheet.getRange('J50');
3809
3921
  * cellRange.setValue('Hello World');
@@ -3820,7 +3932,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3820
3932
  * @example
3821
3933
  * ```ts
3822
3934
  * const fWorkbook = univerAPI.getActiveWorkbook();
3823
- * const fWorkSheet = fWorkbook.getActiveSheet();
3935
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3936
+ * if (!fWorkSheet) return;
3824
3937
  * // Assume the sheet is a empty sheet
3825
3938
  * const cellRange = fWorkSheet.getRange('J50');
3826
3939
  * cellRange.setValue('Hello World');
@@ -3836,7 +3949,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3836
3949
  * @example
3837
3950
  * ```ts
3838
3951
  * const fWorkbook = univerAPI.getActiveWorkbook();
3839
- * const fWorkSheet = fWorkbook.getActiveSheet();
3952
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3953
+ * if (!fWorkSheet) return;
3840
3954
  * // Assume the sheet is a empty sheet
3841
3955
  * const cellRange = fWorkSheet.getRange('J50');
3842
3956
  * cellRange.setValue('Hello World');
@@ -3854,7 +3968,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3854
3968
  * ```ts
3855
3969
  * const fWorkbook = univerAPI.getActiveWorkbook();
3856
3970
  * const sheets = fWorkbook.getSheets();
3857
- * const fWorkSheet = fWorkbook.getActiveSheet();
3971
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
3972
+ * if (!fWorkSheet) return;
3858
3973
  * console.log(fWorkSheet.equalTo(sheets[0])); // true, if the active sheet is the first sheet.
3859
3974
  * ```
3860
3975
  */
@@ -3869,7 +3984,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3869
3984
  * @example
3870
3985
  * ```ts
3871
3986
  * // The code below inserts a defined name
3872
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
3987
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
3988
+ * if (!fWorksheet) return;
3873
3989
  * fWorksheet.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');
3874
3990
  * ```
3875
3991
  */
@@ -3883,7 +3999,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3883
3999
  * @example
3884
4000
  * ```ts
3885
4001
  * // The code below gets all the defined names in the worksheet
3886
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
4002
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
4003
+ * if (!fWorksheet) return;
3887
4004
  * const definedNames = fWorksheet.getDefinedNames();
3888
4005
  * console.log(definedNames, definedNames[0]?.getFormulaOrRefString());
3889
4006
  * ```
@@ -3898,7 +4015,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3898
4015
  * @example
3899
4016
  * ```ts
3900
4017
  * const fWorkbook = univerAPI.getActiveWorkbook();
3901
- * const fWorkSheet = fWorkbook.getActiveSheet();
4018
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4019
+ * if (!fWorkSheet) return;
3902
4020
  * fWorkSheet.setCustomMetadata({ key: 'value' });
3903
4021
  * ```
3904
4022
  */
@@ -3912,7 +4030,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3912
4030
  * @example
3913
4031
  * ```ts
3914
4032
  * const fWorkbook = univerAPI.getActiveWorkbook();
3915
- * const fWorkSheet = fWorkbook.getActiveSheet();
4033
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4034
+ * if (!fWorkSheet) return;
3916
4035
  * const custom = fWorkSheet.getCustomMetadata();
3917
4036
  * console.log(custom);
3918
4037
  * ```
@@ -3928,7 +4047,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3928
4047
  * @example
3929
4048
  * ```ts
3930
4049
  * const fWorkbook = univerAPI.getActiveWorkbook();
3931
- * const fWorkSheet = fWorkbook.getActiveSheet();
4050
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4051
+ * if (!fWorkSheet) return;
3932
4052
  * fWorkSheet.setRowCustomMetadata(0, { key: 'value' });
3933
4053
  * ```
3934
4054
  */
@@ -3944,7 +4064,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3944
4064
  * @example
3945
4065
  * ```ts
3946
4066
  * const fWorkbook = univerAPI.getActiveWorkbook();
3947
- * const fWorkSheet = fWorkbook.getActiveSheet();
4067
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4068
+ * if (!fWorkSheet) return;
3948
4069
  * fWorkSheet.setColumnCustomMetadata(0, { key: 'value' });
3949
4070
  * ```
3950
4071
  */
@@ -3959,7 +4080,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3959
4080
  * @example
3960
4081
  * ```ts
3961
4082
  * const fWorkbook = univerAPI.getActiveWorkbook();
3962
- * const fWorkSheet = fWorkbook.getActiveSheet();
4083
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4084
+ * if (!fWorkSheet) return;
3963
4085
  * const custom = fWorkSheet.getRowCustomMetadata(0);
3964
4086
  * console.log(custom);
3965
4087
  * ```
@@ -3974,7 +4096,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3974
4096
  * @example
3975
4097
  * ```ts
3976
4098
  * const fWorkbook = univerAPI.getActiveWorkbook();
3977
- * const fWorkSheet = fWorkbook.getActiveSheet();
4099
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4100
+ * if (!fWorkSheet) return;
3978
4101
  * const custom = fWorkSheet.getColumnCustomMetadata(0);
3979
4102
  * console.log(custom);
3980
4103
  * ```
@@ -3991,7 +4114,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
3991
4114
  * // Appends a new row with 4 columns to the bottom of the current
3992
4115
  * // data region in the sheet containing the values in the array.
3993
4116
  * const fWorkbook = univerAPI.getActiveWorkbook();
3994
- * const fWorkSheet = fWorkbook.getActiveSheet();
4117
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4118
+ * if (!fWorkSheet) return;
3995
4119
  * fWorkSheet.appendRow([1, 'Hello Univer', true, '=A1']);
3996
4120
  * ```
3997
4121
  */
@@ -4021,7 +4145,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
4021
4145
  * @example
4022
4146
  * ```ts
4023
4147
  * const fWorkbook = univerAPI.getActiveWorkbook();
4024
- * const fWorkSheet = fWorkbook.getActiveSheet();
4148
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4149
+ * if (!fWorkSheet) return;
4025
4150
  *
4026
4151
  * // Set the number of rows in the worksheet to 40
4027
4152
  * fWorkSheet.setRowCount(40);
@@ -4042,7 +4167,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
4042
4167
  * @example
4043
4168
  * ```ts
4044
4169
  * const fWorkbook = univerAPI.getActiveWorkbook();
4045
- * const fWorkSheet = fWorkbook.getActiveSheet();
4170
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
4171
+ * if (!fWorkSheet) return;
4046
4172
  *
4047
4173
  * // Set the number of columns in the worksheet to 10
4048
4174
  * fWorkSheet.setColumnCount(10);
@@ -4062,7 +4188,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
4062
4188
  * @returns {FWorksheetPermission} - The WorksheetPermission instance.
4063
4189
  * @example
4064
4190
  * ```ts
4065
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
4191
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
4192
+ * if (!fWorksheet) return;
4066
4193
  * const permission = fWorksheet.getWorksheetPermission();
4067
4194
  *
4068
4195
  * // Set worksheet to read-only mode
@@ -4116,7 +4243,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
4116
4243
  * @example
4117
4244
  * ```ts
4118
4245
  * const fWorkbook = univerAPI.getActiveWorkbook();
4119
- * const fWorksheet = fWorkbook.getActiveSheet();
4246
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4247
+ * if (!fWorksheet) return;
4120
4248
  * const fRange = fWorksheet.getRange('A1:B2');
4121
4249
  * // Check if the A1:B2 range is protected
4122
4250
  * const isProtected = fRange.getRangePermission().isProtected();
@@ -4133,7 +4261,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
4133
4261
  * @example
4134
4262
  * ```ts
4135
4263
  * const fWorkbook = univerAPI.getActiveWorkbook();
4136
- * const fWorksheet = fWorkbook.getActiveSheet();
4264
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4265
+ * if (!fWorksheet) return;
4137
4266
  * const fRange = fWorksheet.getRange('A1:B2');
4138
4267
  * const rule = await fRange.getRangePermission().protect({
4139
4268
  * name: 'My protected range',
@@ -4203,7 +4332,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
4203
4332
  * @example
4204
4333
  * ```ts
4205
4334
  * const fWorkbook = univerAPI.getActiveWorkbook();
4206
- * const fWorksheet = fWorkbook.getActiveSheet();
4335
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4336
+ * if (!fWorksheet) return;
4207
4337
  * const fRange = fWorksheet.getRange('A1:B2');
4208
4338
  * const result = await fRange.getRangePermission().unprotect();
4209
4339
  * console.log(result);
@@ -4225,7 +4355,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
4225
4355
  * @example
4226
4356
  * ```ts
4227
4357
  * const fWorkbook = univerAPI.getActiveWorkbook();
4228
- * const fWorksheet = fWorkbook.getActiveSheet();
4358
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4359
+ * if (!fWorksheet) return;
4229
4360
  * const fRange = fWorksheet.getRange('A1:B2');
4230
4361
  * const rules = await fRange.getRangePermission().listRules();
4231
4362
  * console.log(rules);
@@ -4269,7 +4400,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4269
4400
  * @example
4270
4401
  * ```ts
4271
4402
  * const fWorkbook = univerAPI.getActiveWorkbook();
4272
- * const fWorksheet = fWorkbook.getActiveSheet();
4403
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4404
+ * if (!fWorksheet) return;
4273
4405
  * const fRange = fWorksheet.getRange('A1:B2');
4274
4406
  * console.log(fRange.getUnitId());
4275
4407
  * ```
@@ -4283,7 +4415,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4283
4415
  * @example
4284
4416
  * ```ts
4285
4417
  * const fWorkbook = univerAPI.getActiveWorkbook();
4286
- * const fWorksheet = fWorkbook.getActiveSheet();
4418
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4419
+ * if (!fWorksheet) return;
4287
4420
  * const fRange = fWorksheet.getRange('A1:B2');
4288
4421
  * console.log(fRange.getSheetName());
4289
4422
  * ```
@@ -4297,7 +4430,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4297
4430
  * @example
4298
4431
  * ```ts
4299
4432
  * const fWorkbook = univerAPI.getActiveWorkbook();
4300
- * const fWorksheet = fWorkbook.getActiveSheet();
4433
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4434
+ * if (!fWorksheet) return;
4301
4435
  * const fRange = fWorksheet.getRange('A1:B2');
4302
4436
  * console.log(fRange.getSheetId());
4303
4437
  * ```
@@ -4311,7 +4445,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4311
4445
  * @example
4312
4446
  * ```ts
4313
4447
  * const fWorkbook = univerAPI.getActiveWorkbook();
4314
- * const fWorksheet = fWorkbook.getActiveSheet();
4448
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4449
+ * if (!fWorksheet) return;
4315
4450
  * const fRange = fWorksheet.getRange('A1:B2');
4316
4451
  * const range = fRange.getRange();
4317
4452
  * const { startRow, startColumn, endRow, endColumn } = range;
@@ -4327,7 +4462,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4327
4462
  * @example
4328
4463
  * ```ts
4329
4464
  * const fWorkbook = univerAPI.getActiveWorkbook();
4330
- * const fWorksheet = fWorkbook.getActiveSheet();
4465
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4466
+ * if (!fWorksheet) return;
4331
4467
  * const fRange = fWorksheet.getRange('A1:B2');
4332
4468
  * console.log(fRange.getRow()); // 0
4333
4469
  * ```
@@ -4341,7 +4477,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4341
4477
  * @example
4342
4478
  * ```ts
4343
4479
  * const fWorkbook = univerAPI.getActiveWorkbook();
4344
- * const fWorksheet = fWorkbook.getActiveSheet();
4480
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4481
+ * if (!fWorksheet) return;
4345
4482
  * const fRange = fWorksheet.getRange('A1:B2');
4346
4483
  * console.log(fRange.getLastRow()); // 1
4347
4484
  * ```
@@ -4355,7 +4492,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4355
4492
  * @example
4356
4493
  * ```ts
4357
4494
  * const fWorkbook = univerAPI.getActiveWorkbook();
4358
- * const fWorksheet = fWorkbook.getActiveSheet();
4495
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4496
+ * if (!fWorksheet) return;
4359
4497
  * const fRange = fWorksheet.getRange('A1:B2');
4360
4498
  * console.log(fRange.getColumn()); // 0
4361
4499
  * ```
@@ -4369,7 +4507,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4369
4507
  * @example
4370
4508
  * ```ts
4371
4509
  * const fWorkbook = univerAPI.getActiveWorkbook();
4372
- * const fWorksheet = fWorkbook.getActiveSheet();
4510
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4511
+ * if (!fWorksheet) return;
4373
4512
  * const fRange = fWorksheet.getRange('A1:B2');
4374
4513
  * console.log(fRange.getLastColumn()); // 1
4375
4514
  * ```
@@ -4383,7 +4522,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4383
4522
  * @example
4384
4523
  * ```ts
4385
4524
  * const fWorkbook = univerAPI.getActiveWorkbook();
4386
- * const fWorksheet = fWorkbook.getActiveSheet();
4525
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4526
+ * if (!fWorksheet) return;
4387
4527
  * const fRange = fWorksheet.getRange('A1:B2');
4388
4528
  * console.log(fRange.getWidth());
4389
4529
  * ```
@@ -4397,7 +4537,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4397
4537
  * @example
4398
4538
  * ```ts
4399
4539
  * const fWorkbook = univerAPI.getActiveWorkbook();
4400
- * const fWorksheet = fWorkbook.getActiveSheet();
4540
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4541
+ * if (!fWorksheet) return;
4401
4542
  * const fRange = fWorksheet.getRange('A1:B2');
4402
4543
  * console.log(fRange.getHeight());
4403
4544
  * ```
@@ -4411,7 +4552,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4411
4552
  * @example
4412
4553
  * ```ts
4413
4554
  * const fWorkbook = univerAPI.getActiveWorkbook();
4414
- * const fWorksheet = fWorkbook.getActiveSheet();
4555
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4556
+ * if (!fWorksheet) return;
4415
4557
  * const fRange = fWorksheet.getRange('A1:B2');
4416
4558
  * console.log(fRange.isMerged());
4417
4559
  * // merge cells A1:B2
@@ -4436,7 +4578,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4436
4578
  * @example
4437
4579
  * ```ts
4438
4580
  * const fWorkbook = univerAPI.getActiveWorkbook();
4439
- * const fWorksheet = fWorkbook.getActiveSheet();
4581
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4582
+ * if (!fWorksheet) return;
4440
4583
  * const fRange = fWorksheet.getRange('A1:B2');
4441
4584
  * console.log(fRange.getCellStyleData());
4442
4585
  * ```
@@ -4457,7 +4600,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4457
4600
  * @example
4458
4601
  * ```ts
4459
4602
  * const fWorkbook = univerAPI.getActiveWorkbook();
4460
- * const fWorksheet = fWorkbook.getActiveSheet();
4603
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4604
+ * if (!fWorksheet) return;
4461
4605
  * const fRange = fWorksheet.getRange('A1:B2');
4462
4606
  * console.log(fRange.getFontFamily());
4463
4607
  * ```
@@ -4478,7 +4622,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4478
4622
  * @example
4479
4623
  * ```ts
4480
4624
  * const fWorkbook = univerAPI.getActiveWorkbook();
4481
- * const fWorksheet = fWorkbook.getActiveSheet();
4625
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4626
+ * if (!fWorksheet) return;
4482
4627
  * const fRange = fWorksheet.getRange('A1:B2');
4483
4628
  * console.log(fRange.getFontSize());
4484
4629
  * ```
@@ -4499,7 +4644,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4499
4644
  * @example
4500
4645
  * ```ts
4501
4646
  * const fWorkbook = univerAPI.getActiveWorkbook();
4502
- * const fWorksheet = fWorkbook.getActiveSheet();
4647
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4648
+ * if (!fWorksheet) return;
4503
4649
  * const fRange = fWorksheet.getRange('A1:B2');
4504
4650
  * console.log(fRange.getCellStyle());
4505
4651
  * ```
@@ -4520,7 +4666,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4520
4666
  * @example
4521
4667
  * ```ts
4522
4668
  * const fWorkbook = univerAPI.getActiveWorkbook();
4523
- * const fWorksheet = fWorkbook.getActiveSheet();
4669
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4670
+ * if (!fWorksheet) return;
4524
4671
  * const fRange = fWorksheet.getRange('A1:B2');
4525
4672
  * console.log(fRange.getCellStyles());
4526
4673
  * ```
@@ -4543,7 +4690,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4543
4690
  * @example
4544
4691
  * ```ts
4545
4692
  * const fWorkbook = univerAPI.getActiveWorkbook();
4546
- * const fWorksheet = fWorkbook.getActiveSheet();
4693
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4694
+ * if (!fWorksheet) return;
4547
4695
  * const fRange = fWorksheet.getRange('A1:B2');
4548
4696
  * fRange.setValueForCell({
4549
4697
  * v: 0.2,
@@ -4568,7 +4716,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4568
4716
  * @example
4569
4717
  * ```ts
4570
4718
  * const fWorkbook = univerAPI.getActiveWorkbook();
4571
- * const fWorksheet = fWorkbook.getActiveSheet();
4719
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4720
+ * if (!fWorksheet) return;
4572
4721
  * const fRange = fWorksheet.getRange('A1:B2');
4573
4722
  * fRange.setValueForCell({
4574
4723
  * v: 0.2,
@@ -4607,7 +4756,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4607
4756
  * @example
4608
4757
  * ```ts
4609
4758
  * const fWorkbook = univerAPI.getActiveWorkbook();
4610
- * const fWorksheet = fWorkbook.getActiveSheet();
4759
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4760
+ * if (!fWorksheet) return;
4611
4761
  * const fRange = fWorksheet.getRange('A1:B2');
4612
4762
  * fRange.setValues([
4613
4763
  * [
@@ -4668,7 +4818,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4668
4818
  * @example
4669
4819
  * ```ts
4670
4820
  * const fWorkbook = univerAPI.getActiveWorkbook();
4671
- * const fWorksheet = fWorkbook.getActiveSheet();
4821
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4822
+ * if (!fWorksheet) return;
4672
4823
  * const fRange = fWorksheet.getRange('A1:B2');
4673
4824
  * fRange.setValues([
4674
4825
  * [
@@ -4728,7 +4879,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4728
4879
  * @example
4729
4880
  * ```ts
4730
4881
  * const fWorkbook = univerAPI.getActiveWorkbook();
4731
- * const fWorksheet = fWorkbook.getActiveSheet();
4882
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4883
+ * if (!fWorksheet) return;
4732
4884
  * const fRange = fWorksheet.getRange('A1:B2');
4733
4885
  * console.log(fRange.getCellData());
4734
4886
  * ```
@@ -4743,7 +4895,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4743
4895
  * @example
4744
4896
  * ```ts
4745
4897
  * const fWorkbook = univerAPI.getActiveWorkbook();
4746
- * const fWorksheet = fWorkbook.getActiveSheet();
4898
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4899
+ * if (!fWorksheet) return;
4747
4900
  * const fRange = fWorksheet.getRange('A1:B2');
4748
4901
  * console.log(fRange.getCellDatas());
4749
4902
  * ```
@@ -4757,7 +4910,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4757
4910
  * @example
4758
4911
  * ```ts
4759
4912
  * const fWorkbook = univerAPI.getActiveWorkbook();
4760
- * const fWorksheet = fWorkbook.getActiveSheet();
4913
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4914
+ * if (!fWorksheet) return;
4761
4915
  * const fRange = fWorksheet.getRange('A1:B2');
4762
4916
  * console.log(fRange.getCellDataGrid());
4763
4917
  * ```
@@ -4780,7 +4934,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4780
4934
  * @example
4781
4935
  * ```ts
4782
4936
  * const fWorkbook = univerAPI.getActiveWorkbook();
4783
- * const fWorksheet = fWorkbook.getActiveSheet();
4937
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4938
+ * if (!fWorksheet) return;
4784
4939
  * const fRange = fWorksheet.getRange('A1:B2');
4785
4940
  * console.log(fRange.getRichTextValue());
4786
4941
  * ```
@@ -4798,7 +4953,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4798
4953
  * @example
4799
4954
  * ```ts
4800
4955
  * const fWorkbook = univerAPI.getActiveWorkbook();
4801
- * const fWorksheet = fWorkbook.getActiveSheet();
4956
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4957
+ * if (!fWorksheet) return;
4802
4958
  * const fRange = fWorksheet.getRange('A1:B2');
4803
4959
  * console.log(fRange.getRichTextValues());
4804
4960
  * ```
@@ -4814,7 +4970,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4814
4970
  * @example
4815
4971
  * ```ts
4816
4972
  * const fWorkbook = univerAPI.getActiveWorkbook();
4817
- * const fWorksheet = fWorkbook.getActiveSheet();
4973
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4974
+ * if (!fWorksheet) return;
4818
4975
  * const fRange = fWorksheet.getRange('A1:B2');
4819
4976
  * console.log(fRange.getValueAndRichTextValue());
4820
4977
  * ```
@@ -4829,7 +4986,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4829
4986
  * @example
4830
4987
  * ```ts
4831
4988
  * const fWorkbook = univerAPI.getActiveWorkbook();
4832
- * const fWorksheet = fWorkbook.getActiveSheet();
4989
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
4990
+ * if (!fWorksheet) return;
4833
4991
  * const fRange = fWorksheet.getRange('A1:B2');
4834
4992
  * console.log(fRange.getValueAndRichTextValues());
4835
4993
  * ```
@@ -4843,7 +5001,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4843
5001
  * @example
4844
5002
  * ```ts
4845
5003
  * const fWorkbook = univerAPI.getActiveWorkbook();
4846
- * const fWorksheet = fWorkbook.getActiveSheet();
5004
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5005
+ * if (!fWorksheet) return;
4847
5006
  * const fRange = fWorksheet.getRange('A1:B2');
4848
5007
  * console.log(fRange.getFormula());
4849
5008
  * ```
@@ -4858,7 +5017,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4858
5017
  * @example
4859
5018
  * ```ts
4860
5019
  * const fWorkbook = univerAPI.getActiveWorkbook();
4861
- * const fWorksheet = fWorkbook.getActiveSheet();
5020
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5021
+ * if (!fWorksheet) return;
4862
5022
  * const fRange = fWorksheet.getRange('A1:B2');
4863
5023
  * console.log(fRange.getFormulas());
4864
5024
  * ```
@@ -4884,7 +5044,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4884
5044
  * @example
4885
5045
  * ```ts
4886
5046
  * const fWorkbook = univerAPI.getActiveWorkbook();
4887
- * const fWorksheet = fWorkbook.getActiveSheet();
5047
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5048
+ * if (!fWorksheet) return;
4888
5049
  * const fRange = fWorksheet.getRange('A1:B2');
4889
5050
  * console.log(fRange.getWrap());
4890
5051
  * ```
@@ -4898,7 +5059,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4898
5059
  * @example
4899
5060
  * ```ts
4900
5061
  * const fWorkbook = univerAPI.getActiveWorkbook();
4901
- * const fWorksheet = fWorkbook.getActiveSheet();
5062
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5063
+ * if (!fWorksheet) return;
4902
5064
  * const fRange = fWorksheet.getRange('A1:B2');
4903
5065
  * console.log(fRange.getWraps());
4904
5066
  */
@@ -4916,7 +5078,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4916
5078
  * @example
4917
5079
  * ```ts
4918
5080
  * const fWorkbook = univerAPI.getActiveWorkbook();
4919
- * const fWorksheet = fWorkbook.getActiveSheet();
5081
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5082
+ * if (!fWorksheet) return;
4920
5083
  * const fRange = fWorksheet.getRange('A1:B2');
4921
5084
  * console.log(fRange.getWrapStrategy());
4922
5085
  * ```
@@ -4930,7 +5093,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4930
5093
  * @example
4931
5094
  * ```ts
4932
5095
  * const fWorkbook = univerAPI.getActiveWorkbook();
4933
- * const fWorksheet = fWorkbook.getActiveSheet();
5096
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5097
+ * if (!fWorksheet) return;
4934
5098
  * const fRange = fWorksheet.getRange('A1:B2');
4935
5099
  * console.log(fRange.getHorizontalAlignment());
4936
5100
  * ```
@@ -4944,7 +5108,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4944
5108
  * @example
4945
5109
  * ```ts
4946
5110
  * const fWorkbook = univerAPI.getActiveWorkbook();
4947
- * const fWorksheet = fWorkbook.getActiveSheet();
5111
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5112
+ * if (!fWorksheet) return;
4948
5113
  * const fRange = fWorksheet.getRange('A1:B2');
4949
5114
  * console.log(fRange.getHorizontalAlignments());
4950
5115
  * ```
@@ -4958,7 +5123,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4958
5123
  * @example
4959
5124
  * ```ts
4960
5125
  * const fWorkbook = univerAPI.getActiveWorkbook();
4961
- * const fWorksheet = fWorkbook.getActiveSheet();
5126
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5127
+ * if (!fWorksheet) return;
4962
5128
  * const fRange = fWorksheet.getRange('A1:B2');
4963
5129
  * console.log(fRange.getVerticalAlignment());
4964
5130
  * ```
@@ -4972,7 +5138,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4972
5138
  * @example
4973
5139
  * ```ts
4974
5140
  * const fWorkbook = univerAPI.getActiveWorkbook();
4975
- * const fWorksheet = fWorkbook.getActiveSheet();
5141
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5142
+ * if (!fWorksheet) return;
4976
5143
  * const fRange = fWorksheet.getRange('A1:B2');
4977
5144
  * console.log(fRange.getVerticalAlignments());
4978
5145
  * ```
@@ -4986,7 +5153,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
4986
5153
  * @returns {FRange} This range, for chaining
4987
5154
  * ```ts
4988
5155
  * const fWorkbook = univerAPI.getActiveWorkbook();
4989
- * const fWorksheet = fWorkbook.getActiveSheet();
5156
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5157
+ * if (!fWorksheet) return;
4990
5158
  * const fRange = fWorksheet.getRange('A1:B2');
4991
5159
  * fRange.setCustomMetaData({ key: 'value' });
4992
5160
  * console.log(fRange.getCustomMetaData());
@@ -5008,7 +5176,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5008
5176
  * @returns {FRange} This range, for chaining
5009
5177
  * ```ts
5010
5178
  * const fWorkbook = univerAPI.getActiveWorkbook();
5011
- * const fWorksheet = fWorkbook.getActiveSheet();
5179
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5180
+ * if (!fWorksheet) return;
5012
5181
  * const fRange = fWorksheet.getRange('A1:B2');
5013
5182
  * fRange.setCustomMetaDatas([
5014
5183
  * [{ key: 'value' }, { key: 'value2' }],
@@ -5033,7 +5202,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5033
5202
  * @example
5034
5203
  * ```
5035
5204
  * const fWorkbook = univerAPI.getActiveWorkbook();
5036
- * const fWorksheet = fWorkbook.getActiveSheet();
5205
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5206
+ * if (!fWorksheet) return;
5037
5207
  * const fRange = fWorksheet.getRange('A1:B2');
5038
5208
  * console.log(fRange.getCustomMetaData());
5039
5209
  * ```
@@ -5049,7 +5219,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5049
5219
  * @example
5050
5220
  * ```
5051
5221
  * const fWorkbook = univerAPI.getActiveWorkbook();
5052
- * const fWorksheet = fWorkbook.getActiveSheet();
5222
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5223
+ * if (!fWorksheet) return;
5053
5224
  * const fRange = fWorksheet.getRange('A1:B2');
5054
5225
  * console.log(fRange.getCustomMetaDatas());
5055
5226
  * ```
@@ -5069,7 +5240,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5069
5240
  * @example
5070
5241
  * ```ts
5071
5242
  * const fWorkbook = univerAPI.getActiveWorkbook();
5072
- * const fWorksheet = fWorkbook.getActiveSheet();
5243
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5244
+ * if (!fWorksheet) return;
5073
5245
  * const fRange = fWorksheet.getRange('A1:B2');
5074
5246
  * fRange.setBorder(univerAPI.Enum.BorderType.ALL, univerAPI.Enum.BorderStyleTypes.THIN, '#ff0000');
5075
5247
  * ```
@@ -5093,7 +5265,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5093
5265
  * @example
5094
5266
  * ```ts
5095
5267
  * const fWorkbook = univerAPI.getActiveWorkbook();
5096
- * const fWorksheet = fWorkbook.getActiveSheet();
5268
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5269
+ * if (!fWorksheet) return;
5097
5270
  * const fRange = fWorksheet.getRange('A1:B2');
5098
5271
  * console.log(fRange.getBackground());
5099
5272
  * ```
@@ -5109,7 +5282,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5109
5282
  * @example
5110
5283
  * ```ts
5111
5284
  * const fWorkbook = univerAPI.getActiveWorkbook();
5112
- * const fWorksheet = fWorkbook.getActiveSheet();
5285
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5286
+ * if (!fWorksheet) return;
5113
5287
  * const fRange = fWorksheet.getRange('A1:B2');
5114
5288
  * console.log(fRange.getBackgrounds());
5115
5289
  * ```
@@ -5127,7 +5301,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5127
5301
  * @example
5128
5302
  * ```ts
5129
5303
  * const fWorkbook = univerAPI.getActiveWorkbook();
5130
- * const fWorksheet = fWorkbook.getActiveSheet();
5304
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5305
+ * if (!fWorksheet) return;
5131
5306
  * const fRange = fWorksheet.getRange('A1:B2');
5132
5307
  * fRange.setBackgroundColor('red');
5133
5308
  * ```
@@ -5151,7 +5326,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5151
5326
  * @example
5152
5327
  * ```typescript
5153
5328
  * const fWorkbook = univerAPI.getActiveWorkbook();
5154
- * const fWorksheet = fWorkbook.getActiveSheet();
5329
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5330
+ * if (!fWorksheet) return;
5155
5331
  * const fRange = fWorksheet.getRange('A1:B2');
5156
5332
  * fRange.setBackground('red');
5157
5333
  * ```
@@ -5167,7 +5343,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5167
5343
  * @example
5168
5344
  * ```typescript
5169
5345
  * const fWorkbook = univerAPI.getActiveWorkbook();
5170
- * const fWorksheet = fWorkbook.getActiveSheet();
5346
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5347
+ * if (!fWorksheet) return;
5171
5348
  * const fRange = fWorksheet.getRange('A1:B2');
5172
5349
  * fRange.setTextRotation(45);
5173
5350
  * ```
@@ -5187,7 +5364,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5187
5364
  * @returns {FRange} This range, for chaining
5188
5365
  * ```ts
5189
5366
  * const fWorkbook = univerAPI.getActiveWorkbook();
5190
- * const fWorksheet = fWorkbook.getActiveSheet();
5367
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5368
+ * if (!fWorksheet) return;
5191
5369
  * const fRange = fWorksheet.getRange('B2');
5192
5370
  * fRange.setValue(123);
5193
5371
  *
@@ -5212,7 +5390,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5212
5390
  * @returns {FRange} This range, for chaining
5213
5391
  * ```ts
5214
5392
  * const fWorkbook = univerAPI.getActiveWorkbook();
5215
- * const fWorksheet = fWorkbook.getActiveSheet();
5393
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5394
+ * if (!fWorksheet) return;
5216
5395
  * const fRange = fWorksheet.getRange('A1:B2');
5217
5396
  * fRange.setValueForCell(123);
5218
5397
  *
@@ -5243,7 +5422,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5243
5422
  * @example
5244
5423
  * ```
5245
5424
  * const fWorkbook = univerAPI.getActiveWorkbook();
5246
- * const fWorksheet = fWorkbook.getActiveSheet();
5425
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5426
+ * if (!fWorksheet) return;
5247
5427
  * const fRange = fWorksheet.getRange('A1:B2');
5248
5428
  * console.log(fRange.getValue(true));
5249
5429
  *
@@ -5279,7 +5459,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5279
5459
  * @example
5280
5460
  * ```ts
5281
5461
  * const fWorkbook = univerAPI.getActiveWorkbook();
5282
- * const fWorksheet = fWorkbook.getActiveSheet();
5462
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5463
+ * if (!fWorksheet) return;
5283
5464
  * const fRange = fWorksheet.getRange('A1:B2');
5284
5465
  * console.log(fRange.getValue(true));
5285
5466
  *
@@ -5314,7 +5495,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5314
5495
  * @example
5315
5496
  * ```ts
5316
5497
  * const fWorkbook = univerAPI.getActiveWorkbook();
5317
- * const fWorksheet = fWorkbook.getActiveSheet();
5498
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5499
+ * if (!fWorksheet) return;
5318
5500
  * const fRange = fWorksheet.getRange('A1:B2');
5319
5501
  * fRange.setWrap(true);
5320
5502
  * console.log(fRange.getWrap());
@@ -5336,7 +5518,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5336
5518
  * @example
5337
5519
  * ```ts
5338
5520
  * const fWorkbook = univerAPI.getActiveWorkbook();
5339
- * const fWorksheet = fWorkbook.getActiveSheet();
5521
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5522
+ * if (!fWorksheet) return;
5340
5523
  * const fRange = fWorksheet.getRange('A1:B2');
5341
5524
  * fRange.setWrapStrategy(univerAPI.Enum.WrapStrategy.WRAP);
5342
5525
  * console.log(fRange.getWrapStrategy());
@@ -5358,7 +5541,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5358
5541
  * @example
5359
5542
  * ```ts
5360
5543
  * const fWorkbook = univerAPI.getActiveWorkbook();
5361
- * const fWorksheet = fWorkbook.getActiveSheet();
5544
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5545
+ * if (!fWorksheet) return;
5362
5546
  * const fRange = fWorksheet.getRange('A1:B2');
5363
5547
  * fRange.setVerticalAlignment('top');
5364
5548
  * ```
@@ -5379,7 +5563,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5379
5563
  * @example
5380
5564
  * ```ts
5381
5565
  * const fWorkbook = univerAPI.getActiveWorkbook();
5382
- * const fWorksheet = fWorkbook.getActiveSheet();
5566
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5567
+ * if (!fWorksheet) return;
5383
5568
  * const fRange = fWorksheet.getRange('A1:B2');
5384
5569
  * fRange.setHorizontalAlignment('left');
5385
5570
  * ```
@@ -5400,7 +5585,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5400
5585
  * @example
5401
5586
  * ```ts
5402
5587
  * const fWorkbook = univerAPI.getActiveWorkbook();
5403
- * const fWorksheet = fWorkbook.getActiveSheet();
5588
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5589
+ * if (!fWorksheet) return;
5404
5590
  * const fRange = fWorksheet.getRange('A1:B2');
5405
5591
  * fRange.setValues([
5406
5592
  * [1, { v: 2, s: { bg: { rgb: '#ff0000' } } }],
@@ -5425,7 +5611,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5425
5611
  * @example
5426
5612
  * ```ts
5427
5613
  * const fWorkbook = univerAPI.getActiveWorkbook();
5428
- * const fWorksheet = fWorkbook.getActiveSheet();
5614
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5615
+ * if (!fWorksheet) return;
5429
5616
  * const fRange = fWorksheet.getRange('A1:B2');
5430
5617
  * fRange.setFontWeight('bold');
5431
5618
  * ```
@@ -5456,7 +5643,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5456
5643
  * @example
5457
5644
  * ```ts
5458
5645
  * const fWorkbook = univerAPI.getActiveWorkbook();
5459
- * const fWorksheet = fWorkbook.getActiveSheet();
5646
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5647
+ * if (!fWorksheet) return;
5460
5648
  * const fRange = fWorksheet.getRange('A1:B2');
5461
5649
  * fRange.setFontStyle('italic');
5462
5650
  * ```
@@ -5487,7 +5675,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5487
5675
  * @example
5488
5676
  * ```ts
5489
5677
  * const fWorkbook = univerAPI.getActiveWorkbook();
5490
- * const fWorksheet = fWorkbook.getActiveSheet();
5678
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5679
+ * if (!fWorksheet) return;
5491
5680
  * const fRange = fWorksheet.getRange('A1:B2');
5492
5681
  * fRange.setFontLine('underline');
5493
5682
  * ```
@@ -5547,7 +5736,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5547
5736
  * @example
5548
5737
  * ```ts
5549
5738
  * const fWorkbook = univerAPI.getActiveWorkbook();
5550
- * const fWorksheet = fWorkbook.getActiveSheet();
5739
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5740
+ * if (!fWorksheet) return;
5551
5741
  * const fRange = fWorksheet.getRange('A1:B2');
5552
5742
  * fRange.setFontFamily('Arial');
5553
5743
  * ```
@@ -5573,7 +5763,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5573
5763
  * @example
5574
5764
  * ```ts
5575
5765
  * const fWorkbook = univerAPI.getActiveWorkbook();
5576
- * const fWorksheet = fWorkbook.getActiveSheet();
5766
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5767
+ * if (!fWorksheet) return;
5577
5768
  * const fRange = fWorksheet.getRange('A1:B2');
5578
5769
  * fRange.setFontSize(24);
5579
5770
  * ```
@@ -5599,7 +5790,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5599
5790
  * @example
5600
5791
  * ```ts
5601
5792
  * const fWorkbook = univerAPI.getActiveWorkbook();
5602
- * const fWorksheet = fWorkbook.getActiveSheet();
5793
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5794
+ * if (!fWorksheet) return;
5603
5795
  * const fRange = fWorksheet.getRange('A1:B2');
5604
5796
  * fRange.setFontColor('#ff0000');
5605
5797
  * ```
@@ -5627,7 +5819,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5627
5819
  * @example
5628
5820
  * ```ts
5629
5821
  * const fWorkbook = univerAPI.getActiveWorkbook();
5630
- * const fWorksheet = fWorkbook.getActiveSheet();
5822
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5823
+ * if (!fWorksheet) return;
5631
5824
  * const fRange = fWorksheet.getRange('A1:B2');
5632
5825
  * fRange.merge();
5633
5826
  * console.log(fRange.isMerged());
@@ -5635,7 +5828,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5635
5828
  *
5636
5829
  * ```ts
5637
5830
  * const fWorkbook = univerAPI.getActiveWorkbook();
5638
- * const fWorksheet = fWorkbook.getActiveSheet();
5831
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5832
+ * if (!fWorksheet) return;
5639
5833
  * const fRange = fWorksheet.getRange('B1:C2');
5640
5834
  * // Assume A1:B2 is already merged.
5641
5835
  * fRange.merge({ isForceMerge: true });
@@ -5657,7 +5851,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5657
5851
  * ```ts
5658
5852
  * // Assume the active sheet is a new sheet with no merged cells.
5659
5853
  * const fWorkbook = univerAPI.getActiveWorkbook();
5660
- * const fWorksheet = fWorkbook.getActiveSheet();
5854
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5855
+ * if (!fWorksheet) return;
5661
5856
  * const fRange = fWorksheet.getRange('A1:B2');
5662
5857
  * fRange.mergeAcross();
5663
5858
  * // There will be two merged cells. A1:B1 and A2:B2.
@@ -5669,7 +5864,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5669
5864
  *
5670
5865
  * ```ts
5671
5866
  * const fWorkbook = univerAPI.getActiveWorkbook();
5672
- * const fWorksheet = fWorkbook.getActiveSheet();
5867
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5868
+ * if (!fWorksheet) return;
5673
5869
  * const fRange = fWorksheet.getRange('B1:C2');
5674
5870
  * // Assume A1:B2 is already merged.
5675
5871
  * fRange.mergeAcross({ isForceMerge: true });
@@ -5692,7 +5888,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5692
5888
  * ```ts
5693
5889
  * // Assume the active sheet is a new sheet with no merged cells.
5694
5890
  * const fWorkbook = univerAPI.getActiveWorkbook();
5695
- * const fWorksheet = fWorkbook.getActiveSheet();
5891
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5892
+ * if (!fWorksheet) return;
5696
5893
  * const fRange = fWorksheet.getRange('A1:B2');
5697
5894
  * fRange.mergeVertically();
5698
5895
  * // There will be two merged cells. A1:A2 and B1:B2.
@@ -5704,7 +5901,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5704
5901
  *
5705
5902
  * ```ts
5706
5903
  * const fWorkbook = univerAPI.getActiveWorkbook();
5707
- * const fWorksheet = fWorkbook.getActiveSheet();
5904
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5905
+ * if (!fWorksheet) return;
5708
5906
  * const fRange = fWorksheet.getRange('B1:C2');
5709
5907
  * // Assume A1:B2 is already merged.
5710
5908
  * fRange.mergeVertically({ isForceMerge: true });
@@ -5723,7 +5921,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5723
5921
  * @example
5724
5922
  * ```ts
5725
5923
  * const fWorkbook = univerAPI.getActiveWorkbook();
5726
- * const fWorksheet = fWorkbook.getActiveSheet();
5924
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5925
+ * if (!fWorksheet) return;
5727
5926
  * const fRange = fWorksheet.getRange('A1:B2');
5728
5927
  * fRange.merge();
5729
5928
  * const anchor = fWorksheet.getRange('A1');
@@ -5740,7 +5939,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5740
5939
  * @example
5741
5940
  * ```ts
5742
5941
  * const fWorkbook = univerAPI.getActiveWorkbook();
5743
- * const fWorksheet = fWorkbook.getActiveSheet();
5942
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5943
+ * if (!fWorksheet) return;
5744
5944
  * const fRange = fWorksheet.getRange('A1:B2');
5745
5945
  * fRange.merge();
5746
5946
  * const anchor = fWorksheet.getRange('A1');
@@ -5765,7 +5965,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5765
5965
  * @param {ICellData} callback.cell the cell data
5766
5966
  * ```ts
5767
5967
  * const fWorkbook = univerAPI.getActiveWorkbook();
5768
- * const fWorksheet = fWorkbook.getActiveSheet();
5968
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5969
+ * if (!fWorksheet) return;
5769
5970
  * const fRange = fWorksheet.getRange('A1:B2');
5770
5971
  * fRange.forEach((row, col, cell) => {
5771
5972
  * console.log(row, col, cell);
@@ -5786,7 +5987,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5786
5987
  * @returns {string} The A1 notation of the range.
5787
5988
  * ```ts
5788
5989
  * const fWorkbook = univerAPI.getActiveWorkbook();
5789
- * const fWorksheet = fWorkbook.getActiveSheet();
5990
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
5991
+ * if (!fWorksheet) return;
5790
5992
  *
5791
5993
  * // By default, the A1 notation is returned without the sheet name and without absolute reference types.
5792
5994
  * const fRange = fWorksheet.getRange('A1:B2');
@@ -5824,7 +6026,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5824
6026
  * @example
5825
6027
  * ```ts
5826
6028
  * const fWorkbook = univerAPI.getActiveWorkbook();
5827
- * const fWorksheet = fWorkbook.getActiveSheet();
6029
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6030
+ * if (!fWorksheet) return;
5828
6031
  * const fRange = fWorksheet.getRange('A1:B2');
5829
6032
  * fRange.activate(); // the active cell will be A1
5830
6033
  * ```
@@ -5842,7 +6045,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5842
6045
  * @example
5843
6046
  * ```ts
5844
6047
  * const fWorkbook = univerAPI.getActiveWorkbook();
5845
- * const fWorksheet = fWorkbook.getActiveSheet();
6048
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6049
+ * if (!fWorksheet) return;
5846
6050
  *
5847
6051
  * // Set the range A1:B2 as the active range, default active cell is A1
5848
6052
  * const fRange = fWorksheet.getRange('A1:B2');
@@ -5894,7 +6098,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5894
6098
  * @example Show how to split text to columns with custom delimiter
5895
6099
  * ```ts
5896
6100
  * const fWorkbook = univerAPI.getActiveWorkbook();
5897
- * const fWorksheet = fWorkbook.getActiveSheet();
6101
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6102
+ * if (!fWorksheet) return;
5898
6103
  *
5899
6104
  * // A1:A3 has following values:
5900
6105
  * // A |
@@ -5936,7 +6141,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5936
6141
  * @example
5937
6142
  * ```ts
5938
6143
  * const fWorkbook = univerAPI.getActiveWorkbook();
5939
- * const fWorksheet = fWorkbook.getActiveSheet();
6144
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6145
+ * if (!fWorksheet) return;
5940
6146
  * const fRange = fWorksheet.getRange('A1:E20');
5941
6147
  * fRange.useThemeStyle('default');
5942
6148
  * ```
@@ -5958,7 +6164,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5958
6164
  * @example
5959
6165
  * ```ts
5960
6166
  * const fWorkbook = univerAPI.getActiveWorkbook();
5961
- * const fWorksheet = fWorkbook.getActiveSheet();
6167
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6168
+ * if (!fWorksheet) return;
5962
6169
  * const fRange = fWorksheet.getRange('A1:E20');
5963
6170
  * fRange.removeThemeStyle('default');
5964
6171
  * ```
@@ -5977,7 +6184,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
5977
6184
  * @example
5978
6185
  * ```ts
5979
6186
  * const fWorkbook = univerAPI.getActiveWorkbook();
5980
- * const fWorksheet = fWorkbook.getActiveSheet();
6187
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6188
+ * if (!fWorksheet) return;
5981
6189
  * const fRange = fWorksheet.getRange('A1:E20');
5982
6190
  * console.log(fRange.getUsedThemeStyle()); // undefined
5983
6191
  * fRange.useThemeStyle('default');
@@ -6000,7 +6208,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6000
6208
  * @example
6001
6209
  * ```ts
6002
6210
  * const fWorkbook = univerAPI.getActiveWorkbook();
6003
- * const fWorkSheet = fWorkbook.getActiveSheet();
6211
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
6212
+ * if (!fWorkSheet) return;
6004
6213
  * const fRange = fWorkSheet.getRange('A1:D10');
6005
6214
  *
6006
6215
  * // clear the content and format of the range A1:D10
@@ -6027,7 +6236,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6027
6236
  * @example
6028
6237
  * ```typescript
6029
6238
  * const fWorkbook = univerAPI.getActiveWorkbook();
6030
- * const fWorkSheet = fWorkbook.getActiveSheet();
6239
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
6240
+ * if (!fWorkSheet) return;
6031
6241
  * const fRange = fWorkSheet.getRange('A1:D10');
6032
6242
  *
6033
6243
  * // clear the content only of the range A1:D10
@@ -6048,7 +6258,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6048
6258
  * @example
6049
6259
  * ```typescript
6050
6260
  * const fWorkbook = univerAPI.getActiveWorkbook();
6051
- * const fWorkSheet = fWorkbook.getActiveSheet();
6261
+ * const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
6262
+ * if (!fWorkSheet) return;
6052
6263
  * const fRange = fWorkSheet.getRange('A1:D10');
6053
6264
  * // clear the format only of the range A1:D10
6054
6265
  * fRange.clearFormat();
@@ -6069,7 +6280,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6069
6280
  * ```ts
6070
6281
  * // Assume the active sheet empty sheet.
6071
6282
  * const fWorkbook = univerAPI.getActiveWorkbook();
6072
- * const fWorksheet = fWorkbook.getActiveSheet();
6283
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6284
+ * if (!fWorksheet) return;
6073
6285
  * const values = [
6074
6286
  * [1, 2, 3, 4],
6075
6287
  * [2, 3, 4, 5],
@@ -6128,7 +6340,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6128
6340
  * ```ts
6129
6341
  * // Assume the active sheet empty sheet.
6130
6342
  * const fWorkbook = univerAPI.getActiveWorkbook();
6131
- * const fWorksheet = fWorkbook.getActiveSheet();
6343
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6344
+ * if (!fWorksheet) return;
6132
6345
  * const values = [
6133
6346
  * [1, 2, 3, 4],
6134
6347
  * [2, 3, 4, 5],
@@ -6191,7 +6404,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6191
6404
  * ```ts
6192
6405
  * // Assume the active sheet is a new sheet with no data.
6193
6406
  * const fWorkbook = univerAPI.getActiveWorkbook();
6194
- * const fWorksheet = fWorkbook.getActiveSheet();
6407
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6408
+ * if (!fWorksheet) return;
6195
6409
  *
6196
6410
  * // Set the range A1:D4 with some values, the range A1:D4 will be:
6197
6411
  * // | | |
@@ -6261,7 +6475,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6261
6475
  * ```ts
6262
6476
  * // Assume the active sheet is a new sheet with no data.
6263
6477
  * const fWorkbook = univerAPI.getActiveWorkbook();
6264
- * const fWorksheet = fWorkbook.getActiveSheet();
6478
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6479
+ * if (!fWorksheet) return;
6265
6480
  * const fRange = fWorksheet.getRange('A1:B2');
6266
6481
  * console.log(fRange.isBlank()); // true
6267
6482
  *
@@ -6293,7 +6508,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6293
6508
  * @example
6294
6509
  * ```ts
6295
6510
  * const fWorkbook = univerAPI.getActiveWorkbook();
6296
- * const fWorksheet = fWorkbook.getActiveSheet();
6511
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6512
+ * if (!fWorksheet) return;
6297
6513
  * const fRange = fWorksheet.getRange('A1:B2');
6298
6514
  * console.log(fRange.getA1Notation()); // A1:B2
6299
6515
  *
@@ -6323,7 +6539,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6323
6539
  * @example
6324
6540
  * ```ts
6325
6541
  * const fWorkbook = univerAPI.getActiveWorkbook();
6326
- * const fWorksheet = fWorkbook.getActiveSheet();
6542
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6543
+ * if (!fWorksheet) return;
6327
6544
  * const fRange = fWorksheet.getRange('A1');
6328
6545
  * fRange.setFormula('=SUM(A2:A5)');
6329
6546
  * console.log(fRange.getFormula()); // '=SUM(A2:A5)'
@@ -6339,7 +6556,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6339
6556
  * @example
6340
6557
  * ```ts
6341
6558
  * const fWorkbook = univerAPI.getActiveWorkbook();
6342
- * const fWorksheet = fWorkbook.getActiveSheet();
6559
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6560
+ * if (!fWorksheet) return;
6343
6561
  * const fRange = fWorksheet.getRange('A1:B2');
6344
6562
  * fRange.setFormulas([
6345
6563
  * ['=SUM(A2:A5)', '=SUM(B2:B5)'],
@@ -6357,7 +6575,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6357
6575
  * @returns {FRangePermission} - The RangePermission instance.
6358
6576
  * @example
6359
6577
  * ```ts
6360
- * const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
6578
+ * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
6579
+ * if (!fWorksheet) return;
6361
6580
  * const fRange = fWorksheet.getRange('A1:B10');
6362
6581
  * const permission = fRange.getRangePermission();
6363
6582
  *
@@ -6392,7 +6611,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
6392
6611
  * ```ts
6393
6612
  * // Auto-fill the range D1:D10 based on the data in the range C1:C2
6394
6613
  * const fWorkbook = univerAPI.getActiveWorkbook();
6395
- * const fWorksheet = fWorkbook.getActiveSheet();
6614
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
6615
+ * if (!fWorksheet) return;
6396
6616
  * const fRange = fWorksheet.getRange('A1:A4');
6397
6617
  *
6398
6618
  * // Auto-fill without specifying applyType (default behavior)
@@ -6780,7 +7000,7 @@ FWorkbookPermission = __decorate([
6780
7000
  //#endregion
6781
7001
  //#region src/facade/f-workbook.ts
6782
7002
  let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
6783
- constructor(_workbook, _injector, _resourceLoaderService, _selectionManagerService, _univerInstanceService, _commandService, _permissionService, _logService, _localeService, _definedNamesService) {
7003
+ constructor(_workbook, _injector, _resourceLoaderService, _selectionManagerService, _univerInstanceService, _commandService, _permissionService, _logService, _definedNamesService) {
6784
7004
  super(_injector);
6785
7005
  this._workbook = _workbook;
6786
7006
  this._injector = _injector;
@@ -6790,7 +7010,6 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
6790
7010
  this._commandService = _commandService;
6791
7011
  this._permissionService = _permissionService;
6792
7012
  this._logService = _logService;
6793
- this._localeService = _localeService;
6794
7013
  this._definedNamesService = _definedNamesService;
6795
7014
  _defineProperty(this, "id", void 0);
6796
7015
  this.id = this._workbook.getUnitId();
@@ -6873,21 +7092,6 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
6873
7092
  return this._resourceLoaderService.saveUnit(this._workbook.getUnitId());
6874
7093
  }
6875
7094
  /**
6876
- * @deprecated use 'save' instead.
6877
- * @returns {IWorkbookData} Workbook snapshot data
6878
- * @memberof FWorkbook
6879
- * @example
6880
- * ```ts
6881
- * // The code below saves the workbook snapshot data
6882
- * const activeSpreadsheet = univerAPI.getActiveWorkbook();
6883
- * const snapshot = activeSpreadsheet.getSnapshot();
6884
- * ```
6885
- */
6886
- getSnapshot() {
6887
- this._logService.warn("use 'save' instead of 'getSnapshot'");
6888
- return this.save();
6889
- }
6890
- /**
6891
7095
  * Get the active sheet of the workbook.
6892
7096
  * @returns {FWorksheet} The active sheet of the workbook
6893
7097
  * @example
@@ -6895,6 +7099,7 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
6895
7099
  * // The code below gets the active sheet of the workbook
6896
7100
  * const fWorkbook = univerAPI.getActiveWorkbook();
6897
7101
  * const fWorksheet = fWorkbook.getActiveSheet();
7102
+ * if (!fWorksheet) return;
6898
7103
  * console.log(fWorksheet);
6899
7104
  * ```
6900
7105
  */
@@ -7239,7 +7444,9 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
7239
7444
  * @example
7240
7445
  * ```ts
7241
7446
  * const fWorkbook = univerAPI.getActiveWorkbook();
7242
- * const range = fWorkbook.getActiveSheet().getRange('A10:B10');
7447
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
7448
+ * if (!fWorksheet) return;
7449
+ * const range = fWorksheet.getRange('A10:B10');
7243
7450
  * fWorkbook.setActiveRange(range);
7244
7451
  * ```
7245
7452
  */
@@ -7317,7 +7524,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
7317
7524
  * ```ts
7318
7525
  * // The code below duplicates the given worksheet
7319
7526
  * const fWorkbook = univerAPI.getActiveWorkbook();
7320
- * const activeSheet = fWorkbook.getActiveSheet();
7527
+ * const activeSheet = fWorkbook.getSheetByName('Sheet1');
7528
+ * if (!activeSheet) return;
7321
7529
  * const duplicatedSheet = fWorkbook.duplicateSheet(activeSheet);
7322
7530
  * console.log(duplicatedSheet);
7323
7531
  * ```
@@ -7357,42 +7565,6 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
7357
7565
  return this._workbook.getSheets().length;
7358
7566
  }
7359
7567
  /**
7360
- * Get the locale of the workbook.
7361
- * @returns {LocaleType} The locale of the workbook
7362
- * @example
7363
- * ```ts
7364
- * // The code below gets the locale of the workbook
7365
- * const fWorkbook = univerAPI.getActiveWorkbook();
7366
- * console.log(fWorkbook.getLocale());
7367
- * ```
7368
- */
7369
- getLocale() {
7370
- return this._localeService.getCurrentLocale();
7371
- }
7372
- /**
7373
- * @deprecated use `setSpreadsheetLocale` instead.
7374
- * @param {LocaleType} locale - The locale to set
7375
- */
7376
- setLocale(locale) {
7377
- this._localeService.setLocale(locale);
7378
- }
7379
- /**
7380
- * Set the locale of the workbook.
7381
- * @param {LocaleType} locale The locale to set
7382
- * @returns {FWorkbook} This workbook, for chaining
7383
- * @example
7384
- * ```ts
7385
- * // The code below sets the locale of the workbook
7386
- * const fWorkbook = univerAPI.getActiveWorkbook();
7387
- * fWorkbook.setSpreadsheetLocale(univerAPI.Enum.LocaleType.EN_US);
7388
- * console.log(fWorkbook.getLocale());
7389
- * ```
7390
- */
7391
- setSpreadsheetLocale(locale) {
7392
- this._localeService.setLocale(locale);
7393
- return this;
7394
- }
7395
- /**
7396
7568
  * Get the URL of the workbook.
7397
7569
  * @returns {string} The URL of the workbook
7398
7570
  * @example
@@ -7415,7 +7587,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
7415
7587
  * ```ts
7416
7588
  * // The code below moves the sheet to the specified index
7417
7589
  * const fWorkbook = univerAPI.getActiveWorkbook();
7418
- * const sheet = fWorkbook.getActiveSheet();
7590
+ * const sheet = fWorkbook.getSheetByName('Sheet1');
7591
+ * if (!sheet) return;
7419
7592
  * fWorkbook.moveSheet(sheet, 1);
7420
7593
  * ```
7421
7594
  */
@@ -7736,7 +7909,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
7736
7909
  * fWorkbook.addStyles(styles);
7737
7910
  *
7738
7911
  * // Set values with the new styles
7739
- * const fWorksheet = fWorkbook.getActiveSheet();
7912
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
7913
+ * if (!fWorksheet) return;
7740
7914
  * const fRange = fWorksheet.getRange('A1:B2');
7741
7915
  * fRange.setValues([
7742
7916
  * [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
@@ -7771,7 +7945,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
7771
7945
  * fWorkbook.addStyles(styles);
7772
7946
  *
7773
7947
  * // Set values with the new styles
7774
- * const fWorksheet = fWorkbook.getActiveSheet();
7948
+ * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
7949
+ * if (!fWorksheet) return;
7775
7950
  * const fRange = fWorksheet.getRange('A1:B2');
7776
7951
  * fRange.setValues([
7777
7952
  * [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
@@ -7797,62 +7972,52 @@ FWorkbook = __decorate([
7797
7972
  __decorateParam(5, _univerjs_core.ICommandService),
7798
7973
  __decorateParam(6, _univerjs_core.IPermissionService),
7799
7974
  __decorateParam(7, _univerjs_core.ILogService),
7800
- __decorateParam(8, (0, _univerjs_core.Inject)(_univerjs_core.LocaleService)),
7801
- __decorateParam(9, _univerjs_engine_formula.IDefinedNamesService)
7975
+ __decorateParam(8, _univerjs_engine_formula.IDefinedNamesService)
7802
7976
  ], FWorkbook);
7803
7977
 
7804
7978
  //#endregion
7805
7979
  //#region src/facade/f-univer.ts
7806
7980
  var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7807
- getCommandSheetTarget(commandInfo) {
7808
- var _this$getActiveWorkbo;
7809
- const params = commandInfo.params;
7810
- if (!params) return this.getActiveSheet();
7811
- const workbook = params.unitId ? this.getUniverSheet(params.unitId) : (_this$getActiveWorkbo = this.getActiveWorkbook) === null || _this$getActiveWorkbo === void 0 ? void 0 : _this$getActiveWorkbo.call(this);
7812
- if (!workbook) return;
7813
- const worksheet = workbook.getSheetBySheetId(params.subUnitId || params.sheetId) || workbook.getActiveSheet();
7814
- if (!worksheet) return;
7981
+ createWorkbook(data, options) {
7982
+ const workbook = this._injector.get(_univerjs_core.IUniverInstanceService).createUnit(_univerjs_core.UniverInstanceType.UNIVER_SHEET, data, options);
7983
+ return this._injector.createInstance(FWorkbook, workbook);
7984
+ }
7985
+ getActiveWorkbook() {
7986
+ const workbook = this._univerInstanceService.getCurrentUnitOfType(_univerjs_core.UniverInstanceType.UNIVER_SHEET);
7987
+ if (!workbook) return null;
7988
+ return this._injector.createInstance(FWorkbook, workbook);
7989
+ }
7990
+ getWorkbook(id) {
7991
+ const workbook = this._univerInstanceService.getUnit(id, _univerjs_core.UniverInstanceType.UNIVER_SHEET);
7992
+ if (!workbook) return null;
7993
+ return this._injector.createInstance(FWorkbook, workbook);
7994
+ }
7995
+ getSheetCommandTarget(params = {}) {
7996
+ const { unitId, subUnitId, sheetId } = params;
7997
+ const workbook = unitId ? this.getWorkbook(unitId) : this.getActiveWorkbook();
7998
+ if (!workbook) return null;
7999
+ const sheetIdToFind = subUnitId || sheetId;
8000
+ const worksheet = sheetIdToFind ? workbook.getSheetBySheetId(sheetIdToFind) : workbook.getActiveSheet();
8001
+ if (!worksheet) return null;
7815
8002
  return {
7816
8003
  workbook,
7817
- worksheet
8004
+ worksheet,
8005
+ unitId: workbook.getId(),
8006
+ subUnitId: worksheet.getSheetId()
7818
8007
  };
7819
8008
  }
7820
- getSheetTarget(unitId, subUnitId) {
7821
- const workbook = this.getUniverSheet(unitId);
7822
- if (!workbook) return;
7823
- const worksheet = workbook.getSheetBySheetId(subUnitId);
7824
- if (!worksheet) return;
8009
+ getActiveSheet() {
8010
+ const workbook = this.getActiveWorkbook();
8011
+ if (!workbook) return null;
8012
+ const worksheet = workbook.getActiveSheet();
8013
+ if (!worksheet) return null;
7825
8014
  return {
7826
8015
  workbook,
7827
8016
  worksheet
7828
8017
  };
7829
8018
  }
7830
- _initWorkbookEvent(injector) {
7831
- const univerInstanceService = injector.get(_univerjs_core.IUniverInstanceService);
7832
- this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookDisposed, () => univerInstanceService.unitDisposed$.subscribe((unit) => {
7833
- if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
7834
- const eventParams = {
7835
- unitId: unit.getUnitId(),
7836
- unitType: unit.type,
7837
- snapshot: unit.getSnapshot()
7838
- };
7839
- this.fireEvent(this.Event.WorkbookDisposed, eventParams);
7840
- }
7841
- })));
7842
- this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookCreated, () => univerInstanceService.unitAdded$.subscribe((event) => {
7843
- const { unit } = event;
7844
- if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
7845
- const workbook = unit;
7846
- const workbookUnit = injector.createInstance(FWorkbook, workbook);
7847
- const eventParams = {
7848
- unitId: unit.getUnitId(),
7849
- type: unit.type,
7850
- workbook: workbookUnit,
7851
- unit: workbookUnit
7852
- };
7853
- this.fireEvent(this.Event.WorkbookCreated, eventParams);
7854
- }
7855
- })));
8019
+ setFreezeSync(enabled) {
8020
+ this._injector.get(_univerjs_sheets.SheetsFreezeSyncController).setEnabled(enabled);
7856
8021
  }
7857
8022
  /**
7858
8023
  * @ignore
@@ -7862,9 +8027,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7862
8027
  const commandService = injector.get(_univerjs_core.ICommandService);
7863
8028
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetCreate, () => commandService.beforeCommandExecuted((commandInfo) => {
7864
8029
  if (commandInfo.id === _univerjs_sheets.InsertSheetCommand.id) {
7865
- var _this$getActiveWorkbo2;
7866
8030
  const { unitId, index, sheet } = commandInfo.params || {};
7867
- const workbook = unitId ? this.getUniverSheet(unitId) : (_this$getActiveWorkbo2 = this.getActiveWorkbook) === null || _this$getActiveWorkbo2 === void 0 ? void 0 : _this$getActiveWorkbo2.call(this);
8031
+ const workbook = unitId ? this.getWorkbook(unitId) : this.getActiveWorkbook();
7868
8032
  if (!workbook) return;
7869
8033
  const eventParams = {
7870
8034
  workbook,
@@ -7877,11 +8041,10 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7877
8041
  })));
7878
8042
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeActiveSheetChange, () => commandService.beforeCommandExecuted((commandInfo) => {
7879
8043
  if (commandInfo.id === _univerjs_sheets.SetWorksheetActiveOperation.id) {
7880
- var _this$getActiveWorkbo3;
7881
- const { subUnitId: sheetId, unitId } = commandInfo.params;
7882
- const workbook = unitId ? this.getUniverSheet(unitId) : (_this$getActiveWorkbo3 = this.getActiveWorkbook) === null || _this$getActiveWorkbo3 === void 0 ? void 0 : _this$getActiveWorkbo3.call(this);
7883
- if (!workbook || !sheetId) return;
7884
- const activeSheet = workbook.getSheetBySheetId(sheetId);
8044
+ const params = commandInfo.params;
8045
+ const target = this.getSheetCommandTarget(params);
8046
+ if (!target) return;
8047
+ const { workbook, worksheet: activeSheet } = target;
7885
8048
  const oldActiveSheet = workbook.getActiveSheet();
7886
8049
  if (!activeSheet || !oldActiveSheet) return;
7887
8050
  const eventParams = {
@@ -7895,7 +8058,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7895
8058
  })));
7896
8059
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetDelete, () => commandService.beforeCommandExecuted((commandInfo) => {
7897
8060
  if (commandInfo.id === _univerjs_sheets.RemoveSheetCommand.id) {
7898
- const target = this.getCommandSheetTarget(commandInfo);
8061
+ const params = commandInfo.params;
8062
+ const target = this.getSheetCommandTarget(params);
7899
8063
  if (!target) return;
7900
8064
  const { workbook, worksheet } = target;
7901
8065
  const eventParams = {
@@ -7908,14 +8072,16 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7908
8072
  })));
7909
8073
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetMove, () => commandService.beforeCommandExecuted((commandInfo) => {
7910
8074
  if (commandInfo.id === _univerjs_sheets.SetWorksheetOrderMutation.id) {
7911
- const { fromOrder, toOrder } = commandInfo.params;
7912
- const target = this.getCommandSheetTarget(commandInfo);
8075
+ const params = commandInfo.params;
8076
+ const target = this.getSheetCommandTarget(params);
7913
8077
  if (!target) return;
8078
+ const { workbook, worksheet } = target;
8079
+ const { fromOrder: oldIndex, toOrder: newIndex } = params;
7914
8080
  const eventParams = {
7915
- workbook: target.workbook,
7916
- worksheet: target.worksheet,
7917
- newIndex: toOrder,
7918
- oldIndex: fromOrder
8081
+ workbook,
8082
+ worksheet,
8083
+ newIndex,
8084
+ oldIndex
7919
8085
  };
7920
8086
  this.fireEvent(this.Event.BeforeSheetMove, eventParams);
7921
8087
  if (eventParams.cancel) throw new _univerjs_core.CanceledError();
@@ -7923,14 +8089,17 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7923
8089
  })));
7924
8090
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNameChange, () => commandService.beforeCommandExecuted((commandInfo) => {
7925
8091
  if (commandInfo.id === _univerjs_sheets.SetWorksheetNameCommand.id) {
7926
- const { name } = commandInfo.params;
7927
- const target = this.getCommandSheetTarget(commandInfo);
8092
+ const params = commandInfo.params;
8093
+ const target = this.getSheetCommandTarget(params);
7928
8094
  if (!target) return;
8095
+ const { workbook, worksheet } = target;
8096
+ const oldName = worksheet.getSheetName();
8097
+ const { name: newName } = params;
7929
8098
  const eventParams = {
7930
- workbook: target.workbook,
7931
- worksheet: target.worksheet,
7932
- newName: name,
7933
- oldName: target.worksheet.getSheetName()
8099
+ workbook,
8100
+ worksheet,
8101
+ newName,
8102
+ oldName
7934
8103
  };
7935
8104
  this.fireEvent(this.Event.BeforeSheetNameChange, eventParams);
7936
8105
  if (eventParams.cancel) throw new _univerjs_core.CanceledError();
@@ -7938,14 +8107,17 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7938
8107
  })));
7939
8108
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetTabColorChange, () => commandService.beforeCommandExecuted((commandInfo) => {
7940
8109
  if (commandInfo.id === _univerjs_sheets.SetTabColorMutation.id) {
7941
- const { color } = commandInfo.params;
7942
- const target = this.getCommandSheetTarget(commandInfo);
8110
+ const params = commandInfo.params;
8111
+ const target = this.getSheetCommandTarget(params);
7943
8112
  if (!target) return;
8113
+ const { workbook, worksheet } = target;
8114
+ const oldColor = worksheet.getTabColor();
8115
+ const { color: newColor } = params;
7944
8116
  const eventParams = {
7945
- workbook: target.workbook,
7946
- worksheet: target.worksheet,
7947
- newColor: color,
7948
- oldColor: target.worksheet.getTabColor()
8117
+ workbook,
8118
+ worksheet,
8119
+ newColor,
8120
+ oldColor
7949
8121
  };
7950
8122
  this.fireEvent(this.Event.BeforeSheetTabColorChange, eventParams);
7951
8123
  if (eventParams.cancel) throw new _univerjs_core.CanceledError();
@@ -7953,12 +8125,14 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7953
8125
  })));
7954
8126
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetHideChange, () => commandService.beforeCommandExecuted((commandInfo) => {
7955
8127
  if (commandInfo.id === _univerjs_sheets.SetWorksheetHideMutation.id) {
7956
- const { hidden } = commandInfo.params;
7957
- const target = this.getCommandSheetTarget(commandInfo);
8128
+ const params = commandInfo.params;
8129
+ const target = this.getSheetCommandTarget(params);
7958
8130
  if (!target) return;
8131
+ const { workbook, worksheet } = target;
8132
+ const { hidden } = params;
7959
8133
  const eventParams = {
7960
- workbook: target.workbook,
7961
- worksheet: target.worksheet,
8134
+ workbook,
8135
+ worksheet,
7962
8136
  hidden: Boolean(hidden)
7963
8137
  };
7964
8138
  this.fireEvent(this.Event.BeforeSheetHideChange, eventParams);
@@ -7967,12 +8141,15 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7967
8141
  })));
7968
8142
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeGridlineColorChange, () => commandService.beforeCommandExecuted((commandInfo) => {
7969
8143
  if (commandInfo.id === _univerjs_sheets.SetGridlinesColorCommand.id) {
7970
- var _commandInfo$params;
7971
- const target = this.getCommandSheetTarget(commandInfo);
8144
+ const params = commandInfo.params;
8145
+ const target = this.getSheetCommandTarget(params);
7972
8146
  if (!target) return;
8147
+ const { workbook, worksheet } = target;
8148
+ const { color } = params;
7973
8149
  const eventParams = {
7974
- ...target,
7975
- color: (_commandInfo$params = commandInfo.params) === null || _commandInfo$params === void 0 ? void 0 : _commandInfo$params.color
8150
+ workbook,
8151
+ worksheet,
8152
+ color
7976
8153
  };
7977
8154
  this.fireEvent(this.Event.BeforeGridlineColorChange, eventParams);
7978
8155
  if (eventParams.cancel) throw new _univerjs_core.CanceledError();
@@ -7980,12 +8157,15 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
7980
8157
  })));
7981
8158
  this.disposeWithMe(this.registerEventHandler(this.Event.BeforeGridlineEnableChange, () => commandService.beforeCommandExecuted((commandInfo) => {
7982
8159
  if (commandInfo.id === _univerjs_sheets.ToggleGridlinesCommand.id) {
7983
- var _showGridlines, _commandInfo$params2;
7984
- const target = this.getCommandSheetTarget(commandInfo);
8160
+ var _params$showGridlines;
8161
+ const params = commandInfo.params;
8162
+ const target = this.getSheetCommandTarget(params);
7985
8163
  if (!target) return;
7986
- const showGridlines = (_showGridlines = (_commandInfo$params2 = commandInfo.params) === null || _commandInfo$params2 === void 0 ? void 0 : _commandInfo$params2.showGridlines) !== null && _showGridlines !== void 0 ? _showGridlines : !target.worksheet.hasHiddenGridLines();
8164
+ const { workbook, worksheet } = target;
8165
+ const showGridlines = (_params$showGridlines = params.showGridlines) !== null && _params$showGridlines !== void 0 ? _params$showGridlines : !worksheet.hasHiddenGridLines();
7987
8166
  const eventParams = {
7988
- ...target,
8167
+ workbook,
8168
+ worksheet,
7989
8169
  enabled: Boolean(showGridlines)
7990
8170
  };
7991
8171
  this.fireEvent(this.Event.BeforeGridlineEnableChange, eventParams);
@@ -8009,12 +8189,10 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
8009
8189
  })));
8010
8190
  this.disposeWithMe(this.registerEventHandler(this.Event.SheetCreated, () => commandService.onCommandExecuted((commandInfo) => {
8011
8191
  if (commandInfo.id === _univerjs_sheets.InsertSheetCommand.id) {
8012
- var _this$getActiveWorkbo4;
8013
- const { unitId } = commandInfo.params || {};
8014
- const workbook = unitId ? this.getUniverSheet(unitId) : (_this$getActiveWorkbo4 = this.getActiveWorkbook) === null || _this$getActiveWorkbo4 === void 0 ? void 0 : _this$getActiveWorkbo4.call(this);
8015
- if (!workbook) return;
8016
- const worksheet = workbook.getActiveSheet();
8017
- if (!worksheet) return;
8192
+ const params = commandInfo.params;
8193
+ const target = this.getSheetCommandTarget(params);
8194
+ if (!target) return;
8195
+ const { workbook, worksheet } = target;
8018
8196
  const eventParams = {
8019
8197
  workbook,
8020
8198
  worksheet
@@ -8024,7 +8202,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
8024
8202
  })));
8025
8203
  this.disposeWithMe(this.registerEventHandler(this.Event.ActiveSheetChanged, () => commandService.onCommandExecuted((commandInfo) => {
8026
8204
  if (commandInfo.id === _univerjs_sheets.SetWorksheetActiveOperation.id) {
8027
- const target = this.getActiveSheet();
8205
+ const params = commandInfo.params;
8206
+ const target = this.getSheetCommandTarget(params);
8028
8207
  if (!target) return;
8029
8208
  const { workbook, worksheet: activeSheet } = target;
8030
8209
  const eventParams = {
@@ -8036,9 +8215,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
8036
8215
  })));
8037
8216
  this.disposeWithMe(this.registerEventHandler(this.Event.SheetDeleted, () => commandService.onCommandExecuted((commandInfo) => {
8038
8217
  if (commandInfo.id === _univerjs_sheets.RemoveSheetCommand.id) {
8039
- var _this$getActiveWorkbo5;
8040
- const { subUnitId: sheetId, unitId } = commandInfo.params;
8041
- const workbook = unitId ? this.getUniverSheet(unitId) : (_this$getActiveWorkbo5 = this.getActiveWorkbook) === null || _this$getActiveWorkbo5 === void 0 ? void 0 : _this$getActiveWorkbo5.call(this);
8218
+ const { unitId, subUnitId: sheetId } = commandInfo.params;
8219
+ const workbook = unitId ? this.getWorkbook(unitId) : this.getActiveWorkbook();
8042
8220
  if (!workbook || !sheetId) return;
8043
8221
  const eventParams = {
8044
8222
  workbook,
@@ -8049,52 +8227,56 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
8049
8227
  })));
8050
8228
  this.disposeWithMe(this.registerEventHandler(this.Event.SheetMoved, () => commandService.onCommandExecuted((commandInfo) => {
8051
8229
  if (commandInfo.id === _univerjs_sheets.SetWorksheetOrderMutation.id) {
8052
- const { toOrder: toIndex } = commandInfo.params;
8053
- const target = this.getCommandSheetTarget(commandInfo);
8230
+ const params = commandInfo.params;
8231
+ const target = this.getSheetCommandTarget(params);
8054
8232
  if (!target) return;
8055
8233
  const { workbook, worksheet } = target;
8234
+ const { toOrder: newIndex } = params;
8056
8235
  const eventParams = {
8057
8236
  workbook,
8058
8237
  worksheet,
8059
- newIndex: toIndex
8238
+ newIndex
8060
8239
  };
8061
8240
  this.fireEvent(this.Event.SheetMoved, eventParams);
8062
8241
  }
8063
8242
  })));
8064
8243
  this.disposeWithMe(this.registerEventHandler(this.Event.SheetNameChanged, () => commandService.onCommandExecuted((commandInfo) => {
8065
8244
  if (commandInfo.id === _univerjs_sheets.SetWorksheetNameCommand.id) {
8066
- const { name } = commandInfo.params;
8067
- const target = this.getCommandSheetTarget(commandInfo);
8245
+ const params = commandInfo.params;
8246
+ const target = this.getSheetCommandTarget(params);
8068
8247
  if (!target) return;
8069
8248
  const { workbook, worksheet } = target;
8249
+ const { name: newName } = params;
8070
8250
  const eventParams = {
8071
8251
  workbook,
8072
8252
  worksheet,
8073
- newName: name
8253
+ newName
8074
8254
  };
8075
8255
  this.fireEvent(this.Event.SheetNameChanged, eventParams);
8076
8256
  }
8077
8257
  })));
8078
8258
  this.disposeWithMe(this.registerEventHandler(this.Event.SheetTabColorChanged, () => commandService.onCommandExecuted((commandInfo) => {
8079
8259
  if (commandInfo.id === _univerjs_sheets.SetTabColorMutation.id) {
8080
- const { color } = commandInfo.params;
8081
- const target = this.getCommandSheetTarget(commandInfo);
8260
+ const params = commandInfo.params;
8261
+ const target = this.getSheetCommandTarget(params);
8082
8262
  if (!target) return;
8083
8263
  const { workbook, worksheet } = target;
8264
+ const { color: newColor } = params;
8084
8265
  const eventParams = {
8085
8266
  workbook,
8086
8267
  worksheet,
8087
- newColor: color
8268
+ newColor
8088
8269
  };
8089
8270
  this.fireEvent(this.Event.SheetTabColorChanged, eventParams);
8090
8271
  }
8091
8272
  })));
8092
8273
  this.disposeWithMe(this.registerEventHandler(this.Event.SheetHideChanged, () => commandService.onCommandExecuted((commandInfo) => {
8093
8274
  if (commandInfo.id === _univerjs_sheets.SetWorksheetHideMutation.id) {
8094
- const { hidden } = commandInfo.params;
8095
- const target = this.getCommandSheetTarget(commandInfo);
8275
+ const params = commandInfo.params;
8276
+ const target = this.getSheetCommandTarget(params);
8096
8277
  if (!target) return;
8097
8278
  const { workbook, worksheet } = target;
8279
+ const { hidden } = params;
8098
8280
  const eventParams = {
8099
8281
  workbook,
8100
8282
  worksheet,
@@ -8105,58 +8287,47 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
8105
8287
  })));
8106
8288
  this.disposeWithMe(this.registerEventHandler(this.Event.GridlineChanged, () => commandService.onCommandExecuted((commandInfo) => {
8107
8289
  if (commandInfo.id === _univerjs_sheets.SetGridlinesColorCommand.id || commandInfo.id === _univerjs_sheets.ToggleGridlinesCommand.id) {
8108
- const target = this.getCommandSheetTarget(commandInfo);
8290
+ const params = commandInfo.params;
8291
+ const target = this.getSheetCommandTarget(params);
8109
8292
  if (!target) return;
8293
+ const { workbook, worksheet } = target;
8110
8294
  const eventParams = {
8111
- ...target,
8112
- enabled: !target.worksheet.hasHiddenGridLines(),
8113
- color: target.worksheet.getGridLinesColor()
8295
+ workbook,
8296
+ worksheet,
8297
+ enabled: !worksheet.hasHiddenGridLines(),
8298
+ color: worksheet.getGridLinesColor()
8114
8299
  };
8115
8300
  this.fireEvent(this.Event.GridlineChanged, eventParams);
8116
8301
  }
8117
8302
  })));
8118
8303
  this._initWorkbookEvent(injector);
8119
8304
  }
8120
- createUniverSheet(data, options) {
8121
- const workbook = this._injector.get(_univerjs_core.IUniverInstanceService).createUnit(_univerjs_core.UniverInstanceType.UNIVER_SHEET, data, options);
8122
- return this._injector.createInstance(FWorkbook, workbook);
8123
- }
8124
- createWorkbook(data, options) {
8125
- return this.createUniverSheet(data, options);
8126
- }
8127
- getActiveWorkbook() {
8128
- const workbook = this._univerInstanceService.getCurrentUnitOfType(_univerjs_core.UniverInstanceType.UNIVER_SHEET);
8129
- if (!workbook) return null;
8130
- return this._injector.createInstance(FWorkbook, workbook);
8131
- }
8132
- getActiveUniverSheet() {
8133
- return this.getActiveWorkbook();
8134
- }
8135
- getUniverSheet(id) {
8136
- const workbook = this._univerInstanceService.getUnit(id, _univerjs_core.UniverInstanceType.UNIVER_SHEET);
8137
- if (!workbook) return null;
8138
- return this._injector.createInstance(FWorkbook, workbook);
8139
- }
8140
- getWorkbook(id) {
8141
- return this.getUniverSheet(id);
8142
- }
8143
- onUniverSheetCreated(callback) {
8144
- return (0, _univerjs_core.toDisposable)(this._univerInstanceService.getTypeOfUnitAdded$(_univerjs_core.UniverInstanceType.UNIVER_SHEET).subscribe((event) => {
8145
- callback(this._injector.createInstance(FWorkbook, event.unit));
8146
- }));
8147
- }
8148
- getActiveSheet() {
8149
- const workbook = this.getActiveWorkbook();
8150
- if (!workbook) return null;
8151
- const worksheet = workbook.getActiveSheet();
8152
- if (!worksheet) return null;
8153
- return {
8154
- workbook,
8155
- worksheet
8156
- };
8157
- }
8158
- setFreezeSync(enabled) {
8159
- this._injector.get(_univerjs_sheets.SheetsFreezeSyncController).setEnabled(enabled);
8305
+ _initWorkbookEvent(injector) {
8306
+ const univerInstanceService = injector.get(_univerjs_core.IUniverInstanceService);
8307
+ this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookDisposed, () => univerInstanceService.unitDisposed$.subscribe((unit) => {
8308
+ if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
8309
+ const eventParams = {
8310
+ unitId: unit.getUnitId(),
8311
+ unitType: unit.type,
8312
+ snapshot: unit.getSnapshot()
8313
+ };
8314
+ this.fireEvent(this.Event.WorkbookDisposed, eventParams);
8315
+ }
8316
+ })));
8317
+ this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookCreated, () => univerInstanceService.unitAdded$.subscribe((event) => {
8318
+ const { unit } = event;
8319
+ if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
8320
+ const workbook = unit;
8321
+ const workbookUnit = injector.createInstance(FWorkbook, workbook);
8322
+ const eventParams = {
8323
+ unitId: unit.getUnitId(),
8324
+ type: unit.type,
8325
+ workbook: workbookUnit,
8326
+ unit: workbookUnit
8327
+ };
8328
+ this.fireEvent(this.Event.WorkbookCreated, eventParams);
8329
+ }
8330
+ })));
8160
8331
  }
8161
8332
  };
8162
8333
  _univerjs_core_facade.FUniver.extend(FUniverSheetsMixin);
@@ -8269,31 +8440,6 @@ var FSheetsEventNameMixin = class extends _univerjs_core_facade.FEventName {
8269
8440
  };
8270
8441
  _univerjs_core_facade.FEventName.extend(FSheetsEventNameMixin);
8271
8442
 
8272
- //#endregion
8273
- //#region src/facade/f-sheet-hooks.ts
8274
- /**
8275
- * Copyright 2023-present DreamNum Co., Ltd.
8276
- *
8277
- * Licensed under the Apache License, Version 2.0 (the "License");
8278
- * you may not use this file except in compliance with the License.
8279
- * You may obtain a copy of the License at
8280
- *
8281
- * http://www.apache.org/licenses/LICENSE-2.0
8282
- *
8283
- * Unless required by applicable law or agreed to in writing, software
8284
- * distributed under the License is distributed on an "AS IS" BASIS,
8285
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
8286
- * See the License for the specific language governing permissions and
8287
- * limitations under the License.
8288
- */
8289
- let FSheetHooks = class FSheetHooks extends _univerjs_core_facade.FBase {
8290
- constructor(_injector) {
8291
- super();
8292
- this._injector = _injector;
8293
- }
8294
- };
8295
- FSheetHooks = __decorate([__decorateParam(0, (0, _univerjs_core.Inject)(_univerjs_core.Injector))], FSheetHooks);
8296
-
8297
8443
  //#endregion
8298
8444
  Object.defineProperty(exports, 'FRange', {
8299
8445
  enumerable: true,
@@ -8307,12 +8453,6 @@ Object.defineProperty(exports, 'FSelection', {
8307
8453
  return FSelection;
8308
8454
  }
8309
8455
  });
8310
- Object.defineProperty(exports, 'FSheetHooks', {
8311
- enumerable: true,
8312
- get: function () {
8313
- return FSheetHooks;
8314
- }
8315
- });
8316
8456
  exports.FSheetsEnumMixin = FSheetsEnumMixin;
8317
8457
  exports.FSheetsEventNameMixin = FSheetsEventNameMixin;
8318
8458
  Object.defineProperty(exports, 'FWorkbook', {