@officesdk/editor-sdk-core 0.0.0-2 → 0.0.0-20
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/diagram/index.js +16 -1
- package/cjs/diagram/sdk.js +1 -1
- package/cjs/docs/index.js +21 -0
- package/cjs/docs/info.js +3 -0
- package/cjs/docs/range.js +7 -0
- package/cjs/docs/sdk.js +28 -0
- package/cjs/docs/selection.js +3 -0
- package/cjs/docx/context-menu.js +3 -0
- package/cjs/docx/index.js +16 -1
- package/cjs/docx/info.js +1 -1
- package/cjs/docx/menu.js +1 -1
- package/cjs/docx/sdk.js +1 -1
- package/cjs/docx/selection.js +1 -1
- package/cjs/docx/theme.js +1 -1
- package/cjs/docx/toolbar.js +3 -0
- package/cjs/docx/window.js +1 -1
- package/cjs/index.js +23 -14
- package/cjs/pdf/index.js +16 -1
- package/cjs/pdf/menu.js +1 -1
- package/cjs/pdf/selection.js +1 -1
- package/cjs/presentation/export.js +14 -0
- package/cjs/presentation/index.js +19 -2
- package/cjs/presentation/menu.js +1 -1
- package/cjs/presentation/sdk.js +1 -1
- package/cjs/presentation/toolbar.js +3 -0
- package/cjs/shared/attachment.js +3 -0
- package/cjs/shared/checkpoints.js +19 -0
- package/cjs/shared/collaboration.js +3 -0
- package/cjs/shared/collaborators.js +3 -0
- package/cjs/shared/comments.js +1 -1
- package/cjs/shared/content.js +1 -1
- package/cjs/shared/context-menu.js +3 -0
- package/cjs/shared/decryption.js +3 -0
- package/cjs/shared/download.js +3 -0
- package/cjs/shared/editor.js +1 -1
- package/cjs/shared/export.js +3 -0
- package/cjs/shared/feature.js +3 -0
- package/cjs/shared/file-picker.js +3 -0
- package/cjs/shared/file.js +50 -0
- package/cjs/shared/follow-mode.js +3 -0
- package/cjs/shared/history.js +3 -0
- package/cjs/shared/index.js +5 -2
- package/cjs/shared/link.js +1 -1
- package/cjs/shared/mention.js +3 -0
- package/cjs/shared/menu.js +1 -1
- package/cjs/shared/performance.js +3 -0
- package/cjs/shared/print.js +1 -1
- package/cjs/shared/render.js +3 -0
- package/cjs/shared/tool-box.js +40 -0
- package/cjs/shared/toolbar.js +1 -1
- package/cjs/shared/ui.js +18 -0
- package/cjs/shared/uploader.js +22 -0
- package/cjs/shared/user.js +1 -1
- package/cjs/shared/version.js +3 -0
- package/cjs/sheet/cell.js +29 -1
- package/cjs/sheet/chart.js +3 -0
- package/cjs/sheet/checklist.js +3 -0
- package/cjs/sheet/combine-sheets.js +3 -0
- package/cjs/sheet/comments.js +3 -0
- package/cjs/sheet/data-transfer.js +3 -0
- package/cjs/sheet/export.js +3 -0
- package/cjs/sheet/font.js +3 -0
- package/cjs/sheet/form.js +3 -0
- package/cjs/sheet/import-formula.js +3 -0
- package/cjs/sheet/index.js +19 -2
- package/cjs/sheet/lock.js +14 -0
- package/cjs/sheet/mention.js +13 -0
- package/cjs/sheet/menu.js +1 -1
- package/cjs/sheet/range.js +1 -1
- package/cjs/sheet/render.js +3 -0
- package/cjs/sheet/sdk.js +1 -1
- package/cjs/sheet/sensitization.js +3 -0
- package/cjs/sheet/sheet2table.js +3 -0
- package/cjs/sheet/toolbar.js +3 -0
- package/cjs/sheet/worksheet.js +1 -1
- package/cjs/table/content.js +3 -0
- package/cjs/table/index.js +23 -0
- package/cjs/table/resource.js +3 -0
- package/cjs/table/sdk.js +11 -0
- package/cjs/table/selection.js +21 -0
- package/cjs/table/table.js +3 -0
- package/esm/diagram/index.js +2 -1
- package/esm/diagram/sdk.js +1 -1
- package/esm/docs/index.js +3 -0
- package/esm/docs/info.js +2 -0
- package/esm/docs/range.js +6 -0
- package/esm/docs/sdk.js +25 -0
- package/esm/docs/selection.js +2 -0
- package/esm/docx/context-menu.js +2 -0
- package/esm/docx/index.js +2 -1
- package/esm/docx/info.js +1 -1
- package/esm/docx/menu.js +1 -1
- package/esm/docx/sdk.js +1 -1
- package/esm/docx/selection.js +1 -1
- package/esm/docx/theme.js +1 -1
- package/esm/docx/toolbar.js +2 -0
- package/esm/docx/window.js +1 -1
- package/esm/index.js +9 -7
- package/esm/pdf/index.js +2 -1
- package/esm/pdf/menu.js +1 -1
- package/esm/pdf/selection.js +1 -1
- package/esm/presentation/export.js +11 -0
- package/esm/presentation/index.js +3 -1
- package/esm/presentation/menu.js +1 -1
- package/esm/presentation/sdk.js +1 -1
- package/esm/presentation/toolbar.js +2 -0
- package/esm/shared/attachment.js +2 -0
- package/esm/shared/checkpoints.js +16 -0
- package/esm/shared/collaboration.js +2 -0
- package/esm/shared/collaborators.js +2 -0
- package/esm/shared/comments.js +1 -1
- package/esm/shared/content.js +1 -1
- package/esm/shared/context-menu.js +2 -0
- package/esm/shared/decryption.js +2 -0
- package/esm/shared/download.js +2 -0
- package/esm/shared/editor.js +1 -1
- package/esm/shared/export.js +2 -0
- package/esm/shared/feature.js +2 -0
- package/esm/shared/file-picker.js +2 -0
- package/esm/shared/file.js +47 -0
- package/esm/shared/follow-mode.js +2 -0
- package/esm/shared/history.js +2 -0
- package/esm/shared/index.js +2 -1
- package/esm/shared/link.js +1 -1
- package/esm/shared/mention.js +2 -0
- package/esm/shared/menu.js +1 -1
- package/esm/shared/performance.js +2 -0
- package/esm/shared/print.js +1 -1
- package/esm/shared/render.js +2 -0
- package/esm/shared/tool-box.js +37 -0
- package/esm/shared/toolbar.js +1 -1
- package/esm/shared/ui.js +15 -0
- package/esm/shared/uploader.js +19 -0
- package/esm/shared/user.js +1 -1
- package/esm/shared/version.js +2 -0
- package/esm/sheet/cell.js +28 -2
- package/esm/sheet/chart.js +2 -0
- package/esm/sheet/checklist.js +2 -0
- package/esm/sheet/combine-sheets.js +2 -0
- package/esm/sheet/comments.js +2 -0
- package/esm/sheet/data-transfer.js +2 -0
- package/esm/sheet/export.js +2 -0
- package/esm/sheet/font.js +2 -0
- package/esm/sheet/form.js +2 -0
- package/esm/sheet/import-formula.js +2 -0
- package/esm/sheet/index.js +3 -1
- package/esm/sheet/lock.js +11 -0
- package/esm/sheet/mention.js +10 -0
- package/esm/sheet/menu.js +1 -1
- package/esm/sheet/range.js +1 -1
- package/esm/sheet/render.js +2 -0
- package/esm/sheet/sdk.js +1 -1
- package/esm/sheet/sensitization.js +2 -0
- package/esm/sheet/sheet2table.js +2 -0
- package/esm/sheet/toolbar.js +2 -0
- package/esm/sheet/worksheet.js +1 -1
- package/esm/table/content.js +2 -0
- package/esm/table/index.js +4 -0
- package/esm/table/resource.js +2 -0
- package/esm/table/sdk.js +8 -0
- package/esm/table/selection.js +18 -0
- package/esm/table/table.js +2 -0
- package/package.json +75 -7
- package/types/combine.d.ts +5159 -0
- package/types/diagram.d.ts +2126 -0
- package/types/docs.d.ts +2253 -0
- package/{docx.d.ts → types/docx.d.ts} +1536 -311
- package/types/pdf.d.ts +2335 -0
- package/types/presentation.d.ts +2394 -0
- package/types/shared.d.ts +2061 -0
- package/types/sheet.d.ts +2885 -0
- package/types/table.d.ts +2381 -0
- package/diagram.d.ts +0 -358
- package/pdf.d.ts +0 -755
- package/presentation.d.ts +0 -1281
- package/shared.d.ts +0 -1066
- package/sheet.d.ts +0 -1370
package/presentation.d.ts
DELETED
|
@@ -1,1281 +0,0 @@
|
|
|
1
|
-
export declare abstract class AbstractedPresentationSDK extends EditorSDK {
|
|
2
|
-
/**
|
|
3
|
-
* 打印幻灯片
|
|
4
|
-
*/
|
|
5
|
-
abstract print(): Promise<void>;
|
|
6
|
-
/**
|
|
7
|
-
* 幻灯片集合接口
|
|
8
|
-
*/
|
|
9
|
-
abstract get slides(): PresentationSlides;
|
|
10
|
-
/**
|
|
11
|
-
* 幻灯片选区接口,用于获取、操作当前 slide 的选区
|
|
12
|
-
*/
|
|
13
|
-
abstract get selection(): PresentationSelection;
|
|
14
|
-
/**
|
|
15
|
-
* 幻灯片缩放接口
|
|
16
|
-
* @param scale
|
|
17
|
-
*/
|
|
18
|
-
abstract get zoom(): PresentationZoom;
|
|
19
|
-
/**
|
|
20
|
-
* 文本格式接口
|
|
21
|
-
*/
|
|
22
|
-
abstract get text(): PresentationText;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* 编辑器内部资源请求配置
|
|
27
|
-
*/
|
|
28
|
-
declare interface EditorAssetsOptions {
|
|
29
|
-
/**
|
|
30
|
-
* 通用资源请求代理配置,
|
|
31
|
-
* 用于套件内部资源请求时代理请求
|
|
32
|
-
*/
|
|
33
|
-
proxy: HTTPProxy;
|
|
34
|
-
/**
|
|
35
|
-
* 资源文件 URL 转换和解析
|
|
36
|
-
*/
|
|
37
|
-
resolver: EditorAssetsResolver;
|
|
38
|
-
/**
|
|
39
|
-
* 图片处理器
|
|
40
|
-
*/
|
|
41
|
-
imageProcessing: EditorAssetsOssImageProcessing;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
* 基于对象存储的图片处理抽象
|
|
46
|
-
*/
|
|
47
|
-
declare interface EditorAssetsOssImageProcessing {
|
|
48
|
-
/**
|
|
49
|
-
* 压缩图片的方法
|
|
50
|
-
* @param imageUrl 图片的 URL
|
|
51
|
-
* @param compressOptions 压缩配置,例如质量、最大宽度和最大高度
|
|
52
|
-
* @returns 压缩后的图片 URL
|
|
53
|
-
*/
|
|
54
|
-
compress: (imageUrl: string, compressOptions?: {
|
|
55
|
-
quality?: number;
|
|
56
|
-
maxWidth?: number;
|
|
57
|
-
maxHeight?: number;
|
|
58
|
-
}) => Promise<string>;
|
|
59
|
-
/**
|
|
60
|
-
* 裁切图片的方法
|
|
61
|
-
* @param imageUrl 图片的 URL
|
|
62
|
-
* @param cropOptions 裁切配置,例如宽度、高度和起始点
|
|
63
|
-
* @returns 裁切后的图片 URL
|
|
64
|
-
*/
|
|
65
|
-
crop: (imageUrl: string, cropOptions: {
|
|
66
|
-
x?: number;
|
|
67
|
-
y?: number;
|
|
68
|
-
w: number;
|
|
69
|
-
h: number;
|
|
70
|
-
g?: EditorImageCropPoint;
|
|
71
|
-
}) => Promise<string>;
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
declare interface EditorAssetsResolver {
|
|
75
|
-
/**
|
|
76
|
-
* 将资源文件 ID 转换为 URL 的方法
|
|
77
|
-
* @param assetId 资源文件 ID
|
|
78
|
-
* @returns 转换后的资源 URL ,如果无法转换则返回 null
|
|
79
|
-
*/
|
|
80
|
-
resolveUrl: (assetId: string) => Promise<string | null>;
|
|
81
|
-
/**
|
|
82
|
-
* 从 URL 中解析资源文件 ID 的方法
|
|
83
|
-
* @param url 资源 URL
|
|
84
|
-
* @returns 解析出的资源文件 ID
|
|
85
|
-
*/
|
|
86
|
-
parseId: (url: string) => Promise<string | null>;
|
|
87
|
-
/**
|
|
88
|
-
* 检查资源文件 ID 对应的文件是否准备就绪,
|
|
89
|
-
* 在部分环境中,资源文件需要异步导入,在编辑器加载的时候可能还未准备就绪
|
|
90
|
-
* @param assetId 资源文件 ID
|
|
91
|
-
* @returns
|
|
92
|
-
*/
|
|
93
|
-
checkAssetReady: (assetId: string) => Promise<boolean> | boolean;
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
/**
|
|
97
|
-
* 品牌相关设置,
|
|
98
|
-
* 用于在套件中展示品牌外露信息
|
|
99
|
-
*/
|
|
100
|
-
declare interface EditorBrandOptions {
|
|
101
|
-
/**
|
|
102
|
-
* 需要显示在品牌展示位的内容,按数组顺序显示
|
|
103
|
-
*/
|
|
104
|
-
content: Array<{
|
|
105
|
-
type: 'image';
|
|
106
|
-
src: string;
|
|
107
|
-
} | {
|
|
108
|
-
type: 'text';
|
|
109
|
-
content: string;
|
|
110
|
-
color?: string;
|
|
111
|
-
}>;
|
|
112
|
-
/**
|
|
113
|
-
* 品牌展示位的布局信息
|
|
114
|
-
*/
|
|
115
|
-
layout: {
|
|
116
|
-
width: string;
|
|
117
|
-
height: string;
|
|
118
|
-
};
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
/**
|
|
122
|
-
* 单条评论数据
|
|
123
|
-
*/
|
|
124
|
-
declare interface EditorCommentItem {
|
|
125
|
-
/**
|
|
126
|
-
* 评论 ID
|
|
127
|
-
*/
|
|
128
|
-
id: string;
|
|
129
|
-
/**
|
|
130
|
-
* 评论用户信息
|
|
131
|
-
*/
|
|
132
|
-
user: {
|
|
133
|
-
id: string;
|
|
134
|
-
name: string;
|
|
135
|
-
};
|
|
136
|
-
content: {
|
|
137
|
-
text: string;
|
|
138
|
-
};
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
declare interface EditorComments {
|
|
142
|
-
/**
|
|
143
|
-
* 检查是否有评论
|
|
144
|
-
* @returns
|
|
145
|
-
*/
|
|
146
|
-
hasAny: () => Promise<boolean>;
|
|
147
|
-
/**
|
|
148
|
-
* 获取评论列表
|
|
149
|
-
* @returns
|
|
150
|
-
*/
|
|
151
|
-
getAll: () => Promise<EditorCommentItem[]>;
|
|
152
|
-
/**
|
|
153
|
-
* 获取单个评论
|
|
154
|
-
* @param commentId
|
|
155
|
-
* @returns
|
|
156
|
-
*/
|
|
157
|
-
getOne: (commentId: string) => Promise<EditorCommentItem | null>;
|
|
158
|
-
/**
|
|
159
|
-
* 添加内容
|
|
160
|
-
* @param options
|
|
161
|
-
* @returns
|
|
162
|
-
*/
|
|
163
|
-
add: (options: {
|
|
164
|
-
/**
|
|
165
|
-
* 评论内容
|
|
166
|
-
*/
|
|
167
|
-
text: string;
|
|
168
|
-
/**
|
|
169
|
-
* 默认评论是添加到当前选区上,也可以指定一个区域
|
|
170
|
-
*/
|
|
171
|
-
range?: string;
|
|
172
|
-
}) => Promise<string | null>;
|
|
173
|
-
/**
|
|
174
|
-
* 删除所有评论
|
|
175
|
-
* @returns
|
|
176
|
-
*/
|
|
177
|
-
deleteAll: () => Promise<boolean>;
|
|
178
|
-
/**
|
|
179
|
-
* 删除单条评论
|
|
180
|
-
*/
|
|
181
|
-
deleteOne: (commentId: string) => Promise<boolean>;
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* 编辑器评论初始化配置
|
|
186
|
-
*/
|
|
187
|
-
declare interface EditorCommentsOptions {
|
|
188
|
-
/**
|
|
189
|
-
* 评论作者信息,如果这里的信息为空,将会使用 user 信息
|
|
190
|
-
*/
|
|
191
|
-
author?: {
|
|
192
|
-
/**
|
|
193
|
-
* 评论作者 ID
|
|
194
|
-
*/
|
|
195
|
-
id: string;
|
|
196
|
-
/**
|
|
197
|
-
* 评论作者信息
|
|
198
|
-
*/
|
|
199
|
-
name: string;
|
|
200
|
-
/**
|
|
201
|
-
* 评论作者头像
|
|
202
|
-
*/
|
|
203
|
-
avatar?: string;
|
|
204
|
-
};
|
|
205
|
-
/**
|
|
206
|
-
* 显示的视图配置
|
|
207
|
-
*/
|
|
208
|
-
view?: {
|
|
209
|
-
/**
|
|
210
|
-
* 评论显示模式,
|
|
211
|
-
* none: 不显示评论,默认值。
|
|
212
|
-
* card: 评论以卡片形式显示。
|
|
213
|
-
*/
|
|
214
|
-
mode: 'none' | 'card';
|
|
215
|
-
};
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
declare interface EditorContent {
|
|
219
|
-
/**
|
|
220
|
-
* 设置编辑器内容
|
|
221
|
-
* @param content
|
|
222
|
-
*/
|
|
223
|
-
setContent: (content: string | ArrayBuffer) => Promise<void>;
|
|
224
|
-
/**
|
|
225
|
-
* 获取编辑器内容
|
|
226
|
-
*/
|
|
227
|
-
getContent: () => Promise<EditorDelta>;
|
|
228
|
-
/**
|
|
229
|
-
* 添加监听,当内容发生变化时触发监听,传入 Delta
|
|
230
|
-
* @param listener
|
|
231
|
-
*/
|
|
232
|
-
addChangeListener: (listener: (change: EditorDelta) => void) => () => void;
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
declare interface EditorDelta {
|
|
236
|
-
compose: (other: EditorDelta, isDocument?: boolean) => EditorDelta;
|
|
237
|
-
transform: (other: EditorDelta, priority?: boolean) => EditorDelta;
|
|
238
|
-
stringify: () => string;
|
|
239
|
-
length: number;
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
/**
|
|
243
|
-
* 编辑器嵌入对象
|
|
244
|
-
*/
|
|
245
|
-
declare interface EditorEmbeddedObject {
|
|
246
|
-
/**
|
|
247
|
-
* 嵌入的对象 url
|
|
248
|
-
*/
|
|
249
|
-
url: string;
|
|
250
|
-
/**
|
|
251
|
-
* 嵌入对象的类型描述
|
|
252
|
-
*/
|
|
253
|
-
type?: string;
|
|
254
|
-
/**
|
|
255
|
-
* 嵌入对象的名
|
|
256
|
-
*/
|
|
257
|
-
name?: string;
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
/**
|
|
261
|
-
* 编辑器嵌入对象抽象类
|
|
262
|
-
*/
|
|
263
|
-
declare interface EditorEmbeddedObjectOptions {
|
|
264
|
-
/**
|
|
265
|
-
* 执行打开嵌入对象操作,
|
|
266
|
-
* 如果已经处理了打开操作,返回 true,否则返回 false,
|
|
267
|
-
* 如果返回 false,编辑器会继续后续默认的打开操作。
|
|
268
|
-
* @param object
|
|
269
|
-
* @returns
|
|
270
|
-
*/
|
|
271
|
-
open: (object: EditorEmbeddedObject) => Promise<boolean>;
|
|
272
|
-
/**
|
|
273
|
-
* 嵌入对象的页面功能
|
|
274
|
-
*/
|
|
275
|
-
ui?: {
|
|
276
|
-
/**
|
|
277
|
-
* 预览功能
|
|
278
|
-
*/
|
|
279
|
-
preview?: {
|
|
280
|
-
disabled?: boolean;
|
|
281
|
-
};
|
|
282
|
-
/**
|
|
283
|
-
* 下载功能
|
|
284
|
-
*/
|
|
285
|
-
download?: {
|
|
286
|
-
disabled?: boolean;
|
|
287
|
-
};
|
|
288
|
-
};
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
declare interface EditorFontFace {
|
|
292
|
-
/**
|
|
293
|
-
* 字体的名称,用于在用户界面上显示的名称
|
|
294
|
-
*/
|
|
295
|
-
name: string;
|
|
296
|
-
/**
|
|
297
|
-
* 字体族
|
|
298
|
-
*/
|
|
299
|
-
family: string;
|
|
300
|
-
/**
|
|
301
|
-
* 用于加载字体的 URL
|
|
302
|
-
*/
|
|
303
|
-
url?: string;
|
|
304
|
-
/**
|
|
305
|
-
* 是否为受版权保护的字体,如果是在用户界面上会有所标识。
|
|
306
|
-
*/
|
|
307
|
-
isCopyrightProtected: boolean;
|
|
308
|
-
/**
|
|
309
|
-
* 字体元数据
|
|
310
|
-
*/
|
|
311
|
-
meta: EditorFontMeta;
|
|
312
|
-
}
|
|
313
|
-
|
|
314
|
-
/**
|
|
315
|
-
* 字体元数据
|
|
316
|
-
*/
|
|
317
|
-
declare interface EditorFontMeta {
|
|
318
|
-
head: {
|
|
319
|
-
unitsPerEm: number;
|
|
320
|
-
};
|
|
321
|
-
hhea: {
|
|
322
|
-
ascender: number;
|
|
323
|
-
descender: number;
|
|
324
|
-
lineGap: number;
|
|
325
|
-
};
|
|
326
|
-
vhea?: {
|
|
327
|
-
ascender: number;
|
|
328
|
-
descender: number;
|
|
329
|
-
lineGap: number;
|
|
330
|
-
};
|
|
331
|
-
os2: {
|
|
332
|
-
usWeightClass?: number;
|
|
333
|
-
usWidthClass?: number;
|
|
334
|
-
italic?: boolean;
|
|
335
|
-
isSymbol?: boolean;
|
|
336
|
-
ulCodePageRange: [number, number];
|
|
337
|
-
};
|
|
338
|
-
/**
|
|
339
|
-
* opentype中没有强制要求必须有en条目,只能确定name下的value的类型是对象
|
|
340
|
-
*/
|
|
341
|
-
name: {
|
|
342
|
-
preferredFamily?: Record<string, string>;
|
|
343
|
-
preferredSubfamily?: Record<string, string>;
|
|
344
|
-
fontFamily?: Record<string, string>;
|
|
345
|
-
fontSubfamily?: Record<string, string>;
|
|
346
|
-
fullName?: Record<string, string>;
|
|
347
|
-
postScriptName?: Record<string, string>;
|
|
348
|
-
};
|
|
349
|
-
}
|
|
350
|
-
|
|
351
|
-
/**
|
|
352
|
-
* i18n 相关设置
|
|
353
|
-
*/
|
|
354
|
-
declare interface EditorI18nOptions {
|
|
355
|
-
/**
|
|
356
|
-
* 语言,默认使用浏览器当前环境中的语言
|
|
357
|
-
*/
|
|
358
|
-
language?: string;
|
|
359
|
-
/**
|
|
360
|
-
* 文本方向,默认根据语言自动适配
|
|
361
|
-
*/
|
|
362
|
-
direction?: 'ltr' | 'rtl';
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
|
|
366
|
-
|
|
367
|
-
/**
|
|
368
|
-
* 链接配置,抽象打开链接等操作
|
|
369
|
-
*/
|
|
370
|
-
declare interface EditorLinkOptions {
|
|
371
|
-
/**
|
|
372
|
-
* 打开链接,如果取消了打开链接操作,返回 false
|
|
373
|
-
* @param url
|
|
374
|
-
* @param target
|
|
375
|
-
* @returns
|
|
376
|
-
*/
|
|
377
|
-
open: (url: string, target: string) => Promise<boolean>;
|
|
378
|
-
}
|
|
379
|
-
|
|
380
|
-
/**
|
|
381
|
-
* 菜单栏自定义按钮配置
|
|
382
|
-
*/
|
|
383
|
-
declare type EditorMenuCustomButton = {
|
|
384
|
-
/**
|
|
385
|
-
* 按钮名称
|
|
386
|
-
*/
|
|
387
|
-
name: string;
|
|
388
|
-
/**
|
|
389
|
-
* 链接
|
|
390
|
-
*/
|
|
391
|
-
type: 'link';
|
|
392
|
-
/**
|
|
393
|
-
* 按钮文本
|
|
394
|
-
*/
|
|
395
|
-
text: string;
|
|
396
|
-
/**
|
|
397
|
-
* 链接地址
|
|
398
|
-
*/
|
|
399
|
-
url: string;
|
|
400
|
-
} | {
|
|
401
|
-
/**
|
|
402
|
-
* 按钮名称
|
|
403
|
-
*/
|
|
404
|
-
name: string;
|
|
405
|
-
/**
|
|
406
|
-
* 按钮,点击后触发 callback 回调
|
|
407
|
-
*/
|
|
408
|
-
type: 'button';
|
|
409
|
-
/**
|
|
410
|
-
* 按钮文本
|
|
411
|
-
*/
|
|
412
|
-
label: string;
|
|
413
|
-
/**
|
|
414
|
-
* 按钮图标,可以是 base64 的图片信息,也可以是图片 url
|
|
415
|
-
*/
|
|
416
|
-
icon?: string;
|
|
417
|
-
/**
|
|
418
|
-
* 按钮点击事件
|
|
419
|
-
*/
|
|
420
|
-
callback: () => void;
|
|
421
|
-
};
|
|
422
|
-
|
|
423
|
-
/**
|
|
424
|
-
* 菜单栏二级以下的菜单入口
|
|
425
|
-
*/
|
|
426
|
-
declare interface EditorMenuEntryButton {
|
|
427
|
-
type: 'entry';
|
|
428
|
-
/**
|
|
429
|
-
* 菜单名称
|
|
430
|
-
*/
|
|
431
|
-
name: string;
|
|
432
|
-
/**
|
|
433
|
-
* 菜单图标
|
|
434
|
-
*/
|
|
435
|
-
icon?: string;
|
|
436
|
-
}
|
|
437
|
-
|
|
438
|
-
/**
|
|
439
|
-
* 菜单栏一级菜单配置,此处用于定义一级菜单的操作入口,
|
|
440
|
-
* 一级菜单在鼠标悬停时展示二级列表
|
|
441
|
-
*/
|
|
442
|
-
declare interface EditorMenuEntryConfig<TName extends string> {
|
|
443
|
-
/**
|
|
444
|
-
* 一级菜单名称
|
|
445
|
-
*/
|
|
446
|
-
name: string;
|
|
447
|
-
/**
|
|
448
|
-
* 二级菜单定义,定一个二维数组,用于定义二级菜单的结构,
|
|
449
|
-
* 将第一层数组中的所有按钮放到一个区域内用分隔符隔开,
|
|
450
|
-
* 第二层数组为按钮的定义,可以是功能按钮也可以是一个下拉入口。
|
|
451
|
-
*/
|
|
452
|
-
children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton>[];
|
|
453
|
-
}
|
|
454
|
-
|
|
455
|
-
/**
|
|
456
|
-
* 菜单栏功能按钮配置
|
|
457
|
-
*/
|
|
458
|
-
declare type EditorMenuFeatureButton<TName extends string> = {
|
|
459
|
-
/**
|
|
460
|
-
* 隐藏按钮,用作在需要隐藏菜单栏时定义
|
|
461
|
-
*/
|
|
462
|
-
type: 'hidden';
|
|
463
|
-
/**
|
|
464
|
-
* 按钮名称
|
|
465
|
-
*/
|
|
466
|
-
name: TName;
|
|
467
|
-
} | {
|
|
468
|
-
type: 'button';
|
|
469
|
-
/**
|
|
470
|
-
* 按钮名称
|
|
471
|
-
*/
|
|
472
|
-
name: TName;
|
|
473
|
-
/**
|
|
474
|
-
* 按钮标签(显示文本)
|
|
475
|
-
*/
|
|
476
|
-
label: string;
|
|
477
|
-
/**
|
|
478
|
-
* 按钮图标,可以是 base64 的图片信息,也可以是图片 url
|
|
479
|
-
*/
|
|
480
|
-
icon?: string;
|
|
481
|
-
};
|
|
482
|
-
|
|
483
|
-
/**
|
|
484
|
-
* 菜单栏按钮配置
|
|
485
|
-
*/
|
|
486
|
-
declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
|
|
487
|
-
|
|
488
|
-
/**
|
|
489
|
-
* 菜单栏相关配置,目前菜单栏不是所有套件都支持,
|
|
490
|
-
* 菜单栏是指的编辑器最上放可以展开二级菜单的那一栏。
|
|
491
|
-
*/
|
|
492
|
-
declare interface EditorMenuOptions<TName extends string> {
|
|
493
|
-
/**
|
|
494
|
-
* 菜单栏是否显示
|
|
495
|
-
*/
|
|
496
|
-
visible?: boolean;
|
|
497
|
-
/**
|
|
498
|
-
* 是否禁用菜单栏所有功能
|
|
499
|
-
*/
|
|
500
|
-
disabled?: boolean;
|
|
501
|
-
/**
|
|
502
|
-
* 菜单栏一级菜单配置
|
|
503
|
-
*/
|
|
504
|
-
entries?: EditorMenuEntryConfig<TName>[];
|
|
505
|
-
/**
|
|
506
|
-
* 菜单栏功能按钮配置
|
|
507
|
-
*/
|
|
508
|
-
features?: Partial<EditorMenuFeatureButtonConfig<TName>>;
|
|
509
|
-
/**
|
|
510
|
-
* 自定义按钮配置
|
|
511
|
-
*/
|
|
512
|
-
custom?: EditorMenuCustomButton[];
|
|
513
|
-
}
|
|
514
|
-
|
|
515
|
-
/**
|
|
516
|
-
* 编辑器基础模式接口
|
|
517
|
-
*/
|
|
518
|
-
declare interface EditorMode {
|
|
519
|
-
/**
|
|
520
|
-
* 获取当前编辑器模式
|
|
521
|
-
*/
|
|
522
|
-
getModeType: () => EditorModeType;
|
|
523
|
-
/**
|
|
524
|
-
* 设置编辑器权限模式,仅在 `standard` 模式下有效
|
|
525
|
-
* @param permission
|
|
526
|
-
*/
|
|
527
|
-
setStandardRole: (standardRole: EditorStandardRole) => Promise<void>;
|
|
528
|
-
/**
|
|
529
|
-
* 获取当前编辑器权限模式,仅在 `standard` 模式下有效
|
|
530
|
-
*/
|
|
531
|
-
getStandardRole: () => EditorStandardRole;
|
|
532
|
-
}
|
|
533
|
-
|
|
534
|
-
/**
|
|
535
|
-
* 编辑器初始化的时相关的模式配置
|
|
536
|
-
*/
|
|
537
|
-
declare type EditorModeOptions = {
|
|
538
|
-
type: 'standard';
|
|
539
|
-
/**
|
|
540
|
-
* 当 mode 为 `standard` 时,可以设置当前编辑器的权限模式
|
|
541
|
-
*/
|
|
542
|
-
role?: EditorStandardRole;
|
|
543
|
-
} | {
|
|
544
|
-
type: 'preview';
|
|
545
|
-
} | {
|
|
546
|
-
type: 'presentation';
|
|
547
|
-
};
|
|
548
|
-
|
|
549
|
-
/**
|
|
550
|
-
* 编辑器模式
|
|
551
|
-
* - `standard` 标准模式,会根据用户权限配置不同的功能
|
|
552
|
-
* - `preview` 预览模式,只能查看内容
|
|
553
|
-
* - `presentation` 演示模式,用作演示场景,演示模式下部分套件可以进行一些简单的编辑操作
|
|
554
|
-
*/
|
|
555
|
-
declare type EditorModeType = 'standard' | 'preview' | 'presentation';
|
|
556
|
-
|
|
557
|
-
/**
|
|
558
|
-
* 编辑器初始化通用参数
|
|
559
|
-
*/
|
|
560
|
-
declare interface EditorOptions {
|
|
561
|
-
/**
|
|
562
|
-
* 编辑器初始化内容,可以是 string 或者 ArrayBuffer,
|
|
563
|
-
* 也可以通过异步 Promise 加载
|
|
564
|
-
*/
|
|
565
|
-
content: MaybePromiseValue<string | ArrayBuffer>;
|
|
566
|
-
/**
|
|
567
|
-
* 初始化时的编辑模式,默认为 `preview`
|
|
568
|
-
*/
|
|
569
|
-
mode?: EditorModeOptions;
|
|
570
|
-
/**
|
|
571
|
-
* 当前操作编辑器的用户信息
|
|
572
|
-
*/
|
|
573
|
-
user?: EditorUserOptions;
|
|
574
|
-
/**
|
|
575
|
-
* i18n 相关设置
|
|
576
|
-
*/
|
|
577
|
-
i18n?: EditorI18nOptions;
|
|
578
|
-
/**
|
|
579
|
-
* 品牌相关设置
|
|
580
|
-
*/
|
|
581
|
-
brand?: EditorBrandOptions;
|
|
582
|
-
/**
|
|
583
|
-
* 工具栏相关设置
|
|
584
|
-
*/
|
|
585
|
-
toolbar?: EditorToolbarOptions;
|
|
586
|
-
/**
|
|
587
|
-
* 编辑器内部资源请求配置
|
|
588
|
-
*/
|
|
589
|
-
assets?: EditorAssetsOptions;
|
|
590
|
-
/**
|
|
591
|
-
* 编辑器内部超链接设置
|
|
592
|
-
*/
|
|
593
|
-
link?: EditorLinkOptions;
|
|
594
|
-
/**
|
|
595
|
-
* 嵌入对象相关配置
|
|
596
|
-
*/
|
|
597
|
-
embeddedObject?: EditorEmbeddedObjectOptions;
|
|
598
|
-
/**
|
|
599
|
-
* 初始化水印配置
|
|
600
|
-
*/
|
|
601
|
-
watermark?: EditorWatermarkOptions;
|
|
602
|
-
/**
|
|
603
|
-
* 编辑器打印设置
|
|
604
|
-
*/
|
|
605
|
-
print?: EditorPrintOptions;
|
|
606
|
-
/**
|
|
607
|
-
* 编辑器评论设置
|
|
608
|
-
*/
|
|
609
|
-
comments?: EditorCommentsOptions;
|
|
610
|
-
}
|
|
611
|
-
|
|
612
|
-
/**
|
|
613
|
-
* 编辑器打印设置
|
|
614
|
-
*/
|
|
615
|
-
declare interface EditorPrintOptions {
|
|
616
|
-
/**
|
|
617
|
-
* 部分套件如果绕过了编辑器预设的打印接口,直接通过拉起了浏览器的打印页面,这时打印页面无法获取到编辑器的内容,
|
|
618
|
-
* 这种情况下就会 fallback 到这个 options 上,显示一个提示信息。
|
|
619
|
-
*/
|
|
620
|
-
fallback?: {
|
|
621
|
-
message: string;
|
|
622
|
-
};
|
|
623
|
-
/**
|
|
624
|
-
* 是否禁用打印功能
|
|
625
|
-
*/
|
|
626
|
-
disabled?: boolean;
|
|
627
|
-
}
|
|
628
|
-
|
|
629
|
-
/**
|
|
630
|
-
* 编辑器通用接口
|
|
631
|
-
*/
|
|
632
|
-
declare abstract class EditorSDK {
|
|
633
|
-
protected options: EditorOptions;
|
|
634
|
-
constructor(options: EditorOptions);
|
|
635
|
-
/**
|
|
636
|
-
* 初始化编辑器、加载插件等操作。
|
|
637
|
-
*/
|
|
638
|
-
abstract init(): Promise<void>;
|
|
639
|
-
/**
|
|
640
|
-
* 销毁编辑器
|
|
641
|
-
*/
|
|
642
|
-
abstract destroy(): Promise<void>;
|
|
643
|
-
/**
|
|
644
|
-
* 将编辑器挂载到指定的根节点上,并渲染,
|
|
645
|
-
* mount 应该在 init 之后调用。
|
|
646
|
-
* @param root
|
|
647
|
-
*/
|
|
648
|
-
abstract mount(root: HTMLElement): Promise<void>;
|
|
649
|
-
/**
|
|
650
|
-
* 从根节点卸载编辑器,对应 `mount` 操作
|
|
651
|
-
*/
|
|
652
|
-
abstract unmount(): Promise<void>;
|
|
653
|
-
/**
|
|
654
|
-
* 编辑器内容相关接口
|
|
655
|
-
*/
|
|
656
|
-
abstract get content(): EditorContent;
|
|
657
|
-
/**
|
|
658
|
-
* 编辑器模式相关接口
|
|
659
|
-
*/
|
|
660
|
-
abstract get mode(): EditorMode;
|
|
661
|
-
/**
|
|
662
|
-
* 编辑器评论相关接口
|
|
663
|
-
*/
|
|
664
|
-
abstract get comments(): EditorComments;
|
|
665
|
-
}
|
|
666
|
-
|
|
667
|
-
/**
|
|
668
|
-
* 编辑器在 `standard` 模式下的权限模式
|
|
669
|
-
* - `editor` 编辑模式
|
|
670
|
-
* - `viewer` 阅读模式
|
|
671
|
-
* - `reviewer` 评论模式
|
|
672
|
-
*/
|
|
673
|
-
declare type EditorStandardRole = 'editor' | 'viewer' | 'reviewer';
|
|
674
|
-
|
|
675
|
-
/**
|
|
676
|
-
* 文本格式接口,
|
|
677
|
-
* 包括设置、读取选区内文本的 BIUS、family、大小、颜色等
|
|
678
|
-
*/
|
|
679
|
-
declare interface EditorText<Color = string, TRangeValue = unknown> {
|
|
680
|
-
/**
|
|
681
|
-
* 获取当前选区或指定选区内的文本格式状态
|
|
682
|
-
*/
|
|
683
|
-
get: (range?: TRangeValue) => Partial<EditorTextFormat<Color>>;
|
|
684
|
-
/**
|
|
685
|
-
* 将文本的格式应用到当前选区或指定选区上,
|
|
686
|
-
* 传入的非空字段会覆盖对应的属性,其他没有传入的属性会保持不变。
|
|
687
|
-
* @param range
|
|
688
|
-
* @param format
|
|
689
|
-
* @returns
|
|
690
|
-
*/
|
|
691
|
-
apply: (format: Partial<EditorTextFormat<Color>>, range?: TRangeValue) => Partial<EditorTextFormat<Color>>;
|
|
692
|
-
/**
|
|
693
|
-
* 清空当前选区或指定选区内文本的格式,将文本格式恢复到默认状态
|
|
694
|
-
* @param range
|
|
695
|
-
* @returns
|
|
696
|
-
*/
|
|
697
|
-
clear: (range: TRangeValue) => void;
|
|
698
|
-
}
|
|
699
|
-
|
|
700
|
-
/**
|
|
701
|
-
* 文本格式状态
|
|
702
|
-
*/
|
|
703
|
-
declare interface EditorTextFormat<Color = string> {
|
|
704
|
-
/**
|
|
705
|
-
* 粗体
|
|
706
|
-
*/
|
|
707
|
-
bold: boolean;
|
|
708
|
-
/**
|
|
709
|
-
* 斜体
|
|
710
|
-
*/
|
|
711
|
-
italic: boolean;
|
|
712
|
-
/**
|
|
713
|
-
* 下划线
|
|
714
|
-
*/
|
|
715
|
-
underline: boolean;
|
|
716
|
-
/**
|
|
717
|
-
* 删除线
|
|
718
|
-
*/
|
|
719
|
-
strike: boolean;
|
|
720
|
-
/**
|
|
721
|
-
* 文本颜色
|
|
722
|
-
*/
|
|
723
|
-
color: Color;
|
|
724
|
-
/**
|
|
725
|
-
* 文本背景高亮颜色
|
|
726
|
-
*/
|
|
727
|
-
highlight: Color;
|
|
728
|
-
/**
|
|
729
|
-
* 文本大小
|
|
730
|
-
*/
|
|
731
|
-
size: number | string;
|
|
732
|
-
/**
|
|
733
|
-
* 文本名称
|
|
734
|
-
*/
|
|
735
|
-
family: string;
|
|
736
|
-
}
|
|
737
|
-
|
|
738
|
-
/**
|
|
739
|
-
* 文本格式初始化选项
|
|
740
|
-
*/
|
|
741
|
-
declare interface EditorTextOptions<Color = string> {
|
|
742
|
-
/**
|
|
743
|
-
* 当前编辑器默认的文本格式
|
|
744
|
-
*/
|
|
745
|
-
defaultFormat?: Partial<EditorTextFormat<Color>>;
|
|
746
|
-
}
|
|
747
|
-
|
|
748
|
-
/**
|
|
749
|
-
* 工具栏自定义按钮配置
|
|
750
|
-
*/
|
|
751
|
-
declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
|
|
752
|
-
/**
|
|
753
|
-
* 自定义按钮名称
|
|
754
|
-
*/
|
|
755
|
-
name: string;
|
|
756
|
-
/**
|
|
757
|
-
* 按钮点击事件
|
|
758
|
-
*/
|
|
759
|
-
callback: () => void;
|
|
760
|
-
/**
|
|
761
|
-
* 按钮在工具栏中的位置,默认添加到工具栏所有按钮后面
|
|
762
|
-
*/
|
|
763
|
-
index?: number;
|
|
764
|
-
}
|
|
765
|
-
|
|
766
|
-
/**
|
|
767
|
-
* 工具栏自定义按钮配置
|
|
768
|
-
*/
|
|
769
|
-
declare interface EditorToolbarCustomButtonConfig {
|
|
770
|
-
/**
|
|
771
|
-
* 按钮配置
|
|
772
|
-
*/
|
|
773
|
-
[key: string]: EditorToolbarCustomButton;
|
|
774
|
-
}
|
|
775
|
-
|
|
776
|
-
/**
|
|
777
|
-
* 工具栏内置功能按钮配置
|
|
778
|
-
*/
|
|
779
|
-
declare interface EditorToolbarFeatureButton {
|
|
780
|
-
/**
|
|
781
|
-
* 按钮类型
|
|
782
|
-
*/
|
|
783
|
-
name: EditorToolbarFeatureButtonName;
|
|
784
|
-
/**
|
|
785
|
-
* 按钮标签(显示文本)
|
|
786
|
-
*/
|
|
787
|
-
label?: string;
|
|
788
|
-
/**
|
|
789
|
-
* 按钮图标,可以是 base64 的图片信息,也可以是图片 url
|
|
790
|
-
*/
|
|
791
|
-
icon?: string;
|
|
792
|
-
/**
|
|
793
|
-
* 按钮是否禁用
|
|
794
|
-
*/
|
|
795
|
-
disabled?: boolean;
|
|
796
|
-
/**
|
|
797
|
-
* 按钮提示文本
|
|
798
|
-
*/
|
|
799
|
-
tooltip?: string;
|
|
800
|
-
}
|
|
801
|
-
|
|
802
|
-
/**
|
|
803
|
-
* 工具栏内置功能按钮配置
|
|
804
|
-
*/
|
|
805
|
-
declare type EditorToolbarFeatureButtonConfig = {
|
|
806
|
-
[key in EditorToolbarFeatureButtonName]?: EditorToolbarFeatureButton;
|
|
807
|
-
};
|
|
808
|
-
|
|
809
|
-
/**
|
|
810
|
-
* 工具栏内置功能按钮
|
|
811
|
-
*/
|
|
812
|
-
declare type EditorToolbarFeatureButtonName =
|
|
813
|
-
/**
|
|
814
|
-
* 加粗
|
|
815
|
-
*/
|
|
816
|
-
'bold'
|
|
817
|
-
/**
|
|
818
|
-
* 斜体
|
|
819
|
-
*/
|
|
820
|
-
| 'italic'
|
|
821
|
-
/**
|
|
822
|
-
* 下划线
|
|
823
|
-
*/
|
|
824
|
-
| 'underline'
|
|
825
|
-
/**
|
|
826
|
-
* 删除线
|
|
827
|
-
*/
|
|
828
|
-
| 'strikethrough'
|
|
829
|
-
/**
|
|
830
|
-
* 插入图片
|
|
831
|
-
*/
|
|
832
|
-
| 'insertImage'
|
|
833
|
-
/**
|
|
834
|
-
* 插入链接
|
|
835
|
-
*/
|
|
836
|
-
| 'insertLink'
|
|
837
|
-
/**
|
|
838
|
-
* 限制编辑
|
|
839
|
-
*/
|
|
840
|
-
| 'restriction';
|
|
841
|
-
|
|
842
|
-
/**
|
|
843
|
-
* 工具栏相关设置,可以控制工具栏的显示内容
|
|
844
|
-
*/
|
|
845
|
-
declare interface EditorToolbarOptions {
|
|
846
|
-
/**
|
|
847
|
-
* 控制工具栏显隐状态
|
|
848
|
-
*/
|
|
849
|
-
visible?: boolean;
|
|
850
|
-
/**
|
|
851
|
-
* 是否禁用工具栏所有功能
|
|
852
|
-
*/
|
|
853
|
-
disabled?: boolean;
|
|
854
|
-
/**
|
|
855
|
-
* 现有按钮的功能配置
|
|
856
|
-
*/
|
|
857
|
-
features?: EditorToolbarFeatureButtonConfig;
|
|
858
|
-
/**
|
|
859
|
-
* 自定义按钮
|
|
860
|
-
*/
|
|
861
|
-
custom?: EditorToolbarCustomButtonConfig;
|
|
862
|
-
}
|
|
863
|
-
|
|
864
|
-
/**
|
|
865
|
-
* 操作当前编辑器的用户信息
|
|
866
|
-
*/
|
|
867
|
-
declare interface EditorUserOptions {
|
|
868
|
-
/**
|
|
869
|
-
* 用户 ID,用于标识用户
|
|
870
|
-
*/
|
|
871
|
-
uid: string;
|
|
872
|
-
/**
|
|
873
|
-
* 用户名
|
|
874
|
-
*/
|
|
875
|
-
name: string;
|
|
876
|
-
/**
|
|
877
|
-
* 用户头像
|
|
878
|
-
*/
|
|
879
|
-
avatar?: string;
|
|
880
|
-
}
|
|
881
|
-
|
|
882
|
-
/**
|
|
883
|
-
* 编辑器外部水印信息
|
|
884
|
-
*/
|
|
885
|
-
declare interface EditorWatermarkOptions {
|
|
886
|
-
/**
|
|
887
|
-
* 获取用作初始化使用的默认水印
|
|
888
|
-
*/
|
|
889
|
-
getWatermark: () => MaybePromiseValue<EditorWatermarkResource | null>;
|
|
890
|
-
/**
|
|
891
|
-
* 是否必须,如果为 true,编辑器将在初始化时强制渲染水印,
|
|
892
|
-
* 水印配置信息加载失败将导致编辑器初始化失败
|
|
893
|
-
*/
|
|
894
|
-
required?: boolean;
|
|
895
|
-
}
|
|
896
|
-
|
|
897
|
-
declare type EditorWatermarkResource = {
|
|
898
|
-
type: 'data-url';
|
|
899
|
-
url: string;
|
|
900
|
-
} | {
|
|
901
|
-
type: 'object-url';
|
|
902
|
-
url: string;
|
|
903
|
-
};
|
|
904
|
-
|
|
905
|
-
/**
|
|
906
|
-
* 请求、响应头
|
|
907
|
-
*/
|
|
908
|
-
declare type HTTPHeaders = Record<string, string | number | boolean | undefined>;
|
|
909
|
-
|
|
910
|
-
/**
|
|
911
|
-
* 请求方法
|
|
912
|
-
*/
|
|
913
|
-
declare type HTTPMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH';
|
|
914
|
-
|
|
915
|
-
/**
|
|
916
|
-
* HTTP 代理,用于抽象 HTTP 请求,
|
|
917
|
-
* 将请求代理编辑器外部
|
|
918
|
-
*/
|
|
919
|
-
declare interface HTTPProxy {
|
|
920
|
-
/**
|
|
921
|
-
* 发送请求,如果需要做请求、响应拦截,需要在 proxy.interceptors 中实现,
|
|
922
|
-
* 套件内使用 proxy 发送请求的方式应该为类似如下方式:
|
|
923
|
-
* ```ts
|
|
924
|
-
* const raw = await proxy.request(proxy.interceptors?.request?.intercept(requestConfig) ?? requestConfig);
|
|
925
|
-
* const response = proxy.interceptors?.response?.intercept(raw) ?? raw;
|
|
926
|
-
* ```
|
|
927
|
-
*
|
|
928
|
-
* 套件内如果需要通过其他方式发送请求,比如通过浏览器的 Image API 加载,可以使用 proxy.interceptors?.request?.intercept(requestConfig) 处理请求配置
|
|
929
|
-
* @param config
|
|
930
|
-
* @returns
|
|
931
|
-
*/
|
|
932
|
-
request: <D = unknown, T = unknown>(config: HTTPRequestConfig<D>) => Promise<HTTPResponse<T>>;
|
|
933
|
-
/**
|
|
934
|
-
* 请求、响应拦截器,
|
|
935
|
-
*
|
|
936
|
-
*/
|
|
937
|
-
interceptors?: {
|
|
938
|
-
request?: {
|
|
939
|
-
/**
|
|
940
|
-
* 请求拦截器,传入请求配置,返回处理后的请求配置
|
|
941
|
-
* @param requestConfig 请求配置
|
|
942
|
-
* @returns
|
|
943
|
-
*/
|
|
944
|
-
intercept: <D = unknown>(requestConfig: HTTPRequestConfig<D>) => HTTPRequestConfig<D>;
|
|
945
|
-
};
|
|
946
|
-
response?: {
|
|
947
|
-
/**
|
|
948
|
-
* 响应拦截器,传入响应,返回处理后的响应
|
|
949
|
-
* @param response
|
|
950
|
-
* @returns
|
|
951
|
-
*/
|
|
952
|
-
intercept: <T = unknown>(response: HTTPResponse<T>) => HTTPResponse<T>;
|
|
953
|
-
};
|
|
954
|
-
};
|
|
955
|
-
/**
|
|
956
|
-
* 创建一个新的 HTTP 代理,用于为不同请求场景创建不同的代理
|
|
957
|
-
* @param id
|
|
958
|
-
* @returns
|
|
959
|
-
*/
|
|
960
|
-
create: (id: string) => Promise<HTTPProxy>;
|
|
961
|
-
}
|
|
962
|
-
|
|
963
|
-
/**
|
|
964
|
-
* 请求配置
|
|
965
|
-
*/
|
|
966
|
-
declare interface HTTPRequestConfig<Data = unknown> {
|
|
967
|
-
/**
|
|
968
|
-
* 请求地址
|
|
969
|
-
*/
|
|
970
|
-
url: string;
|
|
971
|
-
/**
|
|
972
|
-
* 请求方法
|
|
973
|
-
*/
|
|
974
|
-
method?: HTTPMethod;
|
|
975
|
-
/**
|
|
976
|
-
* 请求携带数据,主要是 POST、PUT、PATCH 等方法的请求数据
|
|
977
|
-
*/
|
|
978
|
-
data?: Data;
|
|
979
|
-
/**
|
|
980
|
-
* 期望的响应数据类型
|
|
981
|
-
*/
|
|
982
|
-
responseType?: HTTPResponseType;
|
|
983
|
-
/**
|
|
984
|
-
* 请求头
|
|
985
|
-
*/
|
|
986
|
-
headers?: HTTPHeaders;
|
|
987
|
-
}
|
|
988
|
-
|
|
989
|
-
/**
|
|
990
|
-
* 响应数据
|
|
991
|
-
*/
|
|
992
|
-
declare interface HTTPResponse<Data = unknown> {
|
|
993
|
-
/**
|
|
994
|
-
* 响应数据 body
|
|
995
|
-
*/
|
|
996
|
-
data: Data;
|
|
997
|
-
/**
|
|
998
|
-
* 响应状态码
|
|
999
|
-
*/
|
|
1000
|
-
status: number;
|
|
1001
|
-
/**
|
|
1002
|
-
* 响应头
|
|
1003
|
-
*/
|
|
1004
|
-
headers: HTTPHeaders;
|
|
1005
|
-
}
|
|
1006
|
-
|
|
1007
|
-
/**
|
|
1008
|
-
* 请求返回类型
|
|
1009
|
-
*/
|
|
1010
|
-
declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
|
|
1011
|
-
|
|
1012
|
-
declare type MaybePromiseValue<T> = T | Promise<T>;
|
|
1013
|
-
|
|
1014
|
-
export declare type PresentationFontFace = EditorFontFace;
|
|
1015
|
-
|
|
1016
|
-
export declare type PresentationFontMeta = EditorFontMeta;
|
|
1017
|
-
|
|
1018
|
-
export declare interface PresentationFontsList {
|
|
1019
|
-
getAll: () => Promise<PresentationFontFace[]>;
|
|
1020
|
-
}
|
|
1021
|
-
|
|
1022
|
-
export declare interface PresentationFontsOptions {
|
|
1023
|
-
list: PresentationFontsList;
|
|
1024
|
-
}
|
|
1025
|
-
|
|
1026
|
-
/**
|
|
1027
|
-
* 幻灯片工具栏一级菜单
|
|
1028
|
-
*/
|
|
1029
|
-
export declare type PresentationMenuEntryConfig = EditorMenuEntryConfig<PresentationMenuFeatureButtonName>;
|
|
1030
|
-
|
|
1031
|
-
/**
|
|
1032
|
-
* 幻灯片工具栏功能按钮
|
|
1033
|
-
*/
|
|
1034
|
-
export declare type PresentationMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<PresentationMenuFeatureButtonName>;
|
|
1035
|
-
|
|
1036
|
-
/**
|
|
1037
|
-
* 幻灯片工具栏内置功能按钮
|
|
1038
|
-
*/
|
|
1039
|
-
export declare type PresentationMenuFeatureButtonName = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll';
|
|
1040
|
-
|
|
1041
|
-
export declare type PresentationMenuOptions = EditorMenuOptions<PresentationMenuFeatureButtonName>;
|
|
1042
|
-
|
|
1043
|
-
export declare interface PresentationSDKOptions extends EditorOptions {
|
|
1044
|
-
/**
|
|
1045
|
-
* 字体配置
|
|
1046
|
-
*/
|
|
1047
|
-
fonts?: PresentationFontsOptions;
|
|
1048
|
-
/**
|
|
1049
|
-
* 菜单栏相关设置
|
|
1050
|
-
*/
|
|
1051
|
-
menu?: PresentationMenuOptions;
|
|
1052
|
-
/**
|
|
1053
|
-
* 文本格式相关设置
|
|
1054
|
-
*/
|
|
1055
|
-
text?: PresentationTextOptions;
|
|
1056
|
-
}
|
|
1057
|
-
|
|
1058
|
-
/**
|
|
1059
|
-
* 选区(Selection)
|
|
1060
|
-
* 表示窗口中的当前选定内容。
|
|
1061
|
-
* 选定内容表示幻灯片中的选定(或突出显示)区域,或者代表插入点(如果未选择幻灯片中的任何内容)。
|
|
1062
|
-
*/
|
|
1063
|
-
export declare interface PresentationSelection {
|
|
1064
|
-
/**
|
|
1065
|
-
* 获取选区的区域范围,
|
|
1066
|
-
* 如果没有指定范围,则返回当前选区的范围。
|
|
1067
|
-
* 如果指定了范围,则返回指定范围的选区。
|
|
1068
|
-
* 如果选区不存在,则返回 null。
|
|
1069
|
-
* @returns
|
|
1070
|
-
*/
|
|
1071
|
-
getTextRange: (value?: PresentationTextRangeValue) => PresentationTextRange | null;
|
|
1072
|
-
/**
|
|
1073
|
-
* 设置选区的区域范围,
|
|
1074
|
-
* 设置后,选区会自动选中指定范围。
|
|
1075
|
-
* 如果设置为 null,则清空选区。
|
|
1076
|
-
* @param value
|
|
1077
|
-
*/
|
|
1078
|
-
setTextRange: (value: PresentationTextRangeValue | null) => void;
|
|
1079
|
-
/**
|
|
1080
|
-
* 获取当前选中的形状,
|
|
1081
|
-
* 如果没有选中形状,则返回 null。
|
|
1082
|
-
* 如果指定了 value,则返回指定形状。
|
|
1083
|
-
* @param ids 指定的形状 id
|
|
1084
|
-
* @returns
|
|
1085
|
-
*/
|
|
1086
|
-
getSelectedShapes: (ids?: string[]) => PresentationShape[] | null;
|
|
1087
|
-
/**
|
|
1088
|
-
* 选中指定的形状,选中形状后会清空文字选区。
|
|
1089
|
-
* 如果 value 为 null,则清空选中的形状。
|
|
1090
|
-
* @param ids 指定的形状 id
|
|
1091
|
-
* @returns
|
|
1092
|
-
*/
|
|
1093
|
-
setSelectedShapes: (ids: string[] | null) => void;
|
|
1094
|
-
/**
|
|
1095
|
-
* 添加选区变化监听器,当选区发生变化时,会触发回调。
|
|
1096
|
-
* @param listener
|
|
1097
|
-
* @returns
|
|
1098
|
-
*/
|
|
1099
|
-
addRangeListener: (listener: (value: PresentationTextRangeValue | null) => void) => void;
|
|
1100
|
-
}
|
|
1101
|
-
|
|
1102
|
-
/**
|
|
1103
|
-
* 幻灯片形状(Shape)接口
|
|
1104
|
-
*/
|
|
1105
|
-
export declare interface PresentationShape {
|
|
1106
|
-
/**
|
|
1107
|
-
* 获取形状的 id
|
|
1108
|
-
*/
|
|
1109
|
-
readonly id: string;
|
|
1110
|
-
}
|
|
1111
|
-
|
|
1112
|
-
/**
|
|
1113
|
-
* 幻灯片页面(Slide)对象,
|
|
1114
|
-
* 是幻灯片的基础操作单元,包含幻灯片的基本信息和操作方法。
|
|
1115
|
-
*/
|
|
1116
|
-
export declare interface PresentationSlide {
|
|
1117
|
-
/**
|
|
1118
|
-
* 当前幻灯片的 id
|
|
1119
|
-
*/
|
|
1120
|
-
readonly id: string;
|
|
1121
|
-
/**
|
|
1122
|
-
* 获取当前幻灯片在所有幻灯片中的索引
|
|
1123
|
-
* @returns
|
|
1124
|
-
*/
|
|
1125
|
-
getIndex: () => number;
|
|
1126
|
-
/**
|
|
1127
|
-
* 获取当前页面所有的形状
|
|
1128
|
-
* @returns
|
|
1129
|
-
*/
|
|
1130
|
-
getShapes: () => PresentationShape[];
|
|
1131
|
-
}
|
|
1132
|
-
|
|
1133
|
-
/**
|
|
1134
|
-
* 幻灯片集合对象,
|
|
1135
|
-
* 该接口和 PresentationSlide 负责不同的功能,
|
|
1136
|
-
* PresentationSlide 是一个幻灯片页面的抽象,而 PresentationSlides 是对整个文件中所有页面的操作。
|
|
1137
|
-
*/
|
|
1138
|
-
export declare interface PresentationSlides {
|
|
1139
|
-
/**
|
|
1140
|
-
* 获取当前幻灯片
|
|
1141
|
-
*/
|
|
1142
|
-
getCurrentSlide: () => PresentationSlide;
|
|
1143
|
-
/**
|
|
1144
|
-
* 切换当前幻灯片
|
|
1145
|
-
* @param slideId
|
|
1146
|
-
*/
|
|
1147
|
-
setCurrentSlideIndex: (slideId: string) => void;
|
|
1148
|
-
/**
|
|
1149
|
-
* 获取幻灯片索引
|
|
1150
|
-
* @param slideId
|
|
1151
|
-
* @returns
|
|
1152
|
-
*/
|
|
1153
|
-
getSlideIndex: (slideId: string) => number;
|
|
1154
|
-
/**
|
|
1155
|
-
* 获取幻灯片总数
|
|
1156
|
-
*/
|
|
1157
|
-
getSlidesCount: () => number;
|
|
1158
|
-
/**
|
|
1159
|
-
* 获取所有幻灯片
|
|
1160
|
-
* @returns
|
|
1161
|
-
*/
|
|
1162
|
-
getSlides: () => PresentationSlide[];
|
|
1163
|
-
/**
|
|
1164
|
-
* 获取指定幻灯片
|
|
1165
|
-
* @param slideId
|
|
1166
|
-
*/
|
|
1167
|
-
getSlideById: (slideId: string) => PresentationSlide;
|
|
1168
|
-
/**
|
|
1169
|
-
* 获取当前选中的幻灯片。
|
|
1170
|
-
* 至少存在一个选中的幻灯片。
|
|
1171
|
-
* @returns
|
|
1172
|
-
*/
|
|
1173
|
-
getSelectedSlides: (ids?: string[]) => PresentationSlide[];
|
|
1174
|
-
/**
|
|
1175
|
-
* 设置
|
|
1176
|
-
* @param ids
|
|
1177
|
-
* @returns
|
|
1178
|
-
*/
|
|
1179
|
-
setSelectedSlides: (ids: string[]) => void;
|
|
1180
|
-
}
|
|
1181
|
-
|
|
1182
|
-
/**
|
|
1183
|
-
* 演示文稿文本接口
|
|
1184
|
-
*/
|
|
1185
|
-
export declare type PresentationText = EditorText<string, PresentationTextRangeValue>;
|
|
1186
|
-
|
|
1187
|
-
/**
|
|
1188
|
-
* 演示文稿文本格式
|
|
1189
|
-
*/
|
|
1190
|
-
export declare type PresentationTextFormat = EditorTextFormat;
|
|
1191
|
-
|
|
1192
|
-
/**
|
|
1193
|
-
* 演示文稿文本格式初始化选项
|
|
1194
|
-
*/
|
|
1195
|
-
export declare type PresentationTextOptions = EditorTextOptions<string>;
|
|
1196
|
-
|
|
1197
|
-
/**
|
|
1198
|
-
* 区域(Range)
|
|
1199
|
-
* 区域对象,表示幻灯片页面中的一个连续的文字区域,每个 Range 对象包含起始字符位置和终止字符位置。
|
|
1200
|
-
* 区域信息是一个临时状态,当内容发生变化后,或切换了幻灯片 slide 区域信息可能会失效。
|
|
1201
|
-
*/
|
|
1202
|
-
/**
|
|
1203
|
-
* 幻灯片区域对象,
|
|
1204
|
-
* 用于表示页面中的一个连续区域,
|
|
1205
|
-
* 每个选区值包含了起始位置和结束位置信息的字符串。
|
|
1206
|
-
*/
|
|
1207
|
-
export declare interface PresentationTextRange {
|
|
1208
|
-
/**
|
|
1209
|
-
* 区域的开始位置,
|
|
1210
|
-
* 当内容发生变化后,区域的标识可能会失效。
|
|
1211
|
-
*/
|
|
1212
|
-
readonly start: string;
|
|
1213
|
-
/**
|
|
1214
|
-
* 区域的结束位置,
|
|
1215
|
-
* 当内容发生变化后,区域的标识可能会失效。
|
|
1216
|
-
*/
|
|
1217
|
-
readonly end: string;
|
|
1218
|
-
/**
|
|
1219
|
-
* 获取该区域对应的纯文本信息。
|
|
1220
|
-
* @returns
|
|
1221
|
-
*/
|
|
1222
|
-
getText: () => string;
|
|
1223
|
-
/**
|
|
1224
|
-
* 设置该区域的内容
|
|
1225
|
-
* @param text 内容
|
|
1226
|
-
*/
|
|
1227
|
-
setText: (text: string) => void;
|
|
1228
|
-
/**
|
|
1229
|
-
* 将区域中的内容以 HTML 格式返回
|
|
1230
|
-
*/
|
|
1231
|
-
getHtml: () => string;
|
|
1232
|
-
/**
|
|
1233
|
-
* 设置该区域的内容为 HTML 格式
|
|
1234
|
-
* @param html 内容
|
|
1235
|
-
*/
|
|
1236
|
-
setHtml: (html: string) => void;
|
|
1237
|
-
}
|
|
1238
|
-
|
|
1239
|
-
export declare interface PresentationTextRangeValue {
|
|
1240
|
-
start: string;
|
|
1241
|
-
end: string;
|
|
1242
|
-
}
|
|
1243
|
-
|
|
1244
|
-
/**
|
|
1245
|
-
* 幻灯片缩放接口
|
|
1246
|
-
*/
|
|
1247
|
-
export declare interface PresentationZoom {
|
|
1248
|
-
/**
|
|
1249
|
-
* 获取当前缩放比例。
|
|
1250
|
-
* @returns
|
|
1251
|
-
*/
|
|
1252
|
-
getPercentage: () => number;
|
|
1253
|
-
/**
|
|
1254
|
-
* 设置缩放比例,
|
|
1255
|
-
* 有效范围 10 ~ 500。
|
|
1256
|
-
* @param percentage
|
|
1257
|
-
*/
|
|
1258
|
-
setPercentage: (percentage: number) => void;
|
|
1259
|
-
/**
|
|
1260
|
-
* 设置自动缩放模式,
|
|
1261
|
-
* none: 不自动缩放,默认值。
|
|
1262
|
-
* window: 根据窗口宽度自动缩放,页面宽度随着窗口宽度变化而变化
|
|
1263
|
-
* @param mode 缩放模式,可以是 'window'
|
|
1264
|
-
*/
|
|
1265
|
-
setFitMode: (mode: 'none' | 'window') => void;
|
|
1266
|
-
/**
|
|
1267
|
-
* 获取当前缩放模式。
|
|
1268
|
-
* @returns
|
|
1269
|
-
*/
|
|
1270
|
-
getFitMode: () => 'none' | 'window';
|
|
1271
|
-
/**
|
|
1272
|
-
* 放大。
|
|
1273
|
-
*/
|
|
1274
|
-
zoomIn: () => void;
|
|
1275
|
-
/**
|
|
1276
|
-
* 缩小。
|
|
1277
|
-
*/
|
|
1278
|
-
zoomOut: () => void;
|
|
1279
|
-
}
|
|
1280
|
-
|
|
1281
|
-
export { }
|