@officesdk/editor-sdk-core 0.0.0-alpha.8 → 0.0.1
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/cjs/docs/comments.js +3 -0
- package/cjs/docs/discuss.js +3 -0
- package/cjs/docs/index.js +1 -1
- package/cjs/docs/outline.js +3 -0
- package/cjs/docs/sdk.js +1 -1
- package/cjs/docs/sidebar.js +3 -0
- package/cjs/docs/theme.js +3 -0
- package/cjs/docx/sdk.js +1 -1
- package/cjs/docx/theme.js +1 -1
- package/cjs/form/sdk.js +1 -1
- package/cjs/form/ui.js +1 -1
- package/cjs/presentation/index.js +1 -1
- package/cjs/presentation/sdk.js +1 -1
- package/cjs/presentation/slide-theme.js +3 -0
- package/cjs/presentation/theme.js +1 -1
- package/cjs/shared/attachment.js +11 -1
- package/cjs/shared/editor.js +1 -1
- package/cjs/shared/file-picker.js +1 -1
- package/cjs/shared/fonts.js +16 -1
- package/cjs/shared/history.js +1 -1
- package/cjs/shared/http.js +1 -1
- package/cjs/shared/i18n.js +1 -1
- package/cjs/shared/index.js +4 -2
- package/cjs/shared/spell-check.js +3 -0
- package/cjs/shared/theme/base-types.js +1 -1
- package/cjs/shared/theme/components/dropdown.js +1 -1
- package/cjs/shared/theme/components/index.js +2 -1
- package/cjs/shared/theme/components/input.js +1 -1
- package/cjs/shared/theme/components/menu.js +3 -0
- package/cjs/shared/theme/components/slider.js +1 -1
- package/cjs/shared/theme/components/tab.js +1 -1
- package/cjs/shared/theme/components/toast.js +1 -1
- package/cjs/shared/theme/components/toolbar-button.js +1 -1
- package/cjs/shared/theme/components/tooltip.js +1 -1
- package/cjs/shared/theme/index.js +1 -1
- package/cjs/shared/toolbar.js +1 -1
- package/cjs/shared/version.js +1 -1
- package/cjs/sheet/form.js +1 -1
- package/cjs/sheet/history.js +1 -1
- package/cjs/sheet/index.js +1 -1
- package/cjs/sheet/render.js +1 -1
- package/cjs/sheet/sdk.js +1 -1
- package/cjs/sheet/sheet-tab.js +1 -1
- package/cjs/table/field.js +1 -1
- package/cjs/table/history.js +1 -1
- package/cjs/table/index.js +1 -1
- package/cjs/table/record.js +3 -0
- package/cjs/table/sdk.js +1 -1
- package/cjs/table/snapshot.js +1 -1
- package/cjs/table/view.js +1 -1
- package/esm/docs/comments.js +2 -0
- package/esm/docs/discuss.js +2 -0
- package/esm/docs/index.js +1 -1
- package/esm/docs/outline.js +2 -0
- package/esm/docs/sdk.js +1 -1
- package/esm/docs/sidebar.js +2 -0
- package/esm/docs/theme.js +2 -0
- package/esm/docx/sdk.js +1 -1
- package/esm/docx/theme.js +1 -1
- package/esm/form/sdk.js +1 -1
- package/esm/form/ui.js +1 -1
- package/esm/presentation/index.js +1 -1
- package/esm/presentation/sdk.js +1 -1
- package/esm/presentation/slide-theme.js +2 -0
- package/esm/presentation/theme.js +1 -1
- package/esm/shared/attachment.js +10 -2
- package/esm/shared/editor.js +1 -1
- package/esm/shared/file-picker.js +1 -1
- package/esm/shared/fonts.js +15 -2
- package/esm/shared/history.js +1 -1
- package/esm/shared/http.js +1 -1
- package/esm/shared/i18n.js +1 -1
- package/esm/shared/index.js +2 -1
- package/esm/shared/spell-check.js +2 -0
- package/esm/shared/theme/base-types.js +1 -1
- package/esm/shared/theme/components/dropdown.js +1 -1
- package/esm/shared/theme/components/index.js +2 -1
- package/esm/shared/theme/components/input.js +1 -1
- package/esm/shared/theme/components/menu.js +2 -0
- package/esm/shared/theme/components/slider.js +1 -1
- package/esm/shared/theme/components/tab.js +1 -1
- package/esm/shared/theme/components/toast.js +1 -1
- package/esm/shared/theme/components/toolbar-button.js +1 -1
- package/esm/shared/theme/components/tooltip.js +1 -1
- package/esm/shared/theme/index.js +1 -1
- package/esm/shared/toolbar.js +1 -1
- package/esm/shared/version.js +1 -1
- package/esm/sheet/form.js +1 -1
- package/esm/sheet/history.js +1 -1
- package/esm/sheet/index.js +1 -1
- package/esm/sheet/render.js +1 -1
- package/esm/sheet/sdk.js +1 -1
- package/esm/sheet/sheet-tab.js +1 -1
- package/esm/table/field.js +1 -1
- package/esm/table/history.js +1 -1
- package/esm/table/index.js +1 -1
- package/esm/table/record.js +2 -0
- package/esm/table/sdk.js +1 -1
- package/esm/table/snapshot.js +1 -1
- package/esm/table/view.js +1 -1
- package/package.json +1 -1
- package/types/combine.d.ts +975 -115
- package/types/diagram.d.ts +520 -82
- package/types/docs.d.ts +718 -78
- package/types/docx.d.ts +522 -84
- package/types/form.d.ts +529 -89
- package/types/mindmap.d.ts +520 -82
- package/types/pdf.d.ts +520 -82
- package/types/presentation.d.ts +599 -89
- package/types/shared.d.ts +520 -82
- package/types/sheet.d.ts +579 -105
- package/types/table.d.ts +632 -82
package/types/combine.d.ts
CHANGED
|
@@ -56,6 +56,32 @@ export declare abstract class AbstractedDocsSDK extends EditorSDK {
|
|
|
56
56
|
* 文档选区接口
|
|
57
57
|
*/
|
|
58
58
|
abstract get selection(): DocsSelection;
|
|
59
|
+
/**
|
|
60
|
+
* 文档大纲接口
|
|
61
|
+
*/
|
|
62
|
+
abstract get outline(): DocsOutline;
|
|
63
|
+
/**
|
|
64
|
+
* 文档侧边栏接口
|
|
65
|
+
*/
|
|
66
|
+
abstract get sidebar(): DocsSidebar;
|
|
67
|
+
/**
|
|
68
|
+
* 文档评论接口
|
|
69
|
+
*/
|
|
70
|
+
abstract get comments(): DocsComments | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* 文档演示接口
|
|
73
|
+
*/
|
|
74
|
+
abstract get presentation(): EditorPresentation;
|
|
75
|
+
/**
|
|
76
|
+
* 监听标题的变化
|
|
77
|
+
* @param listener 在内部标题被修改时触发 listener 回调
|
|
78
|
+
* @returns 返回一个取消监听的函数
|
|
79
|
+
*/
|
|
80
|
+
abstract addTitleChangeListener(listener: (newTitle: string) => void): () => void;
|
|
81
|
+
/**
|
|
82
|
+
* 修改标题
|
|
83
|
+
*/
|
|
84
|
+
abstract setTitle(title: string): void;
|
|
59
85
|
}
|
|
60
86
|
|
|
61
87
|
export declare abstract class AbstractedDocxSDK extends EditorSDK {
|
|
@@ -114,6 +140,20 @@ export declare abstract class AbstractedDocxSDK extends EditorSDK {
|
|
|
114
140
|
abstract get paragraphs(): DocxParagraphs;
|
|
115
141
|
}
|
|
116
142
|
|
|
143
|
+
/**
|
|
144
|
+
* 编辑文件检查器
|
|
145
|
+
*/
|
|
146
|
+
export declare abstract class AbstractedEditorFileChecker {
|
|
147
|
+
/**
|
|
148
|
+
* 检查文件是否符合限制
|
|
149
|
+
* @param files
|
|
150
|
+
* @returns 返回符合的files
|
|
151
|
+
*/
|
|
152
|
+
check?: (files: EditorPickedFile[], options?: {
|
|
153
|
+
type: 'image' | 'video' | 'audio' | 'attachment';
|
|
154
|
+
}) => EditorPickedFile[];
|
|
155
|
+
}
|
|
156
|
+
|
|
117
157
|
export declare abstract class AbstractedEditorFileUploader {
|
|
118
158
|
/**
|
|
119
159
|
* 开始上传
|
|
@@ -491,6 +531,12 @@ export declare interface BorderColors {
|
|
|
491
531
|
disabled: string;
|
|
492
532
|
}
|
|
493
533
|
|
|
534
|
+
export declare interface BorderConfig {
|
|
535
|
+
color?: string;
|
|
536
|
+
radius?: string;
|
|
537
|
+
width?: string;
|
|
538
|
+
}
|
|
539
|
+
|
|
494
540
|
/** 圆角配置 */
|
|
495
541
|
export declare interface BorderRadiusConfig {
|
|
496
542
|
/** 无圆角 0px */
|
|
@@ -547,6 +593,8 @@ export declare interface ButtonBaseSizeStyles {
|
|
|
547
593
|
borderRadius: string;
|
|
548
594
|
/** 字重 */
|
|
549
595
|
fontWeight: string | number;
|
|
596
|
+
/** 间距 */
|
|
597
|
+
gap?: string;
|
|
550
598
|
}
|
|
551
599
|
|
|
552
600
|
/** Button 完整配置 */
|
|
@@ -808,12 +856,16 @@ export declare interface CommonThemeConfig {
|
|
|
808
856
|
radio: RadioConfig;
|
|
809
857
|
/** 复选框 */
|
|
810
858
|
checkbox: CheckboxConfig;
|
|
859
|
+
/** 下拉框 */
|
|
860
|
+
dropdown: DropdownConfig;
|
|
861
|
+
/** 下拉框按钮 */
|
|
862
|
+
dropdownButton: DropdownButtonConfig;
|
|
863
|
+
/** 菜单 */
|
|
864
|
+
menu: MenuConfig;
|
|
811
865
|
/** 开关 */
|
|
812
866
|
switch: SwitchConfig;
|
|
813
867
|
/** 按钮 */
|
|
814
868
|
button: ButtonConfig;
|
|
815
|
-
/** 下拉框 */
|
|
816
|
-
dropdown: DropdownConfig;
|
|
817
869
|
/** 标签页 */
|
|
818
870
|
tab: TabConfig;
|
|
819
871
|
/** 滑块 */
|
|
@@ -948,6 +1000,48 @@ export declare interface DiagramSDKOptions extends EditorOptions {
|
|
|
948
1000
|
socket?: EditorSocket;
|
|
949
1001
|
}
|
|
950
1002
|
|
|
1003
|
+
/**
|
|
1004
|
+
* Docs(轻文档)套件的卡点/权限检查结果最小形态。
|
|
1005
|
+
*
|
|
1006
|
+
* @remarks
|
|
1007
|
+
* - 用于宿主(如 lizard-service-iframe-sdk)向 DocsSDK 透传 checkpoint 结果。
|
|
1008
|
+
* - 当前粘贴长度限制仅需要 `authorized/noCheck/max`。
|
|
1009
|
+
*/
|
|
1010
|
+
export declare interface DocsAttachLimitType {
|
|
1011
|
+
authorized: boolean;
|
|
1012
|
+
noCheck: boolean;
|
|
1013
|
+
max?: number;
|
|
1014
|
+
}
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
* Docs(轻文档)套件的卡点/权限检查函数。
|
|
1018
|
+
*/
|
|
1019
|
+
export declare type DocsCheckPermission = (key: string) => DocsAttachLimitType | null;
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
* Docs(轻文档)评论接口
|
|
1023
|
+
*/
|
|
1024
|
+
export declare interface DocsComments extends EditorComments {
|
|
1025
|
+
/**
|
|
1026
|
+
* 显示评论。show方法为默认的显示模式,可以调用showWithMode方法指定显示模式。
|
|
1027
|
+
* @param type 显示模式,list表示评论列表,card表示评论卡片。
|
|
1028
|
+
*/
|
|
1029
|
+
showWithMode: (type: 'list' | 'card') => void;
|
|
1030
|
+
/**
|
|
1031
|
+
* 隐藏评论
|
|
1032
|
+
* @param type list表示评论列表,card表示评论卡片。
|
|
1033
|
+
* 默认为list
|
|
1034
|
+
*/
|
|
1035
|
+
hideWithMode: (type: 'list' | 'card') => void;
|
|
1036
|
+
}
|
|
1037
|
+
|
|
1038
|
+
/**
|
|
1039
|
+
* 文档讨论
|
|
1040
|
+
*/
|
|
1041
|
+
export declare interface DocsDiscussOptions {
|
|
1042
|
+
socket?: EditorSocket;
|
|
1043
|
+
}
|
|
1044
|
+
|
|
951
1045
|
/**
|
|
952
1046
|
* 文档信息配置项,用于显示在文档信息弹窗中的内容
|
|
953
1047
|
*/
|
|
@@ -963,6 +1057,55 @@ export declare interface DocsInfoOptions {
|
|
|
963
1057
|
name: string;
|
|
964
1058
|
}
|
|
965
1059
|
|
|
1060
|
+
/**
|
|
1061
|
+
* Docs(轻文档)套件卡点限制配置。
|
|
1062
|
+
*
|
|
1063
|
+
* @remarks
|
|
1064
|
+
* 由宿主环境注入,用于在运行时查询各卡点的限额/开关。
|
|
1065
|
+
* 每个 getter 返回 `undefined` 表示使用内部默认值。
|
|
1066
|
+
*/
|
|
1067
|
+
export declare interface DocsLimitationOptions {
|
|
1068
|
+
/**
|
|
1069
|
+
* 获取单次可粘贴的最大字符数(Character)。
|
|
1070
|
+
* 返回 `undefined` 表示使用内部默认值(200000,即 20 万字符)。
|
|
1071
|
+
*/
|
|
1072
|
+
getPasteLimitRdoc?: () => number | undefined;
|
|
1073
|
+
/**
|
|
1074
|
+
* 获取单次可粘贴的最大数据体积(Byte)。
|
|
1075
|
+
* 返回 `undefined` 表示使用内部默认值(9437184,即 9 MB)。
|
|
1076
|
+
*/
|
|
1077
|
+
getPasteLimit?: () => number | undefined;
|
|
1078
|
+
/**
|
|
1079
|
+
* 通知提醒功能是否可用。
|
|
1080
|
+
* 返回 `undefined` 表示使用内部默认值(可用)。
|
|
1081
|
+
*/
|
|
1082
|
+
getRdocNotification?: () => boolean | undefined;
|
|
1083
|
+
/**
|
|
1084
|
+
* 跟随模式功能是否可用。
|
|
1085
|
+
* 返回 `undefined` 表示使用内部默认值(可用)。
|
|
1086
|
+
*/
|
|
1087
|
+
getRdocFollowMode?: () => boolean | undefined;
|
|
1088
|
+
/**
|
|
1089
|
+
* 宽纸张功能是否可用。
|
|
1090
|
+
* 返回 `undefined` 表示使用内部默认值(可用)。
|
|
1091
|
+
*/
|
|
1092
|
+
getRdocWidePaper?: () => boolean | undefined;
|
|
1093
|
+
}
|
|
1094
|
+
|
|
1095
|
+
/**
|
|
1096
|
+
* Docs 大纲能力接口。
|
|
1097
|
+
*/
|
|
1098
|
+
export declare interface DocsOutline {
|
|
1099
|
+
/**
|
|
1100
|
+
* 获取当前大纲面板是否打开。
|
|
1101
|
+
*/
|
|
1102
|
+
getOpen: () => boolean;
|
|
1103
|
+
/**
|
|
1104
|
+
* 设置大纲面板开关状态。
|
|
1105
|
+
*/
|
|
1106
|
+
setOpen: (isOpen: boolean) => void;
|
|
1107
|
+
}
|
|
1108
|
+
|
|
966
1109
|
/**
|
|
967
1110
|
* 区域(Range)
|
|
968
1111
|
* 区域对象,表示文档中的一个连续区域,每个 Range 对象包含起始字符位置和终止字符位置。
|
|
@@ -1086,7 +1229,7 @@ export declare interface DocsSDKOptions extends EditorOptions {
|
|
|
1086
1229
|
/**
|
|
1087
1230
|
* 纸张相关设置
|
|
1088
1231
|
*/
|
|
1089
|
-
pages
|
|
1232
|
+
pages?: {
|
|
1090
1233
|
width: 'standard' | 'wide' | 'full';
|
|
1091
1234
|
};
|
|
1092
1235
|
/**
|
|
@@ -1098,14 +1241,44 @@ export declare interface DocsSDKOptions extends EditorOptions {
|
|
|
1098
1241
|
linespacing: string;
|
|
1099
1242
|
size: string;
|
|
1100
1243
|
};
|
|
1244
|
+
fonts?: EditorFontsOptions;
|
|
1101
1245
|
footer?: {
|
|
1102
1246
|
logo?: string;
|
|
1103
1247
|
viewsText?: string;
|
|
1104
1248
|
};
|
|
1249
|
+
/**
|
|
1250
|
+
* UI主题相关设置
|
|
1251
|
+
*/
|
|
1252
|
+
theme?: DocsThemeOptions;
|
|
1253
|
+
/**
|
|
1254
|
+
* 讨论设置
|
|
1255
|
+
*/
|
|
1256
|
+
discuss?: DocsDiscussOptions;
|
|
1257
|
+
/**
|
|
1258
|
+
* 跟随模式设置
|
|
1259
|
+
*/
|
|
1260
|
+
followMode?: EditorFollowModeOptions;
|
|
1105
1261
|
/**
|
|
1106
1262
|
* 错误处理回调
|
|
1107
1263
|
*/
|
|
1108
1264
|
errorHandler?: (context: string, err: Error, extra?: Record<string, string>) => void;
|
|
1265
|
+
/**
|
|
1266
|
+
* Docs 套件的卡点/权限检查函数(可选)。
|
|
1267
|
+
*
|
|
1268
|
+
* @remarks
|
|
1269
|
+
* - 由宿主环境提供(如 lizard-service-iframe-sdk 的 `createCheckPermission`)。
|
|
1270
|
+
* - 用于实现 `paste_limit_rdoc` 等卡点能力(例如粘贴前长度限制)。
|
|
1271
|
+
*/
|
|
1272
|
+
checkPermission?: DocsCheckPermission;
|
|
1273
|
+
/**
|
|
1274
|
+
* Docs 套件卡点限制配置。
|
|
1275
|
+
*
|
|
1276
|
+
* @remarks
|
|
1277
|
+
* 由宿主环境注入,用于查询各卡点的限额/功能开关。
|
|
1278
|
+
* 与 {@link EditorHistoryOptions.limitations | history.limitations}、
|
|
1279
|
+
* {@link EditorVersionOptions.limitations | version.limitations} 保持一致的模式。
|
|
1280
|
+
*/
|
|
1281
|
+
limitations?: DocsLimitationOptions;
|
|
1109
1282
|
}
|
|
1110
1283
|
|
|
1111
1284
|
/**
|
|
@@ -1156,6 +1329,61 @@ export declare interface DocsSelection {
|
|
|
1156
1329
|
insertHtml: (html: string) => DocsRangeValue;
|
|
1157
1330
|
}
|
|
1158
1331
|
|
|
1332
|
+
/**
|
|
1333
|
+
* Docs 侧边栏能力接口。
|
|
1334
|
+
*/
|
|
1335
|
+
export declare interface DocsSidebar {
|
|
1336
|
+
/**
|
|
1337
|
+
* 打开侧边栏,可选指定默认 tab。
|
|
1338
|
+
*/
|
|
1339
|
+
show: (tab?: string) => void;
|
|
1340
|
+
/**
|
|
1341
|
+
* 关闭侧边栏。
|
|
1342
|
+
*/
|
|
1343
|
+
close: () => void;
|
|
1344
|
+
/**
|
|
1345
|
+
* 获取当前侧边栏状态。
|
|
1346
|
+
*/
|
|
1347
|
+
getState: () => DocsSidebarState;
|
|
1348
|
+
}
|
|
1349
|
+
|
|
1350
|
+
/**
|
|
1351
|
+
* Docs 侧边栏状态。
|
|
1352
|
+
*/
|
|
1353
|
+
export declare interface DocsSidebarState {
|
|
1354
|
+
visible: boolean;
|
|
1355
|
+
selectedTab: string;
|
|
1356
|
+
}
|
|
1357
|
+
|
|
1358
|
+
export declare interface DocsThemeExtensions {
|
|
1359
|
+
/** 编辑器容器 */
|
|
1360
|
+
container: {
|
|
1361
|
+
background: string;
|
|
1362
|
+
shadow: string;
|
|
1363
|
+
};
|
|
1364
|
+
/** 工具栏 */
|
|
1365
|
+
toolbar: {
|
|
1366
|
+
background: string;
|
|
1367
|
+
shadow: string;
|
|
1368
|
+
};
|
|
1369
|
+
/** 面板背景色(历史面板、讨论面板等) */
|
|
1370
|
+
drawer: {
|
|
1371
|
+
background: string;
|
|
1372
|
+
};
|
|
1373
|
+
/** 预览组件背景色 */
|
|
1374
|
+
previewer: {
|
|
1375
|
+
background: string;
|
|
1376
|
+
};
|
|
1377
|
+
dropdown: {
|
|
1378
|
+
align: 'left' | 'center' | 'right';
|
|
1379
|
+
};
|
|
1380
|
+
}
|
|
1381
|
+
|
|
1382
|
+
/**
|
|
1383
|
+
* Docs 完整主题配置
|
|
1384
|
+
*/
|
|
1385
|
+
export declare type DocsThemeOptions = EditorThemeOptions<DocsThemeExtensions>;
|
|
1386
|
+
|
|
1159
1387
|
/**
|
|
1160
1388
|
* 传统文档右键菜单功能按钮
|
|
1161
1389
|
*/
|
|
@@ -1657,7 +1885,7 @@ export declare interface DocxSDKOptions extends EditorOptions {
|
|
|
1657
1885
|
/**
|
|
1658
1886
|
* 主题字体相关配置
|
|
1659
1887
|
*/
|
|
1660
|
-
theme
|
|
1888
|
+
theme?: DocxThemeOptions;
|
|
1661
1889
|
/**
|
|
1662
1890
|
* 工具栏设置
|
|
1663
1891
|
*/
|
|
@@ -2013,7 +2241,7 @@ export declare interface DocxThemeStyleConfigList {
|
|
|
2013
2241
|
/**
|
|
2014
2242
|
* 主题样式配置项
|
|
2015
2243
|
*/
|
|
2016
|
-
export declare type DocxThemeStyleKeys = 'BackgroundColor' | 'WebViewBgColor' | 'RulerSize' | 'ScrollWidthInPx' | 'RulerNumber' | 'RulerOutlines' | 'RulerTickMark' | 'RulerMarkersOutline' | 'RulerActiveMarkersOutline' | 'RulerMarkersFill' | 'RulerLightClr' | 'RulerDarkClr' | 'BackgroundScroll' | 'ContentControlBackground' | 'ContentControlTagBackground' | 'ContentControlTagBorder' | 'ContentControllersBrd' | 'ContentControllersHover' | 'ContentControllersActive' | 'ContentControllersText' | 'ContentControllersTextActive' | 'ContentControllersSymbol' | 'ContentControllersSymbolActive' | 'ContentControllersAnchorActive' | 'PageSpace' | 'PageShadowOffsetX' | 'PageShadowOffsetY' | 'PageShadowSize' | 'PageShadowColor' | 'DocumentBottomSpace' | 'DocumentMargins' | 'ToastOffsetTop' | 'ShowTopShadow';
|
|
2244
|
+
export declare type DocxThemeStyleKeys = 'BackgroundColor' | 'WebViewBgColor' | 'RulerSize' | 'ScrollWidthInPx' | 'RulerNumber' | 'RulerOutlines' | 'RulerTickMark' | 'RulerMarkersOutline' | 'RulerActiveMarkersOutline' | 'RulerMarkersFill' | 'RulerLightClr' | 'RulerDarkClr' | 'BackgroundScroll' | 'ContentControlBackground' | 'ContentControlTagBackground' | 'ContentControlTagBorder' | 'ContentControllersBrd' | 'ContentControllersHover' | 'ContentControllersActive' | 'ContentControllersText' | 'ContentControllersTextActive' | 'ContentControllersSymbol' | 'ContentControllersSymbolActive' | 'ContentControllersAnchorActive' | 'PageSpace' | 'PageShadowOffsetX' | 'PageShadowOffsetY' | 'PageShadowSize' | 'PageShadowColor' | 'DocumentBottomSpace' | 'DocumentMargins' | 'ToastOffsetTop' | 'ShowTopShadow' | 'ToolbarBackgroundColor' | 'MenuBarBackgroundColor' | 'StatusBarBackgroundColor' | 'SideBarBackgroundColor';
|
|
2017
2245
|
|
|
2018
2246
|
/**
|
|
2019
2247
|
* 通用目录项条目
|
|
@@ -2493,82 +2721,65 @@ export declare interface DocxZoom {
|
|
|
2493
2721
|
zoomOut: () => void;
|
|
2494
2722
|
}
|
|
2495
2723
|
|
|
2496
|
-
/** Dropdown
|
|
2497
|
-
export declare interface
|
|
2498
|
-
/**
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
/**
|
|
2503
|
-
|
|
2504
|
-
/**
|
|
2505
|
-
|
|
2506
|
-
/**
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
|
-
|
|
2514
|
-
/**
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2724
|
+
/** Dropdown 按钮配置 */
|
|
2725
|
+
export declare interface DropdownButtonConfig {
|
|
2726
|
+
/** 颜色 */
|
|
2727
|
+
color: StateStyles;
|
|
2728
|
+
/** 背景 */
|
|
2729
|
+
background: StateStyles;
|
|
2730
|
+
/** 无边框背景 */
|
|
2731
|
+
frameLessBackground: StateStyles;
|
|
2732
|
+
/** 边框颜色 */
|
|
2733
|
+
borderColor: StateStyles;
|
|
2734
|
+
/** 图标 */
|
|
2735
|
+
icon: {
|
|
2736
|
+
size: IconSize;
|
|
2737
|
+
/** 透明度 */
|
|
2738
|
+
opacity: StateStyles;
|
|
2739
|
+
};
|
|
2740
|
+
/** 指示器 */
|
|
2741
|
+
indicator: IconConfig & {
|
|
2742
|
+
/** 旋转角度 */
|
|
2743
|
+
rotate: string;
|
|
2744
|
+
/** 透明度 */
|
|
2745
|
+
opacity: StateStyles;
|
|
2746
|
+
};
|
|
2747
|
+
/** 尺寸 */
|
|
2748
|
+
size: {
|
|
2749
|
+
/** 大尺寸 */
|
|
2750
|
+
large: DropdownButtonSizeStyles;
|
|
2751
|
+
/** 中尺寸 */
|
|
2752
|
+
medium: DropdownButtonSizeStyles;
|
|
2753
|
+
/** 小尺寸 */
|
|
2754
|
+
small: DropdownButtonSizeStyles;
|
|
2755
|
+
};
|
|
2520
2756
|
}
|
|
2521
2757
|
|
|
2522
|
-
/** Dropdown
|
|
2523
|
-
export declare interface
|
|
2524
|
-
/** 选中背景 */
|
|
2525
|
-
backgroundSelected: string;
|
|
2526
|
-
/** 文字颜色 */
|
|
2527
|
-
color: string;
|
|
2528
|
-
/** 禁用文字颜色 */
|
|
2529
|
-
colorDisabled: string;
|
|
2530
|
-
/** 菜单项内边距 */
|
|
2758
|
+
/** Dropdown 按钮尺寸 */
|
|
2759
|
+
export declare interface DropdownButtonSizeStyles {
|
|
2531
2760
|
padding: string;
|
|
2532
|
-
|
|
2533
|
-
|
|
2534
|
-
|
|
2535
|
-
export declare interface DropdownMenuStyles {
|
|
2536
|
-
/** 背景色 */
|
|
2537
|
-
background: string;
|
|
2538
|
-
/** 边框色 */
|
|
2539
|
-
borderColor: string;
|
|
2540
|
-
/** 圆角 */
|
|
2761
|
+
fontSize: string;
|
|
2762
|
+
height: string;
|
|
2763
|
+
gap: string;
|
|
2541
2764
|
borderRadius: string;
|
|
2542
|
-
/** 内边距 */
|
|
2543
|
-
padding: string;
|
|
2544
|
-
/** 阴影 */
|
|
2545
|
-
boxShadow: string;
|
|
2546
|
-
/** 最大高度 */
|
|
2547
|
-
maxHeight: string;
|
|
2548
|
-
}
|
|
2549
|
-
|
|
2550
|
-
/** Dropdown 尺寸配置 */
|
|
2551
|
-
export declare interface DropdownSizeStyles extends ButtonBaseSizeStyles {
|
|
2552
|
-
/** 图标尺寸 */
|
|
2553
2765
|
iconSize: IconSize;
|
|
2766
|
+
indicatorSize: IconSize;
|
|
2554
2767
|
}
|
|
2555
2768
|
|
|
2556
|
-
/**
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
/**
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2564
|
-
/**
|
|
2565
|
-
|
|
2566
|
-
/**
|
|
2567
|
-
|
|
2568
|
-
/**
|
|
2569
|
-
|
|
2570
|
-
/** 菜单项样式 */
|
|
2571
|
-
menuItem: DropdownMenuItemStyles;
|
|
2769
|
+
/**
|
|
2770
|
+
* Dropdown 下拉框配置
|
|
2771
|
+
*/
|
|
2772
|
+
export declare interface DropdownConfig {
|
|
2773
|
+
/** 阴影 */
|
|
2774
|
+
boxShadow: string;
|
|
2775
|
+
/** 内边距 */
|
|
2776
|
+
padding: string;
|
|
2777
|
+
/** 圆角 */
|
|
2778
|
+
borderRadius: string;
|
|
2779
|
+
/** 边框 */
|
|
2780
|
+
border: string;
|
|
2781
|
+
/** 背景 */
|
|
2782
|
+
background: string;
|
|
2572
2783
|
}
|
|
2573
2784
|
|
|
2574
2785
|
/**
|
|
@@ -2787,6 +2998,10 @@ export declare interface EditorAttachmentOptions {
|
|
|
2787
2998
|
* 附件选择器
|
|
2788
2999
|
*/
|
|
2789
3000
|
picker?: EditorFilePicker;
|
|
3001
|
+
/**
|
|
3002
|
+
* 文件检查器
|
|
3003
|
+
*/
|
|
3004
|
+
checker?: AbstractedEditorFileChecker;
|
|
2790
3005
|
/**
|
|
2791
3006
|
* 附件上传器
|
|
2792
3007
|
*/
|
|
@@ -3219,6 +3434,14 @@ export declare type EditorContextMenuOptions<TName extends string> = EditorMenuO
|
|
|
3219
3434
|
*/
|
|
3220
3435
|
export declare type EditorCopyOptions = EditorLogicFeatureConfig;
|
|
3221
3436
|
|
|
3437
|
+
/**
|
|
3438
|
+
* 日期格式
|
|
3439
|
+
* - `YYYY/MM/DD` 年/月/日(简繁中文、韩语、日语默认)
|
|
3440
|
+
* - `MM/DD/YYYY` 月/日/年(英语默认)
|
|
3441
|
+
* - `DD/MM/YYYY` 日/月/年(其他语言默认)
|
|
3442
|
+
*/
|
|
3443
|
+
export declare type EditorDateFormat = 'YYYY/MM/DD' | 'MM/DD/YYYY' | 'DD/MM/YYYY';
|
|
3444
|
+
|
|
3222
3445
|
/**
|
|
3223
3446
|
* 编辑器解密选项接口
|
|
3224
3447
|
* 用于配置编辑器中需要解密的内容的相关选项
|
|
@@ -3396,11 +3619,31 @@ export declare interface EditorFilePicker {
|
|
|
3396
3619
|
}
|
|
3397
3620
|
|
|
3398
3621
|
export declare interface EditorFilePickerOpenOptions {
|
|
3622
|
+
/**
|
|
3623
|
+
* 文件类型限制
|
|
3624
|
+
*/
|
|
3399
3625
|
mimeTypes?: string[];
|
|
3626
|
+
/**
|
|
3627
|
+
* 最大文件尺寸限制
|
|
3628
|
+
*/
|
|
3400
3629
|
maxSize?: number;
|
|
3630
|
+
/**
|
|
3631
|
+
* 文件后缀限制
|
|
3632
|
+
*/
|
|
3401
3633
|
extensions?: string[];
|
|
3634
|
+
/**
|
|
3635
|
+
* 是否支持多选
|
|
3636
|
+
*/
|
|
3402
3637
|
multiple?: boolean;
|
|
3638
|
+
/**
|
|
3639
|
+
* 是否为选择文件夹
|
|
3640
|
+
*/
|
|
3403
3641
|
directory?: boolean;
|
|
3642
|
+
/**
|
|
3643
|
+
* 文件选择器接受的文件类型,如 'image/*' 表示接受所有图片文件
|
|
3644
|
+
* 如果指定了该配置,则不会再由extensions生成accept
|
|
3645
|
+
*/
|
|
3646
|
+
accept?: string;
|
|
3404
3647
|
}
|
|
3405
3648
|
|
|
3406
3649
|
export declare interface EditorFollowMode {
|
|
@@ -3513,9 +3756,32 @@ export declare interface EditorFontsOptions {
|
|
|
3513
3756
|
*/
|
|
3514
3757
|
list?: EditorFontsList;
|
|
3515
3758
|
/**
|
|
3516
|
-
*
|
|
3759
|
+
* 字体列表中隐藏不可用的字体,包含外部传入的以及各套件内置的字体
|
|
3760
|
+
* 不可用的定义:非本地已安装且不支持下载
|
|
3761
|
+
*/
|
|
3762
|
+
hideUnavailableFonts?: boolean;
|
|
3763
|
+
/**
|
|
3764
|
+
* 字体下载监听器注册函数,当字体状态发生变化时调用提供的回调函数。
|
|
3765
|
+
* 回调函数暂时没有参数,后续可以根据需要添加参数,例如提供变化的字体信息等。
|
|
3766
|
+
* @param listener
|
|
3767
|
+
* @returns
|
|
3517
3768
|
*/
|
|
3518
|
-
|
|
3769
|
+
registerFontLoadListener?: (listener: (options: FontLoadListenerOptions) => void) => void;
|
|
3770
|
+
/**
|
|
3771
|
+
* 下载字体的函数,接受字体族名称和一个可选的配置对象作为参数。
|
|
3772
|
+
* 配置对象可以包含以下回调函数:
|
|
3773
|
+
* - onProgress: 在下载过程中调用,提供下载进度(0 到 1 之间的数字)。
|
|
3774
|
+
* - onComplete: 在下载完成时调用。
|
|
3775
|
+
* - onError: 在下载过程中发生错误时调用,提供错误对象。
|
|
3776
|
+
* @param fontFamily
|
|
3777
|
+
* @param option
|
|
3778
|
+
* @returns
|
|
3779
|
+
*/
|
|
3780
|
+
download?: (fontFamily: string, option?: {
|
|
3781
|
+
onProgress?: (progress: number) => void;
|
|
3782
|
+
onComplete?: () => void;
|
|
3783
|
+
onError?: (error: Error) => void;
|
|
3784
|
+
}) => void;
|
|
3519
3785
|
}
|
|
3520
3786
|
|
|
3521
3787
|
/**
|
|
@@ -3543,20 +3809,61 @@ export declare interface EditorHistory {
|
|
|
3543
3809
|
hide: () => void;
|
|
3544
3810
|
}
|
|
3545
3811
|
|
|
3546
|
-
export declare
|
|
3812
|
+
export declare interface EditorHistoryLimitations {
|
|
3813
|
+
/** 单个文件可还原的最近历史记录数量 */
|
|
3814
|
+
getHistoryLimitRevertNum?: () => number | undefined;
|
|
3815
|
+
/** 文件历史保留天数 */
|
|
3816
|
+
getHistoryLimitAllTime?: () => number | undefined;
|
|
3817
|
+
}
|
|
3818
|
+
|
|
3819
|
+
export declare type EditorHistoryOptions = EditorFeatureConfig & {
|
|
3820
|
+
limitations?: EditorHistoryLimitations;
|
|
3821
|
+
};
|
|
3547
3822
|
|
|
3548
3823
|
/**
|
|
3549
3824
|
* i18n 相关设置
|
|
3550
3825
|
*/
|
|
3551
3826
|
export declare interface EditorI18nOptions {
|
|
3552
3827
|
/**
|
|
3553
|
-
*
|
|
3828
|
+
* 语言代码
|
|
3829
|
+
* 默认读取浏览器/设备语言并在支持的列表中匹配
|
|
3830
|
+
* 匹配规则:优先精确匹配,其次模糊匹配 language 部分,Fallback 为 en-US
|
|
3554
3831
|
*/
|
|
3555
|
-
language?:
|
|
3832
|
+
language?: EditorLanguage;
|
|
3556
3833
|
/**
|
|
3557
3834
|
* 文本方向,默认根据语言自动适配
|
|
3558
3835
|
*/
|
|
3559
3836
|
direction?: 'ltr' | 'rtl';
|
|
3837
|
+
/**
|
|
3838
|
+
* 时区设置(包含 ID、偏移量、标签)
|
|
3839
|
+
* 默认读取浏览器/设备时区,如无法匹配则根据语言推测
|
|
3840
|
+
* Fallback 为 { id: 'Europe/London', offset: 0, label: 'London' }
|
|
3841
|
+
*/
|
|
3842
|
+
timezone?: EditorTimezoneInfo;
|
|
3843
|
+
/**
|
|
3844
|
+
* 日期格式
|
|
3845
|
+
* 默认根据语言自动匹配:
|
|
3846
|
+
* - 简繁中文、韩语、日语:YYYY/MM/DD
|
|
3847
|
+
* - 英语:MM/DD/YYYY
|
|
3848
|
+
* - 其他语言:DD/MM/YYYY
|
|
3849
|
+
* 用户手动设置后将保存并优先使用用户设置
|
|
3850
|
+
*/
|
|
3851
|
+
dateFormat?: EditorDateFormat;
|
|
3852
|
+
/**
|
|
3853
|
+
* 时间格式
|
|
3854
|
+
* 默认使用 24 小时制
|
|
3855
|
+
* 注意:部分语言(如德语、法语、意大利语、俄语)不支持 12 小时制
|
|
3856
|
+
* 用户手动设置后将保存并优先使用用户设置
|
|
3857
|
+
*/
|
|
3858
|
+
timeFormat?: EditorTimeFormat;
|
|
3859
|
+
/**
|
|
3860
|
+
* 周起始日
|
|
3861
|
+
* 默认根据语言自动匹配:
|
|
3862
|
+
* - 英语、阿拉伯语:星期日
|
|
3863
|
+
* - 其他语言:星期一
|
|
3864
|
+
* 用户手动设置后将保存并优先使用用户设置
|
|
3865
|
+
*/
|
|
3866
|
+
weekStartDay?: EditorWeekStartDay;
|
|
3560
3867
|
}
|
|
3561
3868
|
|
|
3562
3869
|
export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
|
|
@@ -3601,6 +3908,27 @@ export declare interface EditorImportOptions {
|
|
|
3601
3908
|
}>;
|
|
3602
3909
|
}
|
|
3603
3910
|
|
|
3911
|
+
/**
|
|
3912
|
+
* 支持的语言代码
|
|
3913
|
+
* - `zh-CN` 简体中文
|
|
3914
|
+
* - `zh-TW` 繁体中文(含 zh-HK, zh-MO)
|
|
3915
|
+
* - `en-US` 英语
|
|
3916
|
+
* - `ja-JP` 日语
|
|
3917
|
+
* - `ko-KR` 韩语
|
|
3918
|
+
* - `es-ES` 西班牙语
|
|
3919
|
+
* - `pt-PT` 葡萄牙语
|
|
3920
|
+
* - `de-DE` 德语
|
|
3921
|
+
* - `fr-FR` 法语
|
|
3922
|
+
* - `it-IT` 意大利语
|
|
3923
|
+
* - `ru-RU` 俄语
|
|
3924
|
+
* - `id-ID` 印度尼西亚语
|
|
3925
|
+
* - `vi-VN` 越南语
|
|
3926
|
+
* - `th-TH` 泰语
|
|
3927
|
+
* - `ms-MY` 马来语
|
|
3928
|
+
* - `ar-SA` 阿拉伯语
|
|
3929
|
+
*/
|
|
3930
|
+
export declare type EditorLanguage = 'zh-CN' | 'zh-TW' | 'en-US' | 'ja-JP' | 'ko-KR' | 'es-ES' | 'pt-PT' | 'de-DE' | 'fr-FR' | 'it-IT' | 'ru-RU' | 'id-ID' | 'vi-VN' | 'th-TH' | 'ms-MY' | 'ar-SA';
|
|
3931
|
+
|
|
3604
3932
|
/**
|
|
3605
3933
|
* 链接配置,抽象打开链接等操作
|
|
3606
3934
|
*/
|
|
@@ -4150,7 +4478,11 @@ export declare interface EditorOptions {
|
|
|
4150
4478
|
/**
|
|
4151
4479
|
* 编辑器主题相关设置
|
|
4152
4480
|
*/
|
|
4153
|
-
theme
|
|
4481
|
+
theme?: EditorThemeOptions;
|
|
4482
|
+
/**
|
|
4483
|
+
* 编辑器拼写检查相关设置
|
|
4484
|
+
*/
|
|
4485
|
+
spellCheck?: EditorSpellCheckOptions;
|
|
4154
4486
|
}
|
|
4155
4487
|
|
|
4156
4488
|
/**
|
|
@@ -4470,6 +4802,49 @@ export declare interface EditorSocket {
|
|
|
4470
4802
|
connected: boolean;
|
|
4471
4803
|
}
|
|
4472
4804
|
|
|
4805
|
+
export declare interface EditorSpellCheckDictionaryFileConfig {
|
|
4806
|
+
/** 词典文件的 aff 文件路径 */
|
|
4807
|
+
aff: string;
|
|
4808
|
+
/** 词典文件的 dic 文件路径 */
|
|
4809
|
+
dic: string;
|
|
4810
|
+
}
|
|
4811
|
+
|
|
4812
|
+
/**
|
|
4813
|
+
* 拼写检查相关配置
|
|
4814
|
+
*/
|
|
4815
|
+
export declare interface EditorSpellCheckOptions extends EditorFeatureConfig {
|
|
4816
|
+
/**
|
|
4817
|
+
* 拼写检查功能配置
|
|
4818
|
+
*/
|
|
4819
|
+
spellCheck?: {
|
|
4820
|
+
/**
|
|
4821
|
+
* 拼写检查功能是否被禁用
|
|
4822
|
+
*/
|
|
4823
|
+
disabled?: boolean;
|
|
4824
|
+
/**
|
|
4825
|
+
* 拼写检查所需要的字典文件 CDN 域名
|
|
4826
|
+
*/
|
|
4827
|
+
dictionaryCDNHost?: string;
|
|
4828
|
+
/**
|
|
4829
|
+
* 自定义拼写检查词典, 用于覆盖内置的默认词典
|
|
4830
|
+
*/
|
|
4831
|
+
customDictionary?: Partial<Record<EditorLanguage, EditorSpellCheckDictionaryFileConfig>>;
|
|
4832
|
+
};
|
|
4833
|
+
/**
|
|
4834
|
+
* 语法检查功能配置
|
|
4835
|
+
*/
|
|
4836
|
+
grammarCheck?: {
|
|
4837
|
+
/**
|
|
4838
|
+
* 语法检查功能是否被禁用
|
|
4839
|
+
*/
|
|
4840
|
+
disabled?: boolean;
|
|
4841
|
+
/**
|
|
4842
|
+
* 拼写检查API的URL,必须使用绝对路径
|
|
4843
|
+
*/
|
|
4844
|
+
url?: string;
|
|
4845
|
+
};
|
|
4846
|
+
}
|
|
4847
|
+
|
|
4473
4848
|
/**
|
|
4474
4849
|
* 编辑器在 `standard` 模式下的权限模式
|
|
4475
4850
|
* - `editor` 编辑模式
|
|
@@ -4612,6 +4987,59 @@ export declare interface EditorThemeOptions<TExtensions = object> extends Common
|
|
|
4612
4987
|
extensions?: TExtensions;
|
|
4613
4988
|
}
|
|
4614
4989
|
|
|
4990
|
+
/**
|
|
4991
|
+
* 时间格式
|
|
4992
|
+
* - `24h` 24 小时制(默认)
|
|
4993
|
+
* - `12h` 12 小时制(部分语言不支持)
|
|
4994
|
+
*/
|
|
4995
|
+
export declare type EditorTimeFormat = '24h' | '12h';
|
|
4996
|
+
|
|
4997
|
+
/**
|
|
4998
|
+
* 支持的时区 IANA ID
|
|
4999
|
+
*
|
|
5000
|
+
* 覆盖范围: UTC-12 到 UTC+12,共 34 个全球主要城市时区
|
|
5001
|
+
*
|
|
5002
|
+
* 注意事项:
|
|
5003
|
+
* - 所有时区 ID 均为 IANA 时区数据库标准标识符
|
|
5004
|
+
* - Etc/GMT+12 表示 UTC-12(Etc/GMT 时区符号与 UTC 相反)
|
|
5005
|
+
* - 不包括已弃用或非标准时区标识符
|
|
5006
|
+
*
|
|
5007
|
+
* @see https://www.iana.org/time-zones
|
|
5008
|
+
*/
|
|
5009
|
+
export declare type EditorTimezoneId = 'Etc/GMT+12' | 'Pacific/Pago_Pago' | 'Pacific/Honolulu' | 'America/Anchorage' | 'America/Los_Angeles' | 'America/Denver' | 'America/Mexico_City' | 'America/New_York' | 'America/Santiago' | 'America/Sao_Paulo' | 'Atlantic/South_Georgia' | 'Atlantic/Cape_Verde' | 'Europe/London' | 'Europe/Lisbon' | 'Europe/Paris' | 'Europe/Berlin' | 'Europe/Rome' | 'Europe/Madrid' | 'Africa/Cairo' | 'Europe/Moscow' | 'Asia/Riyadh' | 'Asia/Dubai' | 'Asia/Karachi' | 'Asia/Dhaka' | 'Asia/Bangkok' | 'Asia/Jakarta' | 'Asia/Ho_Chi_Minh' | 'Asia/Shanghai' | 'Asia/Kuala_Lumpur' | 'Asia/Tokyo' | 'Asia/Seoul' | 'Australia/Sydney' | 'Pacific/Guadalcanal' | 'Pacific/Auckland';
|
|
5010
|
+
|
|
5011
|
+
/**
|
|
5012
|
+
* 时区信息
|
|
5013
|
+
*/
|
|
5014
|
+
export declare interface EditorTimezoneInfo {
|
|
5015
|
+
/**
|
|
5016
|
+
* IANA 时区 ID
|
|
5017
|
+
*
|
|
5018
|
+
* 标准的 IANA 时区数据库标识符
|
|
5019
|
+
*
|
|
5020
|
+
* @example 'Asia/Shanghai', 'America/New_York', 'Europe/London'
|
|
5021
|
+
*/
|
|
5022
|
+
id: EditorTimezoneId;
|
|
5023
|
+
/**
|
|
5024
|
+
* UTC 偏移量(小时,标准时间)
|
|
5025
|
+
*
|
|
5026
|
+
* - 正数:东半球,如 `8` 表示 UTC+8(北京)
|
|
5027
|
+
* - 负数:西半球,如 `-5` 表示 UTC-5(纽约标准时间)
|
|
5028
|
+
* - 零:格林威治标准时间
|
|
5029
|
+
*
|
|
5030
|
+
* 注意:此值为标准时间,不包含夏令时调整
|
|
5031
|
+
*/
|
|
5032
|
+
offset: number;
|
|
5033
|
+
/**
|
|
5034
|
+
* 时区标签(英文)
|
|
5035
|
+
*
|
|
5036
|
+
* 用于 UI 显示的城市或地区名称
|
|
5037
|
+
*
|
|
5038
|
+
* @example 'Shanghai', 'New York', 'London'
|
|
5039
|
+
*/
|
|
5040
|
+
label: string;
|
|
5041
|
+
}
|
|
5042
|
+
|
|
4615
5043
|
/**
|
|
4616
5044
|
* 工具栏功能按钮配置(包括内置按钮和自定义按钮)
|
|
4617
5045
|
*/
|
|
@@ -4675,6 +5103,16 @@ export declare interface EditorToolbarOptions<TName extends string> {
|
|
|
4675
5103
|
* 如果不配置则按照套件的默认方式挂载。
|
|
4676
5104
|
*/
|
|
4677
5105
|
container?: HTMLElement;
|
|
5106
|
+
/**
|
|
5107
|
+
* 工具栏样式
|
|
5108
|
+
* 各套件可自行扩展,目前支持背景色配置
|
|
5109
|
+
*/
|
|
5110
|
+
style?: {
|
|
5111
|
+
/**
|
|
5112
|
+
* 背景色
|
|
5113
|
+
*/
|
|
5114
|
+
backgroundColor?: string;
|
|
5115
|
+
};
|
|
4678
5116
|
}
|
|
4679
5117
|
|
|
4680
5118
|
/**
|
|
@@ -4888,9 +5326,11 @@ export declare interface EditorUserOptions {
|
|
|
4888
5326
|
export declare interface EditorVersion {
|
|
4889
5327
|
/**
|
|
4890
5328
|
* 保存版本
|
|
4891
|
-
* @param
|
|
5329
|
+
* @param options 版本名称
|
|
4892
5330
|
*/
|
|
4893
|
-
createRevision: (
|
|
5331
|
+
createRevision: (options?: string | {
|
|
5332
|
+
name: string;
|
|
5333
|
+
}) => void;
|
|
4894
5334
|
/**
|
|
4895
5335
|
* 显示版本(侧边栏或其他形式)
|
|
4896
5336
|
* 区别于历史侧边栏,在应用表格里表现为打开历史侧边栏切换到版本 tab
|
|
@@ -4903,7 +5343,14 @@ export declare interface EditorVersion {
|
|
|
4903
5343
|
hide?: () => void;
|
|
4904
5344
|
}
|
|
4905
5345
|
|
|
4906
|
-
export declare
|
|
5346
|
+
export declare interface EditorVersionLimitations {
|
|
5347
|
+
/** 单个文件可保存/还原的版本(快照)数量 */
|
|
5348
|
+
getHistoryLimitVersionNum?: () => number | undefined;
|
|
5349
|
+
}
|
|
5350
|
+
|
|
5351
|
+
export declare type EditorVersionOptions = EditorFeatureConfig & {
|
|
5352
|
+
limitations?: EditorVersionLimitations;
|
|
5353
|
+
};
|
|
4907
5354
|
|
|
4908
5355
|
/**
|
|
4909
5356
|
* 编辑器外部水印信息
|
|
@@ -4933,6 +5380,13 @@ export declare type EditorWatermarkResource = {
|
|
|
4933
5380
|
url: string;
|
|
4934
5381
|
};
|
|
4935
5382
|
|
|
5383
|
+
/**
|
|
5384
|
+
* 周起始日
|
|
5385
|
+
* - `sunday` 星期日(英语、阿拉伯语默认)
|
|
5386
|
+
* - `monday` 星期一(其他语言默认)
|
|
5387
|
+
*/
|
|
5388
|
+
export declare type EditorWeekStartDay = 'sunday' | 'monday';
|
|
5389
|
+
|
|
4936
5390
|
/**
|
|
4937
5391
|
* 错误信息接口
|
|
4938
5392
|
* 定义了表格组件中可能发生的错误信息结构
|
|
@@ -5022,6 +5476,35 @@ export declare interface FontFamilyConfig {
|
|
|
5022
5476
|
base: string;
|
|
5023
5477
|
}
|
|
5024
5478
|
|
|
5479
|
+
/**
|
|
5480
|
+
* 字体下载事件类型
|
|
5481
|
+
*/
|
|
5482
|
+
export declare enum FontLoadEventType {
|
|
5483
|
+
DownloadStart = "downloadStart",
|
|
5484
|
+
DownloadProgress = "downloadProgress",
|
|
5485
|
+
DownloadComplete = "downloadComplete",
|
|
5486
|
+
DownloadError = "downloadError"
|
|
5487
|
+
}
|
|
5488
|
+
|
|
5489
|
+
/**
|
|
5490
|
+
* 字体下载事件监听器参数,根据事件类型提供不同的属性
|
|
5491
|
+
*/
|
|
5492
|
+
export declare type FontLoadListenerOptions = {
|
|
5493
|
+
type: FontLoadEventType.DownloadStart;
|
|
5494
|
+
id: string;
|
|
5495
|
+
} | {
|
|
5496
|
+
type: FontLoadEventType.DownloadComplete;
|
|
5497
|
+
id: string;
|
|
5498
|
+
} | {
|
|
5499
|
+
type: FontLoadEventType.DownloadProgress;
|
|
5500
|
+
id: string;
|
|
5501
|
+
progress: number;
|
|
5502
|
+
} | {
|
|
5503
|
+
type: FontLoadEventType.DownloadError;
|
|
5504
|
+
id: string;
|
|
5505
|
+
error: Error;
|
|
5506
|
+
};
|
|
5507
|
+
|
|
5025
5508
|
/** 字号配置 */
|
|
5026
5509
|
export declare interface FontSizeConfig {
|
|
5027
5510
|
/** 超小字号 */
|
|
@@ -5235,6 +5718,16 @@ export declare interface HTTPProxy {
|
|
|
5235
5718
|
* @returns
|
|
5236
5719
|
*/
|
|
5237
5720
|
create: (id: string) => Promise<HTTPProxy>;
|
|
5721
|
+
/**
|
|
5722
|
+
* 凭证更新器,用于套件内部主动发起更新凭证操作
|
|
5723
|
+
* 例如:页面可见性发生变化时,在pull请求发起之前
|
|
5724
|
+
*/
|
|
5725
|
+
credentials?: {
|
|
5726
|
+
/**
|
|
5727
|
+
* 更新凭证
|
|
5728
|
+
*/
|
|
5729
|
+
update: () => Promise<void>;
|
|
5730
|
+
};
|
|
5238
5731
|
}
|
|
5239
5732
|
|
|
5240
5733
|
/**
|
|
@@ -5434,6 +5927,8 @@ export declare interface InputStateColorStyles {
|
|
|
5434
5927
|
textColorNormal: string;
|
|
5435
5928
|
/** 禁用文字颜色 */
|
|
5436
5929
|
textColorDisabled: string;
|
|
5930
|
+
/** 只读文字颜色 */
|
|
5931
|
+
textColorReadOnly: string;
|
|
5437
5932
|
}
|
|
5438
5933
|
|
|
5439
5934
|
/** Input 状态样式配置 */
|
|
@@ -5585,6 +6080,102 @@ export declare enum MentionTypes {
|
|
|
5585
6080
|
DateMention = "date_mention"
|
|
5586
6081
|
}
|
|
5587
6082
|
|
|
6083
|
+
/** 菜单配置 */
|
|
6084
|
+
export declare interface MenuConfig {
|
|
6085
|
+
/** 菜单项配置 */
|
|
6086
|
+
menuItem: MenuItemConfig;
|
|
6087
|
+
/** 子菜单 */
|
|
6088
|
+
subMenu: {
|
|
6089
|
+
/** 子菜单弹出位置偏移 */
|
|
6090
|
+
popupOffset: number[];
|
|
6091
|
+
};
|
|
6092
|
+
/** 边框 */
|
|
6093
|
+
border: BorderConfig;
|
|
6094
|
+
/** 阴影 */
|
|
6095
|
+
boxShadow: Pick<StateStyles, 'normal' | 'hover'>;
|
|
6096
|
+
/** 分割线 */
|
|
6097
|
+
divider: {
|
|
6098
|
+
background: string;
|
|
6099
|
+
height: string;
|
|
6100
|
+
margin: string;
|
|
6101
|
+
};
|
|
6102
|
+
/** 分组标题 */
|
|
6103
|
+
groupTitle: {
|
|
6104
|
+
fontSize: string;
|
|
6105
|
+
fontWeight: string;
|
|
6106
|
+
color: string;
|
|
6107
|
+
};
|
|
6108
|
+
}
|
|
6109
|
+
|
|
6110
|
+
/** 菜单项配置 */
|
|
6111
|
+
export declare interface MenuItemConfig {
|
|
6112
|
+
/** 背景 */
|
|
6113
|
+
background: {
|
|
6114
|
+
normal: string;
|
|
6115
|
+
hover: string;
|
|
6116
|
+
active: string;
|
|
6117
|
+
disabled: string;
|
|
6118
|
+
};
|
|
6119
|
+
/** 边框 */
|
|
6120
|
+
border: BorderConfig;
|
|
6121
|
+
/** 布局 */
|
|
6122
|
+
layout: {
|
|
6123
|
+
/** 内边距 */
|
|
6124
|
+
padding: string;
|
|
6125
|
+
/** 间距 */
|
|
6126
|
+
gap: string;
|
|
6127
|
+
};
|
|
6128
|
+
/** 图标 */
|
|
6129
|
+
icon: {
|
|
6130
|
+
size: IconSize;
|
|
6131
|
+
};
|
|
6132
|
+
/** 标签 */
|
|
6133
|
+
label: {
|
|
6134
|
+
/** 颜色 */
|
|
6135
|
+
color: StateStyles;
|
|
6136
|
+
};
|
|
6137
|
+
/** 描述文本 */
|
|
6138
|
+
description: {
|
|
6139
|
+
/** 颜色 */
|
|
6140
|
+
color: StateStyles;
|
|
6141
|
+
};
|
|
6142
|
+
/** 激活图标 */
|
|
6143
|
+
activeIcon: {
|
|
6144
|
+
url: string;
|
|
6145
|
+
};
|
|
6146
|
+
/** 下一级菜单图标 */
|
|
6147
|
+
nextLevelIcon: {
|
|
6148
|
+
url: string;
|
|
6149
|
+
};
|
|
6150
|
+
/** 尺寸 */
|
|
6151
|
+
size: {
|
|
6152
|
+
/** 小尺寸 */
|
|
6153
|
+
small: MenuItemSizeStyles;
|
|
6154
|
+
/** 中尺寸 */
|
|
6155
|
+
medium: MenuItemSizeStyles;
|
|
6156
|
+
/** 大尺寸 */
|
|
6157
|
+
large: MenuItemSizeStyles;
|
|
6158
|
+
};
|
|
6159
|
+
}
|
|
6160
|
+
|
|
6161
|
+
/** 菜单项尺寸样式 */
|
|
6162
|
+
export declare interface MenuItemSizeStyles {
|
|
6163
|
+
label: {
|
|
6164
|
+
fontSize: string;
|
|
6165
|
+
maxWidth: string;
|
|
6166
|
+
};
|
|
6167
|
+
description: {
|
|
6168
|
+
fontSize: string;
|
|
6169
|
+
maxWidth: string;
|
|
6170
|
+
};
|
|
6171
|
+
activeIcon: {
|
|
6172
|
+
size: IconSize;
|
|
6173
|
+
};
|
|
6174
|
+
nextLevelIcon: {
|
|
6175
|
+
size: IconSize;
|
|
6176
|
+
};
|
|
6177
|
+
}
|
|
6178
|
+
|
|
5588
6179
|
/**
|
|
5589
6180
|
* 幻灯片可导出类型
|
|
5590
6181
|
*/
|
|
@@ -6149,9 +6740,13 @@ export declare interface PresentationSDKOptions extends EditorOptions {
|
|
|
6149
6740
|
*/
|
|
6150
6741
|
chart?: PresentationChartOptions;
|
|
6151
6742
|
/**
|
|
6152
|
-
* 主题相关设置
|
|
6743
|
+
* UI主题相关设置
|
|
6744
|
+
*/
|
|
6745
|
+
theme?: PresentationThemeOptions;
|
|
6746
|
+
/**
|
|
6747
|
+
* 幻灯片主题相关设置
|
|
6153
6748
|
*/
|
|
6154
|
-
|
|
6749
|
+
slideTheme?: PresentationSlideThemeOptions;
|
|
6155
6750
|
/**
|
|
6156
6751
|
* 图示相关设置
|
|
6157
6752
|
*/
|
|
@@ -6338,9 +6933,9 @@ export declare interface PresentationSlidesPaneOptions {
|
|
|
6338
6933
|
}
|
|
6339
6934
|
|
|
6340
6935
|
/**
|
|
6341
|
-
* Presentation
|
|
6936
|
+
* Presentation 幻灯片主题配置
|
|
6342
6937
|
*/
|
|
6343
|
-
export declare interface
|
|
6938
|
+
export declare interface PresentationSlideThemeOptions extends EditorFeatureConfig {
|
|
6344
6939
|
/**
|
|
6345
6940
|
* 是否禁用图片缓存, 默认不禁用
|
|
6346
6941
|
*/
|
|
@@ -6424,11 +7019,79 @@ export declare interface PresentationTextRangeValue {
|
|
|
6424
7019
|
}
|
|
6425
7020
|
|
|
6426
7021
|
/**
|
|
6427
|
-
* Presentation 主题配置扩展
|
|
7022
|
+
* Presentation UI 主题配置扩展
|
|
6428
7023
|
*/
|
|
6429
7024
|
export declare interface PresentationThemeExtensions {
|
|
6430
|
-
/**
|
|
6431
|
-
|
|
7025
|
+
/** 画布 */
|
|
7026
|
+
canvas: {
|
|
7027
|
+
background: string;
|
|
7028
|
+
};
|
|
7029
|
+
/** 设置面板,包括动画、辅助面板、音频设置等等面板 */
|
|
7030
|
+
settingPanel: {
|
|
7031
|
+
background: string;
|
|
7032
|
+
};
|
|
7033
|
+
/** 工具栏 */
|
|
7034
|
+
toolbar: {
|
|
7035
|
+
background: string;
|
|
7036
|
+
};
|
|
7037
|
+
/** 状态栏 */
|
|
7038
|
+
statusBar: {
|
|
7039
|
+
background: string;
|
|
7040
|
+
};
|
|
7041
|
+
/** 幻灯片窗格 */
|
|
7042
|
+
slidesPane: {
|
|
7043
|
+
background: string;
|
|
7044
|
+
/** 幻灯片缩略图 */
|
|
7045
|
+
thumbnail: {
|
|
7046
|
+
/** 边框 */
|
|
7047
|
+
border: {
|
|
7048
|
+
selectedColor: string;
|
|
7049
|
+
};
|
|
7050
|
+
};
|
|
7051
|
+
};
|
|
7052
|
+
/** 历史 */
|
|
7053
|
+
history: {
|
|
7054
|
+
header: {
|
|
7055
|
+
background: string;
|
|
7056
|
+
boxShadow: string;
|
|
7057
|
+
title: {
|
|
7058
|
+
color: string;
|
|
7059
|
+
};
|
|
7060
|
+
description: {
|
|
7061
|
+
color: string;
|
|
7062
|
+
};
|
|
7063
|
+
/** 退出按钮 */
|
|
7064
|
+
quitButton: {
|
|
7065
|
+
icon: IconConfig;
|
|
7066
|
+
};
|
|
7067
|
+
};
|
|
7068
|
+
/** 侧边栏 */
|
|
7069
|
+
sidePanel: {
|
|
7070
|
+
/** 背景 */
|
|
7071
|
+
background: string;
|
|
7072
|
+
};
|
|
7073
|
+
};
|
|
7074
|
+
/** 打印 */
|
|
7075
|
+
print: {
|
|
7076
|
+
/** 头部 */
|
|
7077
|
+
header: {
|
|
7078
|
+
background: string;
|
|
7079
|
+
boxShadow: string;
|
|
7080
|
+
title: {
|
|
7081
|
+
color: string;
|
|
7082
|
+
};
|
|
7083
|
+
description: {
|
|
7084
|
+
color: string;
|
|
7085
|
+
};
|
|
7086
|
+
};
|
|
7087
|
+
/** 侧边栏 */
|
|
7088
|
+
sidePanel: {
|
|
7089
|
+
background: string;
|
|
7090
|
+
};
|
|
7091
|
+
content: {
|
|
7092
|
+
background: string;
|
|
7093
|
+
};
|
|
7094
|
+
};
|
|
6432
7095
|
}
|
|
6433
7096
|
|
|
6434
7097
|
/**
|
|
@@ -6777,6 +7440,18 @@ export declare interface SheetCellData extends SheetCellMeta {
|
|
|
6777
7440
|
value: SheetCellValue | null;
|
|
6778
7441
|
}
|
|
6779
7442
|
|
|
7443
|
+
export declare interface SheetCellHistoryLimitations {
|
|
7444
|
+
/**
|
|
7445
|
+
* 获取单元格历史保留天数
|
|
7446
|
+
* @returns
|
|
7447
|
+
*/
|
|
7448
|
+
getMaxRetentionDays?: () => number | undefined;
|
|
7449
|
+
}
|
|
7450
|
+
|
|
7451
|
+
export declare interface SheetCellHistoryOptions extends EditorFeatureConfig {
|
|
7452
|
+
limitations?: SheetCellHistoryLimitations;
|
|
7453
|
+
}
|
|
7454
|
+
|
|
6780
7455
|
export declare interface SheetCellMeta {
|
|
6781
7456
|
/**
|
|
6782
7457
|
* 单元格格式
|
|
@@ -6967,6 +7642,7 @@ export declare interface SheetFormOptions extends EditorFeatureConfig {
|
|
|
6967
7642
|
}) => Promise<{
|
|
6968
7643
|
guid: string;
|
|
6969
7644
|
id: number;
|
|
7645
|
+
fullUrl?: string;
|
|
6970
7646
|
}>;
|
|
6971
7647
|
/**
|
|
6972
7648
|
* 获取表单文件的父级文件
|
|
@@ -6999,27 +7675,6 @@ export declare interface SheetFormulaOptions {
|
|
|
6999
7675
|
};
|
|
7000
7676
|
}
|
|
7001
7677
|
|
|
7002
|
-
export declare interface SheetHistoryLimitations {
|
|
7003
|
-
maxDays: number;
|
|
7004
|
-
}
|
|
7005
|
-
|
|
7006
|
-
export declare interface SheetHistoryOptions extends EditorHistoryOptions {
|
|
7007
|
-
sidebar?: {
|
|
7008
|
-
/**
|
|
7009
|
-
* 检查侧边栏历史是否有卡点限制,如有,返回具体的限制;如没有,返回 null
|
|
7010
|
-
* @returns
|
|
7011
|
-
*/
|
|
7012
|
-
checkLimitations: () => Promise<SheetHistoryLimitations | null>;
|
|
7013
|
-
};
|
|
7014
|
-
cell?: {
|
|
7015
|
-
/**
|
|
7016
|
-
* 检查单元格历史是否有卡点限制,如有,返回具体的限制;如没有,返回 null
|
|
7017
|
-
* @returns
|
|
7018
|
-
*/
|
|
7019
|
-
checkLimitations: () => Promise<SheetHistoryLimitations | null>;
|
|
7020
|
-
};
|
|
7021
|
-
}
|
|
7022
|
-
|
|
7023
7678
|
export declare interface SheetImportOptions extends EditorImportOptions {
|
|
7024
7679
|
/**
|
|
7025
7680
|
* 获取图片导入状态
|
|
@@ -7309,6 +7964,10 @@ export declare interface SheetRenderOptions extends EditorRenderOptions {
|
|
|
7309
7964
|
* 不自动聚焦需要用鼠标单击选中单元格后才能使用键盘编辑
|
|
7310
7965
|
*/
|
|
7311
7966
|
disableAutoFocus?: boolean;
|
|
7967
|
+
/**
|
|
7968
|
+
* 视图区域相关配置
|
|
7969
|
+
*/
|
|
7970
|
+
viewport?: SheetViewportOptions;
|
|
7312
7971
|
}
|
|
7313
7972
|
|
|
7314
7973
|
export declare interface SheetSDKOptions extends EditorOptions {
|
|
@@ -7419,9 +8078,9 @@ export declare interface SheetSDKOptions extends EditorOptions {
|
|
|
7419
8078
|
*/
|
|
7420
8079
|
paste?: SheetPasteOptions;
|
|
7421
8080
|
/**
|
|
7422
|
-
*
|
|
8081
|
+
* 单元格历史相关设置
|
|
7423
8082
|
*/
|
|
7424
|
-
|
|
8083
|
+
cellHistory?: SheetCellHistoryOptions;
|
|
7425
8084
|
}
|
|
7426
8085
|
|
|
7427
8086
|
/**
|
|
@@ -7460,6 +8119,15 @@ export declare interface SheetTabOptions extends EditorFeatureConfig {
|
|
|
7460
8119
|
* 是否显示演示按钮
|
|
7461
8120
|
*/
|
|
7462
8121
|
showPresentationButton?: boolean;
|
|
8122
|
+
/**
|
|
8123
|
+
* 样式
|
|
8124
|
+
*/
|
|
8125
|
+
style?: {
|
|
8126
|
+
/**
|
|
8127
|
+
* 背景颜色
|
|
8128
|
+
*/
|
|
8129
|
+
backgroundColor?: string;
|
|
8130
|
+
};
|
|
7463
8131
|
}
|
|
7464
8132
|
|
|
7465
8133
|
/**
|
|
@@ -7539,6 +8207,37 @@ export declare interface SheetUiOptions extends EditorUiOptions {
|
|
|
7539
8207
|
};
|
|
7540
8208
|
}
|
|
7541
8209
|
|
|
8210
|
+
export declare interface SheetViewportHeaderOptions {
|
|
8211
|
+
/**
|
|
8212
|
+
* 样式
|
|
8213
|
+
*/
|
|
8214
|
+
style?: {
|
|
8215
|
+
/**
|
|
8216
|
+
* 背景颜色
|
|
8217
|
+
*/
|
|
8218
|
+
backgroundColorNormal?: string;
|
|
8219
|
+
/**
|
|
8220
|
+
* 悬停背景颜色
|
|
8221
|
+
*/
|
|
8222
|
+
backgroundColorHover?: string;
|
|
8223
|
+
/**
|
|
8224
|
+
* 激活背景颜色
|
|
8225
|
+
*/
|
|
8226
|
+
backgroundColorActive?: string;
|
|
8227
|
+
};
|
|
8228
|
+
}
|
|
8229
|
+
|
|
8230
|
+
export declare interface SheetViewportOptions {
|
|
8231
|
+
/**
|
|
8232
|
+
* 行头相关配置
|
|
8233
|
+
*/
|
|
8234
|
+
rowHeader?: SheetViewportHeaderOptions;
|
|
8235
|
+
/**
|
|
8236
|
+
* 列头相关配置
|
|
8237
|
+
*/
|
|
8238
|
+
columnHeader?: SheetViewportHeaderOptions;
|
|
8239
|
+
}
|
|
8240
|
+
|
|
7542
8241
|
/**
|
|
7543
8242
|
* 工作表集合对象
|
|
7544
8243
|
*/
|
|
@@ -7777,6 +8476,7 @@ export declare interface SliderSizeStyles {
|
|
|
7777
8476
|
thumbSize: string;
|
|
7778
8477
|
/** 滑块偏移(距离边缘的间距) */
|
|
7779
8478
|
thumbOffset: string;
|
|
8479
|
+
borderWidth: string;
|
|
7780
8480
|
}
|
|
7781
8481
|
|
|
7782
8482
|
/** Slider 滑块(圆点)样式 */
|
|
@@ -7791,6 +8491,8 @@ export declare interface SliderTrackStyles {
|
|
|
7791
8491
|
backgroundDisabled: string;
|
|
7792
8492
|
/** 已填充部分背景 */
|
|
7793
8493
|
filledBackground: string;
|
|
8494
|
+
/** 已填充部分禁用状态背景 */
|
|
8495
|
+
filledBackgroundDisabled: string;
|
|
7794
8496
|
/** 高度 */
|
|
7795
8497
|
height: string;
|
|
7796
8498
|
/** 宽度 */
|
|
@@ -7812,6 +8514,22 @@ export declare interface Speaker {
|
|
|
7812
8514
|
avatar: string;
|
|
7813
8515
|
}
|
|
7814
8516
|
|
|
8517
|
+
/** 通用状态样式 */
|
|
8518
|
+
export declare interface StateStyles {
|
|
8519
|
+
/** 默认颜色 */
|
|
8520
|
+
normal: string;
|
|
8521
|
+
/** 悬停文字颜色 */
|
|
8522
|
+
hover: string;
|
|
8523
|
+
/** 激活/聚焦文字颜色 */
|
|
8524
|
+
active: string;
|
|
8525
|
+
/** 禁用文字颜色 */
|
|
8526
|
+
disabled: string;
|
|
8527
|
+
/** 只读颜色 */
|
|
8528
|
+
readonly?: string;
|
|
8529
|
+
/** 错误颜色 */
|
|
8530
|
+
error?: string;
|
|
8531
|
+
}
|
|
8532
|
+
|
|
7815
8533
|
/**
|
|
7816
8534
|
* 表格编辑器状态枚举
|
|
7817
8535
|
* 定义了表格编辑器可能处于的各种状态
|
|
@@ -7949,7 +8667,18 @@ export declare interface SyncStatusDelegation {
|
|
|
7949
8667
|
/** Tab 完整配置 */
|
|
7950
8668
|
export declare interface TabConfig {
|
|
7951
8669
|
/** 线性标签页(仅下边框) */
|
|
7952
|
-
line:
|
|
8670
|
+
line: {
|
|
8671
|
+
backgroundColor: string;
|
|
8672
|
+
item: TabStateStyles & {
|
|
8673
|
+
/** 选中底部线条宽度/高度 */
|
|
8674
|
+
bottomActiveWidth: string;
|
|
8675
|
+
/** 选中底部线条圆角 */
|
|
8676
|
+
bottomActiveBorderRadius: string;
|
|
8677
|
+
/** 选中底部线条背景颜色 */
|
|
8678
|
+
bottomActiveBackgroundColor: string;
|
|
8679
|
+
};
|
|
8680
|
+
layout: TabLayoutStyles;
|
|
8681
|
+
};
|
|
7953
8682
|
/** 面性标签页(带所有边框) */
|
|
7954
8683
|
card: TabVariantStyles;
|
|
7955
8684
|
/** 大尺寸配置 */
|
|
@@ -8167,6 +8896,17 @@ export declare type TableFieldContextMenuFeatureButtonName =
|
|
|
8167
8896
|
|
|
8168
8897
|
export declare type TableFieldContextMenuOptions = EditorMenuOptions<TableFieldContextMenuFeatureButtonName>;
|
|
8169
8898
|
|
|
8899
|
+
/**
|
|
8900
|
+
* 字段数量限制配置
|
|
8901
|
+
*/
|
|
8902
|
+
export declare interface TableFieldLimitationOptions {
|
|
8903
|
+
/**
|
|
8904
|
+
* 获取单个数据表支持的最大字段数
|
|
8905
|
+
* @returns 最大字段数,undefined 表示使用内部默认值
|
|
8906
|
+
*/
|
|
8907
|
+
getMaxFieldCount?: () => number | undefined;
|
|
8908
|
+
}
|
|
8909
|
+
|
|
8170
8910
|
/**
|
|
8171
8911
|
* 表格字段配置选项
|
|
8172
8912
|
*/
|
|
@@ -8284,6 +9024,10 @@ export declare interface TableFieldOptions {
|
|
|
8284
9024
|
*/
|
|
8285
9025
|
disabled?: boolean;
|
|
8286
9026
|
};
|
|
9027
|
+
/**
|
|
9028
|
+
* 字段数量限制
|
|
9029
|
+
*/
|
|
9030
|
+
limitations?: TableFieldLimitationOptions;
|
|
8287
9031
|
}
|
|
8288
9032
|
|
|
8289
9033
|
export declare interface TableFormOptions {
|
|
@@ -8350,6 +9094,33 @@ export declare interface TableHistoryOptions extends EditorHistoryOptions {
|
|
|
8350
9094
|
* @default false
|
|
8351
9095
|
*/
|
|
8352
9096
|
disabled?: boolean;
|
|
9097
|
+
/**
|
|
9098
|
+
* 单元格历史记录卡点限制
|
|
9099
|
+
*/
|
|
9100
|
+
limitations?: {
|
|
9101
|
+
/**
|
|
9102
|
+
* 获取单元格历史可查看的最大天数
|
|
9103
|
+
* 返回 0 表示不限制;返回 undefined 表示使用内部默认值
|
|
9104
|
+
* @returns 最大天数
|
|
9105
|
+
*/
|
|
9106
|
+
getMaxCellHistoryDays?: () => number | undefined;
|
|
9107
|
+
};
|
|
9108
|
+
};
|
|
9109
|
+
/**
|
|
9110
|
+
* 行历史记录配置
|
|
9111
|
+
*/
|
|
9112
|
+
rowHistory?: {
|
|
9113
|
+
/**
|
|
9114
|
+
* 行历史记录卡点限制
|
|
9115
|
+
*/
|
|
9116
|
+
limitations?: {
|
|
9117
|
+
/**
|
|
9118
|
+
* 获取行动态历史可查看的最大天数
|
|
9119
|
+
* 返回 0 表示不限制;返回 undefined 表示使用内部默认值
|
|
9120
|
+
* @returns 最大天数
|
|
9121
|
+
*/
|
|
9122
|
+
getMaxRowHistoryDays?: () => number | undefined;
|
|
9123
|
+
};
|
|
8353
9124
|
};
|
|
8354
9125
|
}
|
|
8355
9126
|
|
|
@@ -8503,6 +9274,27 @@ export declare interface TablePasteOptions extends EditorPasteOptions {
|
|
|
8503
9274
|
limitations?: TablePasteLimitationOptions;
|
|
8504
9275
|
}
|
|
8505
9276
|
|
|
9277
|
+
/**
|
|
9278
|
+
* 记录数量限制配置
|
|
9279
|
+
*/
|
|
9280
|
+
export declare interface TableRecordLimitationOptions {
|
|
9281
|
+
/**
|
|
9282
|
+
* 获取单个数据表支持的最大行数
|
|
9283
|
+
* @returns 最大行数,undefined 表示使用内部默认值
|
|
9284
|
+
*/
|
|
9285
|
+
getMaxRowCount?: () => number | undefined;
|
|
9286
|
+
}
|
|
9287
|
+
|
|
9288
|
+
/**
|
|
9289
|
+
* 记录/行配置选项
|
|
9290
|
+
*/
|
|
9291
|
+
export declare interface TableRecordOptions {
|
|
9292
|
+
/**
|
|
9293
|
+
* 记录数量限制
|
|
9294
|
+
*/
|
|
9295
|
+
limitations?: TableRecordLimitationOptions;
|
|
9296
|
+
}
|
|
9297
|
+
|
|
8506
9298
|
export declare interface TableRenderOptions {
|
|
8507
9299
|
/** 当前 table Guid */
|
|
8508
9300
|
table?: string;
|
|
@@ -8639,6 +9431,10 @@ export declare interface TableSDKOptions extends TableEditorOptions {
|
|
|
8639
9431
|
* 初始化页面渲染的时候需要的配置
|
|
8640
9432
|
*/
|
|
8641
9433
|
render?: TableRenderOptions;
|
|
9434
|
+
/**
|
|
9435
|
+
* 记录/行配置
|
|
9436
|
+
*/
|
|
9437
|
+
record?: TableRecordOptions;
|
|
8642
9438
|
}
|
|
8643
9439
|
|
|
8644
9440
|
export declare interface TableSelection {
|
|
@@ -8781,6 +9577,17 @@ export declare interface TableShortcutsOptions extends EditorShortcutOptions {
|
|
|
8781
9577
|
disabledShortcuts?: TableShortcutsFeatureType[];
|
|
8782
9578
|
}
|
|
8783
9579
|
|
|
9580
|
+
/**
|
|
9581
|
+
* 版本数量限制配置
|
|
9582
|
+
*/
|
|
9583
|
+
export declare interface TableSnapshotLimitationOptions {
|
|
9584
|
+
/**
|
|
9585
|
+
* 获取单个数据表支持的最大手动保存版本数量
|
|
9586
|
+
* @returns 最大版本数量,undefined 表示使用内部默认值
|
|
9587
|
+
*/
|
|
9588
|
+
getMaxSnapshot?: () => number | undefined;
|
|
9589
|
+
}
|
|
9590
|
+
|
|
8784
9591
|
/**
|
|
8785
9592
|
* 表格快照配置
|
|
8786
9593
|
* 应用表格在预览指定版本时会显示 Header 用于显示创建时间等信息,预览模式时需要隐藏
|
|
@@ -8794,6 +9601,10 @@ export declare interface TableSnapshotOptions {
|
|
|
8794
9601
|
* 是否禁用快照头部
|
|
8795
9602
|
*/
|
|
8796
9603
|
disableSnapshotHeader?: boolean;
|
|
9604
|
+
/**
|
|
9605
|
+
* 版本数量限制
|
|
9606
|
+
*/
|
|
9607
|
+
limitations?: TableSnapshotLimitationOptions;
|
|
8797
9608
|
}
|
|
8798
9609
|
|
|
8799
9610
|
/**
|
|
@@ -9207,6 +10018,32 @@ export declare type TableViewContextMenuFeatureButtonName = GridMenuItemName | K
|
|
|
9207
10018
|
|
|
9208
10019
|
export declare type TableViewContextMenuOptions = EditorMenuOptions<TableViewContextMenuFeatureButtonName>;
|
|
9209
10020
|
|
|
10021
|
+
/**
|
|
10022
|
+
* 视图数量限制配置
|
|
10023
|
+
*/
|
|
10024
|
+
export declare interface TableViewLimitationOptions {
|
|
10025
|
+
/**
|
|
10026
|
+
* 获取单个数据表支持的最大锁定视图数量
|
|
10027
|
+
* @returns 最大锁定视图数量,undefined 表示使用内部默认值
|
|
10028
|
+
*/
|
|
10029
|
+
getMaxLockedView?: () => number | undefined;
|
|
10030
|
+
/**
|
|
10031
|
+
* 获取单个数据表支持的最大个人视图数量
|
|
10032
|
+
* @returns 最大个人视图数量,undefined 表示使用内部默认值
|
|
10033
|
+
*/
|
|
10034
|
+
getMaxPersonalView?: () => number | undefined;
|
|
10035
|
+
/**
|
|
10036
|
+
* 获取单个数据表支持的最大甘特视图数量
|
|
10037
|
+
* @returns 最大甘特视图数量,undefined 表示使用内部默认值
|
|
10038
|
+
*/
|
|
10039
|
+
getMaxGanttView?: () => number | undefined;
|
|
10040
|
+
/**
|
|
10041
|
+
* 获取单个数据表支持的最大日历视图数量
|
|
10042
|
+
* @returns 最大日历视图数量,undefined 表示使用内部默认值
|
|
10043
|
+
*/
|
|
10044
|
+
getMaxCalendarView?: () => number | undefined;
|
|
10045
|
+
}
|
|
10046
|
+
|
|
9210
10047
|
/**
|
|
9211
10048
|
* 表格视图配置选项
|
|
9212
10049
|
*/
|
|
@@ -9306,6 +10143,10 @@ export declare interface TableViewOptions {
|
|
|
9306
10143
|
disableLayoutConfig?: boolean;
|
|
9307
10144
|
};
|
|
9308
10145
|
};
|
|
10146
|
+
/**
|
|
10147
|
+
* 视图数量限制
|
|
10148
|
+
*/
|
|
10149
|
+
limitations?: TableViewLimitationOptions;
|
|
9309
10150
|
}
|
|
9310
10151
|
|
|
9311
10152
|
export declare interface TableWindow {
|
|
@@ -9335,8 +10176,10 @@ export declare interface TabStateStyles extends BackgroundStateStyles, BorderSta
|
|
|
9335
10176
|
export declare interface TabVariantStyles {
|
|
9336
10177
|
/** Tab 项状态样式 */
|
|
9337
10178
|
item: TabStateStyles;
|
|
9338
|
-
/**
|
|
10179
|
+
/** 布局 */
|
|
9339
10180
|
layout: TabLayoutStyles;
|
|
10181
|
+
/** tab条背景颜色 */
|
|
10182
|
+
backgroundColor: string;
|
|
9340
10183
|
}
|
|
9341
10184
|
|
|
9342
10185
|
export declare interface TemplateProps {
|
|
@@ -9447,6 +10290,10 @@ export declare interface ToastConfig extends ToastBaseStyles {
|
|
|
9447
10290
|
error: ToastVariantStyles;
|
|
9448
10291
|
/** 警告提示样式 */
|
|
9449
10292
|
warn: ToastVariantStyles;
|
|
10293
|
+
/** 严重警告样式 */
|
|
10294
|
+
critical: ToastVariantStyles;
|
|
10295
|
+
/** 加载提示样式 */
|
|
10296
|
+
loading: ToastVariantStyles;
|
|
9450
10297
|
/** 偏移量 */
|
|
9451
10298
|
offset: {
|
|
9452
10299
|
/** 垂直偏移量 */
|
|
@@ -9454,6 +10301,10 @@ export declare interface ToastConfig extends ToastBaseStyles {
|
|
|
9454
10301
|
/** 水平偏移量 */
|
|
9455
10302
|
horizontal: string;
|
|
9456
10303
|
};
|
|
10304
|
+
/** 关闭按钮 */
|
|
10305
|
+
closeButton: {
|
|
10306
|
+
icon: Pick<IconConfig, 'url'>;
|
|
10307
|
+
};
|
|
9457
10308
|
}
|
|
9458
10309
|
|
|
9459
10310
|
/**
|
|
@@ -9525,6 +10376,11 @@ export declare interface ToastVariantStyles {
|
|
|
9525
10376
|
borderColor: string;
|
|
9526
10377
|
/** 图标配置 */
|
|
9527
10378
|
icon: IconConfig;
|
|
10379
|
+
/** 消息 */
|
|
10380
|
+
message: {
|
|
10381
|
+
/** 颜色 */
|
|
10382
|
+
color: string;
|
|
10383
|
+
};
|
|
9528
10384
|
}
|
|
9529
10385
|
|
|
9530
10386
|
/** ToolbarButton 背景状态样式 */
|
|
@@ -9570,6 +10426,8 @@ export declare interface ToolbarButtonLayout {
|
|
|
9570
10426
|
padding: string;
|
|
9571
10427
|
/** 整体高度 */
|
|
9572
10428
|
height: string;
|
|
10429
|
+
/** 整体圆角 */
|
|
10430
|
+
borderRadius: string;
|
|
9573
10431
|
/** 内容布局 */
|
|
9574
10432
|
content: {
|
|
9575
10433
|
padding: string;
|
|
@@ -9664,6 +10522,8 @@ export declare interface TooltipStyleConfig {
|
|
|
9664
10522
|
lineHeight: string;
|
|
9665
10523
|
/** 字重 */
|
|
9666
10524
|
fontWeight: number;
|
|
10525
|
+
/** 最大宽度 */
|
|
10526
|
+
maxWidth?: string;
|
|
9667
10527
|
}
|
|
9668
10528
|
|
|
9669
10529
|
/** Tooltip White 风格配置 */
|