@univerjs/sheets 0.23.0 → 0.24.0-insiders.20260528-29f582d
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.
- package/lib/cjs/facade.js +459 -272
- package/lib/cjs/index.js +74 -65
- package/lib/cjs/locale/ar-SA.js +52 -0
- package/lib/cjs/locale/ca-ES.js +36 -1
- package/lib/cjs/locale/de-DE.js +52 -0
- package/lib/cjs/locale/en-US.js +36 -1
- package/lib/cjs/locale/es-ES.js +36 -1
- package/lib/cjs/locale/fa-IR.js +36 -1
- package/lib/cjs/locale/fr-FR.js +36 -1
- package/lib/cjs/locale/id-ID.js +52 -0
- package/lib/cjs/locale/it-IT.js +52 -0
- package/lib/cjs/locale/ja-JP.js +36 -1
- package/lib/cjs/locale/ko-KR.js +36 -1
- package/lib/cjs/locale/pl-PL.js +52 -0
- package/lib/cjs/locale/pt-BR.js +52 -0
- package/lib/cjs/locale/ru-RU.js +36 -1
- package/lib/cjs/locale/sk-SK.js +36 -1
- package/lib/cjs/locale/vi-VN.js +36 -1
- package/lib/cjs/locale/zh-CN.js +36 -1
- package/lib/cjs/locale/zh-HK.js +52 -0
- package/lib/cjs/locale/zh-TW.js +36 -1
- package/lib/es/facade.js +460 -273
- package/lib/es/index.js +73 -66
- package/lib/es/locale/ar-SA.js +51 -0
- package/lib/es/locale/ca-ES.js +36 -1
- package/lib/es/locale/de-DE.js +51 -0
- package/lib/es/locale/en-US.js +36 -1
- package/lib/es/locale/es-ES.js +36 -1
- package/lib/es/locale/fa-IR.js +36 -1
- package/lib/es/locale/fr-FR.js +36 -1
- package/lib/es/locale/id-ID.js +51 -0
- package/lib/es/locale/it-IT.js +51 -0
- package/lib/es/locale/ja-JP.js +36 -1
- package/lib/es/locale/ko-KR.js +36 -1
- package/lib/es/locale/pl-PL.js +51 -0
- package/lib/es/locale/pt-BR.js +51 -0
- package/lib/es/locale/ru-RU.js +36 -1
- package/lib/es/locale/sk-SK.js +36 -1
- package/lib/es/locale/vi-VN.js +36 -1
- package/lib/es/locale/zh-CN.js +36 -1
- package/lib/es/locale/zh-HK.js +51 -0
- package/lib/es/locale/zh-TW.js +36 -1
- package/lib/facade.js +460 -273
- package/lib/index.js +73 -66
- package/lib/locale/ar-SA.js +51 -0
- package/lib/locale/ca-ES.js +36 -1
- package/lib/locale/de-DE.js +51 -0
- package/lib/locale/en-US.js +36 -1
- package/lib/locale/es-ES.js +36 -1
- package/lib/locale/fa-IR.js +36 -1
- package/lib/locale/fr-FR.js +36 -1
- package/lib/locale/id-ID.js +51 -0
- package/lib/locale/it-IT.js +51 -0
- package/lib/locale/ja-JP.js +36 -1
- package/lib/locale/ko-KR.js +36 -1
- package/lib/locale/pl-PL.js +51 -0
- package/lib/locale/pt-BR.js +51 -0
- package/lib/locale/ru-RU.js +36 -1
- package/lib/locale/sk-SK.js +36 -1
- package/lib/locale/vi-VN.js +36 -1
- package/lib/locale/zh-CN.js +36 -1
- package/lib/locale/zh-HK.js +51 -0
- package/lib/locale/zh-TW.js +36 -1
- package/lib/types/basics/utils.d.ts +2 -0
- package/lib/types/facade/f-range.d.ts +184 -92
- package/lib/types/facade/f-selection.d.ts +15 -8
- package/lib/types/facade/f-workbook.d.ts +12 -5
- package/lib/types/facade/f-worksheet.d.ts +205 -125
- package/lib/types/facade/permission/f-range-permission.d.ts +8 -4
- package/lib/types/facade/permission/f-range-protection-rule.d.ts +18 -9
- package/lib/types/facade/permission/f-worksheet-permission.d.ts +36 -18
- package/lib/types/index.d.ts +8 -8
- package/lib/types/locale/ar-SA.d.ts +18 -0
- package/lib/types/locale/de-DE.d.ts +18 -0
- package/lib/types/locale/en-US.d.ts +39 -0
- package/lib/types/locale/id-ID.d.ts +18 -0
- package/lib/types/locale/it-IT.d.ts +18 -0
- package/lib/types/locale/pl-PL.d.ts +18 -0
- package/lib/types/locale/pt-BR.d.ts +18 -0
- package/lib/types/locale/zh-HK.d.ts +18 -0
- package/lib/umd/facade.js +1 -1
- package/lib/umd/index.js +2 -2
- package/lib/umd/locale/ar-SA.js +1 -0
- package/lib/umd/locale/ca-ES.js +1 -1
- package/lib/umd/locale/de-DE.js +1 -0
- package/lib/umd/locale/en-US.js +1 -1
- package/lib/umd/locale/es-ES.js +1 -1
- package/lib/umd/locale/fa-IR.js +1 -1
- package/lib/umd/locale/fr-FR.js +1 -1
- package/lib/umd/locale/id-ID.js +1 -0
- package/lib/umd/locale/it-IT.js +1 -0
- package/lib/umd/locale/ja-JP.js +1 -1
- package/lib/umd/locale/ko-KR.js +1 -1
- package/lib/umd/locale/pl-PL.js +1 -0
- package/lib/umd/locale/pt-BR.js +1 -0
- package/lib/umd/locale/ru-RU.js +1 -1
- package/lib/umd/locale/sk-SK.js +1 -1
- package/lib/umd/locale/vi-VN.js +1 -1
- package/lib/umd/locale/zh-CN.js +1 -1
- package/lib/umd/locale/zh-HK.js +1 -0
- package/lib/umd/locale/zh-TW.js +1 -1
- package/package.json +8 -8
- package/LICENSE +0 -176
- /package/lib/types/commands/commands/{set-border-command.d.ts → set-border.command.d.ts} +0 -0
- /package/lib/types/commands/mutations/{numfmt-mutation.d.ts → numfmt.mutation.d.ts} +0 -0
- /package/lib/types/commands/utils/{handle-range-mutation.d.ts → handle-range.mutation.d.ts} +0 -0
- /package/lib/types/services/exclusive-range/{exclusive-range-service.d.ts → exclusive-range.service.d.ts} +0 -0
- /package/lib/types/services/{range-theme-service.d.ts → range-theme.service.d.ts} +0 -0
package/lib/cjs/facade.js
CHANGED
|
@@ -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.
|
|
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.
|
|
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.
|
|
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.
|
|
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));
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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()?.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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.
|
|
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.
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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.
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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.
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
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().
|
|
3417
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3418
|
+
* if (!fWorkSheet) return;
|
|
3327
3419
|
* console.log(fWorkSheet.getActiveCell().getA1Notation());
|
|
3328
3420
|
* ```
|
|
3329
3421
|
*/
|
|
@@ -3334,11 +3426,11 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3334
3426
|
* Sets the frozen state of the current sheet.
|
|
3335
3427
|
* @param {IFreeze} freeze - the scrolling viewport start range and count of freezed rows and columns.
|
|
3336
3428
|
* that means if you want to freeze the first 3 rows and 2 columns, you should set freeze as { startRow: 3, startColumn: 2, xSplit: 2, ySplit: 3 }
|
|
3337
|
-
* @deprecated use `setFrozenRows` and `setFrozenColumns` instead.
|
|
3338
3429
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
3339
3430
|
* @example
|
|
3340
3431
|
* ```typescript
|
|
3341
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3432
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3433
|
+
* if (!fWorksheet) return;
|
|
3342
3434
|
* // Freeze first 3 rows and 2 columns
|
|
3343
3435
|
* fWorksheet.setFreeze({
|
|
3344
3436
|
* startRow: 3,
|
|
@@ -3349,7 +3441,6 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3349
3441
|
* ```
|
|
3350
3442
|
*/
|
|
3351
3443
|
setFreeze(freeze) {
|
|
3352
|
-
this._logService.warn("setFreeze is deprecated, use setFrozenRows and setFrozenColumns instead");
|
|
3353
3444
|
this._commandService.syncExecuteCommand(_univerjs_sheets.SetFrozenCommand.id, {
|
|
3354
3445
|
...freeze,
|
|
3355
3446
|
unitId: this._workbook.getUnitId(),
|
|
@@ -3362,7 +3453,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3362
3453
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
3363
3454
|
* @example
|
|
3364
3455
|
* ```typescript
|
|
3365
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3456
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3457
|
+
* if (!fWorksheet) return;
|
|
3366
3458
|
* // Cancel freeze
|
|
3367
3459
|
* fWorksheet.cancelFreeze();
|
|
3368
3460
|
* ```
|
|
@@ -3379,7 +3471,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3379
3471
|
* @returns {IFreeze} The freeze state of the current sheet
|
|
3380
3472
|
* @example
|
|
3381
3473
|
* ```typescript
|
|
3382
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3474
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3475
|
+
* if (!fWorksheet) return;
|
|
3383
3476
|
* // Get the freeze state of the current sheet
|
|
3384
3477
|
* const freeze = fWorksheet.getFreeze();
|
|
3385
3478
|
* console.log(freeze);
|
|
@@ -3439,7 +3532,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3439
3532
|
* @returns {number} The number of frozen columns, returns 0 if no columns are frozen.
|
|
3440
3533
|
* @example
|
|
3441
3534
|
* ```typescript
|
|
3442
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3535
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3536
|
+
* if (!fWorkSheet) return;
|
|
3443
3537
|
* // Get the number of frozen columns
|
|
3444
3538
|
* const frozenColumns = fWorkSheet.getFrozenColumns();
|
|
3445
3539
|
* console.log(frozenColumns);
|
|
@@ -3455,7 +3549,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3455
3549
|
* @returns {number} The number of frozen rows. returns 0 if no rows are frozen.
|
|
3456
3550
|
* @example
|
|
3457
3551
|
* ```typescript
|
|
3458
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3552
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3553
|
+
* if (!fWorkSheet) return;
|
|
3459
3554
|
* // Get the number of frozen rows
|
|
3460
3555
|
* const frozenRows = fWorkSheet.getFrozenRows();
|
|
3461
3556
|
* console.log(frozenRows);
|
|
@@ -3471,7 +3566,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3471
3566
|
* @returns {IRowRange} The range of the frozen rows.
|
|
3472
3567
|
* @example
|
|
3473
3568
|
* ```ts
|
|
3474
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3569
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3570
|
+
* if (!fWorkSheet) return;
|
|
3475
3571
|
* // Get the range of the frozen rows
|
|
3476
3572
|
* const frozenRows = fWorkSheet.getFrozenRowRange();
|
|
3477
3573
|
* console.log(frozenRows);
|
|
@@ -3489,7 +3585,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3489
3585
|
* @returns {IColumnRange} The range of the frozen columns.
|
|
3490
3586
|
* @example
|
|
3491
3587
|
* ```ts
|
|
3492
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3588
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3589
|
+
* if (!fWorkSheet) return;
|
|
3493
3590
|
* // Get the range of the frozen columns
|
|
3494
3591
|
* const frozenColumns = fWorkSheet.getFrozenColumnRange();
|
|
3495
3592
|
* console.log(frozenColumns);
|
|
@@ -3507,7 +3604,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3507
3604
|
* @returns {boolean} True if the sheet's gridlines are hidden; otherwise false.
|
|
3508
3605
|
* @example
|
|
3509
3606
|
* ```ts
|
|
3510
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3607
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3608
|
+
* if (!fWorkSheet) return;
|
|
3511
3609
|
* // check if the gridlines are hidden
|
|
3512
3610
|
* if (fWorkSheet.hasHiddenGridLines()) {
|
|
3513
3611
|
* console.log('Gridlines are hidden');
|
|
@@ -3523,7 +3621,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3523
3621
|
* @returns {FWorksheet} Returns the current worksheet instance for method chaining
|
|
3524
3622
|
* @example
|
|
3525
3623
|
* ``` ts
|
|
3526
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3624
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3625
|
+
* if (!fWorkSheet) return;
|
|
3527
3626
|
* // hide the gridlines
|
|
3528
3627
|
* fWorkSheet.setHiddenGridlines(true);
|
|
3529
3628
|
* ```
|
|
@@ -3542,7 +3641,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3542
3641
|
* @returns {FWorksheet} Returns the current worksheet instance for method chaining
|
|
3543
3642
|
* @example
|
|
3544
3643
|
* ```ts
|
|
3545
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3644
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3645
|
+
* if (!fWorkSheet) return;
|
|
3546
3646
|
* // set the gridlines color to red
|
|
3547
3647
|
* fWorkSheet.setGridLinesColor('#ff0000');
|
|
3548
3648
|
* ```
|
|
@@ -3561,7 +3661,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3561
3661
|
* @example
|
|
3562
3662
|
* ```ts
|
|
3563
3663
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3564
|
-
* const fWorkSheet = fWorkbook.
|
|
3664
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3665
|
+
* if (!fWorkSheet) return;
|
|
3565
3666
|
* // get the gridlines color of the sheet
|
|
3566
3667
|
* console.log(fWorkSheet.getGridLinesColor());
|
|
3567
3668
|
* ```
|
|
@@ -3576,7 +3677,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3576
3677
|
* @example
|
|
3577
3678
|
* ```ts
|
|
3578
3679
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3579
|
-
* const fWorkSheet = fWorkbook.
|
|
3680
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3681
|
+
* if (!fWorkSheet) return;
|
|
3580
3682
|
* // set the tab color to red
|
|
3581
3683
|
* fWorkSheet.setTabColor('#ff0000');
|
|
3582
3684
|
* ```
|
|
@@ -3596,7 +3698,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3596
3698
|
* @example
|
|
3597
3699
|
* ```ts
|
|
3598
3700
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3599
|
-
* const fWorkSheet = fWorkbook.
|
|
3701
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3702
|
+
* if (!fWorkSheet) return;
|
|
3600
3703
|
* // get the tab color of the sheet
|
|
3601
3704
|
* console.log(fWorkSheet.getTabColor());
|
|
3602
3705
|
* ```
|
|
@@ -3605,34 +3708,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3605
3708
|
return this._worksheet.getTabColor();
|
|
3606
3709
|
}
|
|
3607
3710
|
/**
|
|
3608
|
-
* @deprecated use `univerAPI.addEvent(univerAPI.Event.SheetValueChanged, (params) => {})` instead
|
|
3609
|
-
*/
|
|
3610
|
-
onCellDataChange(callback) {
|
|
3611
|
-
return this._injector.get(_univerjs_core.ICommandService).onCommandExecuted((command) => {
|
|
3612
|
-
if (command.id === _univerjs_sheets.SetRangeValuesMutation.id) {
|
|
3613
|
-
const params = command.params;
|
|
3614
|
-
if (params.unitId === this._workbook.getUnitId() && params.subUnitId === this._worksheet.getSheetId() && params.cellValue) callback(new _univerjs_core.ObjectMatrix(params.cellValue));
|
|
3615
|
-
}
|
|
3616
|
-
});
|
|
3617
|
-
}
|
|
3618
|
-
/**
|
|
3619
|
-
* @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeSheetEditEnd, (params) => {})` instead
|
|
3620
|
-
*/
|
|
3621
|
-
onBeforeCellDataChange(callback) {
|
|
3622
|
-
return this._injector.get(_univerjs_core.ICommandService).beforeCommandExecuted((command) => {
|
|
3623
|
-
if (command.id === _univerjs_sheets.SetRangeValuesMutation.id) {
|
|
3624
|
-
const params = command.params;
|
|
3625
|
-
if (params.unitId === this._workbook.getUnitId() && params.subUnitId === this._worksheet.getSheetId() && params.cellValue) callback(new _univerjs_core.ObjectMatrix(params.cellValue));
|
|
3626
|
-
}
|
|
3627
|
-
});
|
|
3628
|
-
}
|
|
3629
|
-
/**
|
|
3630
3711
|
* Hides this sheet. Has no effect if the sheet is already hidden. If this method is called on the only visible sheet, it throws an exception.
|
|
3631
3712
|
* @returns {FWorksheet} Returns the current worksheet instance for method chaining
|
|
3632
3713
|
* @example
|
|
3633
3714
|
* ```ts
|
|
3634
3715
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3635
|
-
* const fWorkSheet = fWorkbook.
|
|
3716
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3717
|
+
* if (!fWorkSheet) return;
|
|
3636
3718
|
* // hide the active sheet
|
|
3637
3719
|
* fWorkSheet.hideSheet();
|
|
3638
3720
|
* ```
|
|
@@ -3685,7 +3767,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3685
3767
|
* @example
|
|
3686
3768
|
* ```ts
|
|
3687
3769
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3688
|
-
* const fWorkSheet = fWorkbook.
|
|
3770
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3771
|
+
* if (!fWorkSheet) return;
|
|
3689
3772
|
* // set the sheet name to 'Sheet1'
|
|
3690
3773
|
* fWorkSheet.setName('NewSheet1');
|
|
3691
3774
|
* ```
|
|
@@ -3719,7 +3802,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3719
3802
|
* @example
|
|
3720
3803
|
* ```ts
|
|
3721
3804
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3722
|
-
* const fWorkSheet = fWorkbook.
|
|
3805
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3806
|
+
* if (!fWorkSheet) return;
|
|
3723
3807
|
* // get the position of the active sheet
|
|
3724
3808
|
* const position = fWorkSheet.getIndex();
|
|
3725
3809
|
* console.log(position);
|
|
@@ -3737,7 +3821,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3737
3821
|
* @example
|
|
3738
3822
|
* ```ts
|
|
3739
3823
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3740
|
-
* const fWorkSheet = fWorkbook.
|
|
3824
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3825
|
+
* if (!fWorkSheet) return;
|
|
3741
3826
|
* // clear the sheet of content and formatting information
|
|
3742
3827
|
* fWorkSheet.clear();
|
|
3743
3828
|
* // clear the sheet of content only
|
|
@@ -3770,7 +3855,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3770
3855
|
* @example
|
|
3771
3856
|
* ```typescript
|
|
3772
3857
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3773
|
-
* const fWorkSheet = fWorkbook.
|
|
3858
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3859
|
+
* if (!fWorkSheet) return;
|
|
3774
3860
|
* // clear the sheet of content only
|
|
3775
3861
|
* fWorkSheet.clearContents();
|
|
3776
3862
|
* ```
|
|
@@ -3798,7 +3884,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3798
3884
|
* @example
|
|
3799
3885
|
* ```typescript
|
|
3800
3886
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3801
|
-
* const fWorkSheet = fWorkbook.
|
|
3887
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3888
|
+
* if (!fWorkSheet) return;
|
|
3802
3889
|
* // clear the sheet of formatting only
|
|
3803
3890
|
* fWorkSheet.clearFormats();
|
|
3804
3891
|
* ```
|
|
@@ -3822,12 +3909,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3822
3909
|
}
|
|
3823
3910
|
/**
|
|
3824
3911
|
* Returns a Range corresponding to the dimensions in which data is present.
|
|
3825
|
-
*
|
|
3912
|
+
* Empty cells with style or formatting will also be included in the data range. If there is no data on the sheet, returns a Range corresponding to the top-left cell of the sheet (A1).
|
|
3826
3913
|
* @returns {FRange} The range of the data in the sheet.
|
|
3827
3914
|
* @example
|
|
3828
3915
|
* ```ts
|
|
3829
3916
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3830
|
-
* const fWorkSheet = fWorkbook.
|
|
3917
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3918
|
+
* if (!fWorkSheet) return;
|
|
3831
3919
|
* // Assume the sheet is a empty sheet
|
|
3832
3920
|
* const cellRange = fWorkSheet.getRange('J50');
|
|
3833
3921
|
* cellRange.setValue('Hello World');
|
|
@@ -3839,20 +3927,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3839
3927
|
return this.getRange(startRow, startColumn, endRow - startRow + 1, endColumn - startColumn + 1);
|
|
3840
3928
|
}
|
|
3841
3929
|
/**
|
|
3842
|
-
* @deprecated use `getLastColumn` instead.
|
|
3843
|
-
* Returns the column index of the last column that contains content.
|
|
3844
|
-
* @returns {number} the column index of the last column that contains content.
|
|
3845
|
-
*/
|
|
3846
|
-
getLastColumns() {
|
|
3847
|
-
return this._worksheet.getLastColumnWithContent();
|
|
3848
|
-
}
|
|
3849
|
-
/**
|
|
3850
3930
|
* Returns the column index of the last column that contains content.
|
|
3851
3931
|
* @returns {number} the column index of the last column that contains content.
|
|
3852
3932
|
* @example
|
|
3853
3933
|
* ```ts
|
|
3854
3934
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3855
|
-
* const fWorkSheet = fWorkbook.
|
|
3935
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3936
|
+
* if (!fWorkSheet) return;
|
|
3856
3937
|
* // Assume the sheet is a empty sheet
|
|
3857
3938
|
* const cellRange = fWorkSheet.getRange('J50');
|
|
3858
3939
|
* cellRange.setValue('Hello World');
|
|
@@ -3863,20 +3944,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3863
3944
|
return this._worksheet.getLastColumnWithContent();
|
|
3864
3945
|
}
|
|
3865
3946
|
/**
|
|
3866
|
-
* @deprecated use `getLastRow` instead.
|
|
3867
|
-
* Returns the row index of the last row that contains content.
|
|
3868
|
-
* @returns {number} the row index of the last row that contains content.
|
|
3869
|
-
*/
|
|
3870
|
-
getLastRows() {
|
|
3871
|
-
return this._worksheet.getLastRowWithContent();
|
|
3872
|
-
}
|
|
3873
|
-
/**
|
|
3874
3947
|
* Returns the row index of the last row that contains content.
|
|
3875
3948
|
* @returns {number} the row index of the last row that contains content.
|
|
3876
3949
|
* @example
|
|
3877
3950
|
* ```ts
|
|
3878
3951
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3879
|
-
* const fWorkSheet = fWorkbook.
|
|
3952
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3953
|
+
* if (!fWorkSheet) return;
|
|
3880
3954
|
* // Assume the sheet is a empty sheet
|
|
3881
3955
|
* const cellRange = fWorkSheet.getRange('J50');
|
|
3882
3956
|
* cellRange.setValue('Hello World');
|
|
@@ -3894,7 +3968,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3894
3968
|
* ```ts
|
|
3895
3969
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3896
3970
|
* const sheets = fWorkbook.getSheets();
|
|
3897
|
-
* const fWorkSheet = fWorkbook.
|
|
3971
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3972
|
+
* if (!fWorkSheet) return;
|
|
3898
3973
|
* console.log(fWorkSheet.equalTo(sheets[0])); // true, if the active sheet is the first sheet.
|
|
3899
3974
|
* ```
|
|
3900
3975
|
*/
|
|
@@ -3909,7 +3984,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3909
3984
|
* @example
|
|
3910
3985
|
* ```ts
|
|
3911
3986
|
* // The code below inserts a defined name
|
|
3912
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3987
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3988
|
+
* if (!fWorksheet) return;
|
|
3913
3989
|
* fWorksheet.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');
|
|
3914
3990
|
* ```
|
|
3915
3991
|
*/
|
|
@@ -3923,7 +3999,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3923
3999
|
* @example
|
|
3924
4000
|
* ```ts
|
|
3925
4001
|
* // The code below gets all the defined names in the worksheet
|
|
3926
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
4002
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
4003
|
+
* if (!fWorksheet) return;
|
|
3927
4004
|
* const definedNames = fWorksheet.getDefinedNames();
|
|
3928
4005
|
* console.log(definedNames, definedNames[0]?.getFormulaOrRefString());
|
|
3929
4006
|
* ```
|
|
@@ -3938,7 +4015,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3938
4015
|
* @example
|
|
3939
4016
|
* ```ts
|
|
3940
4017
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3941
|
-
* const fWorkSheet = fWorkbook.
|
|
4018
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4019
|
+
* if (!fWorkSheet) return;
|
|
3942
4020
|
* fWorkSheet.setCustomMetadata({ key: 'value' });
|
|
3943
4021
|
* ```
|
|
3944
4022
|
*/
|
|
@@ -3952,7 +4030,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3952
4030
|
* @example
|
|
3953
4031
|
* ```ts
|
|
3954
4032
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3955
|
-
* const fWorkSheet = fWorkbook.
|
|
4033
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4034
|
+
* if (!fWorkSheet) return;
|
|
3956
4035
|
* const custom = fWorkSheet.getCustomMetadata();
|
|
3957
4036
|
* console.log(custom);
|
|
3958
4037
|
* ```
|
|
@@ -3968,7 +4047,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3968
4047
|
* @example
|
|
3969
4048
|
* ```ts
|
|
3970
4049
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3971
|
-
* const fWorkSheet = fWorkbook.
|
|
4050
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4051
|
+
* if (!fWorkSheet) return;
|
|
3972
4052
|
* fWorkSheet.setRowCustomMetadata(0, { key: 'value' });
|
|
3973
4053
|
* ```
|
|
3974
4054
|
*/
|
|
@@ -3984,7 +4064,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3984
4064
|
* @example
|
|
3985
4065
|
* ```ts
|
|
3986
4066
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3987
|
-
* const fWorkSheet = fWorkbook.
|
|
4067
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4068
|
+
* if (!fWorkSheet) return;
|
|
3988
4069
|
* fWorkSheet.setColumnCustomMetadata(0, { key: 'value' });
|
|
3989
4070
|
* ```
|
|
3990
4071
|
*/
|
|
@@ -3999,7 +4080,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3999
4080
|
* @example
|
|
4000
4081
|
* ```ts
|
|
4001
4082
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4002
|
-
* const fWorkSheet = fWorkbook.
|
|
4083
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4084
|
+
* if (!fWorkSheet) return;
|
|
4003
4085
|
* const custom = fWorkSheet.getRowCustomMetadata(0);
|
|
4004
4086
|
* console.log(custom);
|
|
4005
4087
|
* ```
|
|
@@ -4014,7 +4096,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
4014
4096
|
* @example
|
|
4015
4097
|
* ```ts
|
|
4016
4098
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4017
|
-
* const fWorkSheet = fWorkbook.
|
|
4099
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4100
|
+
* if (!fWorkSheet) return;
|
|
4018
4101
|
* const custom = fWorkSheet.getColumnCustomMetadata(0);
|
|
4019
4102
|
* console.log(custom);
|
|
4020
4103
|
* ```
|
|
@@ -4031,7 +4114,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
4031
4114
|
* // Appends a new row with 4 columns to the bottom of the current
|
|
4032
4115
|
* // data region in the sheet containing the values in the array.
|
|
4033
4116
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4034
|
-
* const fWorkSheet = fWorkbook.
|
|
4117
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4118
|
+
* if (!fWorkSheet) return;
|
|
4035
4119
|
* fWorkSheet.appendRow([1, 'Hello Univer', true, '=A1']);
|
|
4036
4120
|
* ```
|
|
4037
4121
|
*/
|
|
@@ -4061,7 +4145,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
4061
4145
|
* @example
|
|
4062
4146
|
* ```ts
|
|
4063
4147
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4064
|
-
* const fWorkSheet = fWorkbook.
|
|
4148
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4149
|
+
* if (!fWorkSheet) return;
|
|
4065
4150
|
*
|
|
4066
4151
|
* // Set the number of rows in the worksheet to 40
|
|
4067
4152
|
* fWorkSheet.setRowCount(40);
|
|
@@ -4082,7 +4167,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
4082
4167
|
* @example
|
|
4083
4168
|
* ```ts
|
|
4084
4169
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4085
|
-
* const fWorkSheet = fWorkbook.
|
|
4170
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4171
|
+
* if (!fWorkSheet) return;
|
|
4086
4172
|
*
|
|
4087
4173
|
* // Set the number of columns in the worksheet to 10
|
|
4088
4174
|
* fWorkSheet.setColumnCount(10);
|
|
@@ -4102,7 +4188,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
4102
4188
|
* @returns {FWorksheetPermission} - The WorksheetPermission instance.
|
|
4103
4189
|
* @example
|
|
4104
4190
|
* ```ts
|
|
4105
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
4191
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
4192
|
+
* if (!fWorksheet) return;
|
|
4106
4193
|
* const permission = fWorksheet.getWorksheetPermission();
|
|
4107
4194
|
*
|
|
4108
4195
|
* // Set worksheet to read-only mode
|
|
@@ -4156,7 +4243,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
|
|
|
4156
4243
|
* @example
|
|
4157
4244
|
* ```ts
|
|
4158
4245
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4159
|
-
* const fWorksheet = fWorkbook.
|
|
4246
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4247
|
+
* if (!fWorksheet) return;
|
|
4160
4248
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4161
4249
|
* // Check if the A1:B2 range is protected
|
|
4162
4250
|
* const isProtected = fRange.getRangePermission().isProtected();
|
|
@@ -4173,7 +4261,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
|
|
|
4173
4261
|
* @example
|
|
4174
4262
|
* ```ts
|
|
4175
4263
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4176
|
-
* const fWorksheet = fWorkbook.
|
|
4264
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4265
|
+
* if (!fWorksheet) return;
|
|
4177
4266
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4178
4267
|
* const rule = await fRange.getRangePermission().protect({
|
|
4179
4268
|
* name: 'My protected range',
|
|
@@ -4243,7 +4332,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
|
|
|
4243
4332
|
* @example
|
|
4244
4333
|
* ```ts
|
|
4245
4334
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4246
|
-
* const fWorksheet = fWorkbook.
|
|
4335
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4336
|
+
* if (!fWorksheet) return;
|
|
4247
4337
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4248
4338
|
* const result = await fRange.getRangePermission().unprotect();
|
|
4249
4339
|
* console.log(result);
|
|
@@ -4265,7 +4355,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
|
|
|
4265
4355
|
* @example
|
|
4266
4356
|
* ```ts
|
|
4267
4357
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4268
|
-
* const fWorksheet = fWorkbook.
|
|
4358
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4359
|
+
* if (!fWorksheet) return;
|
|
4269
4360
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4270
4361
|
* const rules = await fRange.getRangePermission().listRules();
|
|
4271
4362
|
* console.log(rules);
|
|
@@ -4309,7 +4400,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4309
4400
|
* @example
|
|
4310
4401
|
* ```ts
|
|
4311
4402
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4312
|
-
* const fWorksheet = fWorkbook.
|
|
4403
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4404
|
+
* if (!fWorksheet) return;
|
|
4313
4405
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4314
4406
|
* console.log(fRange.getUnitId());
|
|
4315
4407
|
* ```
|
|
@@ -4323,7 +4415,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4323
4415
|
* @example
|
|
4324
4416
|
* ```ts
|
|
4325
4417
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4326
|
-
* const fWorksheet = fWorkbook.
|
|
4418
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4419
|
+
* if (!fWorksheet) return;
|
|
4327
4420
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4328
4421
|
* console.log(fRange.getSheetName());
|
|
4329
4422
|
* ```
|
|
@@ -4337,7 +4430,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4337
4430
|
* @example
|
|
4338
4431
|
* ```ts
|
|
4339
4432
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4340
|
-
* const fWorksheet = fWorkbook.
|
|
4433
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4434
|
+
* if (!fWorksheet) return;
|
|
4341
4435
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4342
4436
|
* console.log(fRange.getSheetId());
|
|
4343
4437
|
* ```
|
|
@@ -4351,7 +4445,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4351
4445
|
* @example
|
|
4352
4446
|
* ```ts
|
|
4353
4447
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4354
|
-
* const fWorksheet = fWorkbook.
|
|
4448
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4449
|
+
* if (!fWorksheet) return;
|
|
4355
4450
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4356
4451
|
* const range = fRange.getRange();
|
|
4357
4452
|
* const { startRow, startColumn, endRow, endColumn } = range;
|
|
@@ -4367,7 +4462,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4367
4462
|
* @example
|
|
4368
4463
|
* ```ts
|
|
4369
4464
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4370
|
-
* const fWorksheet = fWorkbook.
|
|
4465
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4466
|
+
* if (!fWorksheet) return;
|
|
4371
4467
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4372
4468
|
* console.log(fRange.getRow()); // 0
|
|
4373
4469
|
* ```
|
|
@@ -4381,7 +4477,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4381
4477
|
* @example
|
|
4382
4478
|
* ```ts
|
|
4383
4479
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4384
|
-
* const fWorksheet = fWorkbook.
|
|
4480
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4481
|
+
* if (!fWorksheet) return;
|
|
4385
4482
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4386
4483
|
* console.log(fRange.getLastRow()); // 1
|
|
4387
4484
|
* ```
|
|
@@ -4395,7 +4492,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4395
4492
|
* @example
|
|
4396
4493
|
* ```ts
|
|
4397
4494
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4398
|
-
* const fWorksheet = fWorkbook.
|
|
4495
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4496
|
+
* if (!fWorksheet) return;
|
|
4399
4497
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4400
4498
|
* console.log(fRange.getColumn()); // 0
|
|
4401
4499
|
* ```
|
|
@@ -4409,7 +4507,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4409
4507
|
* @example
|
|
4410
4508
|
* ```ts
|
|
4411
4509
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4412
|
-
* const fWorksheet = fWorkbook.
|
|
4510
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4511
|
+
* if (!fWorksheet) return;
|
|
4413
4512
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4414
4513
|
* console.log(fRange.getLastColumn()); // 1
|
|
4415
4514
|
* ```
|
|
@@ -4423,7 +4522,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4423
4522
|
* @example
|
|
4424
4523
|
* ```ts
|
|
4425
4524
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4426
|
-
* const fWorksheet = fWorkbook.
|
|
4525
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4526
|
+
* if (!fWorksheet) return;
|
|
4427
4527
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4428
4528
|
* console.log(fRange.getWidth());
|
|
4429
4529
|
* ```
|
|
@@ -4437,7 +4537,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4437
4537
|
* @example
|
|
4438
4538
|
* ```ts
|
|
4439
4539
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4440
|
-
* const fWorksheet = fWorkbook.
|
|
4540
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4541
|
+
* if (!fWorksheet) return;
|
|
4441
4542
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4442
4543
|
* console.log(fRange.getHeight());
|
|
4443
4544
|
* ```
|
|
@@ -4451,7 +4552,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4451
4552
|
* @example
|
|
4452
4553
|
* ```ts
|
|
4453
4554
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4454
|
-
* const fWorksheet = fWorkbook.
|
|
4555
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4556
|
+
* if (!fWorksheet) return;
|
|
4455
4557
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4456
4558
|
* console.log(fRange.isMerged());
|
|
4457
4559
|
* // merge cells A1:B2
|
|
@@ -4476,7 +4578,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4476
4578
|
* @example
|
|
4477
4579
|
* ```ts
|
|
4478
4580
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4479
|
-
* const fWorksheet = fWorkbook.
|
|
4581
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4582
|
+
* if (!fWorksheet) return;
|
|
4480
4583
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4481
4584
|
* console.log(fRange.getCellStyleData());
|
|
4482
4585
|
* ```
|
|
@@ -4497,7 +4600,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4497
4600
|
* @example
|
|
4498
4601
|
* ```ts
|
|
4499
4602
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4500
|
-
* const fWorksheet = fWorkbook.
|
|
4603
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4604
|
+
* if (!fWorksheet) return;
|
|
4501
4605
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4502
4606
|
* console.log(fRange.getFontFamily());
|
|
4503
4607
|
* ```
|
|
@@ -4518,7 +4622,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4518
4622
|
* @example
|
|
4519
4623
|
* ```ts
|
|
4520
4624
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4521
|
-
* const fWorksheet = fWorkbook.
|
|
4625
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4626
|
+
* if (!fWorksheet) return;
|
|
4522
4627
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4523
4628
|
* console.log(fRange.getFontSize());
|
|
4524
4629
|
* ```
|
|
@@ -4539,7 +4644,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4539
4644
|
* @example
|
|
4540
4645
|
* ```ts
|
|
4541
4646
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4542
|
-
* const fWorksheet = fWorkbook.
|
|
4647
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4648
|
+
* if (!fWorksheet) return;
|
|
4543
4649
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4544
4650
|
* console.log(fRange.getCellStyle());
|
|
4545
4651
|
* ```
|
|
@@ -4560,7 +4666,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4560
4666
|
* @example
|
|
4561
4667
|
* ```ts
|
|
4562
4668
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4563
|
-
* const fWorksheet = fWorkbook.
|
|
4669
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4670
|
+
* if (!fWorksheet) return;
|
|
4564
4671
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4565
4672
|
* console.log(fRange.getCellStyles());
|
|
4566
4673
|
* ```
|
|
@@ -4583,7 +4690,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4583
4690
|
* @example
|
|
4584
4691
|
* ```ts
|
|
4585
4692
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4586
|
-
* const fWorksheet = fWorkbook.
|
|
4693
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4694
|
+
* if (!fWorksheet) return;
|
|
4587
4695
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4588
4696
|
* fRange.setValueForCell({
|
|
4589
4697
|
* v: 0.2,
|
|
@@ -4608,7 +4716,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4608
4716
|
* @example
|
|
4609
4717
|
* ```ts
|
|
4610
4718
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4611
|
-
* const fWorksheet = fWorkbook.
|
|
4719
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4720
|
+
* if (!fWorksheet) return;
|
|
4612
4721
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4613
4722
|
* fRange.setValueForCell({
|
|
4614
4723
|
* v: 0.2,
|
|
@@ -4647,7 +4756,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4647
4756
|
* @example
|
|
4648
4757
|
* ```ts
|
|
4649
4758
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4650
|
-
* const fWorksheet = fWorkbook.
|
|
4759
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4760
|
+
* if (!fWorksheet) return;
|
|
4651
4761
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4652
4762
|
* fRange.setValues([
|
|
4653
4763
|
* [
|
|
@@ -4708,7 +4818,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4708
4818
|
* @example
|
|
4709
4819
|
* ```ts
|
|
4710
4820
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4711
|
-
* const fWorksheet = fWorkbook.
|
|
4821
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4822
|
+
* if (!fWorksheet) return;
|
|
4712
4823
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4713
4824
|
* fRange.setValues([
|
|
4714
4825
|
* [
|
|
@@ -4768,7 +4879,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4768
4879
|
* @example
|
|
4769
4880
|
* ```ts
|
|
4770
4881
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4771
|
-
* const fWorksheet = fWorkbook.
|
|
4882
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4883
|
+
* if (!fWorksheet) return;
|
|
4772
4884
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4773
4885
|
* console.log(fRange.getCellData());
|
|
4774
4886
|
* ```
|
|
@@ -4783,7 +4895,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4783
4895
|
* @example
|
|
4784
4896
|
* ```ts
|
|
4785
4897
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4786
|
-
* const fWorksheet = fWorkbook.
|
|
4898
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4899
|
+
* if (!fWorksheet) return;
|
|
4787
4900
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4788
4901
|
* console.log(fRange.getCellDatas());
|
|
4789
4902
|
* ```
|
|
@@ -4797,7 +4910,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4797
4910
|
* @example
|
|
4798
4911
|
* ```ts
|
|
4799
4912
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4800
|
-
* const fWorksheet = fWorkbook.
|
|
4913
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4914
|
+
* if (!fWorksheet) return;
|
|
4801
4915
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4802
4916
|
* console.log(fRange.getCellDataGrid());
|
|
4803
4917
|
* ```
|
|
@@ -4820,7 +4934,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4820
4934
|
* @example
|
|
4821
4935
|
* ```ts
|
|
4822
4936
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4823
|
-
* const fWorksheet = fWorkbook.
|
|
4937
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4938
|
+
* if (!fWorksheet) return;
|
|
4824
4939
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4825
4940
|
* console.log(fRange.getRichTextValue());
|
|
4826
4941
|
* ```
|
|
@@ -4838,7 +4953,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4838
4953
|
* @example
|
|
4839
4954
|
* ```ts
|
|
4840
4955
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4841
|
-
* const fWorksheet = fWorkbook.
|
|
4956
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4957
|
+
* if (!fWorksheet) return;
|
|
4842
4958
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4843
4959
|
* console.log(fRange.getRichTextValues());
|
|
4844
4960
|
* ```
|
|
@@ -4854,7 +4970,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4854
4970
|
* @example
|
|
4855
4971
|
* ```ts
|
|
4856
4972
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4857
|
-
* const fWorksheet = fWorkbook.
|
|
4973
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4974
|
+
* if (!fWorksheet) return;
|
|
4858
4975
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4859
4976
|
* console.log(fRange.getValueAndRichTextValue());
|
|
4860
4977
|
* ```
|
|
@@ -4869,7 +4986,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4869
4986
|
* @example
|
|
4870
4987
|
* ```ts
|
|
4871
4988
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4872
|
-
* const fWorksheet = fWorkbook.
|
|
4989
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4990
|
+
* if (!fWorksheet) return;
|
|
4873
4991
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4874
4992
|
* console.log(fRange.getValueAndRichTextValues());
|
|
4875
4993
|
* ```
|
|
@@ -4883,7 +5001,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4883
5001
|
* @example
|
|
4884
5002
|
* ```ts
|
|
4885
5003
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4886
|
-
* const fWorksheet = fWorkbook.
|
|
5004
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5005
|
+
* if (!fWorksheet) return;
|
|
4887
5006
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4888
5007
|
* console.log(fRange.getFormula());
|
|
4889
5008
|
* ```
|
|
@@ -4898,7 +5017,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4898
5017
|
* @example
|
|
4899
5018
|
* ```ts
|
|
4900
5019
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4901
|
-
* const fWorksheet = fWorkbook.
|
|
5020
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5021
|
+
* if (!fWorksheet) return;
|
|
4902
5022
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4903
5023
|
* console.log(fRange.getFormulas());
|
|
4904
5024
|
* ```
|
|
@@ -4924,7 +5044,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4924
5044
|
* @example
|
|
4925
5045
|
* ```ts
|
|
4926
5046
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4927
|
-
* const fWorksheet = fWorkbook.
|
|
5047
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5048
|
+
* if (!fWorksheet) return;
|
|
4928
5049
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4929
5050
|
* console.log(fRange.getWrap());
|
|
4930
5051
|
* ```
|
|
@@ -4938,7 +5059,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4938
5059
|
* @example
|
|
4939
5060
|
* ```ts
|
|
4940
5061
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4941
|
-
* const fWorksheet = fWorkbook.
|
|
5062
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5063
|
+
* if (!fWorksheet) return;
|
|
4942
5064
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4943
5065
|
* console.log(fRange.getWraps());
|
|
4944
5066
|
*/
|
|
@@ -4956,7 +5078,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4956
5078
|
* @example
|
|
4957
5079
|
* ```ts
|
|
4958
5080
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4959
|
-
* const fWorksheet = fWorkbook.
|
|
5081
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5082
|
+
* if (!fWorksheet) return;
|
|
4960
5083
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4961
5084
|
* console.log(fRange.getWrapStrategy());
|
|
4962
5085
|
* ```
|
|
@@ -4970,7 +5093,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4970
5093
|
* @example
|
|
4971
5094
|
* ```ts
|
|
4972
5095
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4973
|
-
* const fWorksheet = fWorkbook.
|
|
5096
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5097
|
+
* if (!fWorksheet) return;
|
|
4974
5098
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4975
5099
|
* console.log(fRange.getHorizontalAlignment());
|
|
4976
5100
|
* ```
|
|
@@ -4984,7 +5108,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4984
5108
|
* @example
|
|
4985
5109
|
* ```ts
|
|
4986
5110
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4987
|
-
* const fWorksheet = fWorkbook.
|
|
5111
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5112
|
+
* if (!fWorksheet) return;
|
|
4988
5113
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4989
5114
|
* console.log(fRange.getHorizontalAlignments());
|
|
4990
5115
|
* ```
|
|
@@ -4998,7 +5123,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4998
5123
|
* @example
|
|
4999
5124
|
* ```ts
|
|
5000
5125
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5001
|
-
* const fWorksheet = fWorkbook.
|
|
5126
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5127
|
+
* if (!fWorksheet) return;
|
|
5002
5128
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5003
5129
|
* console.log(fRange.getVerticalAlignment());
|
|
5004
5130
|
* ```
|
|
@@ -5012,7 +5138,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5012
5138
|
* @example
|
|
5013
5139
|
* ```ts
|
|
5014
5140
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5015
|
-
* const fWorksheet = fWorkbook.
|
|
5141
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5142
|
+
* if (!fWorksheet) return;
|
|
5016
5143
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5017
5144
|
* console.log(fRange.getVerticalAlignments());
|
|
5018
5145
|
* ```
|
|
@@ -5026,7 +5153,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5026
5153
|
* @returns {FRange} This range, for chaining
|
|
5027
5154
|
* ```ts
|
|
5028
5155
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5029
|
-
* const fWorksheet = fWorkbook.
|
|
5156
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5157
|
+
* if (!fWorksheet) return;
|
|
5030
5158
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5031
5159
|
* fRange.setCustomMetaData({ key: 'value' });
|
|
5032
5160
|
* console.log(fRange.getCustomMetaData());
|
|
@@ -5048,7 +5176,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5048
5176
|
* @returns {FRange} This range, for chaining
|
|
5049
5177
|
* ```ts
|
|
5050
5178
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5051
|
-
* const fWorksheet = fWorkbook.
|
|
5179
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5180
|
+
* if (!fWorksheet) return;
|
|
5052
5181
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5053
5182
|
* fRange.setCustomMetaDatas([
|
|
5054
5183
|
* [{ key: 'value' }, { key: 'value2' }],
|
|
@@ -5073,7 +5202,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5073
5202
|
* @example
|
|
5074
5203
|
* ```
|
|
5075
5204
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5076
|
-
* const fWorksheet = fWorkbook.
|
|
5205
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5206
|
+
* if (!fWorksheet) return;
|
|
5077
5207
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5078
5208
|
* console.log(fRange.getCustomMetaData());
|
|
5079
5209
|
* ```
|
|
@@ -5089,7 +5219,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5089
5219
|
* @example
|
|
5090
5220
|
* ```
|
|
5091
5221
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5092
|
-
* const fWorksheet = fWorkbook.
|
|
5222
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5223
|
+
* if (!fWorksheet) return;
|
|
5093
5224
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5094
5225
|
* console.log(fRange.getCustomMetaDatas());
|
|
5095
5226
|
* ```
|
|
@@ -5109,7 +5240,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5109
5240
|
* @example
|
|
5110
5241
|
* ```ts
|
|
5111
5242
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5112
|
-
* const fWorksheet = fWorkbook.
|
|
5243
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5244
|
+
* if (!fWorksheet) return;
|
|
5113
5245
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5114
5246
|
* fRange.setBorder(univerAPI.Enum.BorderType.ALL, univerAPI.Enum.BorderStyleTypes.THIN, '#ff0000');
|
|
5115
5247
|
* ```
|
|
@@ -5133,7 +5265,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5133
5265
|
* @example
|
|
5134
5266
|
* ```ts
|
|
5135
5267
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5136
|
-
* const fWorksheet = fWorkbook.
|
|
5268
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5269
|
+
* if (!fWorksheet) return;
|
|
5137
5270
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5138
5271
|
* console.log(fRange.getBackground());
|
|
5139
5272
|
* ```
|
|
@@ -5149,7 +5282,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5149
5282
|
* @example
|
|
5150
5283
|
* ```ts
|
|
5151
5284
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5152
|
-
* const fWorksheet = fWorkbook.
|
|
5285
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5286
|
+
* if (!fWorksheet) return;
|
|
5153
5287
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5154
5288
|
* console.log(fRange.getBackgrounds());
|
|
5155
5289
|
* ```
|
|
@@ -5167,7 +5301,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5167
5301
|
* @example
|
|
5168
5302
|
* ```ts
|
|
5169
5303
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5170
|
-
* const fWorksheet = fWorkbook.
|
|
5304
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5305
|
+
* if (!fWorksheet) return;
|
|
5171
5306
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5172
5307
|
* fRange.setBackgroundColor('red');
|
|
5173
5308
|
* ```
|
|
@@ -5191,7 +5326,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5191
5326
|
* @example
|
|
5192
5327
|
* ```typescript
|
|
5193
5328
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5194
|
-
* const fWorksheet = fWorkbook.
|
|
5329
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5330
|
+
* if (!fWorksheet) return;
|
|
5195
5331
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5196
5332
|
* fRange.setBackground('red');
|
|
5197
5333
|
* ```
|
|
@@ -5207,7 +5343,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5207
5343
|
* @example
|
|
5208
5344
|
* ```typescript
|
|
5209
5345
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5210
|
-
* const fWorksheet = fWorkbook.
|
|
5346
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5347
|
+
* if (!fWorksheet) return;
|
|
5211
5348
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5212
5349
|
* fRange.setTextRotation(45);
|
|
5213
5350
|
* ```
|
|
@@ -5227,7 +5364,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5227
5364
|
* @returns {FRange} This range, for chaining
|
|
5228
5365
|
* ```ts
|
|
5229
5366
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5230
|
-
* const fWorksheet = fWorkbook.
|
|
5367
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5368
|
+
* if (!fWorksheet) return;
|
|
5231
5369
|
* const fRange = fWorksheet.getRange('B2');
|
|
5232
5370
|
* fRange.setValue(123);
|
|
5233
5371
|
*
|
|
@@ -5252,7 +5390,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5252
5390
|
* @returns {FRange} This range, for chaining
|
|
5253
5391
|
* ```ts
|
|
5254
5392
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5255
|
-
* const fWorksheet = fWorkbook.
|
|
5393
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5394
|
+
* if (!fWorksheet) return;
|
|
5256
5395
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5257
5396
|
* fRange.setValueForCell(123);
|
|
5258
5397
|
*
|
|
@@ -5283,7 +5422,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5283
5422
|
* @example
|
|
5284
5423
|
* ```
|
|
5285
5424
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5286
|
-
* const fWorksheet = fWorkbook.
|
|
5425
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5426
|
+
* if (!fWorksheet) return;
|
|
5287
5427
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5288
5428
|
* console.log(fRange.getValue(true));
|
|
5289
5429
|
*
|
|
@@ -5319,7 +5459,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5319
5459
|
* @example
|
|
5320
5460
|
* ```ts
|
|
5321
5461
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5322
|
-
* const fWorksheet = fWorkbook.
|
|
5462
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5463
|
+
* if (!fWorksheet) return;
|
|
5323
5464
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5324
5465
|
* console.log(fRange.getValue(true));
|
|
5325
5466
|
*
|
|
@@ -5354,7 +5495,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5354
5495
|
* @example
|
|
5355
5496
|
* ```ts
|
|
5356
5497
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5357
|
-
* const fWorksheet = fWorkbook.
|
|
5498
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5499
|
+
* if (!fWorksheet) return;
|
|
5358
5500
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5359
5501
|
* fRange.setWrap(true);
|
|
5360
5502
|
* console.log(fRange.getWrap());
|
|
@@ -5376,7 +5518,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5376
5518
|
* @example
|
|
5377
5519
|
* ```ts
|
|
5378
5520
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5379
|
-
* const fWorksheet = fWorkbook.
|
|
5521
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5522
|
+
* if (!fWorksheet) return;
|
|
5380
5523
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5381
5524
|
* fRange.setWrapStrategy(univerAPI.Enum.WrapStrategy.WRAP);
|
|
5382
5525
|
* console.log(fRange.getWrapStrategy());
|
|
@@ -5398,7 +5541,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5398
5541
|
* @example
|
|
5399
5542
|
* ```ts
|
|
5400
5543
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5401
|
-
* const fWorksheet = fWorkbook.
|
|
5544
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5545
|
+
* if (!fWorksheet) return;
|
|
5402
5546
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5403
5547
|
* fRange.setVerticalAlignment('top');
|
|
5404
5548
|
* ```
|
|
@@ -5419,7 +5563,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5419
5563
|
* @example
|
|
5420
5564
|
* ```ts
|
|
5421
5565
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5422
|
-
* const fWorksheet = fWorkbook.
|
|
5566
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5567
|
+
* if (!fWorksheet) return;
|
|
5423
5568
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5424
5569
|
* fRange.setHorizontalAlignment('left');
|
|
5425
5570
|
* ```
|
|
@@ -5440,7 +5585,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5440
5585
|
* @example
|
|
5441
5586
|
* ```ts
|
|
5442
5587
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5443
|
-
* const fWorksheet = fWorkbook.
|
|
5588
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5589
|
+
* if (!fWorksheet) return;
|
|
5444
5590
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5445
5591
|
* fRange.setValues([
|
|
5446
5592
|
* [1, { v: 2, s: { bg: { rgb: '#ff0000' } } }],
|
|
@@ -5465,7 +5611,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5465
5611
|
* @example
|
|
5466
5612
|
* ```ts
|
|
5467
5613
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5468
|
-
* const fWorksheet = fWorkbook.
|
|
5614
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5615
|
+
* if (!fWorksheet) return;
|
|
5469
5616
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5470
5617
|
* fRange.setFontWeight('bold');
|
|
5471
5618
|
* ```
|
|
@@ -5496,7 +5643,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5496
5643
|
* @example
|
|
5497
5644
|
* ```ts
|
|
5498
5645
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5499
|
-
* const fWorksheet = fWorkbook.
|
|
5646
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5647
|
+
* if (!fWorksheet) return;
|
|
5500
5648
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5501
5649
|
* fRange.setFontStyle('italic');
|
|
5502
5650
|
* ```
|
|
@@ -5527,7 +5675,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5527
5675
|
* @example
|
|
5528
5676
|
* ```ts
|
|
5529
5677
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5530
|
-
* const fWorksheet = fWorkbook.
|
|
5678
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5679
|
+
* if (!fWorksheet) return;
|
|
5531
5680
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5532
5681
|
* fRange.setFontLine('underline');
|
|
5533
5682
|
* ```
|
|
@@ -5587,7 +5736,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5587
5736
|
* @example
|
|
5588
5737
|
* ```ts
|
|
5589
5738
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5590
|
-
* const fWorksheet = fWorkbook.
|
|
5739
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5740
|
+
* if (!fWorksheet) return;
|
|
5591
5741
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5592
5742
|
* fRange.setFontFamily('Arial');
|
|
5593
5743
|
* ```
|
|
@@ -5613,7 +5763,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5613
5763
|
* @example
|
|
5614
5764
|
* ```ts
|
|
5615
5765
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5616
|
-
* const fWorksheet = fWorkbook.
|
|
5766
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5767
|
+
* if (!fWorksheet) return;
|
|
5617
5768
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5618
5769
|
* fRange.setFontSize(24);
|
|
5619
5770
|
* ```
|
|
@@ -5639,7 +5790,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5639
5790
|
* @example
|
|
5640
5791
|
* ```ts
|
|
5641
5792
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5642
|
-
* const fWorksheet = fWorkbook.
|
|
5793
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5794
|
+
* if (!fWorksheet) return;
|
|
5643
5795
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5644
5796
|
* fRange.setFontColor('#ff0000');
|
|
5645
5797
|
* ```
|
|
@@ -5667,7 +5819,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5667
5819
|
* @example
|
|
5668
5820
|
* ```ts
|
|
5669
5821
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5670
|
-
* const fWorksheet = fWorkbook.
|
|
5822
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5823
|
+
* if (!fWorksheet) return;
|
|
5671
5824
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5672
5825
|
* fRange.merge();
|
|
5673
5826
|
* console.log(fRange.isMerged());
|
|
@@ -5675,7 +5828,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5675
5828
|
*
|
|
5676
5829
|
* ```ts
|
|
5677
5830
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5678
|
-
* const fWorksheet = fWorkbook.
|
|
5831
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5832
|
+
* if (!fWorksheet) return;
|
|
5679
5833
|
* const fRange = fWorksheet.getRange('B1:C2');
|
|
5680
5834
|
* // Assume A1:B2 is already merged.
|
|
5681
5835
|
* fRange.merge({ isForceMerge: true });
|
|
@@ -5697,7 +5851,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5697
5851
|
* ```ts
|
|
5698
5852
|
* // Assume the active sheet is a new sheet with no merged cells.
|
|
5699
5853
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5700
|
-
* const fWorksheet = fWorkbook.
|
|
5854
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5855
|
+
* if (!fWorksheet) return;
|
|
5701
5856
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5702
5857
|
* fRange.mergeAcross();
|
|
5703
5858
|
* // There will be two merged cells. A1:B1 and A2:B2.
|
|
@@ -5709,7 +5864,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5709
5864
|
*
|
|
5710
5865
|
* ```ts
|
|
5711
5866
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5712
|
-
* const fWorksheet = fWorkbook.
|
|
5867
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5868
|
+
* if (!fWorksheet) return;
|
|
5713
5869
|
* const fRange = fWorksheet.getRange('B1:C2');
|
|
5714
5870
|
* // Assume A1:B2 is already merged.
|
|
5715
5871
|
* fRange.mergeAcross({ isForceMerge: true });
|
|
@@ -5732,7 +5888,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5732
5888
|
* ```ts
|
|
5733
5889
|
* // Assume the active sheet is a new sheet with no merged cells.
|
|
5734
5890
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5735
|
-
* const fWorksheet = fWorkbook.
|
|
5891
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5892
|
+
* if (!fWorksheet) return;
|
|
5736
5893
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5737
5894
|
* fRange.mergeVertically();
|
|
5738
5895
|
* // There will be two merged cells. A1:A2 and B1:B2.
|
|
@@ -5744,7 +5901,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5744
5901
|
*
|
|
5745
5902
|
* ```ts
|
|
5746
5903
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5747
|
-
* const fWorksheet = fWorkbook.
|
|
5904
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5905
|
+
* if (!fWorksheet) return;
|
|
5748
5906
|
* const fRange = fWorksheet.getRange('B1:C2');
|
|
5749
5907
|
* // Assume A1:B2 is already merged.
|
|
5750
5908
|
* fRange.mergeVertically({ isForceMerge: true });
|
|
@@ -5763,7 +5921,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5763
5921
|
* @example
|
|
5764
5922
|
* ```ts
|
|
5765
5923
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5766
|
-
* const fWorksheet = fWorkbook.
|
|
5924
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5925
|
+
* if (!fWorksheet) return;
|
|
5767
5926
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5768
5927
|
* fRange.merge();
|
|
5769
5928
|
* const anchor = fWorksheet.getRange('A1');
|
|
@@ -5780,7 +5939,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5780
5939
|
* @example
|
|
5781
5940
|
* ```ts
|
|
5782
5941
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5783
|
-
* const fWorksheet = fWorkbook.
|
|
5942
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5943
|
+
* if (!fWorksheet) return;
|
|
5784
5944
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5785
5945
|
* fRange.merge();
|
|
5786
5946
|
* const anchor = fWorksheet.getRange('A1');
|
|
@@ -5805,7 +5965,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5805
5965
|
* @param {ICellData} callback.cell the cell data
|
|
5806
5966
|
* ```ts
|
|
5807
5967
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5808
|
-
* const fWorksheet = fWorkbook.
|
|
5968
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5969
|
+
* if (!fWorksheet) return;
|
|
5809
5970
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5810
5971
|
* fRange.forEach((row, col, cell) => {
|
|
5811
5972
|
* console.log(row, col, cell);
|
|
@@ -5826,7 +5987,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5826
5987
|
* @returns {string} The A1 notation of the range.
|
|
5827
5988
|
* ```ts
|
|
5828
5989
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5829
|
-
* const fWorksheet = fWorkbook.
|
|
5990
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5991
|
+
* if (!fWorksheet) return;
|
|
5830
5992
|
*
|
|
5831
5993
|
* // By default, the A1 notation is returned without the sheet name and without absolute reference types.
|
|
5832
5994
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
@@ -5864,7 +6026,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5864
6026
|
* @example
|
|
5865
6027
|
* ```ts
|
|
5866
6028
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5867
|
-
* const fWorksheet = fWorkbook.
|
|
6029
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6030
|
+
* if (!fWorksheet) return;
|
|
5868
6031
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5869
6032
|
* fRange.activate(); // the active cell will be A1
|
|
5870
6033
|
* ```
|
|
@@ -5882,7 +6045,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5882
6045
|
* @example
|
|
5883
6046
|
* ```ts
|
|
5884
6047
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5885
|
-
* const fWorksheet = fWorkbook.
|
|
6048
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6049
|
+
* if (!fWorksheet) return;
|
|
5886
6050
|
*
|
|
5887
6051
|
* // Set the range A1:B2 as the active range, default active cell is A1
|
|
5888
6052
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
@@ -5934,7 +6098,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5934
6098
|
* @example Show how to split text to columns with custom delimiter
|
|
5935
6099
|
* ```ts
|
|
5936
6100
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5937
|
-
* const fWorksheet = fWorkbook.
|
|
6101
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6102
|
+
* if (!fWorksheet) return;
|
|
5938
6103
|
*
|
|
5939
6104
|
* // A1:A3 has following values:
|
|
5940
6105
|
* // A |
|
|
@@ -5976,7 +6141,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5976
6141
|
* @example
|
|
5977
6142
|
* ```ts
|
|
5978
6143
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5979
|
-
* const fWorksheet = fWorkbook.
|
|
6144
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6145
|
+
* if (!fWorksheet) return;
|
|
5980
6146
|
* const fRange = fWorksheet.getRange('A1:E20');
|
|
5981
6147
|
* fRange.useThemeStyle('default');
|
|
5982
6148
|
* ```
|
|
@@ -5998,7 +6164,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5998
6164
|
* @example
|
|
5999
6165
|
* ```ts
|
|
6000
6166
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6001
|
-
* const fWorksheet = fWorkbook.
|
|
6167
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6168
|
+
* if (!fWorksheet) return;
|
|
6002
6169
|
* const fRange = fWorksheet.getRange('A1:E20');
|
|
6003
6170
|
* fRange.removeThemeStyle('default');
|
|
6004
6171
|
* ```
|
|
@@ -6017,7 +6184,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6017
6184
|
* @example
|
|
6018
6185
|
* ```ts
|
|
6019
6186
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6020
|
-
* const fWorksheet = fWorkbook.
|
|
6187
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6188
|
+
* if (!fWorksheet) return;
|
|
6021
6189
|
* const fRange = fWorksheet.getRange('A1:E20');
|
|
6022
6190
|
* console.log(fRange.getUsedThemeStyle()); // undefined
|
|
6023
6191
|
* fRange.useThemeStyle('default');
|
|
@@ -6040,7 +6208,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6040
6208
|
* @example
|
|
6041
6209
|
* ```ts
|
|
6042
6210
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6043
|
-
* const fWorkSheet = fWorkbook.
|
|
6211
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
6212
|
+
* if (!fWorkSheet) return;
|
|
6044
6213
|
* const fRange = fWorkSheet.getRange('A1:D10');
|
|
6045
6214
|
*
|
|
6046
6215
|
* // clear the content and format of the range A1:D10
|
|
@@ -6067,7 +6236,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6067
6236
|
* @example
|
|
6068
6237
|
* ```typescript
|
|
6069
6238
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6070
|
-
* const fWorkSheet = fWorkbook.
|
|
6239
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
6240
|
+
* if (!fWorkSheet) return;
|
|
6071
6241
|
* const fRange = fWorkSheet.getRange('A1:D10');
|
|
6072
6242
|
*
|
|
6073
6243
|
* // clear the content only of the range A1:D10
|
|
@@ -6088,7 +6258,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6088
6258
|
* @example
|
|
6089
6259
|
* ```typescript
|
|
6090
6260
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6091
|
-
* const fWorkSheet = fWorkbook.
|
|
6261
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
6262
|
+
* if (!fWorkSheet) return;
|
|
6092
6263
|
* const fRange = fWorkSheet.getRange('A1:D10');
|
|
6093
6264
|
* // clear the format only of the range A1:D10
|
|
6094
6265
|
* fRange.clearFormat();
|
|
@@ -6109,7 +6280,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6109
6280
|
* ```ts
|
|
6110
6281
|
* // Assume the active sheet empty sheet.
|
|
6111
6282
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6112
|
-
* const fWorksheet = fWorkbook.
|
|
6283
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6284
|
+
* if (!fWorksheet) return;
|
|
6113
6285
|
* const values = [
|
|
6114
6286
|
* [1, 2, 3, 4],
|
|
6115
6287
|
* [2, 3, 4, 5],
|
|
@@ -6168,7 +6340,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6168
6340
|
* ```ts
|
|
6169
6341
|
* // Assume the active sheet empty sheet.
|
|
6170
6342
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6171
|
-
* const fWorksheet = fWorkbook.
|
|
6343
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6344
|
+
* if (!fWorksheet) return;
|
|
6172
6345
|
* const values = [
|
|
6173
6346
|
* [1, 2, 3, 4],
|
|
6174
6347
|
* [2, 3, 4, 5],
|
|
@@ -6231,7 +6404,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6231
6404
|
* ```ts
|
|
6232
6405
|
* // Assume the active sheet is a new sheet with no data.
|
|
6233
6406
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6234
|
-
* const fWorksheet = fWorkbook.
|
|
6407
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6408
|
+
* if (!fWorksheet) return;
|
|
6235
6409
|
*
|
|
6236
6410
|
* // Set the range A1:D4 with some values, the range A1:D4 will be:
|
|
6237
6411
|
* // | | |
|
|
@@ -6301,7 +6475,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6301
6475
|
* ```ts
|
|
6302
6476
|
* // Assume the active sheet is a new sheet with no data.
|
|
6303
6477
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6304
|
-
* const fWorksheet = fWorkbook.
|
|
6478
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6479
|
+
* if (!fWorksheet) return;
|
|
6305
6480
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
6306
6481
|
* console.log(fRange.isBlank()); // true
|
|
6307
6482
|
*
|
|
@@ -6333,7 +6508,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6333
6508
|
* @example
|
|
6334
6509
|
* ```ts
|
|
6335
6510
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6336
|
-
* const fWorksheet = fWorkbook.
|
|
6511
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6512
|
+
* if (!fWorksheet) return;
|
|
6337
6513
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
6338
6514
|
* console.log(fRange.getA1Notation()); // A1:B2
|
|
6339
6515
|
*
|
|
@@ -6363,7 +6539,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6363
6539
|
* @example
|
|
6364
6540
|
* ```ts
|
|
6365
6541
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6366
|
-
* const fWorksheet = fWorkbook.
|
|
6542
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6543
|
+
* if (!fWorksheet) return;
|
|
6367
6544
|
* const fRange = fWorksheet.getRange('A1');
|
|
6368
6545
|
* fRange.setFormula('=SUM(A2:A5)');
|
|
6369
6546
|
* console.log(fRange.getFormula()); // '=SUM(A2:A5)'
|
|
@@ -6379,7 +6556,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6379
6556
|
* @example
|
|
6380
6557
|
* ```ts
|
|
6381
6558
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6382
|
-
* const fWorksheet = fWorkbook.
|
|
6559
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6560
|
+
* if (!fWorksheet) return;
|
|
6383
6561
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
6384
6562
|
* fRange.setFormulas([
|
|
6385
6563
|
* ['=SUM(A2:A5)', '=SUM(B2:B5)'],
|
|
@@ -6397,7 +6575,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6397
6575
|
* @returns {FRangePermission} - The RangePermission instance.
|
|
6398
6576
|
* @example
|
|
6399
6577
|
* ```ts
|
|
6400
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
6578
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
6579
|
+
* if (!fWorksheet) return;
|
|
6401
6580
|
* const fRange = fWorksheet.getRange('A1:B10');
|
|
6402
6581
|
* const permission = fRange.getRangePermission();
|
|
6403
6582
|
*
|
|
@@ -6432,7 +6611,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6432
6611
|
* ```ts
|
|
6433
6612
|
* // Auto-fill the range D1:D10 based on the data in the range C1:C2
|
|
6434
6613
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6435
|
-
* const fWorksheet = fWorkbook.
|
|
6614
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6615
|
+
* if (!fWorksheet) return;
|
|
6436
6616
|
* const fRange = fWorksheet.getRange('A1:A4');
|
|
6437
6617
|
*
|
|
6438
6618
|
* // Auto-fill without specifying applyType (default behavior)
|
|
@@ -6935,6 +7115,7 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
6935
7115
|
* // The code below gets the active sheet of the workbook
|
|
6936
7116
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6937
7117
|
* const fWorksheet = fWorkbook.getActiveSheet();
|
|
7118
|
+
* if (!fWorksheet) return;
|
|
6938
7119
|
* console.log(fWorksheet);
|
|
6939
7120
|
* ```
|
|
6940
7121
|
*/
|
|
@@ -7250,7 +7431,7 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7250
7431
|
*/
|
|
7251
7432
|
onSelectionChange(callback) {
|
|
7252
7433
|
return (0, _univerjs_core.toDisposable)(this._selectionManagerService.selectionMoveEnd$.subscribe((selections) => {
|
|
7253
|
-
if (this._univerInstanceService.
|
|
7434
|
+
if (this._univerInstanceService.getCurrentUnitOfType(_univerjs_core.UniverInstanceType.UNIVER_SHEET).getUnitId() !== this.id) return;
|
|
7254
7435
|
if (!(selections === null || selections === void 0 ? void 0 : selections.length)) callback([]);
|
|
7255
7436
|
else callback(selections.map((s) => s.range));
|
|
7256
7437
|
}));
|
|
@@ -7279,7 +7460,9 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7279
7460
|
* @example
|
|
7280
7461
|
* ```ts
|
|
7281
7462
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
7282
|
-
* const
|
|
7463
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
7464
|
+
* if (!fWorksheet) return;
|
|
7465
|
+
* const range = fWorksheet.getRange('A10:B10');
|
|
7283
7466
|
* fWorkbook.setActiveRange(range);
|
|
7284
7467
|
* ```
|
|
7285
7468
|
*/
|
|
@@ -7357,7 +7540,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7357
7540
|
* ```ts
|
|
7358
7541
|
* // The code below duplicates the given worksheet
|
|
7359
7542
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
7360
|
-
* const activeSheet = fWorkbook.
|
|
7543
|
+
* const activeSheet = fWorkbook.getSheetByName('Sheet1');
|
|
7544
|
+
* if (!activeSheet) return;
|
|
7361
7545
|
* const duplicatedSheet = fWorkbook.duplicateSheet(activeSheet);
|
|
7362
7546
|
* console.log(duplicatedSheet);
|
|
7363
7547
|
* ```
|
|
@@ -7455,7 +7639,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7455
7639
|
* ```ts
|
|
7456
7640
|
* // The code below moves the sheet to the specified index
|
|
7457
7641
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
7458
|
-
* const sheet = fWorkbook.
|
|
7642
|
+
* const sheet = fWorkbook.getSheetByName('Sheet1');
|
|
7643
|
+
* if (!sheet) return;
|
|
7459
7644
|
* fWorkbook.moveSheet(sheet, 1);
|
|
7460
7645
|
* ```
|
|
7461
7646
|
*/
|
|
@@ -7776,7 +7961,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7776
7961
|
* fWorkbook.addStyles(styles);
|
|
7777
7962
|
*
|
|
7778
7963
|
* // Set values with the new styles
|
|
7779
|
-
* const fWorksheet = fWorkbook.
|
|
7964
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
7965
|
+
* if (!fWorksheet) return;
|
|
7780
7966
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
7781
7967
|
* fRange.setValues([
|
|
7782
7968
|
* [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
|
|
@@ -7811,7 +7997,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7811
7997
|
* fWorkbook.addStyles(styles);
|
|
7812
7998
|
*
|
|
7813
7999
|
* // Set values with the new styles
|
|
7814
|
-
* const fWorksheet = fWorkbook.
|
|
8000
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
8001
|
+
* if (!fWorksheet) return;
|
|
7815
8002
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
7816
8003
|
* fRange.setValues([
|
|
7817
8004
|
* [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
|
|
@@ -8165,7 +8352,7 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
8165
8352
|
return this.createUniverSheet(data, options);
|
|
8166
8353
|
}
|
|
8167
8354
|
getActiveWorkbook() {
|
|
8168
|
-
const workbook = this._univerInstanceService.
|
|
8355
|
+
const workbook = this._univerInstanceService.getCurrentUnitOfType(_univerjs_core.UniverInstanceType.UNIVER_SHEET);
|
|
8169
8356
|
if (!workbook) return null;
|
|
8170
8357
|
return this._injector.createInstance(FWorkbook, workbook);
|
|
8171
8358
|
}
|