@univerjs/sheets 0.24.0 → 0.25.0-insiders.20260608-e4336f7
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 +641 -466
- package/lib/cjs/index.js +146 -128
- 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 +642 -461
- package/lib/es/index.js +139 -129
- 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 +642 -461
- package/lib/index.js +139 -129
- 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/commands/commands/add-range-protection.command.d.ts +1 -1
- package/lib/types/commands/commands/delete-range-protection.command.d.ts +1 -1
- package/lib/types/commands/commands/register-range-theme.command.d.ts +1 -1
- package/lib/types/commands/commands/set-protection.command.d.ts +1 -1
- package/lib/types/commands/mutations/add-range-protection.mutation.d.ts +1 -1
- package/lib/types/commands/mutations/add-range-theme.mutation.d.ts +1 -1
- package/lib/types/commands/mutations/register-range-theme.mutation.d.ts +1 -1
- package/lib/types/commands/mutations/set-range-protection.mutation.d.ts +1 -1
- package/lib/types/commands/mutations/set-range-theme.mutation.d.ts +1 -1
- package/lib/types/controllers/permission/sheet-permission-check.controller.d.ts +1 -1
- package/lib/types/controllers/permission/sheet-permission-init.controller.d.ts +1 -1
- package/lib/types/controllers/permission/sheet-permission-view-model.controller.d.ts +1 -1
- package/lib/types/controllers/zebar-crossing.controller.d.ts +1 -1
- package/lib/types/facade/{f-sheet-hooks.d.ts → const.d.ts} +1 -9
- package/lib/types/facade/f-range.d.ts +187 -94
- package/lib/types/facade/f-selection.d.ts +15 -8
- package/lib/types/facade/f-univer.d.ts +33 -64
- package/lib/types/facade/f-workbook.d.ts +15 -50
- package/lib/types/facade/f-worksheet.d.ts +202 -101
- package/lib/types/facade/index.d.ts +0 -1
- 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 +9 -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/types/services/permission/range-permission/range-protection.ref-range.d.ts +3 -3
- package/lib/types/services/permission/range-permission/range-protection.service.d.ts +2 -2
- package/lib/types/services/permission/type.d.ts +1 -1
- package/lib/types/services/permission/workbook-permission/workbook-permission.service.d.ts +1 -1
- package/lib/types/services/permission/worksheet-permission/worksheet-permission.service.d.ts +1 -1
- package/lib/types/services/range-theme.service.d.ts +3 -3
- 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 +9 -9
- package/LICENSE +0 -176
- /package/lib/types/{model → models}/range-protection-render.model.d.ts +0 -0
- /package/lib/types/{model → models}/range-protection-rule.model.d.ts +0 -0
- /package/lib/types/{model → models}/range-protection.cache.d.ts +0 -0
- /package/lib/types/{model → models}/range-theme-model.d.ts +0 -0
- /package/lib/types/{model → models}/range-theme-util.d.ts +0 -0
- /package/lib/types/{model → models}/range-themes/build-in-theme.factory.d.ts +0 -0
- /package/lib/types/{model → models}/range-themes/default.d.ts +0 -0
- /package/lib/types/{model → models}/zebra-crossing-cache.d.ts +0 -0
package/lib/cjs/facade.js
CHANGED
|
@@ -5,7 +5,26 @@ let _univerjs_sheets = require("@univerjs/sheets");
|
|
|
5
5
|
let _univerjs_engine_formula = require("@univerjs/engine-formula");
|
|
6
6
|
let _univerjs_protocol = require("@univerjs/protocol");
|
|
7
7
|
|
|
8
|
-
//#region
|
|
8
|
+
//#region src/facade/const.ts
|
|
9
|
+
/**
|
|
10
|
+
* Copyright 2023-present DreamNum Co., Ltd.
|
|
11
|
+
*
|
|
12
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
13
|
+
* you may not use this file except in compliance with the License.
|
|
14
|
+
* You may obtain a copy of the License at
|
|
15
|
+
*
|
|
16
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
17
|
+
*
|
|
18
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
19
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
20
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
21
|
+
* See the License for the specific language governing permissions and
|
|
22
|
+
* limitations under the License.
|
|
23
|
+
*/
|
|
24
|
+
const SHEETS_CUSTOM_FIELD_WARNING_MESSAGE = "[Facade]: The sheets custom field is not recommended for external use. Use it at your own risk.";
|
|
25
|
+
|
|
26
|
+
//#endregion
|
|
27
|
+
//#region \0@oxc-project+runtime@0.134.0/helpers/esm/typeof.js
|
|
9
28
|
function _typeof(o) {
|
|
10
29
|
"@babel/helpers - typeof";
|
|
11
30
|
return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
|
|
@@ -16,7 +35,7 @@ function _typeof(o) {
|
|
|
16
35
|
}
|
|
17
36
|
|
|
18
37
|
//#endregion
|
|
19
|
-
//#region \0@oxc-project+runtime@0.
|
|
38
|
+
//#region \0@oxc-project+runtime@0.134.0/helpers/esm/toPrimitive.js
|
|
20
39
|
function toPrimitive(t, r) {
|
|
21
40
|
if ("object" != _typeof(t) || !t) return t;
|
|
22
41
|
var e = t[Symbol.toPrimitive];
|
|
@@ -29,14 +48,14 @@ function toPrimitive(t, r) {
|
|
|
29
48
|
}
|
|
30
49
|
|
|
31
50
|
//#endregion
|
|
32
|
-
//#region \0@oxc-project+runtime@0.
|
|
51
|
+
//#region \0@oxc-project+runtime@0.134.0/helpers/esm/toPropertyKey.js
|
|
33
52
|
function toPropertyKey(t) {
|
|
34
53
|
var i = toPrimitive(t, "string");
|
|
35
54
|
return "symbol" == _typeof(i) ? i : i + "";
|
|
36
55
|
}
|
|
37
56
|
|
|
38
57
|
//#endregion
|
|
39
|
-
//#region \0@oxc-project+runtime@0.
|
|
58
|
+
//#region \0@oxc-project+runtime@0.134.0/helpers/esm/defineProperty.js
|
|
40
59
|
function _defineProperty(e, r, t) {
|
|
41
60
|
return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
|
|
42
61
|
value: t,
|
|
@@ -47,7 +66,7 @@ function _defineProperty(e, r, t) {
|
|
|
47
66
|
}
|
|
48
67
|
|
|
49
68
|
//#endregion
|
|
50
|
-
//#region \0@oxc-project+runtime@0.
|
|
69
|
+
//#region \0@oxc-project+runtime@0.134.0/helpers/esm/decorateParam.js
|
|
51
70
|
function __decorateParam(paramIndex, decorator) {
|
|
52
71
|
return function(target, key) {
|
|
53
72
|
decorator(target, key, paramIndex);
|
|
@@ -55,7 +74,7 @@ function __decorateParam(paramIndex, decorator) {
|
|
|
55
74
|
}
|
|
56
75
|
|
|
57
76
|
//#endregion
|
|
58
|
-
//#region \0@oxc-project+runtime@0.
|
|
77
|
+
//#region \0@oxc-project+runtime@0.134.0/helpers/esm/decorate.js
|
|
59
78
|
function __decorate(decorators, target, key, desc) {
|
|
60
79
|
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
61
80
|
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
@@ -74,13 +93,13 @@ function __decorate(decorators, target, key, desc) {
|
|
|
74
93
|
*/
|
|
75
94
|
function getDefinedNameFieldName(unitId, localeService, definedNamesService) {
|
|
76
95
|
const definedNameMap = definedNamesService.getDefinedNameMap(unitId);
|
|
77
|
-
if (definedNameMap == null) return localeService.t("definedName.defaultName") + 1;
|
|
96
|
+
if (definedNameMap == null) return localeService.t("sheets.definedName.defaultName") + 1;
|
|
78
97
|
const count = Array.from(Object.values(definedNameMap)).length + 1;
|
|
79
|
-
const name = localeService.t("definedName.defaultName") + count;
|
|
98
|
+
const name = localeService.t("sheets.definedName.defaultName") + count;
|
|
80
99
|
if (definedNamesService.getValueByName(unitId, name) == null) return name;
|
|
81
100
|
let i = count + 1;
|
|
82
101
|
while (true) {
|
|
83
|
-
const newName = localeService.t("definedName.defaultName") + i;
|
|
102
|
+
const newName = localeService.t("sheets.definedName.defaultName") + i;
|
|
84
103
|
if (definedNamesService.getValueByName(unitId, newName) == null) return newName;
|
|
85
104
|
i++;
|
|
86
105
|
}
|
|
@@ -580,7 +599,8 @@ let FSelection = _FSelection = class FSelection {
|
|
|
580
599
|
* @example
|
|
581
600
|
* ```ts
|
|
582
601
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
583
|
-
* const fWorksheet = fWorkbook.
|
|
602
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
603
|
+
* if (!fWorksheet) return;
|
|
584
604
|
* const fRange = fWorksheet.getRange('A10:B11');
|
|
585
605
|
* fRange.activate();
|
|
586
606
|
* const fSelection = fWorksheet.getSelection();
|
|
@@ -598,7 +618,8 @@ let FSelection = _FSelection = class FSelection {
|
|
|
598
618
|
* @example
|
|
599
619
|
* ```ts
|
|
600
620
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
601
|
-
* const fWorksheet = fWorkbook.
|
|
621
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
622
|
+
* if (!fWorksheet) return;
|
|
602
623
|
* const fSelection = fWorksheet.getSelection();
|
|
603
624
|
* const activeRangeList = fSelection.getActiveRangeList();
|
|
604
625
|
* activeRangeList.forEach((range) => {
|
|
@@ -617,7 +638,8 @@ let FSelection = _FSelection = class FSelection {
|
|
|
617
638
|
* @example
|
|
618
639
|
* ```ts
|
|
619
640
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
620
|
-
* const fWorksheet = fWorkbook.
|
|
641
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
642
|
+
* if (!fWorksheet) return;
|
|
621
643
|
* const fRange = fWorksheet.getRange('A10:B11');
|
|
622
644
|
* fRange.activate();
|
|
623
645
|
* const fSelection = fWorksheet.getSelection();
|
|
@@ -638,10 +660,11 @@ let FSelection = _FSelection = class FSelection {
|
|
|
638
660
|
* @example
|
|
639
661
|
* ```ts
|
|
640
662
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
641
|
-
* const fWorksheet = fWorkbook.
|
|
663
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
664
|
+
* if (!fWorksheet) return;
|
|
642
665
|
* const fSelection = fWorksheet.getSelection();
|
|
643
666
|
* const activeSheet = fSelection.getActiveSheet();
|
|
644
|
-
* console.log(activeSheet.equalTo(fWorksheet));
|
|
667
|
+
* console.log(activeSheet.equalTo(fWorksheet));
|
|
645
668
|
* ```
|
|
646
669
|
*/
|
|
647
670
|
getActiveSheet() {
|
|
@@ -655,7 +678,8 @@ let FSelection = _FSelection = class FSelection {
|
|
|
655
678
|
* @example
|
|
656
679
|
* ```ts
|
|
657
680
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
658
|
-
* const fWorksheet = fWorkbook.
|
|
681
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
682
|
+
* if (!fWorksheet) return;
|
|
659
683
|
* const fRange = fWorksheet.getRange('A10:B11');
|
|
660
684
|
* fRange.activate();
|
|
661
685
|
* const cell = fWorksheet.getRange('B11');
|
|
@@ -706,7 +730,8 @@ let FSelection = _FSelection = class FSelection {
|
|
|
706
730
|
* @example
|
|
707
731
|
* ```ts
|
|
708
732
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
709
|
-
* const fWorksheet = fWorkbook.
|
|
733
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
734
|
+
* if (!fWorksheet) return;
|
|
710
735
|
* // make sure the active cell is A1 and selection is A1:B2
|
|
711
736
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
712
737
|
* fRange.activate();
|
|
@@ -1051,7 +1076,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1051
1076
|
* @example
|
|
1052
1077
|
* ```ts
|
|
1053
1078
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1054
|
-
* const fWorksheet = fWorkbook.
|
|
1079
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1080
|
+
* if (!fWorksheet) return;
|
|
1055
1081
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1056
1082
|
* // Update the ranges to A1:C3 for the first rule
|
|
1057
1083
|
* if (rules.length > 0) {
|
|
@@ -1087,7 +1113,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1087
1113
|
* @example
|
|
1088
1114
|
* ```ts
|
|
1089
1115
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1090
|
-
* const fWorksheet = fWorkbook.
|
|
1116
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1117
|
+
* if (!fWorksheet) return;
|
|
1091
1118
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1092
1119
|
* // Remove the first protection rule
|
|
1093
1120
|
* if (rules.length > 0) {
|
|
@@ -1126,7 +1153,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1126
1153
|
* @example
|
|
1127
1154
|
* ```ts
|
|
1128
1155
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1129
|
-
* const fWorksheet = fWorkbook.
|
|
1156
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1157
|
+
* if (!fWorksheet) return;
|
|
1130
1158
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
1131
1159
|
* // First, create a protection rule
|
|
1132
1160
|
* const rule = await fRange.getRangePermission().protect({ name: 'My Range', allowEdit: true });
|
|
@@ -1164,7 +1192,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1164
1192
|
* @example
|
|
1165
1193
|
* ```ts
|
|
1166
1194
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1167
|
-
* const fWorksheet = fWorkbook.
|
|
1195
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1196
|
+
* if (!fWorksheet) return;
|
|
1168
1197
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1169
1198
|
* // Check if the first rule allows editing
|
|
1170
1199
|
* if (rules.length > 0) {
|
|
@@ -1191,7 +1220,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1191
1220
|
* @example
|
|
1192
1221
|
* ```ts
|
|
1193
1222
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1194
|
-
* const fWorksheet = fWorkbook.
|
|
1223
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1224
|
+
* if (!fWorksheet) return;
|
|
1195
1225
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1196
1226
|
* // Check if the first rule allows editing
|
|
1197
1227
|
* const rule = rules[0];
|
|
@@ -1209,7 +1239,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1209
1239
|
* @example
|
|
1210
1240
|
* ```ts
|
|
1211
1241
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1212
|
-
* const fWorksheet = fWorkbook.
|
|
1242
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1243
|
+
* if (!fWorksheet) return;
|
|
1213
1244
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1214
1245
|
* // Check if the first rule allows viewing
|
|
1215
1246
|
* const rule = rules[0];
|
|
@@ -1227,7 +1258,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1227
1258
|
* @example
|
|
1228
1259
|
* ```ts
|
|
1229
1260
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1230
|
-
* const fWorksheet = fWorkbook.
|
|
1261
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1262
|
+
* if (!fWorksheet) return;
|
|
1231
1263
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1232
1264
|
* // Check if the first rule allows managing collaborators
|
|
1233
1265
|
* const rule = rules[0];
|
|
@@ -1245,7 +1277,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1245
1277
|
* @example
|
|
1246
1278
|
* ```ts
|
|
1247
1279
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1248
|
-
* const fWorksheet = fWorkbook.
|
|
1280
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1281
|
+
* if (!fWorksheet) return;
|
|
1249
1282
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1250
1283
|
* // Check if the first rule allows deleting the rule
|
|
1251
1284
|
* const rule = rules[0];
|
|
@@ -1263,7 +1296,8 @@ let FRangeProtectionRule = class FRangeProtectionRule {
|
|
|
1263
1296
|
* @example
|
|
1264
1297
|
* ```ts
|
|
1265
1298
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1266
|
-
* const fWorksheet = fWorkbook.
|
|
1299
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1300
|
+
* if (!fWorksheet) return;
|
|
1267
1301
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1268
1302
|
* // Get the permission snapshot of the first rule
|
|
1269
1303
|
* if (rules.length > 0) {
|
|
@@ -1313,7 +1347,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1313
1347
|
* @example
|
|
1314
1348
|
* ```ts
|
|
1315
1349
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1316
|
-
* const fWorksheet = fWorkbook.
|
|
1350
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1351
|
+
* if (!fWorksheet) return;
|
|
1317
1352
|
* if (fWorksheet.getWorksheetPermission().isProtected()) {
|
|
1318
1353
|
* console.log('Worksheet is protected');
|
|
1319
1354
|
* }
|
|
@@ -1330,7 +1365,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1330
1365
|
* @example
|
|
1331
1366
|
* ```ts
|
|
1332
1367
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1333
|
-
* const fWorksheet = fWorkbook.
|
|
1368
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1369
|
+
* if (!fWorksheet) return;
|
|
1334
1370
|
* const permission = fWorksheet.getWorksheetPermission();
|
|
1335
1371
|
*
|
|
1336
1372
|
* // Create worksheet protection with collaborators
|
|
@@ -1408,7 +1444,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1408
1444
|
* @example
|
|
1409
1445
|
* ```ts
|
|
1410
1446
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1411
|
-
* const fWorksheet = fWorkbook.
|
|
1447
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1448
|
+
* if (!fWorksheet) return;
|
|
1412
1449
|
* await fWorksheet.getWorksheetPermission().unprotect();
|
|
1413
1450
|
* ```
|
|
1414
1451
|
*/
|
|
@@ -1433,7 +1470,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1433
1470
|
* @example
|
|
1434
1471
|
* ```ts
|
|
1435
1472
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1436
|
-
* const fWorksheet = fWorkbook.
|
|
1473
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1474
|
+
* if (!fWorksheet) return;
|
|
1437
1475
|
* await fWorksheet.getWorksheetPermission().setMode('readOnly');
|
|
1438
1476
|
* ```
|
|
1439
1477
|
*/
|
|
@@ -1473,7 +1511,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1473
1511
|
* @example
|
|
1474
1512
|
* ```ts
|
|
1475
1513
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1476
|
-
* const fWorksheet = fWorkbook.
|
|
1514
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1515
|
+
* if (!fWorksheet) return;
|
|
1477
1516
|
* await fWorksheet.getWorksheetPermission().setReadOnly();
|
|
1478
1517
|
* ```
|
|
1479
1518
|
*/
|
|
@@ -1486,7 +1525,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1486
1525
|
* @example
|
|
1487
1526
|
* ```ts
|
|
1488
1527
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1489
|
-
* const fWorksheet = fWorkbook.
|
|
1528
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1529
|
+
* if (!fWorksheet) return;
|
|
1490
1530
|
* await fWorksheet.getWorksheetPermission().setEditable();
|
|
1491
1531
|
* ```
|
|
1492
1532
|
*/
|
|
@@ -1502,7 +1542,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1502
1542
|
* @example
|
|
1503
1543
|
* ```ts
|
|
1504
1544
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1505
|
-
* const fWorksheet = fWorkbook.
|
|
1545
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1546
|
+
* if (!fWorksheet) return;
|
|
1506
1547
|
* const permission = fWorksheet.getWorksheetPermission();
|
|
1507
1548
|
* await permission.setPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow, false);
|
|
1508
1549
|
* ```
|
|
@@ -1537,7 +1578,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1537
1578
|
* @example
|
|
1538
1579
|
* ```ts
|
|
1539
1580
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1540
|
-
* const fWorksheet = fWorkbook.
|
|
1581
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1582
|
+
* if (!fWorksheet) return;
|
|
1541
1583
|
* if (fWorksheet.getWorksheetPermission().canEdit()) {
|
|
1542
1584
|
* console.log('Worksheet is editable');
|
|
1543
1585
|
* }
|
|
@@ -1554,7 +1596,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1554
1596
|
* @example
|
|
1555
1597
|
* ```ts
|
|
1556
1598
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1557
|
-
* const fWorksheet = fWorkbook.
|
|
1599
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1600
|
+
* if (!fWorksheet) return;
|
|
1558
1601
|
* // Check if cell C3 can be edited
|
|
1559
1602
|
* const fRange = fWorksheet.getRange('C3');
|
|
1560
1603
|
* const canEdit = fWorksheet.getWorksheetPermission().canEditCell(fRange.getRow(), fRange.getColumn());
|
|
@@ -1578,7 +1621,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1578
1621
|
* @example
|
|
1579
1622
|
* ```ts
|
|
1580
1623
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1581
|
-
* const fWorksheet = fWorkbook.
|
|
1624
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1625
|
+
* if (!fWorksheet) return;
|
|
1582
1626
|
* if (fWorksheet.getWorksheetPermission().canView()) {
|
|
1583
1627
|
* console.log('Worksheet is viewable');
|
|
1584
1628
|
* }
|
|
@@ -1594,7 +1638,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1594
1638
|
* @example
|
|
1595
1639
|
* ```ts
|
|
1596
1640
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1597
|
-
* const fWorksheet = fWorkbook.
|
|
1641
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1642
|
+
* if (!fWorksheet) return;
|
|
1598
1643
|
* // Check if cell C3 can be viewed
|
|
1599
1644
|
* const fRange = fWorksheet.getRange('C3');
|
|
1600
1645
|
* const canView = fWorksheet.getWorksheetPermission().canViewCell(fRange.getRow(), fRange.getColumn());
|
|
@@ -1619,7 +1664,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1619
1664
|
* @example
|
|
1620
1665
|
* ```ts
|
|
1621
1666
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1622
|
-
* const fWorksheet = fWorkbook.
|
|
1667
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1668
|
+
* if (!fWorksheet) return;
|
|
1623
1669
|
* const permission = fWorksheet.getWorksheetPermission();
|
|
1624
1670
|
* const canInsertRow = permission.getPoint(univerAPI.Enum.WorksheetPermissionPoint.InsertRow);
|
|
1625
1671
|
* console.log(canInsertRow);
|
|
@@ -1639,7 +1685,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1639
1685
|
* @example
|
|
1640
1686
|
* ```ts
|
|
1641
1687
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1642
|
-
* const fWorksheet = fWorkbook.
|
|
1688
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1689
|
+
* if (!fWorksheet) return;
|
|
1643
1690
|
* const snapshot = fWorksheet.getWorksheetPermission().getSnapshot();
|
|
1644
1691
|
* console.log(snapshot);
|
|
1645
1692
|
* ```
|
|
@@ -1658,7 +1705,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1658
1705
|
* @returns {Promise<void>} A promise that resolves when the configuration is applied.
|
|
1659
1706
|
* @example
|
|
1660
1707
|
* ```ts
|
|
1661
|
-
* const worksheet = univerAPI.getActiveWorkbook()?.
|
|
1708
|
+
* const worksheet = univerAPI.getActiveWorkbook()?.getSheetByName('Sheet1');
|
|
1709
|
+
* if (!worksheet) return;
|
|
1662
1710
|
* const permission = worksheet?.getWorksheetPermission();
|
|
1663
1711
|
* await permission?.applyConfig({
|
|
1664
1712
|
* mode: 'readOnly',
|
|
@@ -1689,7 +1737,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1689
1737
|
* @example
|
|
1690
1738
|
* ```ts
|
|
1691
1739
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1692
|
-
* const fWorksheet = fWorkbook.
|
|
1740
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1741
|
+
* if (!fWorksheet) return;
|
|
1693
1742
|
* const rules = await fWorksheet.getWorksheetPermission().protectRanges([
|
|
1694
1743
|
* {
|
|
1695
1744
|
* ranges: [fWorksheet.getRange('A1:B2')],
|
|
@@ -1778,7 +1827,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1778
1827
|
* @example
|
|
1779
1828
|
* ```ts
|
|
1780
1829
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1781
|
-
* const fWorksheet = fWorkbook.
|
|
1830
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1831
|
+
* if (!fWorksheet) return;
|
|
1782
1832
|
* const worksheetPermission = fWorksheet.getWorksheetPermission();
|
|
1783
1833
|
* const rules = await worksheetPermission.listRangeProtectionRules();
|
|
1784
1834
|
* // Unprotect the first rule as an example
|
|
@@ -1804,7 +1854,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1804
1854
|
* @example
|
|
1805
1855
|
* ```ts
|
|
1806
1856
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1807
|
-
* const fWorksheet = fWorkbook.
|
|
1857
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1858
|
+
* if (!fWorksheet) return;
|
|
1808
1859
|
* const rules = await fWorksheet.getWorksheetPermission().listRangeProtectionRules();
|
|
1809
1860
|
* console.log(rules);
|
|
1810
1861
|
* ```
|
|
@@ -1823,7 +1874,8 @@ let FWorksheetPermission = class FWorksheetPermission extends _univerjs_core_fac
|
|
|
1823
1874
|
* @example
|
|
1824
1875
|
* ```ts
|
|
1825
1876
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
1826
|
-
* const fWorksheet = fWorkbook.
|
|
1877
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
1878
|
+
* if (!fWorksheet) return;
|
|
1827
1879
|
* // Get debug info for cell C3
|
|
1828
1880
|
* const fRange = fWorksheet.getRange('C3');
|
|
1829
1881
|
* const debugInfo = await fWorksheet.getWorksheetPermission().debugCellPermission(fRange.getRow(), fRange.getColumn());
|
|
@@ -1983,7 +2035,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
1983
2035
|
* @returns This sheet, for chaining
|
|
1984
2036
|
* @example
|
|
1985
2037
|
* ```ts
|
|
1986
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
2038
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2039
|
+
* if (!fWorkSheet) return;
|
|
1987
2040
|
* fWorkSheet.setActiveSelection(fWorkSheet.getRange('A10:B10'));
|
|
1988
2041
|
* ```
|
|
1989
2042
|
*/
|
|
@@ -2002,7 +2055,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2002
2055
|
* @returns {Worksheet} The worksheet instance.
|
|
2003
2056
|
* @example
|
|
2004
2057
|
* ```typescript
|
|
2005
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2058
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2059
|
+
* if (!fWorksheet) return;
|
|
2006
2060
|
* const sheet = fWorksheet.getSheet();
|
|
2007
2061
|
* console.log(sheet);
|
|
2008
2062
|
* ```
|
|
@@ -2015,7 +2069,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2015
2069
|
* @returns {Injector} The injector instance.
|
|
2016
2070
|
* @example
|
|
2017
2071
|
* ```typescript
|
|
2018
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2072
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2073
|
+
* if (!fWorksheet) return;
|
|
2019
2074
|
* const injector = fWorksheet.getInject();
|
|
2020
2075
|
* console.log(injector);
|
|
2021
2076
|
* ```
|
|
@@ -2028,7 +2083,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2028
2083
|
* @returns {Workbook} The workbook instance.
|
|
2029
2084
|
* @example
|
|
2030
2085
|
* ```typescript
|
|
2031
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2086
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2087
|
+
* if (!fWorksheet) return;
|
|
2032
2088
|
* const workbook = fWorksheet.getWorkbook();
|
|
2033
2089
|
* console.log(workbook);
|
|
2034
2090
|
* ```
|
|
@@ -2041,7 +2097,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2041
2097
|
* @returns {string} The id of the worksheet.
|
|
2042
2098
|
* @example
|
|
2043
2099
|
* ```typescript
|
|
2044
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2100
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2101
|
+
* if (!fWorksheet) return;
|
|
2045
2102
|
* const sheetId = fWorksheet.getSheetId();
|
|
2046
2103
|
* console.log(sheetId);
|
|
2047
2104
|
* ```
|
|
@@ -2054,7 +2111,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2054
2111
|
* @returns {string} The name of the worksheet.
|
|
2055
2112
|
* @example
|
|
2056
2113
|
* ```typescript
|
|
2057
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2114
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2115
|
+
* if (!fWorksheet) return;
|
|
2058
2116
|
* const sheetName = fWorksheet.getSheetName();
|
|
2059
2117
|
* console.log(sheetName);
|
|
2060
2118
|
* ```
|
|
@@ -2067,7 +2125,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2067
2125
|
* @returns {FSelection} return the current selections of the worksheet or null if there is no selection.
|
|
2068
2126
|
* @example
|
|
2069
2127
|
* ```typescript
|
|
2070
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2128
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2129
|
+
* if (!fWorksheet) return;
|
|
2071
2130
|
* const selection = fWorksheet.getSelection();
|
|
2072
2131
|
* console.log(selection);
|
|
2073
2132
|
* ```
|
|
@@ -2082,7 +2141,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2082
2141
|
* @returns {IStyleData} Default style of the worksheet.
|
|
2083
2142
|
* @example
|
|
2084
2143
|
* ```typescript
|
|
2085
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2144
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2145
|
+
* if (!fWorksheet) return;
|
|
2086
2146
|
* const defaultStyle = fWorksheet.getDefaultStyle();
|
|
2087
2147
|
* console.log(defaultStyle);
|
|
2088
2148
|
* ```
|
|
@@ -2097,7 +2157,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2097
2157
|
* @returns {(Nullable<IStyleData> | string)} The default style of the worksheet row name or style data
|
|
2098
2158
|
* @example
|
|
2099
2159
|
* ```typescript
|
|
2100
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2160
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2161
|
+
* if (!fWorksheet) return;
|
|
2101
2162
|
* // Get default style for row 0 (1)
|
|
2102
2163
|
* const rowStyle = fWorksheet.getRowDefaultStyle(0);
|
|
2103
2164
|
* console.log(rowStyle);
|
|
@@ -2116,7 +2177,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2116
2177
|
* @returns {(Nullable<IStyleData> | string)} The default style of the worksheet column name or style data
|
|
2117
2178
|
* @example
|
|
2118
2179
|
* ```typescript
|
|
2119
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2180
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2181
|
+
* if (!fWorksheet) return;
|
|
2120
2182
|
* // Get default style for column 0 (A)
|
|
2121
2183
|
* const colStyle = fWorksheet.getColumnDefaultStyle(0);
|
|
2122
2184
|
* console.log(colStyle);
|
|
@@ -2134,7 +2196,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2134
2196
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2135
2197
|
* @example
|
|
2136
2198
|
* ```typescript
|
|
2137
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2199
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2200
|
+
* if (!fWorksheet) return;
|
|
2138
2201
|
* fWorksheet.setDefaultStyle('default');
|
|
2139
2202
|
* // or
|
|
2140
2203
|
* // fWorksheet.setDefaultStyle({fs: 12, ff: 'Arial'});
|
|
@@ -2159,7 +2222,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2159
2222
|
* @example
|
|
2160
2223
|
* ```ts
|
|
2161
2224
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
2162
|
-
* const fWorksheet = fWorkbook.
|
|
2225
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
2226
|
+
* if (!fWorksheet) return;
|
|
2163
2227
|
* fWorksheet.setColumnDefaultStyle(0, 'default');
|
|
2164
2228
|
* // or
|
|
2165
2229
|
* // fWorksheet.setColumnDefaultStyle(0, {fs: 12, ff: 'Arial'});
|
|
@@ -2182,7 +2246,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2182
2246
|
* @example
|
|
2183
2247
|
* ```ts
|
|
2184
2248
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
2185
|
-
* const fWorksheet = fWorkbook.
|
|
2249
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
2250
|
+
* if (!fWorksheet) return;
|
|
2186
2251
|
* fWorksheet.setRowDefaultStyle(0, 'default');
|
|
2187
2252
|
* // or
|
|
2188
2253
|
* // fWorksheet.setRowDefaultStyle(0, {fs: 12, ff: 'Arial'});
|
|
@@ -2236,7 +2301,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2236
2301
|
* @returns {number} The maximum columns count of the sheet
|
|
2237
2302
|
* @example
|
|
2238
2303
|
* ```typescript
|
|
2239
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2304
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2305
|
+
* if (!fWorksheet) return;
|
|
2240
2306
|
* const totalColumns = fWorksheet.getMaxColumns();
|
|
2241
2307
|
* console.log(`Sheet has ${totalColumns} columns`);
|
|
2242
2308
|
* ```
|
|
@@ -2249,7 +2315,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2249
2315
|
* @returns {number}The maximum rows count of the sheet
|
|
2250
2316
|
* @example
|
|
2251
2317
|
* ```typescript
|
|
2252
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2318
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2319
|
+
* if (!fWorksheet) return;
|
|
2253
2320
|
* const totalRows = fWorksheet.getMaxRows();
|
|
2254
2321
|
* console.log(`Sheet has ${totalRows} rows`);
|
|
2255
2322
|
* ```
|
|
@@ -2263,7 +2330,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2263
2330
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2264
2331
|
* @example
|
|
2265
2332
|
* ```typescript
|
|
2266
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2333
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2334
|
+
* if (!fWorksheet) return;
|
|
2267
2335
|
* // Insert a row after the third row
|
|
2268
2336
|
* fWorksheet.insertRowAfter(2);
|
|
2269
2337
|
* // Insert a row after the first row
|
|
@@ -2279,7 +2347,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2279
2347
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2280
2348
|
* @example
|
|
2281
2349
|
* ```typescript
|
|
2282
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2350
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2351
|
+
* if (!fWorksheet) return;
|
|
2283
2352
|
* // Insert a row before the third row
|
|
2284
2353
|
* fWorksheet.insertRowBefore(2);
|
|
2285
2354
|
* // Insert a row before the first row
|
|
@@ -2296,7 +2365,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2296
2365
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2297
2366
|
* @example
|
|
2298
2367
|
* ```typescript
|
|
2299
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2368
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2369
|
+
* if (!fWorksheet) return;
|
|
2300
2370
|
* // Insert 3 rows before the third row
|
|
2301
2371
|
* fWorksheet.insertRows(2, 3);
|
|
2302
2372
|
* // Insert 1 row before the first row
|
|
@@ -2313,7 +2383,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2313
2383
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2314
2384
|
* @example
|
|
2315
2385
|
* ```typescript
|
|
2316
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2386
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2387
|
+
* if (!fWorksheet) return;
|
|
2317
2388
|
* // Insert 3 rows after the third row
|
|
2318
2389
|
* fWorksheet.insertRowsAfter(2, 3);
|
|
2319
2390
|
* // Insert 1 row after the first row
|
|
@@ -2350,7 +2421,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2350
2421
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2351
2422
|
* @example
|
|
2352
2423
|
* ```typescript
|
|
2353
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2424
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2425
|
+
* if (!fWorksheet) return;
|
|
2354
2426
|
* // Insert 3 rows before the third row
|
|
2355
2427
|
* fWorksheet.insertRowsBefore(2, 3);
|
|
2356
2428
|
* // Insert 1 row before the first row
|
|
@@ -2386,7 +2458,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2386
2458
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2387
2459
|
* @example
|
|
2388
2460
|
* ```typescript
|
|
2389
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2461
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2462
|
+
* if (!fWorksheet) return;
|
|
2390
2463
|
* // Delete the third row
|
|
2391
2464
|
* fWorksheet.deleteRow(2);
|
|
2392
2465
|
* // Delete the first row
|
|
@@ -2403,7 +2476,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2403
2476
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2404
2477
|
* @example
|
|
2405
2478
|
* ```typescript
|
|
2406
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2479
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2480
|
+
* if (!fWorksheet) return;
|
|
2407
2481
|
* // Delete 3 rows at row index 2 (rows 3-5)
|
|
2408
2482
|
* fWorksheet.deleteRows(2, 3);
|
|
2409
2483
|
* // Delete 1 row at row index 0 (first row)
|
|
@@ -2430,7 +2504,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2430
2504
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2431
2505
|
* @example
|
|
2432
2506
|
* ```typescript
|
|
2433
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2507
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2508
|
+
* if (!fWorksheet) return;
|
|
2434
2509
|
* // Delete rows at index 2, and range from index 4 to 6 (rows 3, 5-7)
|
|
2435
2510
|
* fWorksheet.deleteRowsByPoints([2, [4, 6]]);
|
|
2436
2511
|
* ```
|
|
@@ -2448,7 +2523,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2448
2523
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2449
2524
|
* @example
|
|
2450
2525
|
* ```typescript
|
|
2451
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2526
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2527
|
+
* if (!fWorksheet) return;
|
|
2452
2528
|
* // Move 3 rows at row index 2 (rows 3-5) to row index 0
|
|
2453
2529
|
* const rowSpec1 = fWorksheet.getRange('3:5');
|
|
2454
2530
|
* fWorksheet.moveRows(rowSpec1, 0);
|
|
@@ -2483,7 +2559,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2483
2559
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2484
2560
|
* @example
|
|
2485
2561
|
* ```typescript
|
|
2486
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2562
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2563
|
+
* if (!fWorksheet) return;
|
|
2487
2564
|
* // Hide 3 rows starting from row index 1 (rows 2-4)
|
|
2488
2565
|
* const row1 = fWorksheet.getRange('2:4');
|
|
2489
2566
|
* fWorksheet.hideRow(row1);
|
|
@@ -2510,7 +2587,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2510
2587
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2511
2588
|
* @example
|
|
2512
2589
|
* ```typescript
|
|
2513
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2590
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2591
|
+
* if (!fWorksheet) return;
|
|
2514
2592
|
* // Hide 3 rows starting from row index 1 (rows 2-4)
|
|
2515
2593
|
* fWorksheet.hideRows(1, 3);
|
|
2516
2594
|
* // Hide single row at index 0 (first row)
|
|
@@ -2540,7 +2618,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2540
2618
|
* @returns {FWorksheet} This sheet, for chaining.
|
|
2541
2619
|
* @example
|
|
2542
2620
|
* ```typescript
|
|
2543
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2621
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2622
|
+
* if (!fWorksheet) return;
|
|
2544
2623
|
* // Unhide 3 rows starting from row index 1 (rows 2-4)
|
|
2545
2624
|
* const row1 = fWorksheet.getRange('2:4');
|
|
2546
2625
|
* fWorksheet.unhideRow(row1);
|
|
@@ -2567,7 +2646,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2567
2646
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2568
2647
|
* @example
|
|
2569
2648
|
* ```typescript
|
|
2570
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2649
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2650
|
+
* if (!fWorksheet) return;
|
|
2571
2651
|
* // Show 3 rows starting from row index 1 (rows 2-4)
|
|
2572
2652
|
* fWorksheet.showRows(1, 3);
|
|
2573
2653
|
* // Show single row at index 0 (first row)
|
|
@@ -2598,7 +2678,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2598
2678
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2599
2679
|
* @example
|
|
2600
2680
|
* ```typescript
|
|
2601
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2681
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2682
|
+
* if (!fWorksheet) return;
|
|
2602
2683
|
* // Set the height of the second row to 30 pixels
|
|
2603
2684
|
* fWorksheet.setRowHeight(1, 30);
|
|
2604
2685
|
* // Set the height of the first row to 20 pixels
|
|
@@ -2615,7 +2696,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2615
2696
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2616
2697
|
* @example
|
|
2617
2698
|
* ```ts
|
|
2618
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
2699
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2700
|
+
* if (!fWorkSheet) return;
|
|
2619
2701
|
* fWorkSheet.autoFitRow(24);
|
|
2620
2702
|
* ```
|
|
2621
2703
|
*/
|
|
@@ -2651,7 +2733,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2651
2733
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2652
2734
|
* @example
|
|
2653
2735
|
* ```typescript
|
|
2654
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2736
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2737
|
+
* if (!fWorksheet) return;
|
|
2655
2738
|
* fWorksheet.setRowHeights(1, 10, 30);
|
|
2656
2739
|
* ```
|
|
2657
2740
|
*/
|
|
@@ -2693,7 +2776,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2693
2776
|
* @example
|
|
2694
2777
|
* ```typescript
|
|
2695
2778
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
2696
|
-
* const fWorksheet = fWorkbook.
|
|
2779
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
2780
|
+
* if (!fWorksheet) return;
|
|
2697
2781
|
*
|
|
2698
2782
|
* // Set the value of the cell A1 to 'Hello, Univer!', set the font size to 30 and font weight to bold
|
|
2699
2783
|
* const fRange = fWorksheet.getRange('A1');
|
|
@@ -2713,7 +2797,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2713
2797
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2714
2798
|
* @example
|
|
2715
2799
|
* ```typescript
|
|
2716
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2800
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2801
|
+
* if (!fWorksheet) return;
|
|
2717
2802
|
* fWorksheet.setRowAutoHeight(1, 10);
|
|
2718
2803
|
* ```
|
|
2719
2804
|
*/
|
|
@@ -2739,7 +2824,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2739
2824
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2740
2825
|
* @example
|
|
2741
2826
|
* ```typescript
|
|
2742
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2827
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2828
|
+
* if (!fWorksheet) return;
|
|
2743
2829
|
* const ranges = [
|
|
2744
2830
|
* { startRow: 1, endRow: 10, startColumn: 0, endColumn: 10 },
|
|
2745
2831
|
* { startRow: 11, endRow: 20, startColumn: 0, endColumn: 10 },
|
|
@@ -2765,7 +2851,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2765
2851
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2766
2852
|
* @example
|
|
2767
2853
|
* ```typescript
|
|
2768
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2854
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2855
|
+
* if (!fWorksheet) return;
|
|
2769
2856
|
* fWorksheet.setRowHeightsForced(1, 10, 30);
|
|
2770
2857
|
* ```
|
|
2771
2858
|
*/
|
|
@@ -2792,11 +2879,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2792
2879
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2793
2880
|
* @example
|
|
2794
2881
|
* ```typescript
|
|
2795
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
2882
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2883
|
+
* if (!fWorkSheet) return;
|
|
2796
2884
|
* fWorkSheet.setRowCustom({ 0: { key: 'value' } });
|
|
2797
2885
|
* ```
|
|
2798
2886
|
*/
|
|
2799
2887
|
setRowCustom(custom) {
|
|
2888
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
2800
2889
|
const unitId = this._workbook.getUnitId();
|
|
2801
2890
|
const subUnitId = this._worksheet.getSheetId();
|
|
2802
2891
|
const rowData = {};
|
|
@@ -2815,7 +2904,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2815
2904
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2816
2905
|
* @example
|
|
2817
2906
|
* ```typescript
|
|
2818
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2907
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2908
|
+
* if (!fWorksheet) return;
|
|
2819
2909
|
* // Insert a column after column C
|
|
2820
2910
|
* fWorksheet.insertColumnAfter(2);
|
|
2821
2911
|
* // Insert a column after column A
|
|
@@ -2831,7 +2921,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2831
2921
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
2832
2922
|
* @example
|
|
2833
2923
|
* ```typescript
|
|
2834
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2924
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2925
|
+
* if (!fWorksheet) return;
|
|
2835
2926
|
* // Insert a column before column C
|
|
2836
2927
|
* fWorksheet.insertColumnBefore(2);
|
|
2837
2928
|
* // Insert a column before column A
|
|
@@ -2848,7 +2939,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2848
2939
|
* @returns {FWorksheet} This sheet, for chaining
|
|
2849
2940
|
* @example
|
|
2850
2941
|
* ```typescript
|
|
2851
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2942
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2943
|
+
* if (!fWorksheet) return;
|
|
2852
2944
|
* // Insert 3 columns before column C
|
|
2853
2945
|
* fWorksheet.insertColumns(2, 3);
|
|
2854
2946
|
* // Insert 1 column before column A
|
|
@@ -2865,7 +2957,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2865
2957
|
* @returns {FWorksheet} This sheet, for chaining
|
|
2866
2958
|
* @example
|
|
2867
2959
|
* ```typescript
|
|
2868
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2960
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2961
|
+
* if (!fWorksheet) return;
|
|
2869
2962
|
* // Insert 3 columns after column C
|
|
2870
2963
|
* fWorksheet.insertColumnsAfter(2, 3);
|
|
2871
2964
|
* // Insert 1 column after column A
|
|
@@ -2902,7 +2995,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2902
2995
|
* @returns {FWorksheet} This sheet, for chaining
|
|
2903
2996
|
* @example
|
|
2904
2997
|
* ```typescript
|
|
2905
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
2998
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
2999
|
+
* if (!fWorksheet) return;
|
|
2906
3000
|
* // Insert 3 columns before column C
|
|
2907
3001
|
* fWorksheet.insertColumnsBefore(2, 3);
|
|
2908
3002
|
* // Insert 1 column before column A
|
|
@@ -2938,7 +3032,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2938
3032
|
* @returns {FWorksheet} This sheet, for chaining
|
|
2939
3033
|
* @example
|
|
2940
3034
|
* ```typescript
|
|
2941
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3035
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3036
|
+
* if (!fWorksheet) return;
|
|
2942
3037
|
* // Delete column C
|
|
2943
3038
|
* fWorksheet.deleteColumn(2);
|
|
2944
3039
|
* // Delete column A
|
|
@@ -2955,7 +3050,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2955
3050
|
* @returns {FWorksheet} This sheet, for chaining
|
|
2956
3051
|
* @example
|
|
2957
3052
|
* ```typescript
|
|
2958
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3053
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3054
|
+
* if (!fWorksheet) return;
|
|
2959
3055
|
* // Delete 3 columns at column index 2 (columns C, D, E)
|
|
2960
3056
|
* fWorksheet.deleteColumns(2, 3);
|
|
2961
3057
|
* // Delete 1 column at column index 0 (column A)
|
|
@@ -2982,7 +3078,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
2982
3078
|
* @returns {FWorksheet} This sheet, for chaining
|
|
2983
3079
|
* @example
|
|
2984
3080
|
* ```typescript
|
|
2985
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3081
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3082
|
+
* if (!fWorksheet) return;
|
|
2986
3083
|
* // Delete columns at index 2, and range from index 4 to 6 (columns C, E-G)
|
|
2987
3084
|
* fWorksheet.deleteColumnsByPoints([2, [4, 6]]);
|
|
2988
3085
|
* ```
|
|
@@ -3000,7 +3097,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3000
3097
|
* @returns {FWorksheet} This sheet, for chaining
|
|
3001
3098
|
* @example
|
|
3002
3099
|
* ```typescript
|
|
3003
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3100
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3101
|
+
* if (!fWorksheet) return;
|
|
3004
3102
|
* // Move columns C, D, E to column index 2 (columns B, C, D)
|
|
3005
3103
|
* const columnSpec1 = fWorksheet.getRange('C:E');
|
|
3006
3104
|
* fWorksheet.moveColumns(columnSpec1, 1);
|
|
@@ -3035,7 +3133,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3035
3133
|
* @returns {FWorksheet} This sheet, for chaining
|
|
3036
3134
|
* @example
|
|
3037
3135
|
* ```typescript
|
|
3038
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3136
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3137
|
+
* if (!fWorksheet) return;
|
|
3039
3138
|
* // Hide columns C, D, E
|
|
3040
3139
|
* const column1 = fWorksheet.getRange('C:E');
|
|
3041
3140
|
* fWorksheet.hideColumn(column1);
|
|
@@ -3062,7 +3161,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3062
3161
|
* @returns {FWorksheet} This sheet, for chaining
|
|
3063
3162
|
* @example
|
|
3064
3163
|
* ```typescript
|
|
3065
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3164
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3165
|
+
* if (!fWorksheet) return;
|
|
3066
3166
|
* // Hide columns C, D, E
|
|
3067
3167
|
* fWorksheet.hideColumns(2, 3);
|
|
3068
3168
|
* // Hide column A
|
|
@@ -3092,7 +3192,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3092
3192
|
* @returns {FWorksheet} This sheet, for chaining
|
|
3093
3193
|
* @example
|
|
3094
3194
|
* ```typescript
|
|
3095
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3195
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3196
|
+
* if (!fWorksheet) return;
|
|
3096
3197
|
* // Unhide columns C, D, E
|
|
3097
3198
|
* const column1 = fWorksheet.getRange('C:E');
|
|
3098
3199
|
* fWorksheet.unhideColumn(column1);
|
|
@@ -3119,7 +3220,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3119
3220
|
* @returns {FWorksheet} This sheet, for chaining
|
|
3120
3221
|
* @example
|
|
3121
3222
|
* ```typescript
|
|
3122
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3223
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3224
|
+
* if (!fWorksheet) return;
|
|
3123
3225
|
* // Unhide columns C, D, E
|
|
3124
3226
|
* fWorksheet.showColumns(2, 3);
|
|
3125
3227
|
* // Unhide column A
|
|
@@ -3150,7 +3252,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3150
3252
|
* @returns {FWorksheet} This sheet, for chaining
|
|
3151
3253
|
* @example
|
|
3152
3254
|
* ```typescript
|
|
3153
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3255
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3256
|
+
* if (!fWorksheet) return;
|
|
3154
3257
|
* // Set width of column B to 100 pixels
|
|
3155
3258
|
* fWorksheet.setColumnWidth(1, 100);
|
|
3156
3259
|
* ```
|
|
@@ -3166,7 +3269,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3166
3269
|
* @returns {FWorksheet} This sheet, for chaining
|
|
3167
3270
|
* @example
|
|
3168
3271
|
* ```typescript
|
|
3169
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3272
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3273
|
+
* if (!fWorksheet) return;
|
|
3170
3274
|
* // Set width of columns B-D (index 1-3) to 100 pixels
|
|
3171
3275
|
* fWorksheet.setColumnWidths(1, 3, 100);
|
|
3172
3276
|
* ```
|
|
@@ -3195,7 +3299,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3195
3299
|
* @example
|
|
3196
3300
|
* ```typescript
|
|
3197
3301
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3198
|
-
* const fWorksheet = fWorkbook.
|
|
3302
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
3303
|
+
* if (!fWorksheet) return;
|
|
3199
3304
|
*
|
|
3200
3305
|
* // Set the long text value in cell A1
|
|
3201
3306
|
* const fRange = fWorksheet.getRange('A1');
|
|
@@ -3217,11 +3322,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3217
3322
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
3218
3323
|
* @example
|
|
3219
3324
|
* ```ts
|
|
3220
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3325
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3326
|
+
* if (!fWorkSheet) return;
|
|
3221
3327
|
* fWorkSheet.setColumnCustom({ 0: { key: 'value' } });
|
|
3222
3328
|
* ```
|
|
3223
3329
|
*/
|
|
3224
3330
|
setColumnCustom(custom) {
|
|
3331
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
3225
3332
|
const unitId = this._workbook.getUnitId();
|
|
3226
3333
|
const subUnitId = this._worksheet.getSheetId();
|
|
3227
3334
|
const columnData = {};
|
|
@@ -3239,7 +3346,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3239
3346
|
* @returns {FRange[]} All the merged cells in the worksheet
|
|
3240
3347
|
* @example
|
|
3241
3348
|
* ```ts
|
|
3242
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3349
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3350
|
+
* if (!fWorksheet) return;
|
|
3243
3351
|
* // Get all merged ranges in the sheet
|
|
3244
3352
|
* const mergedData = fWorksheet.getMergeData();
|
|
3245
3353
|
* // Process each merged range
|
|
@@ -3256,7 +3364,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3256
3364
|
* @returns {FRange[]} all merged cells
|
|
3257
3365
|
* @example
|
|
3258
3366
|
* ```typescript
|
|
3259
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3367
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3368
|
+
* if (!fWorksheet) return;
|
|
3260
3369
|
* // Get all merged ranges in the sheet
|
|
3261
3370
|
* const mergedRanges = fWorksheet.getMergedRanges();
|
|
3262
3371
|
* // Process each merged range
|
|
@@ -3275,7 +3384,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3275
3384
|
* @returns {FRange|undefined} The merged cell data, or undefined if the cell is not merged
|
|
3276
3385
|
* @example
|
|
3277
3386
|
* ```ts
|
|
3278
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3387
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3388
|
+
* if (!fWorkSheet) return;
|
|
3279
3389
|
* const merge = fWorkSheet.getCellMergeData(0, 0);
|
|
3280
3390
|
* if (merge) {
|
|
3281
3391
|
* console.log('Merged range:', merge.getA1Notation());
|
|
@@ -3291,7 +3401,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3291
3401
|
* @returns {FRange | null} the active range
|
|
3292
3402
|
* @example
|
|
3293
3403
|
* ```typescript
|
|
3294
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3404
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3405
|
+
* if (!fWorksheet) return;
|
|
3295
3406
|
* // Get the currently active range
|
|
3296
3407
|
* const activeRange = fWorksheet.getActiveRange();
|
|
3297
3408
|
* if (activeRange) {
|
|
@@ -3308,7 +3419,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3308
3419
|
* @returns {FWorksheet} This sheet, for chaining
|
|
3309
3420
|
* @example
|
|
3310
3421
|
* ```ts
|
|
3311
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3422
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3423
|
+
* if (!fWorkSheet) return;
|
|
3312
3424
|
* fWorkSheet.setActiveRange(fWorkSheet.getRange('A10:B10'));
|
|
3313
3425
|
* ```
|
|
3314
3426
|
*/
|
|
@@ -3323,7 +3435,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3323
3435
|
* @returns {FRange | null} The active cell
|
|
3324
3436
|
* @example
|
|
3325
3437
|
* ```typescript
|
|
3326
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3438
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3439
|
+
* if (!fWorkSheet) return;
|
|
3327
3440
|
* console.log(fWorkSheet.getActiveCell().getA1Notation());
|
|
3328
3441
|
* ```
|
|
3329
3442
|
*/
|
|
@@ -3337,7 +3450,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3337
3450
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
3338
3451
|
* @example
|
|
3339
3452
|
* ```typescript
|
|
3340
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3453
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3454
|
+
* if (!fWorksheet) return;
|
|
3341
3455
|
* // Freeze first 3 rows and 2 columns
|
|
3342
3456
|
* fWorksheet.setFreeze({
|
|
3343
3457
|
* startRow: 3,
|
|
@@ -3360,7 +3474,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3360
3474
|
* @returns {FWorksheet} This worksheet instance for chaining
|
|
3361
3475
|
* @example
|
|
3362
3476
|
* ```typescript
|
|
3363
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3477
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3478
|
+
* if (!fWorksheet) return;
|
|
3364
3479
|
* // Cancel freeze
|
|
3365
3480
|
* fWorksheet.cancelFreeze();
|
|
3366
3481
|
* ```
|
|
@@ -3377,7 +3492,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3377
3492
|
* @returns {IFreeze} The freeze state of the current sheet
|
|
3378
3493
|
* @example
|
|
3379
3494
|
* ```typescript
|
|
3380
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
3495
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3496
|
+
* if (!fWorksheet) return;
|
|
3381
3497
|
* // Get the freeze state of the current sheet
|
|
3382
3498
|
* const freeze = fWorksheet.getFreeze();
|
|
3383
3499
|
* console.log(freeze);
|
|
@@ -3437,7 +3553,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3437
3553
|
* @returns {number} The number of frozen columns, returns 0 if no columns are frozen.
|
|
3438
3554
|
* @example
|
|
3439
3555
|
* ```typescript
|
|
3440
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3556
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3557
|
+
* if (!fWorkSheet) return;
|
|
3441
3558
|
* // Get the number of frozen columns
|
|
3442
3559
|
* const frozenColumns = fWorkSheet.getFrozenColumns();
|
|
3443
3560
|
* console.log(frozenColumns);
|
|
@@ -3453,7 +3570,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3453
3570
|
* @returns {number} The number of frozen rows. returns 0 if no rows are frozen.
|
|
3454
3571
|
* @example
|
|
3455
3572
|
* ```typescript
|
|
3456
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3573
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3574
|
+
* if (!fWorkSheet) return;
|
|
3457
3575
|
* // Get the number of frozen rows
|
|
3458
3576
|
* const frozenRows = fWorkSheet.getFrozenRows();
|
|
3459
3577
|
* console.log(frozenRows);
|
|
@@ -3469,7 +3587,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3469
3587
|
* @returns {IRowRange} The range of the frozen rows.
|
|
3470
3588
|
* @example
|
|
3471
3589
|
* ```ts
|
|
3472
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3590
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3591
|
+
* if (!fWorkSheet) return;
|
|
3473
3592
|
* // Get the range of the frozen rows
|
|
3474
3593
|
* const frozenRows = fWorkSheet.getFrozenRowRange();
|
|
3475
3594
|
* console.log(frozenRows);
|
|
@@ -3487,7 +3606,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3487
3606
|
* @returns {IColumnRange} The range of the frozen columns.
|
|
3488
3607
|
* @example
|
|
3489
3608
|
* ```ts
|
|
3490
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3609
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3610
|
+
* if (!fWorkSheet) return;
|
|
3491
3611
|
* // Get the range of the frozen columns
|
|
3492
3612
|
* const frozenColumns = fWorkSheet.getFrozenColumnRange();
|
|
3493
3613
|
* console.log(frozenColumns);
|
|
@@ -3505,7 +3625,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3505
3625
|
* @returns {boolean} True if the sheet's gridlines are hidden; otherwise false.
|
|
3506
3626
|
* @example
|
|
3507
3627
|
* ```ts
|
|
3508
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3628
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3629
|
+
* if (!fWorkSheet) return;
|
|
3509
3630
|
* // check if the gridlines are hidden
|
|
3510
3631
|
* if (fWorkSheet.hasHiddenGridLines()) {
|
|
3511
3632
|
* console.log('Gridlines are hidden');
|
|
@@ -3521,7 +3642,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3521
3642
|
* @returns {FWorksheet} Returns the current worksheet instance for method chaining
|
|
3522
3643
|
* @example
|
|
3523
3644
|
* ``` ts
|
|
3524
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3645
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3646
|
+
* if (!fWorkSheet) return;
|
|
3525
3647
|
* // hide the gridlines
|
|
3526
3648
|
* fWorkSheet.setHiddenGridlines(true);
|
|
3527
3649
|
* ```
|
|
@@ -3540,7 +3662,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3540
3662
|
* @returns {FWorksheet} Returns the current worksheet instance for method chaining
|
|
3541
3663
|
* @example
|
|
3542
3664
|
* ```ts
|
|
3543
|
-
* const fWorkSheet = univerAPI.getActiveWorkbook().
|
|
3665
|
+
* const fWorkSheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
3666
|
+
* if (!fWorkSheet) return;
|
|
3544
3667
|
* // set the gridlines color to red
|
|
3545
3668
|
* fWorkSheet.setGridLinesColor('#ff0000');
|
|
3546
3669
|
* ```
|
|
@@ -3559,7 +3682,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3559
3682
|
* @example
|
|
3560
3683
|
* ```ts
|
|
3561
3684
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3562
|
-
* const fWorkSheet = fWorkbook.
|
|
3685
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3686
|
+
* if (!fWorkSheet) return;
|
|
3563
3687
|
* // get the gridlines color of the sheet
|
|
3564
3688
|
* console.log(fWorkSheet.getGridLinesColor());
|
|
3565
3689
|
* ```
|
|
@@ -3574,7 +3698,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3574
3698
|
* @example
|
|
3575
3699
|
* ```ts
|
|
3576
3700
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3577
|
-
* const fWorkSheet = fWorkbook.
|
|
3701
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3702
|
+
* if (!fWorkSheet) return;
|
|
3578
3703
|
* // set the tab color to red
|
|
3579
3704
|
* fWorkSheet.setTabColor('#ff0000');
|
|
3580
3705
|
* ```
|
|
@@ -3594,7 +3719,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3594
3719
|
* @example
|
|
3595
3720
|
* ```ts
|
|
3596
3721
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3597
|
-
* const fWorkSheet = fWorkbook.
|
|
3722
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3723
|
+
* if (!fWorkSheet) return;
|
|
3598
3724
|
* // get the tab color of the sheet
|
|
3599
3725
|
* console.log(fWorkSheet.getTabColor());
|
|
3600
3726
|
* ```
|
|
@@ -3608,7 +3734,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3608
3734
|
* @example
|
|
3609
3735
|
* ```ts
|
|
3610
3736
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3611
|
-
* const fWorkSheet = fWorkbook.
|
|
3737
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3738
|
+
* if (!fWorkSheet) return;
|
|
3612
3739
|
* // hide the active sheet
|
|
3613
3740
|
* fWorkSheet.hideSheet();
|
|
3614
3741
|
* ```
|
|
@@ -3661,7 +3788,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3661
3788
|
* @example
|
|
3662
3789
|
* ```ts
|
|
3663
3790
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3664
|
-
* const fWorkSheet = fWorkbook.
|
|
3791
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3792
|
+
* if (!fWorkSheet) return;
|
|
3665
3793
|
* // set the sheet name to 'Sheet1'
|
|
3666
3794
|
* fWorkSheet.setName('NewSheet1');
|
|
3667
3795
|
* ```
|
|
@@ -3695,7 +3823,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3695
3823
|
* @example
|
|
3696
3824
|
* ```ts
|
|
3697
3825
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3698
|
-
* const fWorkSheet = fWorkbook.
|
|
3826
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3827
|
+
* if (!fWorkSheet) return;
|
|
3699
3828
|
* // get the position of the active sheet
|
|
3700
3829
|
* const position = fWorkSheet.getIndex();
|
|
3701
3830
|
* console.log(position);
|
|
@@ -3713,7 +3842,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3713
3842
|
* @example
|
|
3714
3843
|
* ```ts
|
|
3715
3844
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3716
|
-
* const fWorkSheet = fWorkbook.
|
|
3845
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3846
|
+
* if (!fWorkSheet) return;
|
|
3717
3847
|
* // clear the sheet of content and formatting information
|
|
3718
3848
|
* fWorkSheet.clear();
|
|
3719
3849
|
* // clear the sheet of content only
|
|
@@ -3746,7 +3876,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3746
3876
|
* @example
|
|
3747
3877
|
* ```typescript
|
|
3748
3878
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3749
|
-
* const fWorkSheet = fWorkbook.
|
|
3879
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3880
|
+
* if (!fWorkSheet) return;
|
|
3750
3881
|
* // clear the sheet of content only
|
|
3751
3882
|
* fWorkSheet.clearContents();
|
|
3752
3883
|
* ```
|
|
@@ -3774,7 +3905,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3774
3905
|
* @example
|
|
3775
3906
|
* ```typescript
|
|
3776
3907
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3777
|
-
* const fWorkSheet = fWorkbook.
|
|
3908
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3909
|
+
* if (!fWorkSheet) return;
|
|
3778
3910
|
* // clear the sheet of formatting only
|
|
3779
3911
|
* fWorkSheet.clearFormats();
|
|
3780
3912
|
* ```
|
|
@@ -3803,7 +3935,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3803
3935
|
* @example
|
|
3804
3936
|
* ```ts
|
|
3805
3937
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3806
|
-
* const fWorkSheet = fWorkbook.
|
|
3938
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3939
|
+
* if (!fWorkSheet) return;
|
|
3807
3940
|
* // Assume the sheet is a empty sheet
|
|
3808
3941
|
* const cellRange = fWorkSheet.getRange('J50');
|
|
3809
3942
|
* cellRange.setValue('Hello World');
|
|
@@ -3820,7 +3953,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3820
3953
|
* @example
|
|
3821
3954
|
* ```ts
|
|
3822
3955
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3823
|
-
* const fWorkSheet = fWorkbook.
|
|
3956
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3957
|
+
* if (!fWorkSheet) return;
|
|
3824
3958
|
* // Assume the sheet is a empty sheet
|
|
3825
3959
|
* const cellRange = fWorkSheet.getRange('J50');
|
|
3826
3960
|
* cellRange.setValue('Hello World');
|
|
@@ -3836,7 +3970,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3836
3970
|
* @example
|
|
3837
3971
|
* ```ts
|
|
3838
3972
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3839
|
-
* const fWorkSheet = fWorkbook.
|
|
3973
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3974
|
+
* if (!fWorkSheet) return;
|
|
3840
3975
|
* // Assume the sheet is a empty sheet
|
|
3841
3976
|
* const cellRange = fWorkSheet.getRange('J50');
|
|
3842
3977
|
* cellRange.setValue('Hello World');
|
|
@@ -3854,7 +3989,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3854
3989
|
* ```ts
|
|
3855
3990
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3856
3991
|
* const sheets = fWorkbook.getSheets();
|
|
3857
|
-
* const fWorkSheet = fWorkbook.
|
|
3992
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
3993
|
+
* if (!fWorkSheet) return;
|
|
3858
3994
|
* console.log(fWorkSheet.equalTo(sheets[0])); // true, if the active sheet is the first sheet.
|
|
3859
3995
|
* ```
|
|
3860
3996
|
*/
|
|
@@ -3869,7 +4005,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3869
4005
|
* @example
|
|
3870
4006
|
* ```ts
|
|
3871
4007
|
* // The code below inserts a defined name
|
|
3872
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
4008
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
4009
|
+
* if (!fWorksheet) return;
|
|
3873
4010
|
* fWorksheet.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');
|
|
3874
4011
|
* ```
|
|
3875
4012
|
*/
|
|
@@ -3883,7 +4020,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3883
4020
|
* @example
|
|
3884
4021
|
* ```ts
|
|
3885
4022
|
* // The code below gets all the defined names in the worksheet
|
|
3886
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
4023
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
4024
|
+
* if (!fWorksheet) return;
|
|
3887
4025
|
* const definedNames = fWorksheet.getDefinedNames();
|
|
3888
4026
|
* console.log(definedNames, definedNames[0]?.getFormulaOrRefString());
|
|
3889
4027
|
* ```
|
|
@@ -3898,11 +4036,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3898
4036
|
* @example
|
|
3899
4037
|
* ```ts
|
|
3900
4038
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3901
|
-
* const fWorkSheet = fWorkbook.
|
|
4039
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4040
|
+
* if (!fWorkSheet) return;
|
|
3902
4041
|
* fWorkSheet.setCustomMetadata({ key: 'value' });
|
|
3903
4042
|
* ```
|
|
3904
4043
|
*/
|
|
3905
4044
|
setCustomMetadata(custom) {
|
|
4045
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
3906
4046
|
this._worksheet.setCustomMetadata(custom);
|
|
3907
4047
|
return this;
|
|
3908
4048
|
}
|
|
@@ -3912,12 +4052,14 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3912
4052
|
* @example
|
|
3913
4053
|
* ```ts
|
|
3914
4054
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3915
|
-
* const fWorkSheet = fWorkbook.
|
|
4055
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4056
|
+
* if (!fWorkSheet) return;
|
|
3916
4057
|
* const custom = fWorkSheet.getCustomMetadata();
|
|
3917
4058
|
* console.log(custom);
|
|
3918
4059
|
* ```
|
|
3919
4060
|
*/
|
|
3920
4061
|
getCustomMetadata() {
|
|
4062
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
3921
4063
|
return this._worksheet.getCustomMetadata();
|
|
3922
4064
|
}
|
|
3923
4065
|
/**
|
|
@@ -3928,11 +4070,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3928
4070
|
* @example
|
|
3929
4071
|
* ```ts
|
|
3930
4072
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3931
|
-
* const fWorkSheet = fWorkbook.
|
|
4073
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4074
|
+
* if (!fWorkSheet) return;
|
|
3932
4075
|
* fWorkSheet.setRowCustomMetadata(0, { key: 'value' });
|
|
3933
4076
|
* ```
|
|
3934
4077
|
*/
|
|
3935
4078
|
setRowCustomMetadata(index, custom) {
|
|
4079
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
3936
4080
|
this._worksheet.getRowManager().setCustomMetadata(index, custom);
|
|
3937
4081
|
return this;
|
|
3938
4082
|
}
|
|
@@ -3944,11 +4088,13 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3944
4088
|
* @example
|
|
3945
4089
|
* ```ts
|
|
3946
4090
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3947
|
-
* const fWorkSheet = fWorkbook.
|
|
4091
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4092
|
+
* if (!fWorkSheet) return;
|
|
3948
4093
|
* fWorkSheet.setColumnCustomMetadata(0, { key: 'value' });
|
|
3949
4094
|
* ```
|
|
3950
4095
|
*/
|
|
3951
4096
|
setColumnCustomMetadata(index, custom) {
|
|
4097
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
3952
4098
|
this._worksheet.getColumnManager().setCustomMetadata(index, custom);
|
|
3953
4099
|
return this;
|
|
3954
4100
|
}
|
|
@@ -3959,12 +4105,14 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3959
4105
|
* @example
|
|
3960
4106
|
* ```ts
|
|
3961
4107
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3962
|
-
* const fWorkSheet = fWorkbook.
|
|
4108
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4109
|
+
* if (!fWorkSheet) return;
|
|
3963
4110
|
* const custom = fWorkSheet.getRowCustomMetadata(0);
|
|
3964
4111
|
* console.log(custom);
|
|
3965
4112
|
* ```
|
|
3966
4113
|
*/
|
|
3967
4114
|
getRowCustomMetadata(index) {
|
|
4115
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
3968
4116
|
return this._worksheet.getRowManager().getCustomMetadata(index);
|
|
3969
4117
|
}
|
|
3970
4118
|
/**
|
|
@@ -3974,12 +4122,14 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3974
4122
|
* @example
|
|
3975
4123
|
* ```ts
|
|
3976
4124
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3977
|
-
* const fWorkSheet = fWorkbook.
|
|
4125
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4126
|
+
* if (!fWorkSheet) return;
|
|
3978
4127
|
* const custom = fWorkSheet.getColumnCustomMetadata(0);
|
|
3979
4128
|
* console.log(custom);
|
|
3980
4129
|
* ```
|
|
3981
4130
|
*/
|
|
3982
4131
|
getColumnCustomMetadata(index) {
|
|
4132
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
3983
4133
|
return this._worksheet.getColumnManager().getCustomMetadata(index);
|
|
3984
4134
|
}
|
|
3985
4135
|
/**
|
|
@@ -3991,7 +4141,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
3991
4141
|
* // Appends a new row with 4 columns to the bottom of the current
|
|
3992
4142
|
* // data region in the sheet containing the values in the array.
|
|
3993
4143
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
3994
|
-
* const fWorkSheet = fWorkbook.
|
|
4144
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4145
|
+
* if (!fWorkSheet) return;
|
|
3995
4146
|
* fWorkSheet.appendRow([1, 'Hello Univer', true, '=A1']);
|
|
3996
4147
|
* ```
|
|
3997
4148
|
*/
|
|
@@ -4021,7 +4172,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
4021
4172
|
* @example
|
|
4022
4173
|
* ```ts
|
|
4023
4174
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4024
|
-
* const fWorkSheet = fWorkbook.
|
|
4175
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4176
|
+
* if (!fWorkSheet) return;
|
|
4025
4177
|
*
|
|
4026
4178
|
* // Set the number of rows in the worksheet to 40
|
|
4027
4179
|
* fWorkSheet.setRowCount(40);
|
|
@@ -4042,7 +4194,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
4042
4194
|
* @example
|
|
4043
4195
|
* ```ts
|
|
4044
4196
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4045
|
-
* const fWorkSheet = fWorkbook.
|
|
4197
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
4198
|
+
* if (!fWorkSheet) return;
|
|
4046
4199
|
*
|
|
4047
4200
|
* // Set the number of columns in the worksheet to 10
|
|
4048
4201
|
* fWorkSheet.setColumnCount(10);
|
|
@@ -4062,7 +4215,8 @@ let FWorksheet = _FWorksheet = class FWorksheet extends _univerjs_core_facade.FB
|
|
|
4062
4215
|
* @returns {FWorksheetPermission} - The WorksheetPermission instance.
|
|
4063
4216
|
* @example
|
|
4064
4217
|
* ```ts
|
|
4065
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
4218
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
4219
|
+
* if (!fWorksheet) return;
|
|
4066
4220
|
* const permission = fWorksheet.getWorksheetPermission();
|
|
4067
4221
|
*
|
|
4068
4222
|
* // Set worksheet to read-only mode
|
|
@@ -4116,7 +4270,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
|
|
|
4116
4270
|
* @example
|
|
4117
4271
|
* ```ts
|
|
4118
4272
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4119
|
-
* const fWorksheet = fWorkbook.
|
|
4273
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4274
|
+
* if (!fWorksheet) return;
|
|
4120
4275
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4121
4276
|
* // Check if the A1:B2 range is protected
|
|
4122
4277
|
* const isProtected = fRange.getRangePermission().isProtected();
|
|
@@ -4133,7 +4288,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
|
|
|
4133
4288
|
* @example
|
|
4134
4289
|
* ```ts
|
|
4135
4290
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4136
|
-
* const fWorksheet = fWorkbook.
|
|
4291
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4292
|
+
* if (!fWorksheet) return;
|
|
4137
4293
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4138
4294
|
* const rule = await fRange.getRangePermission().protect({
|
|
4139
4295
|
* name: 'My protected range',
|
|
@@ -4203,7 +4359,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
|
|
|
4203
4359
|
* @example
|
|
4204
4360
|
* ```ts
|
|
4205
4361
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4206
|
-
* const fWorksheet = fWorkbook.
|
|
4362
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4363
|
+
* if (!fWorksheet) return;
|
|
4207
4364
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4208
4365
|
* const result = await fRange.getRangePermission().unprotect();
|
|
4209
4366
|
* console.log(result);
|
|
@@ -4225,7 +4382,8 @@ let FRangePermission = class FRangePermission extends _univerjs_core_facade.FBas
|
|
|
4225
4382
|
* @example
|
|
4226
4383
|
* ```ts
|
|
4227
4384
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4228
|
-
* const fWorksheet = fWorkbook.
|
|
4385
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4386
|
+
* if (!fWorksheet) return;
|
|
4229
4387
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4230
4388
|
* const rules = await fRange.getRangePermission().listRules();
|
|
4231
4389
|
* console.log(rules);
|
|
@@ -4250,7 +4408,7 @@ FRangePermission = __decorate([
|
|
|
4250
4408
|
//#region src/facade/f-range.ts
|
|
4251
4409
|
var _FRange, _FRange2;
|
|
4252
4410
|
let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialable {
|
|
4253
|
-
constructor(_workbook, _worksheet, _range, _injector, _commandService, _formulaDataModel) {
|
|
4411
|
+
constructor(_workbook, _worksheet, _range, _injector, _commandService, _formulaDataModel, _logService) {
|
|
4254
4412
|
super(_injector);
|
|
4255
4413
|
this._workbook = _workbook;
|
|
4256
4414
|
this._worksheet = _worksheet;
|
|
@@ -4258,6 +4416,7 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4258
4416
|
this._injector = _injector;
|
|
4259
4417
|
this._commandService = _commandService;
|
|
4260
4418
|
this._formulaDataModel = _formulaDataModel;
|
|
4419
|
+
this._logService = _logService;
|
|
4261
4420
|
const maxRows = this._worksheet.getRowCount();
|
|
4262
4421
|
const maxColumns = this._worksheet.getColumnCount();
|
|
4263
4422
|
if (this._range.startRow < 0 || this._range.startColumn < 0 || this._range.endRow >= maxRows || this._range.endColumn >= maxColumns) throw new Error(`Range is out of bounds. Max rows: ${maxRows}, Max columns: ${maxColumns}, Given range: ${JSON.stringify(this._range)}`);
|
|
@@ -4269,7 +4428,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4269
4428
|
* @example
|
|
4270
4429
|
* ```ts
|
|
4271
4430
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4272
|
-
* const fWorksheet = fWorkbook.
|
|
4431
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4432
|
+
* if (!fWorksheet) return;
|
|
4273
4433
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4274
4434
|
* console.log(fRange.getUnitId());
|
|
4275
4435
|
* ```
|
|
@@ -4283,7 +4443,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4283
4443
|
* @example
|
|
4284
4444
|
* ```ts
|
|
4285
4445
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4286
|
-
* const fWorksheet = fWorkbook.
|
|
4446
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4447
|
+
* if (!fWorksheet) return;
|
|
4287
4448
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4288
4449
|
* console.log(fRange.getSheetName());
|
|
4289
4450
|
* ```
|
|
@@ -4297,7 +4458,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4297
4458
|
* @example
|
|
4298
4459
|
* ```ts
|
|
4299
4460
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4300
|
-
* const fWorksheet = fWorkbook.
|
|
4461
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4462
|
+
* if (!fWorksheet) return;
|
|
4301
4463
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4302
4464
|
* console.log(fRange.getSheetId());
|
|
4303
4465
|
* ```
|
|
@@ -4311,7 +4473,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4311
4473
|
* @example
|
|
4312
4474
|
* ```ts
|
|
4313
4475
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4314
|
-
* const fWorksheet = fWorkbook.
|
|
4476
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4477
|
+
* if (!fWorksheet) return;
|
|
4315
4478
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4316
4479
|
* const range = fRange.getRange();
|
|
4317
4480
|
* const { startRow, startColumn, endRow, endColumn } = range;
|
|
@@ -4327,7 +4490,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4327
4490
|
* @example
|
|
4328
4491
|
* ```ts
|
|
4329
4492
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4330
|
-
* const fWorksheet = fWorkbook.
|
|
4493
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4494
|
+
* if (!fWorksheet) return;
|
|
4331
4495
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4332
4496
|
* console.log(fRange.getRow()); // 0
|
|
4333
4497
|
* ```
|
|
@@ -4341,7 +4505,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4341
4505
|
* @example
|
|
4342
4506
|
* ```ts
|
|
4343
4507
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4344
|
-
* const fWorksheet = fWorkbook.
|
|
4508
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4509
|
+
* if (!fWorksheet) return;
|
|
4345
4510
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4346
4511
|
* console.log(fRange.getLastRow()); // 1
|
|
4347
4512
|
* ```
|
|
@@ -4355,7 +4520,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4355
4520
|
* @example
|
|
4356
4521
|
* ```ts
|
|
4357
4522
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4358
|
-
* const fWorksheet = fWorkbook.
|
|
4523
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4524
|
+
* if (!fWorksheet) return;
|
|
4359
4525
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4360
4526
|
* console.log(fRange.getColumn()); // 0
|
|
4361
4527
|
* ```
|
|
@@ -4369,7 +4535,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4369
4535
|
* @example
|
|
4370
4536
|
* ```ts
|
|
4371
4537
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4372
|
-
* const fWorksheet = fWorkbook.
|
|
4538
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4539
|
+
* if (!fWorksheet) return;
|
|
4373
4540
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4374
4541
|
* console.log(fRange.getLastColumn()); // 1
|
|
4375
4542
|
* ```
|
|
@@ -4383,7 +4550,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4383
4550
|
* @example
|
|
4384
4551
|
* ```ts
|
|
4385
4552
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4386
|
-
* const fWorksheet = fWorkbook.
|
|
4553
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4554
|
+
* if (!fWorksheet) return;
|
|
4387
4555
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4388
4556
|
* console.log(fRange.getWidth());
|
|
4389
4557
|
* ```
|
|
@@ -4397,7 +4565,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4397
4565
|
* @example
|
|
4398
4566
|
* ```ts
|
|
4399
4567
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4400
|
-
* const fWorksheet = fWorkbook.
|
|
4568
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4569
|
+
* if (!fWorksheet) return;
|
|
4401
4570
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4402
4571
|
* console.log(fRange.getHeight());
|
|
4403
4572
|
* ```
|
|
@@ -4411,7 +4580,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4411
4580
|
* @example
|
|
4412
4581
|
* ```ts
|
|
4413
4582
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4414
|
-
* const fWorksheet = fWorkbook.
|
|
4583
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4584
|
+
* if (!fWorksheet) return;
|
|
4415
4585
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4416
4586
|
* console.log(fRange.isMerged());
|
|
4417
4587
|
* // merge cells A1:B2
|
|
@@ -4436,7 +4606,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4436
4606
|
* @example
|
|
4437
4607
|
* ```ts
|
|
4438
4608
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4439
|
-
* const fWorksheet = fWorkbook.
|
|
4609
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4610
|
+
* if (!fWorksheet) return;
|
|
4440
4611
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4441
4612
|
* console.log(fRange.getCellStyleData());
|
|
4442
4613
|
* ```
|
|
@@ -4457,7 +4628,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4457
4628
|
* @example
|
|
4458
4629
|
* ```ts
|
|
4459
4630
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4460
|
-
* const fWorksheet = fWorkbook.
|
|
4631
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4632
|
+
* if (!fWorksheet) return;
|
|
4461
4633
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4462
4634
|
* console.log(fRange.getFontFamily());
|
|
4463
4635
|
* ```
|
|
@@ -4478,7 +4650,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4478
4650
|
* @example
|
|
4479
4651
|
* ```ts
|
|
4480
4652
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4481
|
-
* const fWorksheet = fWorkbook.
|
|
4653
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4654
|
+
* if (!fWorksheet) return;
|
|
4482
4655
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4483
4656
|
* console.log(fRange.getFontSize());
|
|
4484
4657
|
* ```
|
|
@@ -4499,7 +4672,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4499
4672
|
* @example
|
|
4500
4673
|
* ```ts
|
|
4501
4674
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4502
|
-
* const fWorksheet = fWorkbook.
|
|
4675
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4676
|
+
* if (!fWorksheet) return;
|
|
4503
4677
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4504
4678
|
* console.log(fRange.getCellStyle());
|
|
4505
4679
|
* ```
|
|
@@ -4520,7 +4694,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4520
4694
|
* @example
|
|
4521
4695
|
* ```ts
|
|
4522
4696
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4523
|
-
* const fWorksheet = fWorkbook.
|
|
4697
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4698
|
+
* if (!fWorksheet) return;
|
|
4524
4699
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4525
4700
|
* console.log(fRange.getCellStyles());
|
|
4526
4701
|
* ```
|
|
@@ -4543,7 +4718,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4543
4718
|
* @example
|
|
4544
4719
|
* ```ts
|
|
4545
4720
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4546
|
-
* const fWorksheet = fWorkbook.
|
|
4721
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4722
|
+
* if (!fWorksheet) return;
|
|
4547
4723
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4548
4724
|
* fRange.setValueForCell({
|
|
4549
4725
|
* v: 0.2,
|
|
@@ -4568,7 +4744,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4568
4744
|
* @example
|
|
4569
4745
|
* ```ts
|
|
4570
4746
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4571
|
-
* const fWorksheet = fWorkbook.
|
|
4747
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4748
|
+
* if (!fWorksheet) return;
|
|
4572
4749
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4573
4750
|
* fRange.setValueForCell({
|
|
4574
4751
|
* v: 0.2,
|
|
@@ -4607,7 +4784,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4607
4784
|
* @example
|
|
4608
4785
|
* ```ts
|
|
4609
4786
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4610
|
-
* const fWorksheet = fWorkbook.
|
|
4787
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4788
|
+
* if (!fWorksheet) return;
|
|
4611
4789
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4612
4790
|
* fRange.setValues([
|
|
4613
4791
|
* [
|
|
@@ -4668,7 +4846,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4668
4846
|
* @example
|
|
4669
4847
|
* ```ts
|
|
4670
4848
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4671
|
-
* const fWorksheet = fWorkbook.
|
|
4849
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4850
|
+
* if (!fWorksheet) return;
|
|
4672
4851
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4673
4852
|
* fRange.setValues([
|
|
4674
4853
|
* [
|
|
@@ -4728,7 +4907,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4728
4907
|
* @example
|
|
4729
4908
|
* ```ts
|
|
4730
4909
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4731
|
-
* const fWorksheet = fWorkbook.
|
|
4910
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4911
|
+
* if (!fWorksheet) return;
|
|
4732
4912
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4733
4913
|
* console.log(fRange.getCellData());
|
|
4734
4914
|
* ```
|
|
@@ -4743,7 +4923,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4743
4923
|
* @example
|
|
4744
4924
|
* ```ts
|
|
4745
4925
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4746
|
-
* const fWorksheet = fWorkbook.
|
|
4926
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4927
|
+
* if (!fWorksheet) return;
|
|
4747
4928
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4748
4929
|
* console.log(fRange.getCellDatas());
|
|
4749
4930
|
* ```
|
|
@@ -4757,7 +4938,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4757
4938
|
* @example
|
|
4758
4939
|
* ```ts
|
|
4759
4940
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4760
|
-
* const fWorksheet = fWorkbook.
|
|
4941
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4942
|
+
* if (!fWorksheet) return;
|
|
4761
4943
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4762
4944
|
* console.log(fRange.getCellDataGrid());
|
|
4763
4945
|
* ```
|
|
@@ -4780,7 +4962,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4780
4962
|
* @example
|
|
4781
4963
|
* ```ts
|
|
4782
4964
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4783
|
-
* const fWorksheet = fWorkbook.
|
|
4965
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4966
|
+
* if (!fWorksheet) return;
|
|
4784
4967
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4785
4968
|
* console.log(fRange.getRichTextValue());
|
|
4786
4969
|
* ```
|
|
@@ -4798,7 +4981,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4798
4981
|
* @example
|
|
4799
4982
|
* ```ts
|
|
4800
4983
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4801
|
-
* const fWorksheet = fWorkbook.
|
|
4984
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
4985
|
+
* if (!fWorksheet) return;
|
|
4802
4986
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4803
4987
|
* console.log(fRange.getRichTextValues());
|
|
4804
4988
|
* ```
|
|
@@ -4814,7 +4998,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4814
4998
|
* @example
|
|
4815
4999
|
* ```ts
|
|
4816
5000
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4817
|
-
* const fWorksheet = fWorkbook.
|
|
5001
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5002
|
+
* if (!fWorksheet) return;
|
|
4818
5003
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4819
5004
|
* console.log(fRange.getValueAndRichTextValue());
|
|
4820
5005
|
* ```
|
|
@@ -4829,7 +5014,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4829
5014
|
* @example
|
|
4830
5015
|
* ```ts
|
|
4831
5016
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4832
|
-
* const fWorksheet = fWorkbook.
|
|
5017
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5018
|
+
* if (!fWorksheet) return;
|
|
4833
5019
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4834
5020
|
* console.log(fRange.getValueAndRichTextValues());
|
|
4835
5021
|
* ```
|
|
@@ -4843,7 +5029,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4843
5029
|
* @example
|
|
4844
5030
|
* ```ts
|
|
4845
5031
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4846
|
-
* const fWorksheet = fWorkbook.
|
|
5032
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5033
|
+
* if (!fWorksheet) return;
|
|
4847
5034
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4848
5035
|
* console.log(fRange.getFormula());
|
|
4849
5036
|
* ```
|
|
@@ -4858,7 +5045,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4858
5045
|
* @example
|
|
4859
5046
|
* ```ts
|
|
4860
5047
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4861
|
-
* const fWorksheet = fWorkbook.
|
|
5048
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5049
|
+
* if (!fWorksheet) return;
|
|
4862
5050
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4863
5051
|
* console.log(fRange.getFormulas());
|
|
4864
5052
|
* ```
|
|
@@ -4884,7 +5072,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4884
5072
|
* @example
|
|
4885
5073
|
* ```ts
|
|
4886
5074
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4887
|
-
* const fWorksheet = fWorkbook.
|
|
5075
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5076
|
+
* if (!fWorksheet) return;
|
|
4888
5077
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4889
5078
|
* console.log(fRange.getWrap());
|
|
4890
5079
|
* ```
|
|
@@ -4898,7 +5087,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4898
5087
|
* @example
|
|
4899
5088
|
* ```ts
|
|
4900
5089
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4901
|
-
* const fWorksheet = fWorkbook.
|
|
5090
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5091
|
+
* if (!fWorksheet) return;
|
|
4902
5092
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4903
5093
|
* console.log(fRange.getWraps());
|
|
4904
5094
|
*/
|
|
@@ -4916,7 +5106,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4916
5106
|
* @example
|
|
4917
5107
|
* ```ts
|
|
4918
5108
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4919
|
-
* const fWorksheet = fWorkbook.
|
|
5109
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5110
|
+
* if (!fWorksheet) return;
|
|
4920
5111
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4921
5112
|
* console.log(fRange.getWrapStrategy());
|
|
4922
5113
|
* ```
|
|
@@ -4930,7 +5121,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4930
5121
|
* @example
|
|
4931
5122
|
* ```ts
|
|
4932
5123
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4933
|
-
* const fWorksheet = fWorkbook.
|
|
5124
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5125
|
+
* if (!fWorksheet) return;
|
|
4934
5126
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4935
5127
|
* console.log(fRange.getHorizontalAlignment());
|
|
4936
5128
|
* ```
|
|
@@ -4944,7 +5136,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4944
5136
|
* @example
|
|
4945
5137
|
* ```ts
|
|
4946
5138
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4947
|
-
* const fWorksheet = fWorkbook.
|
|
5139
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5140
|
+
* if (!fWorksheet) return;
|
|
4948
5141
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4949
5142
|
* console.log(fRange.getHorizontalAlignments());
|
|
4950
5143
|
* ```
|
|
@@ -4958,7 +5151,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4958
5151
|
* @example
|
|
4959
5152
|
* ```ts
|
|
4960
5153
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4961
|
-
* const fWorksheet = fWorkbook.
|
|
5154
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5155
|
+
* if (!fWorksheet) return;
|
|
4962
5156
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4963
5157
|
* console.log(fRange.getVerticalAlignment());
|
|
4964
5158
|
* ```
|
|
@@ -4972,7 +5166,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4972
5166
|
* @example
|
|
4973
5167
|
* ```ts
|
|
4974
5168
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4975
|
-
* const fWorksheet = fWorkbook.
|
|
5169
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5170
|
+
* if (!fWorksheet) return;
|
|
4976
5171
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4977
5172
|
* console.log(fRange.getVerticalAlignments());
|
|
4978
5173
|
* ```
|
|
@@ -4986,13 +5181,15 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
4986
5181
|
* @returns {FRange} This range, for chaining
|
|
4987
5182
|
* ```ts
|
|
4988
5183
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
4989
|
-
* const fWorksheet = fWorkbook.
|
|
5184
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5185
|
+
* if (!fWorksheet) return;
|
|
4990
5186
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
4991
5187
|
* fRange.setCustomMetaData({ key: 'value' });
|
|
4992
5188
|
* console.log(fRange.getCustomMetaData());
|
|
4993
5189
|
* ```
|
|
4994
5190
|
*/
|
|
4995
5191
|
setCustomMetaData(data) {
|
|
5192
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
4996
5193
|
const params = {
|
|
4997
5194
|
unitId: this._workbook.getUnitId(),
|
|
4998
5195
|
subUnitId: this._worksheet.getSheetId(),
|
|
@@ -5008,7 +5205,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5008
5205
|
* @returns {FRange} This range, for chaining
|
|
5009
5206
|
* ```ts
|
|
5010
5207
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5011
|
-
* const fWorksheet = fWorkbook.
|
|
5208
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5209
|
+
* if (!fWorksheet) return;
|
|
5012
5210
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5013
5211
|
* fRange.setCustomMetaDatas([
|
|
5014
5212
|
* [{ key: 'value' }, { key: 'value2' }],
|
|
@@ -5018,6 +5216,7 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5018
5216
|
* ```
|
|
5019
5217
|
*/
|
|
5020
5218
|
setCustomMetaDatas(datas) {
|
|
5219
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
5021
5220
|
const params = {
|
|
5022
5221
|
unitId: this._workbook.getUnitId(),
|
|
5023
5222
|
subUnitId: this._worksheet.getSheetId(),
|
|
@@ -5033,13 +5232,15 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5033
5232
|
* @example
|
|
5034
5233
|
* ```
|
|
5035
5234
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5036
|
-
* const fWorksheet = fWorkbook.
|
|
5235
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5236
|
+
* if (!fWorksheet) return;
|
|
5037
5237
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5038
5238
|
* console.log(fRange.getCustomMetaData());
|
|
5039
5239
|
* ```
|
|
5040
5240
|
*/
|
|
5041
5241
|
getCustomMetaData() {
|
|
5042
5242
|
var _cell$custom;
|
|
5243
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
5043
5244
|
const cell = this.getCellData();
|
|
5044
5245
|
return (_cell$custom = cell === null || cell === void 0 ? void 0 : cell.custom) !== null && _cell$custom !== void 0 ? _cell$custom : null;
|
|
5045
5246
|
}
|
|
@@ -5049,12 +5250,14 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5049
5250
|
* @example
|
|
5050
5251
|
* ```
|
|
5051
5252
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5052
|
-
* const fWorksheet = fWorkbook.
|
|
5253
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5254
|
+
* if (!fWorksheet) return;
|
|
5053
5255
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5054
5256
|
* console.log(fRange.getCustomMetaDatas());
|
|
5055
5257
|
* ```
|
|
5056
5258
|
*/
|
|
5057
5259
|
getCustomMetaDatas() {
|
|
5260
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
5058
5261
|
return this.getCellDataGrid().map((row) => row.map((data) => {
|
|
5059
5262
|
var _data$custom;
|
|
5060
5263
|
return (_data$custom = data === null || data === void 0 ? void 0 : data.custom) !== null && _data$custom !== void 0 ? _data$custom : null;
|
|
@@ -5069,7 +5272,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5069
5272
|
* @example
|
|
5070
5273
|
* ```ts
|
|
5071
5274
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5072
|
-
* const fWorksheet = fWorkbook.
|
|
5275
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5276
|
+
* if (!fWorksheet) return;
|
|
5073
5277
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5074
5278
|
* fRange.setBorder(univerAPI.Enum.BorderType.ALL, univerAPI.Enum.BorderStyleTypes.THIN, '#ff0000');
|
|
5075
5279
|
* ```
|
|
@@ -5093,7 +5297,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5093
5297
|
* @example
|
|
5094
5298
|
* ```ts
|
|
5095
5299
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5096
|
-
* const fWorksheet = fWorkbook.
|
|
5300
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5301
|
+
* if (!fWorksheet) return;
|
|
5097
5302
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5098
5303
|
* console.log(fRange.getBackground());
|
|
5099
5304
|
* ```
|
|
@@ -5109,7 +5314,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5109
5314
|
* @example
|
|
5110
5315
|
* ```ts
|
|
5111
5316
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5112
|
-
* const fWorksheet = fWorkbook.
|
|
5317
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5318
|
+
* if (!fWorksheet) return;
|
|
5113
5319
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5114
5320
|
* console.log(fRange.getBackgrounds());
|
|
5115
5321
|
* ```
|
|
@@ -5127,7 +5333,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5127
5333
|
* @example
|
|
5128
5334
|
* ```ts
|
|
5129
5335
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5130
|
-
* const fWorksheet = fWorkbook.
|
|
5336
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5337
|
+
* if (!fWorksheet) return;
|
|
5131
5338
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5132
5339
|
* fRange.setBackgroundColor('red');
|
|
5133
5340
|
* ```
|
|
@@ -5151,7 +5358,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5151
5358
|
* @example
|
|
5152
5359
|
* ```typescript
|
|
5153
5360
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5154
|
-
* const fWorksheet = fWorkbook.
|
|
5361
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5362
|
+
* if (!fWorksheet) return;
|
|
5155
5363
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5156
5364
|
* fRange.setBackground('red');
|
|
5157
5365
|
* ```
|
|
@@ -5167,7 +5375,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5167
5375
|
* @example
|
|
5168
5376
|
* ```typescript
|
|
5169
5377
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5170
|
-
* const fWorksheet = fWorkbook.
|
|
5378
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5379
|
+
* if (!fWorksheet) return;
|
|
5171
5380
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5172
5381
|
* fRange.setTextRotation(45);
|
|
5173
5382
|
* ```
|
|
@@ -5187,7 +5396,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5187
5396
|
* @returns {FRange} This range, for chaining
|
|
5188
5397
|
* ```ts
|
|
5189
5398
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5190
|
-
* const fWorksheet = fWorkbook.
|
|
5399
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5400
|
+
* if (!fWorksheet) return;
|
|
5191
5401
|
* const fRange = fWorksheet.getRange('B2');
|
|
5192
5402
|
* fRange.setValue(123);
|
|
5193
5403
|
*
|
|
@@ -5212,7 +5422,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5212
5422
|
* @returns {FRange} This range, for chaining
|
|
5213
5423
|
* ```ts
|
|
5214
5424
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5215
|
-
* const fWorksheet = fWorkbook.
|
|
5425
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5426
|
+
* if (!fWorksheet) return;
|
|
5216
5427
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5217
5428
|
* fRange.setValueForCell(123);
|
|
5218
5429
|
*
|
|
@@ -5243,7 +5454,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5243
5454
|
* @example
|
|
5244
5455
|
* ```
|
|
5245
5456
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5246
|
-
* const fWorksheet = fWorkbook.
|
|
5457
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5458
|
+
* if (!fWorksheet) return;
|
|
5247
5459
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5248
5460
|
* console.log(fRange.getValue(true));
|
|
5249
5461
|
*
|
|
@@ -5279,7 +5491,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5279
5491
|
* @example
|
|
5280
5492
|
* ```ts
|
|
5281
5493
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5282
|
-
* const fWorksheet = fWorkbook.
|
|
5494
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5495
|
+
* if (!fWorksheet) return;
|
|
5283
5496
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5284
5497
|
* console.log(fRange.getValue(true));
|
|
5285
5498
|
*
|
|
@@ -5314,7 +5527,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5314
5527
|
* @example
|
|
5315
5528
|
* ```ts
|
|
5316
5529
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5317
|
-
* const fWorksheet = fWorkbook.
|
|
5530
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5531
|
+
* if (!fWorksheet) return;
|
|
5318
5532
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5319
5533
|
* fRange.setWrap(true);
|
|
5320
5534
|
* console.log(fRange.getWrap());
|
|
@@ -5336,7 +5550,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5336
5550
|
* @example
|
|
5337
5551
|
* ```ts
|
|
5338
5552
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5339
|
-
* const fWorksheet = fWorkbook.
|
|
5553
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5554
|
+
* if (!fWorksheet) return;
|
|
5340
5555
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5341
5556
|
* fRange.setWrapStrategy(univerAPI.Enum.WrapStrategy.WRAP);
|
|
5342
5557
|
* console.log(fRange.getWrapStrategy());
|
|
@@ -5358,7 +5573,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5358
5573
|
* @example
|
|
5359
5574
|
* ```ts
|
|
5360
5575
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5361
|
-
* const fWorksheet = fWorkbook.
|
|
5576
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5577
|
+
* if (!fWorksheet) return;
|
|
5362
5578
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5363
5579
|
* fRange.setVerticalAlignment('top');
|
|
5364
5580
|
* ```
|
|
@@ -5379,7 +5595,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5379
5595
|
* @example
|
|
5380
5596
|
* ```ts
|
|
5381
5597
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5382
|
-
* const fWorksheet = fWorkbook.
|
|
5598
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5599
|
+
* if (!fWorksheet) return;
|
|
5383
5600
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5384
5601
|
* fRange.setHorizontalAlignment('left');
|
|
5385
5602
|
* ```
|
|
@@ -5400,7 +5617,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5400
5617
|
* @example
|
|
5401
5618
|
* ```ts
|
|
5402
5619
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5403
|
-
* const fWorksheet = fWorkbook.
|
|
5620
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5621
|
+
* if (!fWorksheet) return;
|
|
5404
5622
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5405
5623
|
* fRange.setValues([
|
|
5406
5624
|
* [1, { v: 2, s: { bg: { rgb: '#ff0000' } } }],
|
|
@@ -5425,7 +5643,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5425
5643
|
* @example
|
|
5426
5644
|
* ```ts
|
|
5427
5645
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5428
|
-
* const fWorksheet = fWorkbook.
|
|
5646
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5647
|
+
* if (!fWorksheet) return;
|
|
5429
5648
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5430
5649
|
* fRange.setFontWeight('bold');
|
|
5431
5650
|
* ```
|
|
@@ -5456,7 +5675,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5456
5675
|
* @example
|
|
5457
5676
|
* ```ts
|
|
5458
5677
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5459
|
-
* const fWorksheet = fWorkbook.
|
|
5678
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5679
|
+
* if (!fWorksheet) return;
|
|
5460
5680
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5461
5681
|
* fRange.setFontStyle('italic');
|
|
5462
5682
|
* ```
|
|
@@ -5487,7 +5707,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5487
5707
|
* @example
|
|
5488
5708
|
* ```ts
|
|
5489
5709
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5490
|
-
* const fWorksheet = fWorkbook.
|
|
5710
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5711
|
+
* if (!fWorksheet) return;
|
|
5491
5712
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5492
5713
|
* fRange.setFontLine('underline');
|
|
5493
5714
|
* ```
|
|
@@ -5547,7 +5768,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5547
5768
|
* @example
|
|
5548
5769
|
* ```ts
|
|
5549
5770
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5550
|
-
* const fWorksheet = fWorkbook.
|
|
5771
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5772
|
+
* if (!fWorksheet) return;
|
|
5551
5773
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5552
5774
|
* fRange.setFontFamily('Arial');
|
|
5553
5775
|
* ```
|
|
@@ -5573,7 +5795,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5573
5795
|
* @example
|
|
5574
5796
|
* ```ts
|
|
5575
5797
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5576
|
-
* const fWorksheet = fWorkbook.
|
|
5798
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5799
|
+
* if (!fWorksheet) return;
|
|
5577
5800
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5578
5801
|
* fRange.setFontSize(24);
|
|
5579
5802
|
* ```
|
|
@@ -5599,7 +5822,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5599
5822
|
* @example
|
|
5600
5823
|
* ```ts
|
|
5601
5824
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5602
|
-
* const fWorksheet = fWorkbook.
|
|
5825
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5826
|
+
* if (!fWorksheet) return;
|
|
5603
5827
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5604
5828
|
* fRange.setFontColor('#ff0000');
|
|
5605
5829
|
* ```
|
|
@@ -5627,7 +5851,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5627
5851
|
* @example
|
|
5628
5852
|
* ```ts
|
|
5629
5853
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5630
|
-
* const fWorksheet = fWorkbook.
|
|
5854
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5855
|
+
* if (!fWorksheet) return;
|
|
5631
5856
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5632
5857
|
* fRange.merge();
|
|
5633
5858
|
* console.log(fRange.isMerged());
|
|
@@ -5635,7 +5860,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5635
5860
|
*
|
|
5636
5861
|
* ```ts
|
|
5637
5862
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5638
|
-
* const fWorksheet = fWorkbook.
|
|
5863
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5864
|
+
* if (!fWorksheet) return;
|
|
5639
5865
|
* const fRange = fWorksheet.getRange('B1:C2');
|
|
5640
5866
|
* // Assume A1:B2 is already merged.
|
|
5641
5867
|
* fRange.merge({ isForceMerge: true });
|
|
@@ -5657,7 +5883,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5657
5883
|
* ```ts
|
|
5658
5884
|
* // Assume the active sheet is a new sheet with no merged cells.
|
|
5659
5885
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5660
|
-
* const fWorksheet = fWorkbook.
|
|
5886
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5887
|
+
* if (!fWorksheet) return;
|
|
5661
5888
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5662
5889
|
* fRange.mergeAcross();
|
|
5663
5890
|
* // There will be two merged cells. A1:B1 and A2:B2.
|
|
@@ -5669,7 +5896,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5669
5896
|
*
|
|
5670
5897
|
* ```ts
|
|
5671
5898
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5672
|
-
* const fWorksheet = fWorkbook.
|
|
5899
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5900
|
+
* if (!fWorksheet) return;
|
|
5673
5901
|
* const fRange = fWorksheet.getRange('B1:C2');
|
|
5674
5902
|
* // Assume A1:B2 is already merged.
|
|
5675
5903
|
* fRange.mergeAcross({ isForceMerge: true });
|
|
@@ -5692,7 +5920,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5692
5920
|
* ```ts
|
|
5693
5921
|
* // Assume the active sheet is a new sheet with no merged cells.
|
|
5694
5922
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5695
|
-
* const fWorksheet = fWorkbook.
|
|
5923
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5924
|
+
* if (!fWorksheet) return;
|
|
5696
5925
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5697
5926
|
* fRange.mergeVertically();
|
|
5698
5927
|
* // There will be two merged cells. A1:A2 and B1:B2.
|
|
@@ -5704,7 +5933,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5704
5933
|
*
|
|
5705
5934
|
* ```ts
|
|
5706
5935
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5707
|
-
* const fWorksheet = fWorkbook.
|
|
5936
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5937
|
+
* if (!fWorksheet) return;
|
|
5708
5938
|
* const fRange = fWorksheet.getRange('B1:C2');
|
|
5709
5939
|
* // Assume A1:B2 is already merged.
|
|
5710
5940
|
* fRange.mergeVertically({ isForceMerge: true });
|
|
@@ -5723,7 +5953,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5723
5953
|
* @example
|
|
5724
5954
|
* ```ts
|
|
5725
5955
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5726
|
-
* const fWorksheet = fWorkbook.
|
|
5956
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5957
|
+
* if (!fWorksheet) return;
|
|
5727
5958
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5728
5959
|
* fRange.merge();
|
|
5729
5960
|
* const anchor = fWorksheet.getRange('A1');
|
|
@@ -5740,7 +5971,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5740
5971
|
* @example
|
|
5741
5972
|
* ```ts
|
|
5742
5973
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5743
|
-
* const fWorksheet = fWorkbook.
|
|
5974
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
5975
|
+
* if (!fWorksheet) return;
|
|
5744
5976
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5745
5977
|
* fRange.merge();
|
|
5746
5978
|
* const anchor = fWorksheet.getRange('A1');
|
|
@@ -5765,7 +5997,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5765
5997
|
* @param {ICellData} callback.cell the cell data
|
|
5766
5998
|
* ```ts
|
|
5767
5999
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5768
|
-
* const fWorksheet = fWorkbook.
|
|
6000
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6001
|
+
* if (!fWorksheet) return;
|
|
5769
6002
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5770
6003
|
* fRange.forEach((row, col, cell) => {
|
|
5771
6004
|
* console.log(row, col, cell);
|
|
@@ -5786,7 +6019,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5786
6019
|
* @returns {string} The A1 notation of the range.
|
|
5787
6020
|
* ```ts
|
|
5788
6021
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5789
|
-
* const fWorksheet = fWorkbook.
|
|
6022
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6023
|
+
* if (!fWorksheet) return;
|
|
5790
6024
|
*
|
|
5791
6025
|
* // By default, the A1 notation is returned without the sheet name and without absolute reference types.
|
|
5792
6026
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
@@ -5824,7 +6058,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5824
6058
|
* @example
|
|
5825
6059
|
* ```ts
|
|
5826
6060
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5827
|
-
* const fWorksheet = fWorkbook.
|
|
6061
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6062
|
+
* if (!fWorksheet) return;
|
|
5828
6063
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
5829
6064
|
* fRange.activate(); // the active cell will be A1
|
|
5830
6065
|
* ```
|
|
@@ -5842,7 +6077,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5842
6077
|
* @example
|
|
5843
6078
|
* ```ts
|
|
5844
6079
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5845
|
-
* const fWorksheet = fWorkbook.
|
|
6080
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6081
|
+
* if (!fWorksheet) return;
|
|
5846
6082
|
*
|
|
5847
6083
|
* // Set the range A1:B2 as the active range, default active cell is A1
|
|
5848
6084
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
@@ -5894,7 +6130,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5894
6130
|
* @example Show how to split text to columns with custom delimiter
|
|
5895
6131
|
* ```ts
|
|
5896
6132
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5897
|
-
* const fWorksheet = fWorkbook.
|
|
6133
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6134
|
+
* if (!fWorksheet) return;
|
|
5898
6135
|
*
|
|
5899
6136
|
* // A1:A3 has following values:
|
|
5900
6137
|
* // A |
|
|
@@ -5936,7 +6173,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5936
6173
|
* @example
|
|
5937
6174
|
* ```ts
|
|
5938
6175
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5939
|
-
* const fWorksheet = fWorkbook.
|
|
6176
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6177
|
+
* if (!fWorksheet) return;
|
|
5940
6178
|
* const fRange = fWorksheet.getRange('A1:E20');
|
|
5941
6179
|
* fRange.useThemeStyle('default');
|
|
5942
6180
|
* ```
|
|
@@ -5958,7 +6196,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5958
6196
|
* @example
|
|
5959
6197
|
* ```ts
|
|
5960
6198
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5961
|
-
* const fWorksheet = fWorkbook.
|
|
6199
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6200
|
+
* if (!fWorksheet) return;
|
|
5962
6201
|
* const fRange = fWorksheet.getRange('A1:E20');
|
|
5963
6202
|
* fRange.removeThemeStyle('default');
|
|
5964
6203
|
* ```
|
|
@@ -5977,7 +6216,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
5977
6216
|
* @example
|
|
5978
6217
|
* ```ts
|
|
5979
6218
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
5980
|
-
* const fWorksheet = fWorkbook.
|
|
6219
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6220
|
+
* if (!fWorksheet) return;
|
|
5981
6221
|
* const fRange = fWorksheet.getRange('A1:E20');
|
|
5982
6222
|
* console.log(fRange.getUsedThemeStyle()); // undefined
|
|
5983
6223
|
* fRange.useThemeStyle('default');
|
|
@@ -6000,7 +6240,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6000
6240
|
* @example
|
|
6001
6241
|
* ```ts
|
|
6002
6242
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6003
|
-
* const fWorkSheet = fWorkbook.
|
|
6243
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
6244
|
+
* if (!fWorkSheet) return;
|
|
6004
6245
|
* const fRange = fWorkSheet.getRange('A1:D10');
|
|
6005
6246
|
*
|
|
6006
6247
|
* // clear the content and format of the range A1:D10
|
|
@@ -6027,7 +6268,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6027
6268
|
* @example
|
|
6028
6269
|
* ```typescript
|
|
6029
6270
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6030
|
-
* const fWorkSheet = fWorkbook.
|
|
6271
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
6272
|
+
* if (!fWorkSheet) return;
|
|
6031
6273
|
* const fRange = fWorkSheet.getRange('A1:D10');
|
|
6032
6274
|
*
|
|
6033
6275
|
* // clear the content only of the range A1:D10
|
|
@@ -6048,7 +6290,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6048
6290
|
* @example
|
|
6049
6291
|
* ```typescript
|
|
6050
6292
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6051
|
-
* const fWorkSheet = fWorkbook.
|
|
6293
|
+
* const fWorkSheet = fWorkbook.getSheetByName('Sheet1');
|
|
6294
|
+
* if (!fWorkSheet) return;
|
|
6052
6295
|
* const fRange = fWorkSheet.getRange('A1:D10');
|
|
6053
6296
|
* // clear the format only of the range A1:D10
|
|
6054
6297
|
* fRange.clearFormat();
|
|
@@ -6069,7 +6312,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6069
6312
|
* ```ts
|
|
6070
6313
|
* // Assume the active sheet empty sheet.
|
|
6071
6314
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6072
|
-
* const fWorksheet = fWorkbook.
|
|
6315
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6316
|
+
* if (!fWorksheet) return;
|
|
6073
6317
|
* const values = [
|
|
6074
6318
|
* [1, 2, 3, 4],
|
|
6075
6319
|
* [2, 3, 4, 5],
|
|
@@ -6128,7 +6372,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6128
6372
|
* ```ts
|
|
6129
6373
|
* // Assume the active sheet empty sheet.
|
|
6130
6374
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6131
|
-
* const fWorksheet = fWorkbook.
|
|
6375
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6376
|
+
* if (!fWorksheet) return;
|
|
6132
6377
|
* const values = [
|
|
6133
6378
|
* [1, 2, 3, 4],
|
|
6134
6379
|
* [2, 3, 4, 5],
|
|
@@ -6191,7 +6436,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6191
6436
|
* ```ts
|
|
6192
6437
|
* // Assume the active sheet is a new sheet with no data.
|
|
6193
6438
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6194
|
-
* const fWorksheet = fWorkbook.
|
|
6439
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6440
|
+
* if (!fWorksheet) return;
|
|
6195
6441
|
*
|
|
6196
6442
|
* // Set the range A1:D4 with some values, the range A1:D4 will be:
|
|
6197
6443
|
* // | | |
|
|
@@ -6261,7 +6507,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6261
6507
|
* ```ts
|
|
6262
6508
|
* // Assume the active sheet is a new sheet with no data.
|
|
6263
6509
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6264
|
-
* const fWorksheet = fWorkbook.
|
|
6510
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6511
|
+
* if (!fWorksheet) return;
|
|
6265
6512
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
6266
6513
|
* console.log(fRange.isBlank()); // true
|
|
6267
6514
|
*
|
|
@@ -6293,7 +6540,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6293
6540
|
* @example
|
|
6294
6541
|
* ```ts
|
|
6295
6542
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6296
|
-
* const fWorksheet = fWorkbook.
|
|
6543
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6544
|
+
* if (!fWorksheet) return;
|
|
6297
6545
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
6298
6546
|
* console.log(fRange.getA1Notation()); // A1:B2
|
|
6299
6547
|
*
|
|
@@ -6323,7 +6571,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6323
6571
|
* @example
|
|
6324
6572
|
* ```ts
|
|
6325
6573
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6326
|
-
* const fWorksheet = fWorkbook.
|
|
6574
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6575
|
+
* if (!fWorksheet) return;
|
|
6327
6576
|
* const fRange = fWorksheet.getRange('A1');
|
|
6328
6577
|
* fRange.setFormula('=SUM(A2:A5)');
|
|
6329
6578
|
* console.log(fRange.getFormula()); // '=SUM(A2:A5)'
|
|
@@ -6339,7 +6588,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6339
6588
|
* @example
|
|
6340
6589
|
* ```ts
|
|
6341
6590
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6342
|
-
* const fWorksheet = fWorkbook.
|
|
6591
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6592
|
+
* if (!fWorksheet) return;
|
|
6343
6593
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
6344
6594
|
* fRange.setFormulas([
|
|
6345
6595
|
* ['=SUM(A2:A5)', '=SUM(B2:B5)'],
|
|
@@ -6357,7 +6607,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6357
6607
|
* @returns {FRangePermission} - The RangePermission instance.
|
|
6358
6608
|
* @example
|
|
6359
6609
|
* ```ts
|
|
6360
|
-
* const fWorksheet = univerAPI.getActiveWorkbook().
|
|
6610
|
+
* const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
|
|
6611
|
+
* if (!fWorksheet) return;
|
|
6361
6612
|
* const fRange = fWorksheet.getRange('A1:B10');
|
|
6362
6613
|
* const permission = fRange.getRangePermission();
|
|
6363
6614
|
*
|
|
@@ -6392,7 +6643,8 @@ let FRange = _FRange = class FRange extends _univerjs_core_facade.FBaseInitialab
|
|
|
6392
6643
|
* ```ts
|
|
6393
6644
|
* // Auto-fill the range D1:D10 based on the data in the range C1:C2
|
|
6394
6645
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6395
|
-
* const fWorksheet = fWorkbook.
|
|
6646
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
6647
|
+
* if (!fWorksheet) return;
|
|
6396
6648
|
* const fRange = fWorksheet.getRange('A1:A4');
|
|
6397
6649
|
*
|
|
6398
6650
|
* // Auto-fill without specifying applyType (default behavior)
|
|
@@ -6444,7 +6696,8 @@ _FRange2._enableManualInit();
|
|
|
6444
6696
|
FRange = _FRange = __decorate([
|
|
6445
6697
|
__decorateParam(3, (0, _univerjs_core.Inject)(_univerjs_core.Injector)),
|
|
6446
6698
|
__decorateParam(4, _univerjs_core.ICommandService),
|
|
6447
|
-
__decorateParam(5, (0, _univerjs_core.Inject)(_univerjs_engine_formula.FormulaDataModel))
|
|
6699
|
+
__decorateParam(5, (0, _univerjs_core.Inject)(_univerjs_engine_formula.FormulaDataModel)),
|
|
6700
|
+
__decorateParam(6, _univerjs_core.ILogService)
|
|
6448
6701
|
], FRange);
|
|
6449
6702
|
|
|
6450
6703
|
//#endregion
|
|
@@ -6780,7 +7033,7 @@ FWorkbookPermission = __decorate([
|
|
|
6780
7033
|
//#endregion
|
|
6781
7034
|
//#region src/facade/f-workbook.ts
|
|
6782
7035
|
let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
6783
|
-
constructor(_workbook, _injector, _resourceLoaderService, _selectionManagerService, _univerInstanceService, _commandService, _permissionService, _logService,
|
|
7036
|
+
constructor(_workbook, _injector, _resourceLoaderService, _selectionManagerService, _univerInstanceService, _commandService, _permissionService, _logService, _definedNamesService) {
|
|
6784
7037
|
super(_injector);
|
|
6785
7038
|
this._workbook = _workbook;
|
|
6786
7039
|
this._injector = _injector;
|
|
@@ -6790,7 +7043,6 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
6790
7043
|
this._commandService = _commandService;
|
|
6791
7044
|
this._permissionService = _permissionService;
|
|
6792
7045
|
this._logService = _logService;
|
|
6793
|
-
this._localeService = _localeService;
|
|
6794
7046
|
this._definedNamesService = _definedNamesService;
|
|
6795
7047
|
_defineProperty(this, "id", void 0);
|
|
6796
7048
|
this.id = this._workbook.getUnitId();
|
|
@@ -6873,21 +7125,6 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
6873
7125
|
return this._resourceLoaderService.saveUnit(this._workbook.getUnitId());
|
|
6874
7126
|
}
|
|
6875
7127
|
/**
|
|
6876
|
-
* @deprecated use 'save' instead.
|
|
6877
|
-
* @returns {IWorkbookData} Workbook snapshot data
|
|
6878
|
-
* @memberof FWorkbook
|
|
6879
|
-
* @example
|
|
6880
|
-
* ```ts
|
|
6881
|
-
* // The code below saves the workbook snapshot data
|
|
6882
|
-
* const activeSpreadsheet = univerAPI.getActiveWorkbook();
|
|
6883
|
-
* const snapshot = activeSpreadsheet.getSnapshot();
|
|
6884
|
-
* ```
|
|
6885
|
-
*/
|
|
6886
|
-
getSnapshot() {
|
|
6887
|
-
this._logService.warn("use 'save' instead of 'getSnapshot'");
|
|
6888
|
-
return this.save();
|
|
6889
|
-
}
|
|
6890
|
-
/**
|
|
6891
7128
|
* Get the active sheet of the workbook.
|
|
6892
7129
|
* @returns {FWorksheet} The active sheet of the workbook
|
|
6893
7130
|
* @example
|
|
@@ -6895,6 +7132,7 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
6895
7132
|
* // The code below gets the active sheet of the workbook
|
|
6896
7133
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
6897
7134
|
* const fWorksheet = fWorkbook.getActiveSheet();
|
|
7135
|
+
* if (!fWorksheet) return;
|
|
6898
7136
|
* console.log(fWorksheet);
|
|
6899
7137
|
* ```
|
|
6900
7138
|
*/
|
|
@@ -7239,7 +7477,9 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7239
7477
|
* @example
|
|
7240
7478
|
* ```ts
|
|
7241
7479
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
7242
|
-
* const
|
|
7480
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
7481
|
+
* if (!fWorksheet) return;
|
|
7482
|
+
* const range = fWorksheet.getRange('A10:B10');
|
|
7243
7483
|
* fWorkbook.setActiveRange(range);
|
|
7244
7484
|
* ```
|
|
7245
7485
|
*/
|
|
@@ -7317,7 +7557,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7317
7557
|
* ```ts
|
|
7318
7558
|
* // The code below duplicates the given worksheet
|
|
7319
7559
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
7320
|
-
* const activeSheet = fWorkbook.
|
|
7560
|
+
* const activeSheet = fWorkbook.getSheetByName('Sheet1');
|
|
7561
|
+
* if (!activeSheet) return;
|
|
7321
7562
|
* const duplicatedSheet = fWorkbook.duplicateSheet(activeSheet);
|
|
7322
7563
|
* console.log(duplicatedSheet);
|
|
7323
7564
|
* ```
|
|
@@ -7357,42 +7598,6 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7357
7598
|
return this._workbook.getSheets().length;
|
|
7358
7599
|
}
|
|
7359
7600
|
/**
|
|
7360
|
-
* Get the locale of the workbook.
|
|
7361
|
-
* @returns {LocaleType} The locale of the workbook
|
|
7362
|
-
* @example
|
|
7363
|
-
* ```ts
|
|
7364
|
-
* // The code below gets the locale of the workbook
|
|
7365
|
-
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
7366
|
-
* console.log(fWorkbook.getLocale());
|
|
7367
|
-
* ```
|
|
7368
|
-
*/
|
|
7369
|
-
getLocale() {
|
|
7370
|
-
return this._localeService.getCurrentLocale();
|
|
7371
|
-
}
|
|
7372
|
-
/**
|
|
7373
|
-
* @deprecated use `setSpreadsheetLocale` instead.
|
|
7374
|
-
* @param {LocaleType} locale - The locale to set
|
|
7375
|
-
*/
|
|
7376
|
-
setLocale(locale) {
|
|
7377
|
-
this._localeService.setLocale(locale);
|
|
7378
|
-
}
|
|
7379
|
-
/**
|
|
7380
|
-
* Set the locale of the workbook.
|
|
7381
|
-
* @param {LocaleType} locale The locale to set
|
|
7382
|
-
* @returns {FWorkbook} This workbook, for chaining
|
|
7383
|
-
* @example
|
|
7384
|
-
* ```ts
|
|
7385
|
-
* // The code below sets the locale of the workbook
|
|
7386
|
-
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
7387
|
-
* fWorkbook.setSpreadsheetLocale(univerAPI.Enum.LocaleType.EN_US);
|
|
7388
|
-
* console.log(fWorkbook.getLocale());
|
|
7389
|
-
* ```
|
|
7390
|
-
*/
|
|
7391
|
-
setSpreadsheetLocale(locale) {
|
|
7392
|
-
this._localeService.setLocale(locale);
|
|
7393
|
-
return this;
|
|
7394
|
-
}
|
|
7395
|
-
/**
|
|
7396
7601
|
* Get the URL of the workbook.
|
|
7397
7602
|
* @returns {string} The URL of the workbook
|
|
7398
7603
|
* @example
|
|
@@ -7415,7 +7620,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7415
7620
|
* ```ts
|
|
7416
7621
|
* // The code below moves the sheet to the specified index
|
|
7417
7622
|
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
7418
|
-
* const sheet = fWorkbook.
|
|
7623
|
+
* const sheet = fWorkbook.getSheetByName('Sheet1');
|
|
7624
|
+
* if (!sheet) return;
|
|
7419
7625
|
* fWorkbook.moveSheet(sheet, 1);
|
|
7420
7626
|
* ```
|
|
7421
7627
|
*/
|
|
@@ -7696,6 +7902,7 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7696
7902
|
* ```
|
|
7697
7903
|
*/
|
|
7698
7904
|
setCustomMetadata(custom) {
|
|
7905
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
7699
7906
|
this._workbook.setCustomMetadata(custom);
|
|
7700
7907
|
return this;
|
|
7701
7908
|
}
|
|
@@ -7710,6 +7917,7 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7710
7917
|
* ```
|
|
7711
7918
|
*/
|
|
7712
7919
|
getCustomMetadata() {
|
|
7920
|
+
this._logService.warn(SHEETS_CUSTOM_FIELD_WARNING_MESSAGE);
|
|
7713
7921
|
return this._workbook.getCustomMetadata();
|
|
7714
7922
|
}
|
|
7715
7923
|
/**
|
|
@@ -7736,7 +7944,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7736
7944
|
* fWorkbook.addStyles(styles);
|
|
7737
7945
|
*
|
|
7738
7946
|
* // Set values with the new styles
|
|
7739
|
-
* const fWorksheet = fWorkbook.
|
|
7947
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
7948
|
+
* if (!fWorksheet) return;
|
|
7740
7949
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
7741
7950
|
* fRange.setValues([
|
|
7742
7951
|
* [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
|
|
@@ -7771,7 +7980,8 @@ let FWorkbook = class FWorkbook extends _univerjs_core_facade.FBaseInitialable {
|
|
|
7771
7980
|
* fWorkbook.addStyles(styles);
|
|
7772
7981
|
*
|
|
7773
7982
|
* // Set values with the new styles
|
|
7774
|
-
* const fWorksheet = fWorkbook.
|
|
7983
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
7984
|
+
* if (!fWorksheet) return;
|
|
7775
7985
|
* const fRange = fWorksheet.getRange('A1:B2');
|
|
7776
7986
|
* fRange.setValues([
|
|
7777
7987
|
* [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
|
|
@@ -7797,62 +8007,52 @@ FWorkbook = __decorate([
|
|
|
7797
8007
|
__decorateParam(5, _univerjs_core.ICommandService),
|
|
7798
8008
|
__decorateParam(6, _univerjs_core.IPermissionService),
|
|
7799
8009
|
__decorateParam(7, _univerjs_core.ILogService),
|
|
7800
|
-
__decorateParam(8,
|
|
7801
|
-
__decorateParam(9, _univerjs_engine_formula.IDefinedNamesService)
|
|
8010
|
+
__decorateParam(8, _univerjs_engine_formula.IDefinedNamesService)
|
|
7802
8011
|
], FWorkbook);
|
|
7803
8012
|
|
|
7804
8013
|
//#endregion
|
|
7805
8014
|
//#region src/facade/f-univer.ts
|
|
7806
8015
|
var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
7807
|
-
|
|
7808
|
-
|
|
7809
|
-
|
|
7810
|
-
|
|
7811
|
-
|
|
7812
|
-
|
|
7813
|
-
|
|
7814
|
-
|
|
8016
|
+
createWorkbook(data, options) {
|
|
8017
|
+
const workbook = this._injector.get(_univerjs_core.IUniverInstanceService).createUnit(_univerjs_core.UniverInstanceType.UNIVER_SHEET, data, options);
|
|
8018
|
+
return this._injector.createInstance(FWorkbook, workbook);
|
|
8019
|
+
}
|
|
8020
|
+
getActiveWorkbook() {
|
|
8021
|
+
const workbook = this._univerInstanceService.getCurrentUnitOfType(_univerjs_core.UniverInstanceType.UNIVER_SHEET);
|
|
8022
|
+
if (!workbook) return null;
|
|
8023
|
+
return this._injector.createInstance(FWorkbook, workbook);
|
|
8024
|
+
}
|
|
8025
|
+
getWorkbook(id) {
|
|
8026
|
+
const workbook = this._univerInstanceService.getUnit(id, _univerjs_core.UniverInstanceType.UNIVER_SHEET);
|
|
8027
|
+
if (!workbook) return null;
|
|
8028
|
+
return this._injector.createInstance(FWorkbook, workbook);
|
|
8029
|
+
}
|
|
8030
|
+
getSheetCommandTarget(params = {}) {
|
|
8031
|
+
const { unitId, subUnitId, sheetId } = params;
|
|
8032
|
+
const workbook = unitId ? this.getWorkbook(unitId) : this.getActiveWorkbook();
|
|
8033
|
+
if (!workbook) return null;
|
|
8034
|
+
const sheetIdToFind = subUnitId || sheetId;
|
|
8035
|
+
const worksheet = sheetIdToFind ? workbook.getSheetBySheetId(sheetIdToFind) : workbook.getActiveSheet();
|
|
8036
|
+
if (!worksheet) return null;
|
|
7815
8037
|
return {
|
|
7816
8038
|
workbook,
|
|
7817
|
-
worksheet
|
|
8039
|
+
worksheet,
|
|
8040
|
+
unitId: workbook.getId(),
|
|
8041
|
+
subUnitId: worksheet.getSheetId()
|
|
7818
8042
|
};
|
|
7819
8043
|
}
|
|
7820
|
-
|
|
7821
|
-
const workbook = this.
|
|
7822
|
-
if (!workbook) return;
|
|
7823
|
-
const worksheet = workbook.
|
|
7824
|
-
if (!worksheet) return;
|
|
8044
|
+
getActiveSheet() {
|
|
8045
|
+
const workbook = this.getActiveWorkbook();
|
|
8046
|
+
if (!workbook) return null;
|
|
8047
|
+
const worksheet = workbook.getActiveSheet();
|
|
8048
|
+
if (!worksheet) return null;
|
|
7825
8049
|
return {
|
|
7826
8050
|
workbook,
|
|
7827
8051
|
worksheet
|
|
7828
8052
|
};
|
|
7829
8053
|
}
|
|
7830
|
-
|
|
7831
|
-
|
|
7832
|
-
this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookDisposed, () => univerInstanceService.unitDisposed$.subscribe((unit) => {
|
|
7833
|
-
if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
|
|
7834
|
-
const eventParams = {
|
|
7835
|
-
unitId: unit.getUnitId(),
|
|
7836
|
-
unitType: unit.type,
|
|
7837
|
-
snapshot: unit.getSnapshot()
|
|
7838
|
-
};
|
|
7839
|
-
this.fireEvent(this.Event.WorkbookDisposed, eventParams);
|
|
7840
|
-
}
|
|
7841
|
-
})));
|
|
7842
|
-
this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookCreated, () => univerInstanceService.unitAdded$.subscribe((event) => {
|
|
7843
|
-
const { unit } = event;
|
|
7844
|
-
if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
|
|
7845
|
-
const workbook = unit;
|
|
7846
|
-
const workbookUnit = injector.createInstance(FWorkbook, workbook);
|
|
7847
|
-
const eventParams = {
|
|
7848
|
-
unitId: unit.getUnitId(),
|
|
7849
|
-
type: unit.type,
|
|
7850
|
-
workbook: workbookUnit,
|
|
7851
|
-
unit: workbookUnit
|
|
7852
|
-
};
|
|
7853
|
-
this.fireEvent(this.Event.WorkbookCreated, eventParams);
|
|
7854
|
-
}
|
|
7855
|
-
})));
|
|
8054
|
+
setFreezeSync(enabled) {
|
|
8055
|
+
this._injector.get(_univerjs_sheets.SheetsFreezeSyncController).setEnabled(enabled);
|
|
7856
8056
|
}
|
|
7857
8057
|
/**
|
|
7858
8058
|
* @ignore
|
|
@@ -7862,9 +8062,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7862
8062
|
const commandService = injector.get(_univerjs_core.ICommandService);
|
|
7863
8063
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetCreate, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7864
8064
|
if (commandInfo.id === _univerjs_sheets.InsertSheetCommand.id) {
|
|
7865
|
-
var _this$getActiveWorkbo2;
|
|
7866
8065
|
const { unitId, index, sheet } = commandInfo.params || {};
|
|
7867
|
-
const workbook = unitId ? this.
|
|
8066
|
+
const workbook = unitId ? this.getWorkbook(unitId) : this.getActiveWorkbook();
|
|
7868
8067
|
if (!workbook) return;
|
|
7869
8068
|
const eventParams = {
|
|
7870
8069
|
workbook,
|
|
@@ -7877,11 +8076,10 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7877
8076
|
})));
|
|
7878
8077
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeActiveSheetChange, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7879
8078
|
if (commandInfo.id === _univerjs_sheets.SetWorksheetActiveOperation.id) {
|
|
7880
|
-
|
|
7881
|
-
const
|
|
7882
|
-
|
|
7883
|
-
|
|
7884
|
-
const activeSheet = workbook.getSheetBySheetId(sheetId);
|
|
8079
|
+
const params = commandInfo.params;
|
|
8080
|
+
const target = this.getSheetCommandTarget(params);
|
|
8081
|
+
if (!target) return;
|
|
8082
|
+
const { workbook, worksheet: activeSheet } = target;
|
|
7885
8083
|
const oldActiveSheet = workbook.getActiveSheet();
|
|
7886
8084
|
if (!activeSheet || !oldActiveSheet) return;
|
|
7887
8085
|
const eventParams = {
|
|
@@ -7895,7 +8093,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7895
8093
|
})));
|
|
7896
8094
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetDelete, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7897
8095
|
if (commandInfo.id === _univerjs_sheets.RemoveSheetCommand.id) {
|
|
7898
|
-
const
|
|
8096
|
+
const params = commandInfo.params;
|
|
8097
|
+
const target = this.getSheetCommandTarget(params);
|
|
7899
8098
|
if (!target) return;
|
|
7900
8099
|
const { workbook, worksheet } = target;
|
|
7901
8100
|
const eventParams = {
|
|
@@ -7908,14 +8107,16 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7908
8107
|
})));
|
|
7909
8108
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetMove, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7910
8109
|
if (commandInfo.id === _univerjs_sheets.SetWorksheetOrderMutation.id) {
|
|
7911
|
-
const
|
|
7912
|
-
const target = this.
|
|
8110
|
+
const params = commandInfo.params;
|
|
8111
|
+
const target = this.getSheetCommandTarget(params);
|
|
7913
8112
|
if (!target) return;
|
|
8113
|
+
const { workbook, worksheet } = target;
|
|
8114
|
+
const { fromOrder: oldIndex, toOrder: newIndex } = params;
|
|
7914
8115
|
const eventParams = {
|
|
7915
|
-
workbook
|
|
7916
|
-
worksheet
|
|
7917
|
-
newIndex
|
|
7918
|
-
oldIndex
|
|
8116
|
+
workbook,
|
|
8117
|
+
worksheet,
|
|
8118
|
+
newIndex,
|
|
8119
|
+
oldIndex
|
|
7919
8120
|
};
|
|
7920
8121
|
this.fireEvent(this.Event.BeforeSheetMove, eventParams);
|
|
7921
8122
|
if (eventParams.cancel) throw new _univerjs_core.CanceledError();
|
|
@@ -7923,14 +8124,17 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7923
8124
|
})));
|
|
7924
8125
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetNameChange, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7925
8126
|
if (commandInfo.id === _univerjs_sheets.SetWorksheetNameCommand.id) {
|
|
7926
|
-
const
|
|
7927
|
-
const target = this.
|
|
8127
|
+
const params = commandInfo.params;
|
|
8128
|
+
const target = this.getSheetCommandTarget(params);
|
|
7928
8129
|
if (!target) return;
|
|
8130
|
+
const { workbook, worksheet } = target;
|
|
8131
|
+
const oldName = worksheet.getSheetName();
|
|
8132
|
+
const { name: newName } = params;
|
|
7929
8133
|
const eventParams = {
|
|
7930
|
-
workbook
|
|
7931
|
-
worksheet
|
|
7932
|
-
newName
|
|
7933
|
-
oldName
|
|
8134
|
+
workbook,
|
|
8135
|
+
worksheet,
|
|
8136
|
+
newName,
|
|
8137
|
+
oldName
|
|
7934
8138
|
};
|
|
7935
8139
|
this.fireEvent(this.Event.BeforeSheetNameChange, eventParams);
|
|
7936
8140
|
if (eventParams.cancel) throw new _univerjs_core.CanceledError();
|
|
@@ -7938,14 +8142,17 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7938
8142
|
})));
|
|
7939
8143
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetTabColorChange, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7940
8144
|
if (commandInfo.id === _univerjs_sheets.SetTabColorMutation.id) {
|
|
7941
|
-
const
|
|
7942
|
-
const target = this.
|
|
8145
|
+
const params = commandInfo.params;
|
|
8146
|
+
const target = this.getSheetCommandTarget(params);
|
|
7943
8147
|
if (!target) return;
|
|
8148
|
+
const { workbook, worksheet } = target;
|
|
8149
|
+
const oldColor = worksheet.getTabColor();
|
|
8150
|
+
const { color: newColor } = params;
|
|
7944
8151
|
const eventParams = {
|
|
7945
|
-
workbook
|
|
7946
|
-
worksheet
|
|
7947
|
-
newColor
|
|
7948
|
-
oldColor
|
|
8152
|
+
workbook,
|
|
8153
|
+
worksheet,
|
|
8154
|
+
newColor,
|
|
8155
|
+
oldColor
|
|
7949
8156
|
};
|
|
7950
8157
|
this.fireEvent(this.Event.BeforeSheetTabColorChange, eventParams);
|
|
7951
8158
|
if (eventParams.cancel) throw new _univerjs_core.CanceledError();
|
|
@@ -7953,12 +8160,14 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7953
8160
|
})));
|
|
7954
8161
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeSheetHideChange, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7955
8162
|
if (commandInfo.id === _univerjs_sheets.SetWorksheetHideMutation.id) {
|
|
7956
|
-
const
|
|
7957
|
-
const target = this.
|
|
8163
|
+
const params = commandInfo.params;
|
|
8164
|
+
const target = this.getSheetCommandTarget(params);
|
|
7958
8165
|
if (!target) return;
|
|
8166
|
+
const { workbook, worksheet } = target;
|
|
8167
|
+
const { hidden } = params;
|
|
7959
8168
|
const eventParams = {
|
|
7960
|
-
workbook
|
|
7961
|
-
worksheet
|
|
8169
|
+
workbook,
|
|
8170
|
+
worksheet,
|
|
7962
8171
|
hidden: Boolean(hidden)
|
|
7963
8172
|
};
|
|
7964
8173
|
this.fireEvent(this.Event.BeforeSheetHideChange, eventParams);
|
|
@@ -7967,12 +8176,15 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7967
8176
|
})));
|
|
7968
8177
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeGridlineColorChange, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7969
8178
|
if (commandInfo.id === _univerjs_sheets.SetGridlinesColorCommand.id) {
|
|
7970
|
-
|
|
7971
|
-
const target = this.
|
|
8179
|
+
const params = commandInfo.params;
|
|
8180
|
+
const target = this.getSheetCommandTarget(params);
|
|
7972
8181
|
if (!target) return;
|
|
8182
|
+
const { workbook, worksheet } = target;
|
|
8183
|
+
const { color } = params;
|
|
7973
8184
|
const eventParams = {
|
|
7974
|
-
|
|
7975
|
-
|
|
8185
|
+
workbook,
|
|
8186
|
+
worksheet,
|
|
8187
|
+
color
|
|
7976
8188
|
};
|
|
7977
8189
|
this.fireEvent(this.Event.BeforeGridlineColorChange, eventParams);
|
|
7978
8190
|
if (eventParams.cancel) throw new _univerjs_core.CanceledError();
|
|
@@ -7980,12 +8192,15 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
7980
8192
|
})));
|
|
7981
8193
|
this.disposeWithMe(this.registerEventHandler(this.Event.BeforeGridlineEnableChange, () => commandService.beforeCommandExecuted((commandInfo) => {
|
|
7982
8194
|
if (commandInfo.id === _univerjs_sheets.ToggleGridlinesCommand.id) {
|
|
7983
|
-
var
|
|
7984
|
-
const
|
|
8195
|
+
var _params$showGridlines;
|
|
8196
|
+
const params = commandInfo.params;
|
|
8197
|
+
const target = this.getSheetCommandTarget(params);
|
|
7985
8198
|
if (!target) return;
|
|
7986
|
-
const
|
|
8199
|
+
const { workbook, worksheet } = target;
|
|
8200
|
+
const showGridlines = (_params$showGridlines = params.showGridlines) !== null && _params$showGridlines !== void 0 ? _params$showGridlines : !worksheet.hasHiddenGridLines();
|
|
7987
8201
|
const eventParams = {
|
|
7988
|
-
|
|
8202
|
+
workbook,
|
|
8203
|
+
worksheet,
|
|
7989
8204
|
enabled: Boolean(showGridlines)
|
|
7990
8205
|
};
|
|
7991
8206
|
this.fireEvent(this.Event.BeforeGridlineEnableChange, eventParams);
|
|
@@ -8009,12 +8224,10 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
8009
8224
|
})));
|
|
8010
8225
|
this.disposeWithMe(this.registerEventHandler(this.Event.SheetCreated, () => commandService.onCommandExecuted((commandInfo) => {
|
|
8011
8226
|
if (commandInfo.id === _univerjs_sheets.InsertSheetCommand.id) {
|
|
8012
|
-
|
|
8013
|
-
const
|
|
8014
|
-
|
|
8015
|
-
|
|
8016
|
-
const worksheet = workbook.getActiveSheet();
|
|
8017
|
-
if (!worksheet) return;
|
|
8227
|
+
const params = commandInfo.params;
|
|
8228
|
+
const target = this.getSheetCommandTarget(params);
|
|
8229
|
+
if (!target) return;
|
|
8230
|
+
const { workbook, worksheet } = target;
|
|
8018
8231
|
const eventParams = {
|
|
8019
8232
|
workbook,
|
|
8020
8233
|
worksheet
|
|
@@ -8024,7 +8237,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
8024
8237
|
})));
|
|
8025
8238
|
this.disposeWithMe(this.registerEventHandler(this.Event.ActiveSheetChanged, () => commandService.onCommandExecuted((commandInfo) => {
|
|
8026
8239
|
if (commandInfo.id === _univerjs_sheets.SetWorksheetActiveOperation.id) {
|
|
8027
|
-
const
|
|
8240
|
+
const params = commandInfo.params;
|
|
8241
|
+
const target = this.getSheetCommandTarget(params);
|
|
8028
8242
|
if (!target) return;
|
|
8029
8243
|
const { workbook, worksheet: activeSheet } = target;
|
|
8030
8244
|
const eventParams = {
|
|
@@ -8036,9 +8250,8 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
8036
8250
|
})));
|
|
8037
8251
|
this.disposeWithMe(this.registerEventHandler(this.Event.SheetDeleted, () => commandService.onCommandExecuted((commandInfo) => {
|
|
8038
8252
|
if (commandInfo.id === _univerjs_sheets.RemoveSheetCommand.id) {
|
|
8039
|
-
|
|
8040
|
-
const
|
|
8041
|
-
const workbook = unitId ? this.getUniverSheet(unitId) : (_this$getActiveWorkbo5 = this.getActiveWorkbook) === null || _this$getActiveWorkbo5 === void 0 ? void 0 : _this$getActiveWorkbo5.call(this);
|
|
8253
|
+
const { unitId, subUnitId: sheetId } = commandInfo.params;
|
|
8254
|
+
const workbook = unitId ? this.getWorkbook(unitId) : this.getActiveWorkbook();
|
|
8042
8255
|
if (!workbook || !sheetId) return;
|
|
8043
8256
|
const eventParams = {
|
|
8044
8257
|
workbook,
|
|
@@ -8049,52 +8262,56 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
8049
8262
|
})));
|
|
8050
8263
|
this.disposeWithMe(this.registerEventHandler(this.Event.SheetMoved, () => commandService.onCommandExecuted((commandInfo) => {
|
|
8051
8264
|
if (commandInfo.id === _univerjs_sheets.SetWorksheetOrderMutation.id) {
|
|
8052
|
-
const
|
|
8053
|
-
const target = this.
|
|
8265
|
+
const params = commandInfo.params;
|
|
8266
|
+
const target = this.getSheetCommandTarget(params);
|
|
8054
8267
|
if (!target) return;
|
|
8055
8268
|
const { workbook, worksheet } = target;
|
|
8269
|
+
const { toOrder: newIndex } = params;
|
|
8056
8270
|
const eventParams = {
|
|
8057
8271
|
workbook,
|
|
8058
8272
|
worksheet,
|
|
8059
|
-
newIndex
|
|
8273
|
+
newIndex
|
|
8060
8274
|
};
|
|
8061
8275
|
this.fireEvent(this.Event.SheetMoved, eventParams);
|
|
8062
8276
|
}
|
|
8063
8277
|
})));
|
|
8064
8278
|
this.disposeWithMe(this.registerEventHandler(this.Event.SheetNameChanged, () => commandService.onCommandExecuted((commandInfo) => {
|
|
8065
8279
|
if (commandInfo.id === _univerjs_sheets.SetWorksheetNameCommand.id) {
|
|
8066
|
-
const
|
|
8067
|
-
const target = this.
|
|
8280
|
+
const params = commandInfo.params;
|
|
8281
|
+
const target = this.getSheetCommandTarget(params);
|
|
8068
8282
|
if (!target) return;
|
|
8069
8283
|
const { workbook, worksheet } = target;
|
|
8284
|
+
const { name: newName } = params;
|
|
8070
8285
|
const eventParams = {
|
|
8071
8286
|
workbook,
|
|
8072
8287
|
worksheet,
|
|
8073
|
-
newName
|
|
8288
|
+
newName
|
|
8074
8289
|
};
|
|
8075
8290
|
this.fireEvent(this.Event.SheetNameChanged, eventParams);
|
|
8076
8291
|
}
|
|
8077
8292
|
})));
|
|
8078
8293
|
this.disposeWithMe(this.registerEventHandler(this.Event.SheetTabColorChanged, () => commandService.onCommandExecuted((commandInfo) => {
|
|
8079
8294
|
if (commandInfo.id === _univerjs_sheets.SetTabColorMutation.id) {
|
|
8080
|
-
const
|
|
8081
|
-
const target = this.
|
|
8295
|
+
const params = commandInfo.params;
|
|
8296
|
+
const target = this.getSheetCommandTarget(params);
|
|
8082
8297
|
if (!target) return;
|
|
8083
8298
|
const { workbook, worksheet } = target;
|
|
8299
|
+
const { color: newColor } = params;
|
|
8084
8300
|
const eventParams = {
|
|
8085
8301
|
workbook,
|
|
8086
8302
|
worksheet,
|
|
8087
|
-
newColor
|
|
8303
|
+
newColor
|
|
8088
8304
|
};
|
|
8089
8305
|
this.fireEvent(this.Event.SheetTabColorChanged, eventParams);
|
|
8090
8306
|
}
|
|
8091
8307
|
})));
|
|
8092
8308
|
this.disposeWithMe(this.registerEventHandler(this.Event.SheetHideChanged, () => commandService.onCommandExecuted((commandInfo) => {
|
|
8093
8309
|
if (commandInfo.id === _univerjs_sheets.SetWorksheetHideMutation.id) {
|
|
8094
|
-
const
|
|
8095
|
-
const target = this.
|
|
8310
|
+
const params = commandInfo.params;
|
|
8311
|
+
const target = this.getSheetCommandTarget(params);
|
|
8096
8312
|
if (!target) return;
|
|
8097
8313
|
const { workbook, worksheet } = target;
|
|
8314
|
+
const { hidden } = params;
|
|
8098
8315
|
const eventParams = {
|
|
8099
8316
|
workbook,
|
|
8100
8317
|
worksheet,
|
|
@@ -8105,58 +8322,47 @@ var FUniverSheetsMixin = class extends _univerjs_core_facade.FUniver {
|
|
|
8105
8322
|
})));
|
|
8106
8323
|
this.disposeWithMe(this.registerEventHandler(this.Event.GridlineChanged, () => commandService.onCommandExecuted((commandInfo) => {
|
|
8107
8324
|
if (commandInfo.id === _univerjs_sheets.SetGridlinesColorCommand.id || commandInfo.id === _univerjs_sheets.ToggleGridlinesCommand.id) {
|
|
8108
|
-
const
|
|
8325
|
+
const params = commandInfo.params;
|
|
8326
|
+
const target = this.getSheetCommandTarget(params);
|
|
8109
8327
|
if (!target) return;
|
|
8328
|
+
const { workbook, worksheet } = target;
|
|
8110
8329
|
const eventParams = {
|
|
8111
|
-
|
|
8112
|
-
|
|
8113
|
-
|
|
8330
|
+
workbook,
|
|
8331
|
+
worksheet,
|
|
8332
|
+
enabled: !worksheet.hasHiddenGridLines(),
|
|
8333
|
+
color: worksheet.getGridLinesColor()
|
|
8114
8334
|
};
|
|
8115
8335
|
this.fireEvent(this.Event.GridlineChanged, eventParams);
|
|
8116
8336
|
}
|
|
8117
8337
|
})));
|
|
8118
8338
|
this._initWorkbookEvent(injector);
|
|
8119
8339
|
}
|
|
8120
|
-
|
|
8121
|
-
const
|
|
8122
|
-
|
|
8123
|
-
|
|
8124
|
-
|
|
8125
|
-
|
|
8126
|
-
|
|
8127
|
-
|
|
8128
|
-
|
|
8129
|
-
|
|
8130
|
-
|
|
8131
|
-
|
|
8132
|
-
|
|
8133
|
-
|
|
8134
|
-
|
|
8135
|
-
|
|
8136
|
-
|
|
8137
|
-
|
|
8138
|
-
|
|
8139
|
-
|
|
8140
|
-
|
|
8141
|
-
|
|
8142
|
-
|
|
8143
|
-
|
|
8144
|
-
|
|
8145
|
-
|
|
8146
|
-
}));
|
|
8147
|
-
}
|
|
8148
|
-
getActiveSheet() {
|
|
8149
|
-
const workbook = this.getActiveWorkbook();
|
|
8150
|
-
if (!workbook) return null;
|
|
8151
|
-
const worksheet = workbook.getActiveSheet();
|
|
8152
|
-
if (!worksheet) return null;
|
|
8153
|
-
return {
|
|
8154
|
-
workbook,
|
|
8155
|
-
worksheet
|
|
8156
|
-
};
|
|
8157
|
-
}
|
|
8158
|
-
setFreezeSync(enabled) {
|
|
8159
|
-
this._injector.get(_univerjs_sheets.SheetsFreezeSyncController).setEnabled(enabled);
|
|
8340
|
+
_initWorkbookEvent(injector) {
|
|
8341
|
+
const univerInstanceService = injector.get(_univerjs_core.IUniverInstanceService);
|
|
8342
|
+
this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookDisposed, () => univerInstanceService.unitDisposed$.subscribe((unit) => {
|
|
8343
|
+
if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
|
|
8344
|
+
const eventParams = {
|
|
8345
|
+
unitId: unit.getUnitId(),
|
|
8346
|
+
unitType: unit.type,
|
|
8347
|
+
snapshot: unit.getSnapshot()
|
|
8348
|
+
};
|
|
8349
|
+
this.fireEvent(this.Event.WorkbookDisposed, eventParams);
|
|
8350
|
+
}
|
|
8351
|
+
})));
|
|
8352
|
+
this.disposeWithMe(this.registerEventHandler(this.Event.WorkbookCreated, () => univerInstanceService.unitAdded$.subscribe((event) => {
|
|
8353
|
+
const { unit } = event;
|
|
8354
|
+
if (unit.type === _univerjs_core.UniverInstanceType.UNIVER_SHEET) {
|
|
8355
|
+
const workbook = unit;
|
|
8356
|
+
const workbookUnit = injector.createInstance(FWorkbook, workbook);
|
|
8357
|
+
const eventParams = {
|
|
8358
|
+
unitId: unit.getUnitId(),
|
|
8359
|
+
type: unit.type,
|
|
8360
|
+
workbook: workbookUnit,
|
|
8361
|
+
unit: workbookUnit
|
|
8362
|
+
};
|
|
8363
|
+
this.fireEvent(this.Event.WorkbookCreated, eventParams);
|
|
8364
|
+
}
|
|
8365
|
+
})));
|
|
8160
8366
|
}
|
|
8161
8367
|
};
|
|
8162
8368
|
_univerjs_core_facade.FUniver.extend(FUniverSheetsMixin);
|
|
@@ -8269,31 +8475,6 @@ var FSheetsEventNameMixin = class extends _univerjs_core_facade.FEventName {
|
|
|
8269
8475
|
};
|
|
8270
8476
|
_univerjs_core_facade.FEventName.extend(FSheetsEventNameMixin);
|
|
8271
8477
|
|
|
8272
|
-
//#endregion
|
|
8273
|
-
//#region src/facade/f-sheet-hooks.ts
|
|
8274
|
-
/**
|
|
8275
|
-
* Copyright 2023-present DreamNum Co., Ltd.
|
|
8276
|
-
*
|
|
8277
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
8278
|
-
* you may not use this file except in compliance with the License.
|
|
8279
|
-
* You may obtain a copy of the License at
|
|
8280
|
-
*
|
|
8281
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
8282
|
-
*
|
|
8283
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8284
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
8285
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
8286
|
-
* See the License for the specific language governing permissions and
|
|
8287
|
-
* limitations under the License.
|
|
8288
|
-
*/
|
|
8289
|
-
let FSheetHooks = class FSheetHooks extends _univerjs_core_facade.FBase {
|
|
8290
|
-
constructor(_injector) {
|
|
8291
|
-
super();
|
|
8292
|
-
this._injector = _injector;
|
|
8293
|
-
}
|
|
8294
|
-
};
|
|
8295
|
-
FSheetHooks = __decorate([__decorateParam(0, (0, _univerjs_core.Inject)(_univerjs_core.Injector))], FSheetHooks);
|
|
8296
|
-
|
|
8297
8478
|
//#endregion
|
|
8298
8479
|
Object.defineProperty(exports, 'FRange', {
|
|
8299
8480
|
enumerable: true,
|
|
@@ -8307,12 +8488,6 @@ Object.defineProperty(exports, 'FSelection', {
|
|
|
8307
8488
|
return FSelection;
|
|
8308
8489
|
}
|
|
8309
8490
|
});
|
|
8310
|
-
Object.defineProperty(exports, 'FSheetHooks', {
|
|
8311
|
-
enumerable: true,
|
|
8312
|
-
get: function () {
|
|
8313
|
-
return FSheetHooks;
|
|
8314
|
-
}
|
|
8315
|
-
});
|
|
8316
8491
|
exports.FSheetsEnumMixin = FSheetsEnumMixin;
|
|
8317
8492
|
exports.FSheetsEventNameMixin = FSheetsEventNameMixin;
|
|
8318
8493
|
Object.defineProperty(exports, 'FWorkbook', {
|