@officesdk/editor-sdk-core 0.0.0-21 → 0.0.0-23
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/sdk.js +1 -1
- package/cjs/docx/index.js +1 -1
- package/cjs/docx/menu.js +1 -1
- package/cjs/docx/outline.js +1 -1
- package/cjs/docx/pages.js +17 -1
- package/cjs/docx/paragraphs.js +3 -0
- package/cjs/docx/revisions.js +3 -0
- package/cjs/docx/sdk.js +1 -1
- package/cjs/docx/signature.js +3 -0
- package/cjs/docx/statistic.js +3 -0
- package/cjs/docx/theme.js +1 -1
- package/cjs/docx/ui.js +3 -0
- package/cjs/form/feature.js +3 -0
- package/cjs/form/index.js +21 -0
- package/cjs/form/link.js +3 -0
- package/cjs/form/publish.js +3 -0
- package/cjs/form/sdk.js +28 -0
- package/cjs/form/sheet.js +3 -0
- package/cjs/form/table.js +3 -0
- package/cjs/form/ui.js +3 -0
- package/cjs/pdf/pages.js +1 -1
- package/cjs/presentation/anonymous.js +3 -0
- package/cjs/presentation/assistant.js +3 -0
- package/cjs/presentation/chart.js +3 -0
- package/cjs/presentation/comments.js +3 -0
- package/cjs/presentation/diagram.js +3 -0
- package/cjs/presentation/event-subscription.js +3 -0
- package/cjs/presentation/export.js +1 -1
- package/cjs/presentation/fonts.js +1 -1
- package/cjs/presentation/index.js +1 -1
- package/cjs/presentation/presentation.js +3 -0
- package/cjs/presentation/remote-live.js +3 -0
- package/cjs/presentation/sdk.js +1 -1
- package/cjs/presentation/slides-pane.js +3 -0
- package/cjs/presentation/theme.js +3 -0
- package/cjs/shared/assets.js +1 -1
- package/cjs/shared/attachment.js +1 -1
- package/cjs/shared/brand.js +1 -1
- package/cjs/shared/collaborators.js +1 -1
- package/cjs/shared/comments.js +1 -1
- package/cjs/shared/copy.js +3 -0
- package/cjs/shared/device.js +3 -0
- package/cjs/shared/download.js +1 -2
- package/cjs/shared/drag-n-drop.js +6 -0
- package/cjs/shared/duplicate.js +6 -0
- package/cjs/shared/edit.js +2 -0
- package/cjs/shared/editor.js +1 -1
- package/cjs/shared/export.js +1 -1
- package/cjs/shared/feature.js +1 -1
- package/cjs/shared/file.js +1 -1
- package/cjs/shared/follow-mode.js +1 -1
- package/cjs/shared/fonts.js +1 -1
- package/cjs/shared/guides.js +3 -0
- package/cjs/shared/history.js +1 -1
- package/cjs/shared/import.js +1 -1
- package/cjs/shared/index.js +1 -1
- package/cjs/shared/link.js +1 -1
- package/cjs/shared/logs.js +3 -0
- package/cjs/shared/mention.js +1 -1
- package/cjs/shared/menu.js +1 -1
- package/cjs/shared/mode.js +1 -1
- package/cjs/shared/outline.js +1 -1
- package/cjs/shared/paste.js +3 -0
- package/cjs/shared/presentation.js +3 -0
- package/cjs/shared/render.js +3 -0
- package/cjs/shared/share.js +3 -0
- package/cjs/shared/shortcut.js +3 -0
- package/cjs/shared/socket.js +3 -0
- package/cjs/shared/toolbar.js +1 -1
- package/cjs/shared/ui.js +1 -1
- package/cjs/shared/uploader.js +1 -1
- package/cjs/shared/version.js +1 -1
- package/cjs/shared/watermark.js +1 -1
- package/cjs/sheet/combine-sheets.js +1 -1
- package/cjs/sheet/date-mention.js +3 -0
- package/cjs/sheet/event-subscription.js +3 -0
- package/cjs/sheet/export.js +1 -1
- package/cjs/sheet/follow-selection.js +3 -0
- package/cjs/sheet/form.js +1 -1
- package/cjs/sheet/formula.js +1 -1
- package/cjs/sheet/import-range.js +1 -1
- package/cjs/sheet/import.js +3 -0
- package/cjs/sheet/independent-viewport.js +3 -0
- package/cjs/sheet/index.js +1 -1
- package/cjs/sheet/lock.js +1 -1
- package/cjs/sheet/ole.js +3 -0
- package/cjs/sheet/paste.js +3 -0
- package/cjs/sheet/render.js +1 -1
- package/cjs/sheet/sdk.js +1 -1
- package/cjs/sheet/sheet-tab.js +3 -0
- package/cjs/sheet/ui.js +3 -0
- package/cjs/sheet/worksheet.js +1 -1
- package/cjs/table/combine-tables.js +3 -0
- package/cjs/table/copy.js +3 -0
- package/cjs/table/dashboard.js +3 -0
- package/cjs/table/explain-page.js +3 -0
- package/cjs/table/export.js +3 -0
- package/cjs/table/field.js +3 -0
- package/cjs/table/form.js +3 -0
- package/cjs/table/formula.js +3 -0
- package/cjs/table/history.js +3 -0
- package/cjs/table/import.js +3 -0
- package/cjs/table/index.js +6 -2
- package/cjs/table/list-bar-context-menu.js +3 -0
- package/cjs/table/mention.js +3 -0
- package/cjs/table/motable.js +16 -0
- package/cjs/table/paste.js +3 -0
- package/cjs/table/render.js +3 -0
- package/cjs/table/resource.js +1 -1
- package/cjs/table/sdk.js +1 -1
- package/cjs/table/shortcuts.js +3 -0
- package/cjs/table/snapshot.js +3 -0
- package/cjs/table/subscription.js +25 -0
- package/cjs/table/table.js +1 -1
- package/cjs/table/template.js +3 -0
- package/cjs/table/toolbar.js +1 -1
- package/cjs/table/toolbox.js +3 -0
- package/cjs/table/ui.js +3 -0
- package/cjs/table/version.js +3 -0
- package/cjs/table/view.js +26 -0
- package/cjs/table/window.js +3 -0
- package/esm/docs/sdk.js +1 -1
- package/esm/docx/index.js +1 -1
- package/esm/docx/menu.js +1 -1
- package/esm/docx/outline.js +1 -1
- package/esm/docx/pages.js +15 -2
- package/esm/docx/paragraphs.js +2 -0
- package/esm/docx/revisions.js +2 -0
- package/esm/docx/sdk.js +1 -1
- package/esm/docx/signature.js +2 -0
- package/esm/docx/statistic.js +2 -0
- package/esm/docx/theme.js +1 -1
- package/esm/docx/ui.js +2 -0
- package/esm/form/feature.js +2 -0
- package/esm/form/index.js +3 -0
- package/esm/form/link.js +2 -0
- package/esm/form/publish.js +2 -0
- package/esm/form/sdk.js +25 -0
- package/esm/form/sheet.js +2 -0
- package/esm/form/table.js +2 -0
- package/esm/form/ui.js +2 -0
- package/esm/pdf/pages.js +1 -1
- package/esm/presentation/anonymous.js +2 -0
- package/esm/presentation/assistant.js +2 -0
- package/esm/presentation/chart.js +2 -0
- package/esm/presentation/comments.js +2 -0
- package/esm/presentation/diagram.js +2 -0
- package/esm/presentation/event-subscription.js +2 -0
- package/esm/presentation/export.js +1 -1
- package/esm/presentation/fonts.js +1 -1
- package/esm/presentation/index.js +1 -1
- package/esm/presentation/presentation.js +2 -0
- package/esm/presentation/remote-live.js +2 -0
- package/esm/presentation/sdk.js +1 -1
- package/esm/presentation/slides-pane.js +2 -0
- package/esm/presentation/theme.js +2 -0
- package/esm/shared/assets.js +1 -1
- package/esm/shared/attachment.js +1 -1
- package/esm/shared/brand.js +1 -1
- package/esm/shared/collaborators.js +1 -1
- package/esm/shared/comments.js +1 -1
- package/esm/shared/copy.js +2 -0
- package/esm/shared/device.js +2 -0
- package/esm/shared/download.js +2 -2
- package/esm/shared/drag-n-drop.js +5 -0
- package/esm/shared/duplicate.js +5 -0
- package/esm/shared/edit.js +2 -0
- package/esm/shared/editor.js +1 -1
- package/esm/shared/export.js +1 -1
- package/esm/shared/feature.js +1 -1
- package/esm/shared/file.js +1 -1
- package/esm/shared/follow-mode.js +1 -1
- package/esm/shared/fonts.js +1 -1
- package/esm/shared/guides.js +2 -0
- package/esm/shared/history.js +1 -1
- package/esm/shared/import.js +1 -1
- package/esm/shared/index.js +1 -1
- package/esm/shared/link.js +1 -1
- package/esm/shared/logs.js +2 -0
- package/esm/shared/mention.js +1 -1
- package/esm/shared/menu.js +1 -1
- package/esm/shared/mode.js +1 -1
- package/esm/shared/outline.js +1 -1
- package/esm/shared/paste.js +2 -0
- package/esm/shared/presentation.js +2 -0
- package/esm/shared/render.js +2 -0
- package/esm/shared/share.js +2 -0
- package/esm/shared/shortcut.js +2 -0
- package/esm/shared/socket.js +2 -0
- package/esm/shared/toolbar.js +1 -1
- package/esm/shared/ui.js +1 -1
- package/esm/shared/uploader.js +1 -1
- package/esm/shared/version.js +1 -1
- package/esm/shared/watermark.js +1 -1
- package/esm/sheet/combine-sheets.js +1 -1
- package/esm/sheet/date-mention.js +2 -0
- package/esm/sheet/event-subscription.js +2 -0
- package/esm/sheet/export.js +1 -1
- package/esm/sheet/follow-selection.js +2 -0
- package/esm/sheet/form.js +1 -1
- package/esm/sheet/formula.js +1 -1
- package/esm/sheet/import-range.js +1 -1
- package/esm/sheet/import.js +2 -0
- package/esm/sheet/independent-viewport.js +2 -0
- package/esm/sheet/index.js +1 -1
- package/esm/sheet/lock.js +1 -1
- package/esm/sheet/ole.js +2 -0
- package/esm/sheet/paste.js +2 -0
- package/esm/sheet/render.js +1 -1
- package/esm/sheet/sdk.js +1 -1
- package/esm/sheet/sheet-tab.js +2 -0
- package/esm/sheet/ui.js +2 -0
- package/esm/sheet/worksheet.js +1 -1
- package/esm/table/combine-tables.js +2 -0
- package/esm/table/copy.js +2 -0
- package/esm/table/dashboard.js +2 -0
- package/esm/table/explain-page.js +2 -0
- package/esm/table/export.js +2 -0
- package/esm/table/field.js +2 -0
- package/esm/table/form.js +2 -0
- package/esm/table/formula.js +2 -0
- package/esm/table/history.js +2 -0
- package/esm/table/import.js +2 -0
- package/esm/table/index.js +3 -1
- package/esm/table/list-bar-context-menu.js +2 -0
- package/esm/table/mention.js +2 -0
- package/esm/table/motable.js +13 -0
- package/esm/table/paste.js +2 -0
- package/esm/table/render.js +2 -0
- package/esm/table/resource.js +1 -1
- package/esm/table/sdk.js +1 -1
- package/esm/table/shortcuts.js +2 -0
- package/esm/table/snapshot.js +2 -0
- package/esm/table/subscription.js +22 -0
- package/esm/table/table.js +1 -1
- package/esm/table/template.js +2 -0
- package/esm/table/toolbar.js +1 -1
- package/esm/table/toolbox.js +2 -0
- package/esm/table/ui.js +2 -0
- package/esm/table/version.js +2 -0
- package/esm/table/view.js +23 -0
- package/esm/table/window.js +2 -0
- package/package.json +6 -1
- package/types/combine.d.ts +2985 -265
- package/types/diagram.d.ts +823 -115
- package/types/docs.d.ts +850 -115
- package/types/docx.d.ts +1096 -119
- package/types/form.d.ts +3027 -0
- package/types/pdf.d.ts +829 -115
- package/types/presentation.d.ts +1088 -129
- package/types/shared.d.ts +823 -115
- package/types/sheet.d.ts +1112 -161
- package/types/table.d.ts +2097 -173
- package/cjs/shared/checkpoints.js +0 -19
- package/cjs/sheet/comments.js +0 -3
- package/cjs/sheet/font.js +0 -3
- package/esm/shared/checkpoints.js +0 -16
- package/esm/sheet/comments.js +0 -2
- package/esm/sheet/font.js +0 -2
package/types/combine.d.ts
CHANGED
|
@@ -44,6 +44,10 @@ export declare abstract class AbstractedDocxSDK extends EditorSDK {
|
|
|
44
44
|
* 打印文档
|
|
45
45
|
*/
|
|
46
46
|
abstract print(): Promise<void>;
|
|
47
|
+
/**
|
|
48
|
+
* 导出文档
|
|
49
|
+
*/
|
|
50
|
+
abstract export(type: string): Promise<void>;
|
|
47
51
|
/**
|
|
48
52
|
* 文档目录集合接口,
|
|
49
53
|
* 一个文档中可以存在多个目录,这个接口是用来管理文档中的所有目录的。
|
|
@@ -77,6 +81,10 @@ export declare abstract class AbstractedDocxSDK extends EditorSDK {
|
|
|
77
81
|
* 搜索接口
|
|
78
82
|
*/
|
|
79
83
|
abstract get search(): DocxSearch;
|
|
84
|
+
/**
|
|
85
|
+
* 文档统计接口
|
|
86
|
+
*/
|
|
87
|
+
abstract get statistic(): DocxStatistic;
|
|
80
88
|
}
|
|
81
89
|
|
|
82
90
|
export declare abstract class AbstractedEditorFileUploader {
|
|
@@ -170,6 +178,18 @@ export declare abstract class AbstractedPresentationSDK extends EditorSDK {
|
|
|
170
178
|
* 文本格式接口
|
|
171
179
|
*/
|
|
172
180
|
abstract get text(): PresentationText;
|
|
181
|
+
/**
|
|
182
|
+
* 幻灯片评论接口
|
|
183
|
+
*/
|
|
184
|
+
abstract get comments(): PresentationComments;
|
|
185
|
+
/**
|
|
186
|
+
* 事件订阅接口
|
|
187
|
+
*/
|
|
188
|
+
abstract get eventSubscription(): PresentationEventSubscription;
|
|
189
|
+
/**
|
|
190
|
+
* 幻灯片演示模式接口
|
|
191
|
+
*/
|
|
192
|
+
abstract get presentation(): PresentationOfPresentation;
|
|
173
193
|
}
|
|
174
194
|
|
|
175
195
|
export declare abstract class AbstractedSheetSDK extends EditorSDK {
|
|
@@ -182,17 +202,22 @@ export declare abstract class AbstractedSheetSDK extends EditorSDK {
|
|
|
182
202
|
*/
|
|
183
203
|
abstract print(): Promise<void>;
|
|
184
204
|
/**
|
|
185
|
-
*
|
|
205
|
+
* 导出接口
|
|
206
|
+
* @param type 导出类型 image、pdf、或者export options supportedTypes中限定的类型
|
|
186
207
|
*/
|
|
187
|
-
abstract
|
|
208
|
+
abstract export(type: string): Promise<void>;
|
|
188
209
|
/**
|
|
189
|
-
*
|
|
210
|
+
* 更新表格runtime env(web worker)
|
|
190
211
|
*/
|
|
191
|
-
abstract
|
|
212
|
+
abstract updateRuntimeEnv(env: Record<string, unknown>): Promise<void>;
|
|
192
213
|
/**
|
|
193
|
-
*
|
|
214
|
+
* 设置表格标题
|
|
194
215
|
*/
|
|
195
|
-
abstract
|
|
216
|
+
abstract setTitle(title: string): Promise<void>;
|
|
217
|
+
/**
|
|
218
|
+
* 设置表格是否聚焦
|
|
219
|
+
*/
|
|
220
|
+
abstract setFocus(isFocus: boolean): Promise<void>;
|
|
196
221
|
/**
|
|
197
222
|
* 工作簿接口
|
|
198
223
|
*/
|
|
@@ -213,10 +238,6 @@ export declare abstract class AbstractedSheetSDK extends EditorSDK {
|
|
|
213
238
|
* 文本格式接口
|
|
214
239
|
*/
|
|
215
240
|
abstract get text(): SheetText;
|
|
216
|
-
/**
|
|
217
|
-
* 评论接口
|
|
218
|
-
*/
|
|
219
|
-
abstract get comments(): SheetComments | undefined;
|
|
220
241
|
/**
|
|
221
242
|
* 锁定接口
|
|
222
243
|
*/
|
|
@@ -229,9 +250,13 @@ export declare abstract class AbstractedSheetSDK extends EditorSDK {
|
|
|
229
250
|
* 跟随模式接口
|
|
230
251
|
*/
|
|
231
252
|
abstract get followMode(): EditorFollowMode | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* 事件订阅接口
|
|
255
|
+
*/
|
|
256
|
+
abstract get eventSubscription(): SheetEventSubscription;
|
|
232
257
|
}
|
|
233
258
|
|
|
234
|
-
export declare abstract class AbstractedTableSDK implements Omit<EditorSDK, 'content'> {
|
|
259
|
+
export declare abstract class AbstractedTableSDK implements Omit<EditorSDK, 'content' | 'menu' | 'presentation'> {
|
|
235
260
|
protected options: TableEditorOptions;
|
|
236
261
|
constructor(options: TableEditorOptions);
|
|
237
262
|
/**
|
|
@@ -276,6 +301,10 @@ export declare abstract class AbstractedTableSDK implements Omit<EditorSDK, 'con
|
|
|
276
301
|
* 编辑器历史相关接口
|
|
277
302
|
*/
|
|
278
303
|
abstract get history(): EditorHistory;
|
|
304
|
+
/**
|
|
305
|
+
* 编辑器协作相关
|
|
306
|
+
*/
|
|
307
|
+
abstract get collaboration(): EditorCollaborationOptions;
|
|
279
308
|
/**
|
|
280
309
|
* 编辑器协作者相关接口
|
|
281
310
|
*/
|
|
@@ -284,6 +313,23 @@ export declare abstract class AbstractedTableSDK implements Omit<EditorSDK, 'con
|
|
|
284
313
|
* 编辑器版本相关接口
|
|
285
314
|
*/
|
|
286
315
|
abstract get version(): EditorVersion;
|
|
316
|
+
/**
|
|
317
|
+
* 视图相关接口
|
|
318
|
+
*/
|
|
319
|
+
abstract get view(): TableView;
|
|
320
|
+
/**
|
|
321
|
+
* 窗口相关接口
|
|
322
|
+
*/
|
|
323
|
+
abstract get window(): TableWindow;
|
|
324
|
+
/**
|
|
325
|
+
* 订阅事件
|
|
326
|
+
*/
|
|
327
|
+
abstract get subscription(): TableSubscription;
|
|
328
|
+
/**
|
|
329
|
+
* 导出表格文件
|
|
330
|
+
* @param type 导出类型,'sheets'(转化为石墨表格)或 'excel'(下载为 Excel 格式)
|
|
331
|
+
*/
|
|
332
|
+
abstract export(type: 'sheets' | 'excel'): Promise<void>;
|
|
287
333
|
}
|
|
288
334
|
|
|
289
335
|
export declare interface AddRangeLockParams {
|
|
@@ -329,16 +375,6 @@ export declare type CalendarMenuItemName =
|
|
|
329
375
|
/** 删除记录 */
|
|
330
376
|
| 'remove';
|
|
331
377
|
|
|
332
|
-
export declare type CheckLimitationResult = {
|
|
333
|
-
status: 'limited';
|
|
334
|
-
/**
|
|
335
|
-
* 被限制原因
|
|
336
|
-
*/
|
|
337
|
-
reason?: string;
|
|
338
|
-
} | {
|
|
339
|
-
status: 'unlimited';
|
|
340
|
-
};
|
|
341
|
-
|
|
342
378
|
export declare interface ClipboardPasteParams {
|
|
343
379
|
/**
|
|
344
380
|
* 粘贴的html内容
|
|
@@ -389,12 +425,22 @@ export declare interface ConfirmButtonConfig {
|
|
|
389
425
|
onClick?: () => void;
|
|
390
426
|
}
|
|
391
427
|
|
|
428
|
+
/**
|
|
429
|
+
* 表格数据对象接口
|
|
430
|
+
*/
|
|
392
431
|
export declare interface DBTable {
|
|
393
432
|
/**
|
|
394
|
-
*
|
|
395
|
-
* @returns
|
|
433
|
+
* 获取当前表格选区
|
|
396
434
|
*/
|
|
397
435
|
get selection(): TableSelection | null;
|
|
436
|
+
/**
|
|
437
|
+
* 撤销
|
|
438
|
+
*/
|
|
439
|
+
undo: () => void;
|
|
440
|
+
/**
|
|
441
|
+
* 重做
|
|
442
|
+
*/
|
|
443
|
+
redo: () => void;
|
|
398
444
|
}
|
|
399
445
|
|
|
400
446
|
/**
|
|
@@ -567,6 +613,33 @@ export declare interface DocsSDKOptions extends EditorOptions {
|
|
|
567
613
|
* 文档信息配置
|
|
568
614
|
*/
|
|
569
615
|
info?: DocsInfoOptions;
|
|
616
|
+
/**
|
|
617
|
+
* 缩放比例
|
|
618
|
+
*/
|
|
619
|
+
zoom?: number;
|
|
620
|
+
/**
|
|
621
|
+
* 纸张相关设置
|
|
622
|
+
*/
|
|
623
|
+
pages: {
|
|
624
|
+
width: 'standard' | 'wide' | 'full';
|
|
625
|
+
};
|
|
626
|
+
/**
|
|
627
|
+
* 默认的文档样式,包括字体字号等等
|
|
628
|
+
*/
|
|
629
|
+
defaultStyle?: {
|
|
630
|
+
color: string;
|
|
631
|
+
font: string;
|
|
632
|
+
linespacing: string;
|
|
633
|
+
size: string;
|
|
634
|
+
};
|
|
635
|
+
footer?: {
|
|
636
|
+
logo?: string;
|
|
637
|
+
viewsText?: string;
|
|
638
|
+
};
|
|
639
|
+
/**
|
|
640
|
+
* 错误处理回调
|
|
641
|
+
*/
|
|
642
|
+
errorHandler?: (context: string, err: Error, extra?: Record<string, string>) => void;
|
|
570
643
|
}
|
|
571
644
|
|
|
572
645
|
/**
|
|
@@ -779,7 +852,7 @@ export declare type DocxMenuEntryConfig<T extends EditorMenuItemType = EditorMen
|
|
|
779
852
|
/**
|
|
780
853
|
* 传统文档菜单栏内置功能按钮
|
|
781
854
|
*/
|
|
782
|
-
export declare type DocxMenuFeatureButtonName = 'file' | 'edit' | 'view' | 'insert' | 'format' | 'design' | 'transform-file' | 'plugins' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'exportWord' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'insertAttachment' | 'insertFilesFromDrive' | 'insertSignature' | 'insertImage' | 'insertImageFromLocal' | 'insertImageFromUrl' | 'enableEditingRestriction';
|
|
855
|
+
export declare type DocxMenuFeatureButtonName = 'file' | 'edit' | 'view' | 'insert' | 'format' | 'design' | 'transform-file' | 'plugins' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'exportWord' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'print' | 'viewFileInfo' | 'insertAttachment' | 'insertFilesFromDrive' | 'insertSignature' | 'insertImage' | 'insertImageFromLocal' | 'insertImageFromUrl' | 'enableEditingRestriction';
|
|
783
856
|
|
|
784
857
|
export declare type DocxMenuFeatureConfig = EditorMenuFeatureConfig;
|
|
785
858
|
|
|
@@ -802,7 +875,137 @@ export declare type DocxOutlineItem = EditorOutlineItem<{
|
|
|
802
875
|
text: string;
|
|
803
876
|
}>;
|
|
804
877
|
|
|
805
|
-
export declare
|
|
878
|
+
export declare interface DocxOutlineOptions extends EditorOutlineOptions {
|
|
879
|
+
/**
|
|
880
|
+
* 是否为特殊模式
|
|
881
|
+
*
|
|
882
|
+
* 对应shark项目中的isTocNormalMode函数逻辑(取反)
|
|
883
|
+
*
|
|
884
|
+
* 目前还不知道此逻辑主要作用,但是按照之前的判断,此配置为true时,应该在移动端或者【来自分享且无编辑和评论权限】的情况。
|
|
885
|
+
*
|
|
886
|
+
* 特定配置,其他地方避免使用。
|
|
887
|
+
*/
|
|
888
|
+
isSpecialMode?: boolean;
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
/**
|
|
892
|
+
* 页面Bounding属性
|
|
893
|
+
*/
|
|
894
|
+
export declare interface DocxPageBounding {
|
|
895
|
+
top: number;
|
|
896
|
+
right: number;
|
|
897
|
+
bottom: number;
|
|
898
|
+
left: number;
|
|
899
|
+
width: number;
|
|
900
|
+
height: number;
|
|
901
|
+
}
|
|
902
|
+
|
|
903
|
+
/**
|
|
904
|
+
* 传统文档页对象
|
|
905
|
+
*/
|
|
906
|
+
export declare interface DocxPageItem {
|
|
907
|
+
/**
|
|
908
|
+
* 获取页的索引
|
|
909
|
+
* @returns 页的索引
|
|
910
|
+
*/
|
|
911
|
+
getPageIndex: () => Promise<number>;
|
|
912
|
+
/**
|
|
913
|
+
* 获取页的方向
|
|
914
|
+
* @returns
|
|
915
|
+
*/
|
|
916
|
+
getOrient: () => Promise<DocxPageOrient>;
|
|
917
|
+
/**
|
|
918
|
+
* 获取页面Bounding(相对于当前视口)
|
|
919
|
+
* @param options.unit 单位: 'px' | 'mm' 默认为px
|
|
920
|
+
* @returns
|
|
921
|
+
*/
|
|
922
|
+
getBounding: (options?: DocxPageItemBaseOptions) => Promise<DocxPageBounding>;
|
|
923
|
+
/**
|
|
924
|
+
* 获取页边距
|
|
925
|
+
* @param options.unit 单位: 'px' | 'mm' 默认为px
|
|
926
|
+
* @returns
|
|
927
|
+
*/
|
|
928
|
+
getMargin: (options?: DocxPageItemBaseOptions) => Promise<DocxPageMargin>;
|
|
929
|
+
}
|
|
930
|
+
|
|
931
|
+
/**
|
|
932
|
+
* 页的方法基础配置项
|
|
933
|
+
*/
|
|
934
|
+
export declare interface DocxPageItemBaseOptions {
|
|
935
|
+
/**
|
|
936
|
+
* 单位
|
|
937
|
+
*/
|
|
938
|
+
unit?: 'px' | 'mm';
|
|
939
|
+
}
|
|
940
|
+
|
|
941
|
+
/**
|
|
942
|
+
* 页边距属性
|
|
943
|
+
*/
|
|
944
|
+
export declare interface DocxPageMargin {
|
|
945
|
+
top: number;
|
|
946
|
+
right: number;
|
|
947
|
+
bottom: number;
|
|
948
|
+
left: number;
|
|
949
|
+
}
|
|
950
|
+
|
|
951
|
+
/**
|
|
952
|
+
* 传统文档页的方向枚举
|
|
953
|
+
*/
|
|
954
|
+
export declare enum DocxPageOrient {
|
|
955
|
+
/**
|
|
956
|
+
* 横向
|
|
957
|
+
*/
|
|
958
|
+
HORIZONTAL = 1,
|
|
959
|
+
/**
|
|
960
|
+
* 纵向
|
|
961
|
+
*/
|
|
962
|
+
VERTICAL = 2
|
|
963
|
+
}
|
|
964
|
+
|
|
965
|
+
/**
|
|
966
|
+
* 传统文档页列表接口,
|
|
967
|
+
* 表示文档中的所有页,
|
|
968
|
+
*/
|
|
969
|
+
export declare interface DocxPages {
|
|
970
|
+
/**
|
|
971
|
+
* 获取所有页列表
|
|
972
|
+
* @returns 页列表
|
|
973
|
+
*/
|
|
974
|
+
getAll: () => Promise<DocxPageItem[]>;
|
|
975
|
+
/**
|
|
976
|
+
* 获取某个页对象
|
|
977
|
+
* @param index 页对象索引
|
|
978
|
+
* @returns 页对象
|
|
979
|
+
*/
|
|
980
|
+
getOne: (index: number) => Promise<DocxPageItem | null>;
|
|
981
|
+
}
|
|
982
|
+
|
|
983
|
+
export declare interface DocxParagraphItem {
|
|
984
|
+
/**
|
|
985
|
+
* 获取段落范围(Range)
|
|
986
|
+
* @returns 段落范围
|
|
987
|
+
*/
|
|
988
|
+
getRange: () => Promise<DocxRange>;
|
|
989
|
+
}
|
|
990
|
+
|
|
991
|
+
export declare interface DocxParagraphs {
|
|
992
|
+
/**
|
|
993
|
+
* 获取所有段落列表
|
|
994
|
+
* @returns 段落列表
|
|
995
|
+
*/
|
|
996
|
+
getAll: () => Promise<DocxParagraphItem[]>;
|
|
997
|
+
/**
|
|
998
|
+
* 获取某个段落对象
|
|
999
|
+
* @param index 段落对象索引
|
|
1000
|
+
* @returns 段落对象
|
|
1001
|
+
*/
|
|
1002
|
+
getOne: (index: number) => Promise<DocxParagraphItem | null>;
|
|
1003
|
+
/**
|
|
1004
|
+
* 获取段落数量
|
|
1005
|
+
* @returns 段落数量
|
|
1006
|
+
*/
|
|
1007
|
+
count: () => Promise<number>;
|
|
1008
|
+
}
|
|
806
1009
|
|
|
807
1010
|
/**
|
|
808
1011
|
* 区域(Range)
|
|
@@ -939,6 +1142,11 @@ export declare interface DocxReplaceResult {
|
|
|
939
1142
|
oldValue: string;
|
|
940
1143
|
}
|
|
941
1144
|
|
|
1145
|
+
/**
|
|
1146
|
+
* 修订功能相关配置
|
|
1147
|
+
*/
|
|
1148
|
+
export declare type DocxRevisionOptions = EditorFeatureConfig;
|
|
1149
|
+
|
|
942
1150
|
export declare interface DocxSDKOptions extends EditorOptions {
|
|
943
1151
|
/**
|
|
944
1152
|
* 文档信息配置
|
|
@@ -976,6 +1184,18 @@ export declare interface DocxSDKOptions extends EditorOptions {
|
|
|
976
1184
|
* 工具栏设置
|
|
977
1185
|
*/
|
|
978
1186
|
toolbar?: DocxToolbarOptions;
|
|
1187
|
+
/**
|
|
1188
|
+
* 签名相关配置
|
|
1189
|
+
*/
|
|
1190
|
+
signature?: DocxSignatureOptions;
|
|
1191
|
+
/**
|
|
1192
|
+
* 文档UI相关设置
|
|
1193
|
+
*/
|
|
1194
|
+
ui?: DocxUiOptions;
|
|
1195
|
+
/**
|
|
1196
|
+
* 修订相关配置
|
|
1197
|
+
*/
|
|
1198
|
+
revisions?: DocxRevisionOptions;
|
|
979
1199
|
}
|
|
980
1200
|
|
|
981
1201
|
/**
|
|
@@ -1098,6 +1318,48 @@ export declare interface DocxSelection {
|
|
|
1098
1318
|
insertHtml: (html: string) => DocxRangeValue;
|
|
1099
1319
|
}
|
|
1100
1320
|
|
|
1321
|
+
/**
|
|
1322
|
+
* 文档签名相关设置
|
|
1323
|
+
*/
|
|
1324
|
+
export declare type DocxSignatureOptions = EditorFeatureConfig;
|
|
1325
|
+
|
|
1326
|
+
/**
|
|
1327
|
+
* 文档统计接口
|
|
1328
|
+
*/
|
|
1329
|
+
export declare interface DocxStatistic {
|
|
1330
|
+
getStatistic: () => Promise<DocxStatisticValue>;
|
|
1331
|
+
}
|
|
1332
|
+
|
|
1333
|
+
/**
|
|
1334
|
+
* 文档统计值
|
|
1335
|
+
*/
|
|
1336
|
+
export declare interface DocxStatisticValue {
|
|
1337
|
+
/**
|
|
1338
|
+
* 文档字数
|
|
1339
|
+
*/
|
|
1340
|
+
wordCount: number;
|
|
1341
|
+
/**
|
|
1342
|
+
* 文档页数
|
|
1343
|
+
*/
|
|
1344
|
+
pageCount: number;
|
|
1345
|
+
/**
|
|
1346
|
+
* 文档段落数
|
|
1347
|
+
*/
|
|
1348
|
+
paragraphCount: number;
|
|
1349
|
+
/**
|
|
1350
|
+
* 文档字符数(包含空格)
|
|
1351
|
+
*/
|
|
1352
|
+
charCount: number;
|
|
1353
|
+
/**
|
|
1354
|
+
* 文档字符数(不包含空格)
|
|
1355
|
+
*/
|
|
1356
|
+
charCountWithoutSpace: number;
|
|
1357
|
+
/**
|
|
1358
|
+
* 文档节数
|
|
1359
|
+
*/
|
|
1360
|
+
sectionCount: number;
|
|
1361
|
+
}
|
|
1362
|
+
|
|
1101
1363
|
/**
|
|
1102
1364
|
* 传统文档文本接口
|
|
1103
1365
|
*/
|
|
@@ -1144,7 +1406,7 @@ export declare interface DocxTextWatermark {
|
|
|
1144
1406
|
}
|
|
1145
1407
|
|
|
1146
1408
|
export declare interface DocxThemeFont {
|
|
1147
|
-
typeface
|
|
1409
|
+
typeface?: string;
|
|
1148
1410
|
}
|
|
1149
1411
|
|
|
1150
1412
|
/**
|
|
@@ -1225,9 +1487,38 @@ export declare interface DocxThemeOptions {
|
|
|
1225
1487
|
*/
|
|
1226
1488
|
get?: (id?: string) => Promise<DocxThemeFontsScheme | null>;
|
|
1227
1489
|
};
|
|
1490
|
+
/**
|
|
1491
|
+
* 文档样式设置。
|
|
1492
|
+
* 增量设置,docx内部会有一个默认配置。
|
|
1493
|
+
*/
|
|
1494
|
+
styles?: Omit<{
|
|
1495
|
+
[key in EditorModeType]?: DocxThemeStyleConfigList;
|
|
1496
|
+
}, 'standard'> & {
|
|
1497
|
+
standard?: {
|
|
1498
|
+
[key in EditorStandardRole]?: DocxThemeStyleConfigList;
|
|
1499
|
+
};
|
|
1500
|
+
};
|
|
1228
1501
|
};
|
|
1229
1502
|
}
|
|
1230
1503
|
|
|
1504
|
+
/**
|
|
1505
|
+
* 主题样式配置对象
|
|
1506
|
+
*/
|
|
1507
|
+
export declare type DocxThemeStyleConfig = Partial<Record<DocxThemeStyleKeys, string>>;
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* 主题样式配置列表,区分默认样式(PC端)和紧凑模式(移动端)
|
|
1511
|
+
*/
|
|
1512
|
+
export declare interface DocxThemeStyleConfigList {
|
|
1513
|
+
normal?: DocxThemeStyleConfig;
|
|
1514
|
+
compact?: DocxThemeStyleConfig;
|
|
1515
|
+
}
|
|
1516
|
+
|
|
1517
|
+
/**
|
|
1518
|
+
* 主题样式配置项
|
|
1519
|
+
*/
|
|
1520
|
+
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';
|
|
1521
|
+
|
|
1231
1522
|
/**
|
|
1232
1523
|
* 通用目录项条目
|
|
1233
1524
|
*/
|
|
@@ -1424,6 +1715,49 @@ export declare type DocxToolbarFeatureButtonName =
|
|
|
1424
1715
|
*/
|
|
1425
1716
|
export declare type DocxToolbarOptions = EditorToolbarOptions<DocxToolbarFeatureButtonName>;
|
|
1426
1717
|
|
|
1718
|
+
export declare type DocxUiAttachmentMenuFeatureButtonName = 'download';
|
|
1719
|
+
|
|
1720
|
+
export declare type DocxUiAttachmentPreviewMenuFeatureButtonName = 'download';
|
|
1721
|
+
|
|
1722
|
+
export declare type DocxUiHistoryMoreMenuFeatureButtonName = 'restore' | 'duplicate' | 'print' | 'export' | 'exportWord' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF';
|
|
1723
|
+
|
|
1724
|
+
export declare type DocxUiImageGallaryMenuFeatureButtonName = 'download';
|
|
1725
|
+
|
|
1726
|
+
export declare interface DocxUiOptions extends EditorUiOptions {
|
|
1727
|
+
/**
|
|
1728
|
+
* 历史记录列表更多菜单配置
|
|
1729
|
+
* 用于配置文档历史版本的更多操作菜单
|
|
1730
|
+
*/
|
|
1731
|
+
historyMoreMenu?: EditorMenuOptions<DocxUiHistoryMoreMenuFeatureButtonName>;
|
|
1732
|
+
/**
|
|
1733
|
+
* 版本列表更多菜单项配置
|
|
1734
|
+
* 用于配置文档版本列表的更多操作菜单
|
|
1735
|
+
*/
|
|
1736
|
+
versionMoreMenu?: EditorMenuOptions<DocxUiVersionMoreMenuFeatureButtonName>;
|
|
1737
|
+
/**
|
|
1738
|
+
* 附件操作菜单配置
|
|
1739
|
+
* 用于配置文档中附件鼠标悬浮时的操作菜单
|
|
1740
|
+
*/
|
|
1741
|
+
attachmentMenu?: EditorMenuOptions<DocxUiAttachmentMenuFeatureButtonName>;
|
|
1742
|
+
/**
|
|
1743
|
+
* 附件预览菜单配置
|
|
1744
|
+
* 用于配置附件预览窗口打开时里面的操作菜单
|
|
1745
|
+
*/
|
|
1746
|
+
attachmentPreviewMenu?: EditorMenuOptions<DocxUiAttachmentPreviewMenuFeatureButtonName>;
|
|
1747
|
+
/**
|
|
1748
|
+
* 文档信息栏配置
|
|
1749
|
+
* 用于配置底部文档信息栏的显示与隐藏
|
|
1750
|
+
*/
|
|
1751
|
+
documentInfoBar?: {
|
|
1752
|
+
/**
|
|
1753
|
+
* 是否禁用文档信息栏
|
|
1754
|
+
*/
|
|
1755
|
+
disabled?: boolean;
|
|
1756
|
+
};
|
|
1757
|
+
}
|
|
1758
|
+
|
|
1759
|
+
export declare type DocxUiVersionMoreMenuFeatureButtonName = 'rename' | 'duplicate' | 'print' | 'export' | 'exportWord' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'delete';
|
|
1760
|
+
|
|
1427
1761
|
/**
|
|
1428
1762
|
* 文本水印操作接口,
|
|
1429
1763
|
* 水印属于文档的一种特殊业务,水印是 OOXML 是形状的一种业务形态封装,
|
|
@@ -1711,7 +2045,7 @@ export declare interface EditorAssetsOssImageProcessing {
|
|
|
1711
2045
|
quality?: number;
|
|
1712
2046
|
maxWidth?: number;
|
|
1713
2047
|
maxHeight?: number;
|
|
1714
|
-
}) =>
|
|
2048
|
+
}) => string;
|
|
1715
2049
|
/**
|
|
1716
2050
|
* 裁切图片的方法
|
|
1717
2051
|
* @param imageUrl 图片的 URL
|
|
@@ -1719,12 +2053,12 @@ export declare interface EditorAssetsOssImageProcessing {
|
|
|
1719
2053
|
* @returns 裁切后的图片 URL
|
|
1720
2054
|
*/
|
|
1721
2055
|
crop: (imageUrl: string, cropOptions: {
|
|
1722
|
-
x
|
|
1723
|
-
y
|
|
2056
|
+
x: number;
|
|
2057
|
+
y: number;
|
|
1724
2058
|
w: number;
|
|
1725
2059
|
h: number;
|
|
1726
|
-
g
|
|
1727
|
-
}) =>
|
|
2060
|
+
g: EditorImageCropPoint;
|
|
2061
|
+
}) => string;
|
|
1728
2062
|
}
|
|
1729
2063
|
|
|
1730
2064
|
export declare interface EditorAssetsResolver {
|
|
@@ -1733,13 +2067,13 @@ export declare interface EditorAssetsResolver {
|
|
|
1733
2067
|
* @param assetId 资源文件 ID
|
|
1734
2068
|
* @returns 转换后的资源 URL ,如果无法转换则返回 null
|
|
1735
2069
|
*/
|
|
1736
|
-
resolveUrl: (assetId: string) =>
|
|
2070
|
+
resolveUrl: (assetId: string) => string | null;
|
|
1737
2071
|
/**
|
|
1738
2072
|
* 从 URL 中解析资源文件 ID 的方法
|
|
1739
2073
|
* @param url 资源 URL
|
|
1740
2074
|
* @returns 解析出的资源文件 ID
|
|
1741
2075
|
*/
|
|
1742
|
-
parseId: (url: string) =>
|
|
2076
|
+
parseId: (url: string) => string | null;
|
|
1743
2077
|
/**
|
|
1744
2078
|
* 检查资源文件 ID 对应的文件是否准备就绪,
|
|
1745
2079
|
* 在部分环境中,资源文件需要异步导入,在编辑器加载的时候可能还未准备就绪
|
|
@@ -1749,6 +2083,28 @@ export declare interface EditorAssetsResolver {
|
|
|
1749
2083
|
checkAssetReady: (assetId: string) => Promise<boolean> | boolean;
|
|
1750
2084
|
}
|
|
1751
2085
|
|
|
2086
|
+
/**
|
|
2087
|
+
* 编辑器附件下载配置
|
|
2088
|
+
*/
|
|
2089
|
+
export declare interface EditorAttachmentDownloadOptions {
|
|
2090
|
+
/**
|
|
2091
|
+
* 是否禁用下载
|
|
2092
|
+
*/
|
|
2093
|
+
disabled?: boolean;
|
|
2094
|
+
/**
|
|
2095
|
+
* 是否跳过验证
|
|
2096
|
+
*/
|
|
2097
|
+
skipValidate?: boolean;
|
|
2098
|
+
/**
|
|
2099
|
+
* 下载附件
|
|
2100
|
+
*/
|
|
2101
|
+
download?: (url: string) => void;
|
|
2102
|
+
/**
|
|
2103
|
+
* 获取附件下载地址
|
|
2104
|
+
*/
|
|
2105
|
+
getDownloadUrl?: (url: string) => Promise<string>;
|
|
2106
|
+
}
|
|
2107
|
+
|
|
1752
2108
|
/**
|
|
1753
2109
|
* 编辑器附件限制配置,sdk中会使用在不同的场景下使用不同的限制规则组合
|
|
1754
2110
|
*/
|
|
@@ -1758,9 +2114,9 @@ export declare interface EditorAttachmentLimitationOptions {
|
|
|
1758
2114
|
* @param file
|
|
1759
2115
|
* @returns
|
|
1760
2116
|
*/
|
|
1761
|
-
checkFile
|
|
2117
|
+
checkFile?: (params: EditorAttachmentLimitationOptionsCheckFunctionParams) => Promise<{
|
|
1762
2118
|
limited: true;
|
|
1763
|
-
message
|
|
2119
|
+
message?: string;
|
|
1764
2120
|
} | {
|
|
1765
2121
|
limited: false;
|
|
1766
2122
|
}>;
|
|
@@ -1809,9 +2165,24 @@ export declare interface EditorAttachmentMaxSizeOptions {
|
|
|
1809
2165
|
* 编辑器附件信息
|
|
1810
2166
|
*/
|
|
1811
2167
|
export declare interface EditorAttachmentOptions {
|
|
2168
|
+
/**
|
|
2169
|
+
* 附件选择器
|
|
2170
|
+
*/
|
|
1812
2171
|
picker?: EditorFilePicker;
|
|
2172
|
+
/**
|
|
2173
|
+
* 附件上传器
|
|
2174
|
+
*/
|
|
1813
2175
|
uploader?: AbstractedEditorFileUploader;
|
|
2176
|
+
/**
|
|
2177
|
+
* 下载
|
|
2178
|
+
* @deprecated, 使用不同类型附件的download配置
|
|
2179
|
+
*/
|
|
1814
2180
|
download?: (url: string) => void;
|
|
2181
|
+
/**
|
|
2182
|
+
* 预览
|
|
2183
|
+
* @deprecated, 使用不同类型附件的preview配置
|
|
2184
|
+
*/
|
|
2185
|
+
preview?: (url: string) => void;
|
|
1815
2186
|
/**
|
|
1816
2187
|
* 图片附件相关配置
|
|
1817
2188
|
*/
|
|
@@ -1829,9 +2200,27 @@ export declare interface EditorAttachmentOptions {
|
|
|
1829
2200
|
* 图片附件的限制配置
|
|
1830
2201
|
*/
|
|
1831
2202
|
limitations?: EditorAttachmentLimitationOptions;
|
|
2203
|
+
/**
|
|
2204
|
+
* 禁止预览
|
|
2205
|
+
* @deprecated 使用preview.disabled代替
|
|
2206
|
+
*/
|
|
2207
|
+
disablePreview?: boolean;
|
|
2208
|
+
/**
|
|
2209
|
+
* 预览
|
|
2210
|
+
*/
|
|
2211
|
+
preview?: EditorAttachmentPreviewOptions;
|
|
2212
|
+
/**
|
|
2213
|
+
* 下载
|
|
2214
|
+
*/
|
|
2215
|
+
download?: EditorAttachmentDownloadOptions;
|
|
2216
|
+
/**
|
|
2217
|
+
* 是否禁用缩略图
|
|
2218
|
+
* 桌面客户端/极速sdk需要禁用
|
|
2219
|
+
*/
|
|
2220
|
+
disableThumbnail?: boolean;
|
|
1832
2221
|
};
|
|
1833
2222
|
/**
|
|
1834
|
-
*
|
|
2223
|
+
* 附件相关配置
|
|
1835
2224
|
*/
|
|
1836
2225
|
attachment?: {
|
|
1837
2226
|
/**
|
|
@@ -1847,60 +2236,135 @@ export declare interface EditorAttachmentOptions {
|
|
|
1847
2236
|
* 附件的限制配置
|
|
1848
2237
|
*/
|
|
1849
2238
|
limitations?: EditorAttachmentLimitationOptions;
|
|
2239
|
+
/**
|
|
2240
|
+
* 禁止预览
|
|
2241
|
+
* @deprecated 使用preview.disabled代替
|
|
2242
|
+
*/
|
|
2243
|
+
disablePreview?: boolean;
|
|
2244
|
+
/**
|
|
2245
|
+
* 预览
|
|
2246
|
+
*/
|
|
2247
|
+
preview?: EditorAttachmentPreviewOptions;
|
|
2248
|
+
/**
|
|
2249
|
+
* 下载
|
|
2250
|
+
*/
|
|
2251
|
+
download?: EditorAttachmentDownloadOptions;
|
|
1850
2252
|
};
|
|
1851
|
-
}
|
|
1852
|
-
|
|
1853
|
-
/**
|
|
1854
|
-
* 基础文件属性
|
|
1855
|
-
*/
|
|
1856
|
-
export declare interface EditorBaseUploadableFile {
|
|
1857
|
-
secretly?: boolean;
|
|
1858
|
-
bucket: 'images' | 'attachments';
|
|
1859
|
-
encrypt: string;
|
|
1860
|
-
fileGuid: string;
|
|
1861
|
-
}
|
|
1862
|
-
|
|
1863
|
-
/**
|
|
1864
|
-
* 品牌相关设置,
|
|
1865
|
-
* 用于在套件中展示品牌外露信息
|
|
1866
|
-
*/
|
|
1867
|
-
export declare interface EditorBrandOptions {
|
|
1868
2253
|
/**
|
|
1869
|
-
*
|
|
2254
|
+
* 视频相关配置
|
|
1870
2255
|
*/
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
2256
|
+
video?: {
|
|
2257
|
+
/**
|
|
2258
|
+
* 支持的视频格式
|
|
2259
|
+
*/
|
|
2260
|
+
supportTypes?: string[];
|
|
2261
|
+
/**
|
|
2262
|
+
* 视频的限制配置
|
|
2263
|
+
*/
|
|
2264
|
+
limitations?: EditorAttachmentLimitationOptions;
|
|
2265
|
+
/**
|
|
2266
|
+
* 预览
|
|
2267
|
+
*/
|
|
2268
|
+
preview?: EditorAttachmentPreviewOptions;
|
|
2269
|
+
/**
|
|
2270
|
+
* 下载
|
|
2271
|
+
*/
|
|
2272
|
+
download?: EditorAttachmentDownloadOptions;
|
|
2273
|
+
};
|
|
1879
2274
|
/**
|
|
1880
|
-
*
|
|
2275
|
+
* 音频相关配置
|
|
1881
2276
|
*/
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
2277
|
+
audio?: {
|
|
2278
|
+
/**
|
|
2279
|
+
* 支持的音频
|
|
2280
|
+
*/
|
|
2281
|
+
supportTypes?: string[];
|
|
2282
|
+
/**
|
|
2283
|
+
* 音频的限制配置
|
|
2284
|
+
*/
|
|
2285
|
+
limitations?: EditorAttachmentLimitationOptions;
|
|
2286
|
+
/**
|
|
2287
|
+
* 预览
|
|
2288
|
+
*/
|
|
2289
|
+
preview?: EditorAttachmentPreviewOptions;
|
|
2290
|
+
/**
|
|
2291
|
+
* 下载
|
|
2292
|
+
*/
|
|
2293
|
+
download?: EditorAttachmentDownloadOptions;
|
|
2294
|
+
};
|
|
2295
|
+
/**
|
|
2296
|
+
* 云文件附件相关配置
|
|
2297
|
+
*/
|
|
2298
|
+
cloudFile?: {
|
|
2299
|
+
/**
|
|
2300
|
+
* 是否禁用云文件
|
|
2301
|
+
*/
|
|
2302
|
+
disabled?: boolean;
|
|
1885
2303
|
};
|
|
1886
2304
|
}
|
|
1887
2305
|
|
|
1888
|
-
|
|
2306
|
+
/**
|
|
2307
|
+
* 编辑器附件预览配置
|
|
2308
|
+
*/
|
|
2309
|
+
export declare interface EditorAttachmentPreviewOptions {
|
|
2310
|
+
/**
|
|
2311
|
+
* 预览附件
|
|
2312
|
+
* app, 桌面客户端需提供
|
|
2313
|
+
*/
|
|
2314
|
+
preview?: (url: string) => void;
|
|
2315
|
+
/**
|
|
2316
|
+
* 获取附件预览url,saas、sdk、极速sdk需要提供
|
|
2317
|
+
* @param id 文件url
|
|
2318
|
+
* @returns 预览url
|
|
2319
|
+
*/
|
|
2320
|
+
getPreviewUrl?: (url: string) => Promise<string>;
|
|
1889
2321
|
/**
|
|
1890
|
-
*
|
|
1891
|
-
* undefined代表无限制
|
|
2322
|
+
* 是否禁用预览
|
|
1892
2323
|
*/
|
|
1893
|
-
|
|
2324
|
+
disabled?: boolean;
|
|
2325
|
+
}
|
|
2326
|
+
|
|
2327
|
+
/**
|
|
2328
|
+
* 基础文件属性
|
|
2329
|
+
*/
|
|
2330
|
+
export declare interface EditorBaseUploadableFile {
|
|
2331
|
+
secretly?: boolean;
|
|
2332
|
+
bucket: 'images' | 'attachments';
|
|
2333
|
+
encrypt: string;
|
|
2334
|
+
fileGuid: string;
|
|
2335
|
+
}
|
|
2336
|
+
|
|
2337
|
+
/**
|
|
2338
|
+
* 品牌设置
|
|
2339
|
+
*/
|
|
2340
|
+
export declare interface EditorBrandOptions {
|
|
2341
|
+
enable: boolean;
|
|
2342
|
+
getSettings: () => Promise<EditorBrandSetting | null>;
|
|
2343
|
+
}
|
|
2344
|
+
|
|
2345
|
+
/**
|
|
2346
|
+
* 品牌相关设置,
|
|
2347
|
+
* 用于在套件中展示品牌外露信息
|
|
2348
|
+
*/
|
|
2349
|
+
export declare interface EditorBrandSetting {
|
|
1894
2350
|
/**
|
|
1895
|
-
*
|
|
1896
|
-
* @param key 功能卡点key
|
|
1897
|
-
* @param value 功能卡点检查值,如文件大小/行列数量等
|
|
2351
|
+
* 需要显示在品牌展示位的内容,按数组顺序显示
|
|
1898
2352
|
*/
|
|
1899
|
-
|
|
2353
|
+
content: Array<{
|
|
2354
|
+
type: 'image';
|
|
2355
|
+
src: string;
|
|
2356
|
+
} | {
|
|
2357
|
+
type: 'text';
|
|
2358
|
+
content: string;
|
|
2359
|
+
color?: string;
|
|
2360
|
+
}>;
|
|
1900
2361
|
/**
|
|
1901
|
-
*
|
|
2362
|
+
* 品牌展示位的布局信息
|
|
1902
2363
|
*/
|
|
1903
|
-
|
|
2364
|
+
layout: {
|
|
2365
|
+
width: string;
|
|
2366
|
+
height: string;
|
|
2367
|
+
};
|
|
1904
2368
|
}
|
|
1905
2369
|
|
|
1906
2370
|
export declare interface EditorCollaborationOptions {
|
|
@@ -1944,32 +2408,36 @@ export declare interface EditorCollaborators {
|
|
|
1944
2408
|
* 停止监听协作者状态变化
|
|
1945
2409
|
* 调用此方法后,将不再接收协作者进入/离开的事件
|
|
1946
2410
|
*/
|
|
1947
|
-
|
|
2411
|
+
quit: () => void;
|
|
2412
|
+
/**
|
|
2413
|
+
* 监听事件
|
|
2414
|
+
*/
|
|
2415
|
+
on: (event: string, callback: (...args: unknown[]) => void) => unknown;
|
|
2416
|
+
/**
|
|
2417
|
+
* 监听事件, 只监听一次
|
|
2418
|
+
*/
|
|
2419
|
+
once: (event: string, callback: (...args: unknown[]) => void) => unknown;
|
|
1948
2420
|
/**
|
|
1949
|
-
*
|
|
1950
|
-
* @param listener - 监听器回调函数,参数如下:
|
|
1951
|
-
* - allUsers: 当前所有协作者列表
|
|
1952
|
-
* - enteredUsers: 新进入的协作者列表
|
|
1953
|
-
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
2421
|
+
* 移除事件
|
|
1954
2422
|
*/
|
|
1955
|
-
|
|
2423
|
+
off: (event: string, callback: (...args: unknown[]) => void) => unknown;
|
|
1956
2424
|
/**
|
|
1957
|
-
*
|
|
1958
|
-
* @param listener - 监听器回调函数
|
|
1959
|
-
* - allUsers: 当前所有协作者列表
|
|
1960
|
-
* - leftUsers: 离开的协作者列表
|
|
1961
|
-
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
2425
|
+
* 发送事件
|
|
1962
2426
|
*/
|
|
1963
|
-
|
|
2427
|
+
emit: (event: string, ...args: unknown[]) => unknown;
|
|
1964
2428
|
}
|
|
1965
2429
|
|
|
1966
2430
|
export declare interface EditorCollaboratorsOptions {
|
|
2431
|
+
/**
|
|
2432
|
+
* 是否禁用
|
|
2433
|
+
*/
|
|
2434
|
+
disabled?: boolean;
|
|
1967
2435
|
/**
|
|
1968
2436
|
* 推送协作者socket 对象
|
|
1969
2437
|
* 实际类型为socketIO.client
|
|
1970
2438
|
* TODO: 抽象为接口
|
|
1971
2439
|
*/
|
|
1972
|
-
socket?:
|
|
2440
|
+
socket?: EditorSocket;
|
|
1973
2441
|
}
|
|
1974
2442
|
|
|
1975
2443
|
/**
|
|
@@ -2033,6 +2501,14 @@ export declare interface EditorComments {
|
|
|
2033
2501
|
* 删除单条评论
|
|
2034
2502
|
*/
|
|
2035
2503
|
deleteOne: (commentId: string) => Promise<boolean>;
|
|
2504
|
+
/**
|
|
2505
|
+
* 显示评论(侧边栏或其他形式)
|
|
2506
|
+
*/
|
|
2507
|
+
show?: () => void;
|
|
2508
|
+
/**
|
|
2509
|
+
* 隐藏评论(侧边栏或其他形式)
|
|
2510
|
+
*/
|
|
2511
|
+
hide?: () => void;
|
|
2036
2512
|
}
|
|
2037
2513
|
|
|
2038
2514
|
/**
|
|
@@ -2068,11 +2544,22 @@ export declare interface EditorCommentsOptions extends EditorFeatureConfig {
|
|
|
2068
2544
|
mode: 'none' | 'card';
|
|
2069
2545
|
};
|
|
2070
2546
|
/**
|
|
2071
|
-
*
|
|
2072
|
-
* @param listener
|
|
2073
|
-
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
2547
|
+
* 推送评论的 socket 对象
|
|
2074
2548
|
*/
|
|
2075
|
-
|
|
2549
|
+
socket?: EditorSocket;
|
|
2550
|
+
/**
|
|
2551
|
+
* 评论相关功能配置
|
|
2552
|
+
*/
|
|
2553
|
+
features?: {
|
|
2554
|
+
/**
|
|
2555
|
+
* 添加评论
|
|
2556
|
+
*/
|
|
2557
|
+
addComment?: EditorFeatureConfig;
|
|
2558
|
+
/**
|
|
2559
|
+
* 评论列表
|
|
2560
|
+
*/
|
|
2561
|
+
commentList?: EditorFeatureConfig;
|
|
2562
|
+
};
|
|
2076
2563
|
}
|
|
2077
2564
|
|
|
2078
2565
|
export declare interface EditorContent<Delta = EditorDelta> {
|
|
@@ -2098,6 +2585,11 @@ export declare interface EditorContent<Delta = EditorDelta> {
|
|
|
2098
2585
|
*/
|
|
2099
2586
|
export declare type EditorContextMenuOptions<TName extends string> = EditorMenuOptions<TName>;
|
|
2100
2587
|
|
|
2588
|
+
/**
|
|
2589
|
+
* 粘贴相关设置
|
|
2590
|
+
*/
|
|
2591
|
+
export declare type EditorCopyOptions = EditorLogicFeatureConfig;
|
|
2592
|
+
|
|
2101
2593
|
/**
|
|
2102
2594
|
* 编辑器解密选项接口
|
|
2103
2595
|
* 用于配置编辑器中需要解密的内容的相关选项
|
|
@@ -2118,6 +2610,28 @@ export declare interface EditorDelta {
|
|
|
2118
2610
|
length: number;
|
|
2119
2611
|
}
|
|
2120
2612
|
|
|
2613
|
+
export declare type EditorDeviceMode = 'desktop' | 'mobile' | 'tablet';
|
|
2614
|
+
|
|
2615
|
+
/**
|
|
2616
|
+
* 编辑器设备相关设置
|
|
2617
|
+
*/
|
|
2618
|
+
export declare interface EditorDeviceOptions {
|
|
2619
|
+
/**
|
|
2620
|
+
* 设备模式
|
|
2621
|
+
*/
|
|
2622
|
+
mode?: EditorDeviceMode;
|
|
2623
|
+
}
|
|
2624
|
+
|
|
2625
|
+
/**
|
|
2626
|
+
* 编辑器拖放配置
|
|
2627
|
+
*/
|
|
2628
|
+
export declare type EditorDragNDropOptions = EditorFeatureConfig;
|
|
2629
|
+
|
|
2630
|
+
/**
|
|
2631
|
+
* 编辑器创建副本配置
|
|
2632
|
+
*/
|
|
2633
|
+
export declare type EditorDuplicateOptions = EditorFeatureConfig;
|
|
2634
|
+
|
|
2121
2635
|
/**
|
|
2122
2636
|
* 编辑器嵌入对象
|
|
2123
2637
|
*/
|
|
@@ -2167,15 +2681,20 @@ export declare interface EditorEmbeddedObjectOptions {
|
|
|
2167
2681
|
};
|
|
2168
2682
|
}
|
|
2169
2683
|
|
|
2170
|
-
export declare interface EditorExportOptions {
|
|
2684
|
+
export declare interface EditorExportOptions extends EditorFeatureConfig {
|
|
2685
|
+
/**
|
|
2686
|
+
* 可导出类型, undefined 表示对可导出类型无限制
|
|
2687
|
+
* 导出由接口 + 本地实现
|
|
2688
|
+
*/
|
|
2689
|
+
types?: string[];
|
|
2171
2690
|
/**
|
|
2172
|
-
*
|
|
2691
|
+
* 接口支持的导出类型
|
|
2173
2692
|
*/
|
|
2174
2693
|
supportedTypes?: string[];
|
|
2175
2694
|
/**
|
|
2176
|
-
*
|
|
2695
|
+
* 导出文件,调用接口实现
|
|
2177
2696
|
*/
|
|
2178
|
-
exportFile
|
|
2697
|
+
exportFile?: (type: string) => Promise<void>;
|
|
2179
2698
|
}
|
|
2180
2699
|
|
|
2181
2700
|
export declare interface EditorFeatureConfig {
|
|
@@ -2189,6 +2708,28 @@ export declare interface EditorFeatureConfig {
|
|
|
2189
2708
|
hidden?: boolean;
|
|
2190
2709
|
}
|
|
2191
2710
|
|
|
2711
|
+
export declare interface EditorFeaturesOptions {
|
|
2712
|
+
/**
|
|
2713
|
+
* 禁用特性入口
|
|
2714
|
+
*/
|
|
2715
|
+
disabled?: boolean;
|
|
2716
|
+
/**
|
|
2717
|
+
* 对应/features接口,返回所有功能key
|
|
2718
|
+
*/
|
|
2719
|
+
getFeatures?: () => Promise<string[]>;
|
|
2720
|
+
}
|
|
2721
|
+
|
|
2722
|
+
/**
|
|
2723
|
+
* 文件限制
|
|
2724
|
+
*/
|
|
2725
|
+
export declare interface EditorFileLimitationOptions {
|
|
2726
|
+
/**
|
|
2727
|
+
* 获取最大文件大小,单位为MB
|
|
2728
|
+
* 超过该上限后禁止编辑
|
|
2729
|
+
*/
|
|
2730
|
+
getMaxFileSize?: () => number | undefined;
|
|
2731
|
+
}
|
|
2732
|
+
|
|
2192
2733
|
export declare interface EditorFileOptions {
|
|
2193
2734
|
/**
|
|
2194
2735
|
* 文件guid
|
|
@@ -2198,6 +2739,18 @@ export declare interface EditorFileOptions {
|
|
|
2198
2739
|
* 文件名
|
|
2199
2740
|
*/
|
|
2200
2741
|
name?: string;
|
|
2742
|
+
/**
|
|
2743
|
+
* 创建者,以id标识
|
|
2744
|
+
*/
|
|
2745
|
+
creator?: number;
|
|
2746
|
+
/**
|
|
2747
|
+
* 创建时间, 毫秒级时间戳
|
|
2748
|
+
*/
|
|
2749
|
+
createdAt?: number;
|
|
2750
|
+
/**
|
|
2751
|
+
* 文件限制
|
|
2752
|
+
*/
|
|
2753
|
+
limitations?: EditorFileLimitationOptions;
|
|
2201
2754
|
}
|
|
2202
2755
|
|
|
2203
2756
|
export declare interface EditorFilePicker {
|
|
@@ -2227,7 +2780,7 @@ export declare interface EditorFollowMode {
|
|
|
2227
2780
|
* 获取当前演讲者信息
|
|
2228
2781
|
* @returns 返回包含演讲者ID、姓名和头像信息的对象
|
|
2229
2782
|
*/
|
|
2230
|
-
getSpeaker: () => Speaker;
|
|
2783
|
+
getSpeaker: () => Speaker | undefined;
|
|
2231
2784
|
/**
|
|
2232
2785
|
* 添加跟随状态变化的监听器
|
|
2233
2786
|
* @param listener 状态变化时的回调函数
|
|
@@ -2242,7 +2795,7 @@ export declare interface EditorFollowModeOptions extends EditorFeatureConfig {
|
|
|
2242
2795
|
* 实际类型为socketIO.client
|
|
2243
2796
|
* TODO: 抽象为接口
|
|
2244
2797
|
*/
|
|
2245
|
-
socket?:
|
|
2798
|
+
socket?: EditorSocket;
|
|
2246
2799
|
}
|
|
2247
2800
|
|
|
2248
2801
|
export declare interface EditorFontFace {
|
|
@@ -2321,17 +2874,35 @@ export declare interface EditorFontsOptions {
|
|
|
2321
2874
|
* 并提供可用于字体的加载 URL 和字体元数据。
|
|
2322
2875
|
*/
|
|
2323
2876
|
list: EditorFontsList;
|
|
2877
|
+
/**
|
|
2878
|
+
* 是否只使用本地字体,如果为 true,则不会从服务器获取字体列表。
|
|
2879
|
+
*/
|
|
2880
|
+
useLocalFontsOnly?: boolean;
|
|
2881
|
+
}
|
|
2882
|
+
|
|
2883
|
+
/**
|
|
2884
|
+
* 功能引导设置
|
|
2885
|
+
*/
|
|
2886
|
+
export declare interface EditorGuidesOptions {
|
|
2887
|
+
/**
|
|
2888
|
+
* 是否禁用
|
|
2889
|
+
*/
|
|
2890
|
+
disabled?: boolean;
|
|
2891
|
+
/**
|
|
2892
|
+
* 获取引导数据
|
|
2893
|
+
*/
|
|
2894
|
+
data?: <T = GuideData>() => Promise<T>;
|
|
2324
2895
|
}
|
|
2325
2896
|
|
|
2326
2897
|
export declare interface EditorHistory {
|
|
2327
2898
|
/**
|
|
2328
|
-
*
|
|
2899
|
+
* 显示历史记录(侧边栏或其他形式)
|
|
2329
2900
|
*/
|
|
2330
|
-
|
|
2901
|
+
show: () => void;
|
|
2331
2902
|
/**
|
|
2332
|
-
*
|
|
2903
|
+
* 隐藏历史记录(侧边栏或其他形式)
|
|
2333
2904
|
*/
|
|
2334
|
-
|
|
2905
|
+
hide: () => void;
|
|
2335
2906
|
}
|
|
2336
2907
|
|
|
2337
2908
|
export declare type EditorHistoryOptions = EditorFeatureConfig;
|
|
@@ -2354,7 +2925,12 @@ export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'cen
|
|
|
2354
2925
|
|
|
2355
2926
|
export declare interface EditorImportOptions {
|
|
2356
2927
|
/**
|
|
2357
|
-
*
|
|
2928
|
+
* 当前文件是否正在导入中
|
|
2929
|
+
* 用于初始化时判断是否需要显示导入进度
|
|
2930
|
+
*/
|
|
2931
|
+
isImporting?: boolean;
|
|
2932
|
+
/**
|
|
2933
|
+
* 获取当前文件导入状态,没有contentUrl时需要显示导入进度
|
|
2358
2934
|
* 待导入完成后再渲染
|
|
2359
2935
|
*/
|
|
2360
2936
|
getImportStatus?: () => Promise<{
|
|
@@ -2371,15 +2947,19 @@ export declare interface EditorImportOptions {
|
|
|
2371
2947
|
* 导入完成
|
|
2372
2948
|
*/
|
|
2373
2949
|
status: 'completed';
|
|
2950
|
+
/**
|
|
2951
|
+
* 导入完成后的内容URL
|
|
2952
|
+
*/
|
|
2953
|
+
contentUrl: string;
|
|
2374
2954
|
} | {
|
|
2375
2955
|
/**
|
|
2376
2956
|
* 导入失败
|
|
2377
2957
|
*/
|
|
2378
2958
|
status: 'failed';
|
|
2379
2959
|
/**
|
|
2380
|
-
*
|
|
2960
|
+
* 导入失败报错
|
|
2381
2961
|
*/
|
|
2382
|
-
|
|
2962
|
+
error?: unknown;
|
|
2383
2963
|
}>;
|
|
2384
2964
|
}
|
|
2385
2965
|
|
|
@@ -2432,6 +3012,74 @@ export declare interface EditorLocalUploadableFile extends EditorBaseUploadableF
|
|
|
2432
3012
|
raw: File;
|
|
2433
3013
|
}
|
|
2434
3014
|
|
|
3015
|
+
/**
|
|
3016
|
+
* 纯逻辑功能配置。
|
|
3017
|
+
* 不包含 UI 相关配置,仅用于逻辑判断。
|
|
3018
|
+
* 如:权限判断、功能开关等。
|
|
3019
|
+
* 所以不需要hidden,只使用disabled来判断
|
|
3020
|
+
*/
|
|
3021
|
+
export declare type EditorLogicFeatureConfig = Omit<EditorFeatureConfig, 'hidden'>;
|
|
3022
|
+
|
|
3023
|
+
export declare interface EditorLogsOptions {
|
|
3024
|
+
/**
|
|
3025
|
+
* 是否禁用审计日志
|
|
3026
|
+
* sdk2.0需要禁用
|
|
3027
|
+
*/
|
|
3028
|
+
isAuditLogDisabled?: boolean;
|
|
3029
|
+
/**
|
|
3030
|
+
* 是否禁用日志
|
|
3031
|
+
*/
|
|
3032
|
+
disabled?: boolean;
|
|
3033
|
+
}
|
|
3034
|
+
|
|
3035
|
+
export declare interface EditorMentionOptions extends EditorFeatureConfig {
|
|
3036
|
+
/**
|
|
3037
|
+
* mention api url前缀
|
|
3038
|
+
* @shimo/mention-suggestion 需要用到
|
|
3039
|
+
* 对应环境变量 SDK_V2_PATH_PREFIX
|
|
3040
|
+
*/
|
|
3041
|
+
apiUrlPrefix?: string;
|
|
3042
|
+
/**
|
|
3043
|
+
* mention文件卡片禁用设置
|
|
3044
|
+
*/
|
|
3045
|
+
disableFileCard?: boolean;
|
|
3046
|
+
/**
|
|
3047
|
+
* mention日期卡片禁用设置
|
|
3048
|
+
*/
|
|
3049
|
+
disableDateCard?: boolean;
|
|
3050
|
+
/**
|
|
3051
|
+
* mention用户卡片禁用设置
|
|
3052
|
+
*/
|
|
3053
|
+
disableUserCard?: boolean;
|
|
3054
|
+
/**
|
|
3055
|
+
* mention点击回调
|
|
3056
|
+
*/
|
|
3057
|
+
onMentionClick?: (payload: MentionEventPayload) => void;
|
|
3058
|
+
/**
|
|
3059
|
+
* mention文件选择弹窗支持的tab类型
|
|
3060
|
+
*/
|
|
3061
|
+
mentionFilePanelTabs?: ('mine' | 'recent' | 'space')[];
|
|
3062
|
+
/**
|
|
3063
|
+
* mention弹窗底部支持的tab类型
|
|
3064
|
+
*/
|
|
3065
|
+
mentionPopoverTabs?: ('contacts' | 'file' | 'calendar')[];
|
|
3066
|
+
/**
|
|
3067
|
+
* 是否禁止检查组织架构成员可见性
|
|
3068
|
+
* 该属性需要各套件对接最新版本@shimo/mention-suggestion(没用到的话可忽略)
|
|
3069
|
+
*/
|
|
3070
|
+
disableCheckStaffVisibility?: boolean;
|
|
3071
|
+
}
|
|
3072
|
+
|
|
3073
|
+
/**
|
|
3074
|
+
* 编辑器菜单api
|
|
3075
|
+
*/
|
|
3076
|
+
export declare interface EditorMenu {
|
|
3077
|
+
/**
|
|
3078
|
+
* 菜单功能api
|
|
3079
|
+
*/
|
|
3080
|
+
features: EditorMenuFeatures;
|
|
3081
|
+
}
|
|
3082
|
+
|
|
2435
3083
|
/**
|
|
2436
3084
|
* 基础菜单项配置,所有菜单项类型都包含这些属性
|
|
2437
3085
|
*/
|
|
@@ -2532,6 +3180,38 @@ export declare interface EditorMenuFeatureConfig extends EditorFeatureConfig {
|
|
|
2532
3180
|
index?: number;
|
|
2533
3181
|
}
|
|
2534
3182
|
|
|
3183
|
+
/**
|
|
3184
|
+
* 编辑器菜单功能api
|
|
3185
|
+
*
|
|
3186
|
+
* 提供对菜单项的显示、隐藏、启用和禁用等操作
|
|
3187
|
+
*/
|
|
3188
|
+
export declare interface EditorMenuFeatures {
|
|
3189
|
+
/**
|
|
3190
|
+
* 显示菜单项
|
|
3191
|
+
* @param name 菜单项名称
|
|
3192
|
+
*/
|
|
3193
|
+
showFeature: (name: string) => void;
|
|
3194
|
+
/**
|
|
3195
|
+
* 隐藏菜单项
|
|
3196
|
+
* @param name 菜单项名称
|
|
3197
|
+
*/
|
|
3198
|
+
hideFeature: (name: string) => void;
|
|
3199
|
+
/**
|
|
3200
|
+
* 启用菜单项
|
|
3201
|
+
* @param name 菜单项名称
|
|
3202
|
+
*/
|
|
3203
|
+
enableFeature: (name: string) => void;
|
|
3204
|
+
/**
|
|
3205
|
+
* 禁用菜单项
|
|
3206
|
+
* @param name 菜单项名称
|
|
3207
|
+
*/
|
|
3208
|
+
disableFeature: (name: string) => void;
|
|
3209
|
+
/**
|
|
3210
|
+
* 恢复菜单项到默认状态,即根据配置项确定如何渲染菜单项。
|
|
3211
|
+
*/
|
|
3212
|
+
resetFeature: (name: string) => void;
|
|
3213
|
+
}
|
|
3214
|
+
|
|
2535
3215
|
/**
|
|
2536
3216
|
* 隐藏菜单项配置
|
|
2537
3217
|
*/
|
|
@@ -2598,7 +3278,7 @@ export declare interface EditorMenuOptions<TName extends EditorMenuName> {
|
|
|
2598
3278
|
* 更加间接的配置项
|
|
2599
3279
|
* 仅在 TName 为字符串类型时有效
|
|
2600
3280
|
*/
|
|
2601
|
-
features?: TName extends string ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
|
|
3281
|
+
features?: [TName] extends [string] ? Partial<Record<TName, EditorMenuFeatureConfig>> : never;
|
|
2602
3282
|
/**
|
|
2603
3283
|
* 自定义按钮配置
|
|
2604
3284
|
*/
|
|
@@ -2634,9 +3314,25 @@ export declare type EditorModeOptions = {
|
|
|
2634
3314
|
*/
|
|
2635
3315
|
role?: EditorStandardRole;
|
|
2636
3316
|
} | {
|
|
3317
|
+
/**
|
|
3318
|
+
* 预览模式
|
|
3319
|
+
*/
|
|
2637
3320
|
type: 'preview';
|
|
2638
3321
|
} | {
|
|
3322
|
+
/**
|
|
3323
|
+
* 演示模式
|
|
3324
|
+
*/
|
|
2639
3325
|
type: 'presentation';
|
|
3326
|
+
} | {
|
|
3327
|
+
/**
|
|
3328
|
+
* 历史模式
|
|
3329
|
+
*/
|
|
3330
|
+
type: 'history';
|
|
3331
|
+
} | {
|
|
3332
|
+
/**
|
|
3333
|
+
* 嵌入模式
|
|
3334
|
+
*/
|
|
3335
|
+
type: 'embedded';
|
|
2640
3336
|
};
|
|
2641
3337
|
|
|
2642
3338
|
/**
|
|
@@ -2644,8 +3340,9 @@ export declare type EditorModeOptions = {
|
|
|
2644
3340
|
* - `standard` 标准模式,会根据用户权限配置不同的功能
|
|
2645
3341
|
* - `preview` 预览模式,只能查看内容
|
|
2646
3342
|
* - `presentation` 演示模式,用作演示场景,演示模式下部分套件可以进行一些简单的编辑操作
|
|
3343
|
+
* - `history` 历史模式,用作查看历史版本场景
|
|
2647
3344
|
*/
|
|
2648
|
-
export declare type EditorModeType = 'standard' | 'preview' | 'presentation';
|
|
3345
|
+
export declare type EditorModeType = 'standard' | 'preview' | 'presentation' | 'history' | 'embedded';
|
|
2649
3346
|
|
|
2650
3347
|
/**
|
|
2651
3348
|
* 编辑器初始化通用参数
|
|
@@ -2669,7 +3366,7 @@ export declare interface EditorOptions {
|
|
|
2669
3366
|
*/
|
|
2670
3367
|
anonymous?: EditorAnonymousOptions;
|
|
2671
3368
|
/**
|
|
2672
|
-
* 当前文件信息
|
|
3369
|
+
* 当前文件信息 & 配置
|
|
2673
3370
|
*/
|
|
2674
3371
|
file?: EditorFileOptions;
|
|
2675
3372
|
/**
|
|
@@ -2679,7 +3376,7 @@ export declare interface EditorOptions {
|
|
|
2679
3376
|
/**
|
|
2680
3377
|
* 品牌相关设置
|
|
2681
3378
|
*/
|
|
2682
|
-
brand?:
|
|
3379
|
+
brand?: EditorBrandOptions;
|
|
2683
3380
|
/**
|
|
2684
3381
|
* 编辑器内部资源请求配置
|
|
2685
3382
|
*/
|
|
@@ -2728,10 +3425,6 @@ export declare interface EditorOptions {
|
|
|
2728
3425
|
* 编辑器 UI 相关
|
|
2729
3426
|
*/
|
|
2730
3427
|
ui?: EditorUiOptions;
|
|
2731
|
-
/**
|
|
2732
|
-
* 编辑器卡点限制
|
|
2733
|
-
*/
|
|
2734
|
-
checkpoints?: EditorCheckpointsOptions;
|
|
2735
3428
|
/**
|
|
2736
3429
|
* 编辑器工具箱设置
|
|
2737
3430
|
*/
|
|
@@ -2744,6 +3437,54 @@ export declare interface EditorOptions {
|
|
|
2744
3437
|
* 编辑器协作相关
|
|
2745
3438
|
*/
|
|
2746
3439
|
collaboration?: EditorCollaborationOptions;
|
|
3440
|
+
/**
|
|
3441
|
+
* 编辑器功能相关设置
|
|
3442
|
+
*/
|
|
3443
|
+
features?: EditorFeaturesOptions;
|
|
3444
|
+
/**
|
|
3445
|
+
* 编辑器版本相关设置
|
|
3446
|
+
*/
|
|
3447
|
+
version?: EditorVersionOptions;
|
|
3448
|
+
/**
|
|
3449
|
+
* 编辑器日志相关设置
|
|
3450
|
+
*/
|
|
3451
|
+
logs?: EditorLogsOptions;
|
|
3452
|
+
/**
|
|
3453
|
+
* 编辑器快捷键相关设置
|
|
3454
|
+
*/
|
|
3455
|
+
shortcuts?: EditorShortcutOptions;
|
|
3456
|
+
/**
|
|
3457
|
+
* 提及相关设置
|
|
3458
|
+
*/
|
|
3459
|
+
mention?: EditorMentionOptions;
|
|
3460
|
+
/**
|
|
3461
|
+
* 编辑器拖放相关配置
|
|
3462
|
+
*/
|
|
3463
|
+
dragNDrop?: EditorDragNDropOptions;
|
|
3464
|
+
/**
|
|
3465
|
+
* 编辑器引导相关设置
|
|
3466
|
+
*/
|
|
3467
|
+
guides?: EditorGuidesOptions;
|
|
3468
|
+
/**
|
|
3469
|
+
* 编辑器复制相关设置
|
|
3470
|
+
*/
|
|
3471
|
+
copy?: EditorCopyOptions;
|
|
3472
|
+
/**
|
|
3473
|
+
* 编辑器粘贴相关设置
|
|
3474
|
+
*/
|
|
3475
|
+
paste?: EditorPasteOptions;
|
|
3476
|
+
/**
|
|
3477
|
+
* 编辑器设备信息相关设置
|
|
3478
|
+
*/
|
|
3479
|
+
device?: EditorDeviceOptions;
|
|
3480
|
+
/**
|
|
3481
|
+
* 编辑器副本相关配置
|
|
3482
|
+
*/
|
|
3483
|
+
duplicate?: EditorDuplicateOptions;
|
|
3484
|
+
/**
|
|
3485
|
+
* 分享相关接口
|
|
3486
|
+
*/
|
|
3487
|
+
share?: EditorShareOptions;
|
|
2747
3488
|
}
|
|
2748
3489
|
|
|
2749
3490
|
/**
|
|
@@ -2796,7 +3537,7 @@ export declare interface EditorOutlineItem<Content = unknown> {
|
|
|
2796
3537
|
* 大纲目录初始化参数,
|
|
2797
3538
|
* 用于配置大纲目录的行为和外观。
|
|
2798
3539
|
*/
|
|
2799
|
-
export declare interface EditorOutlineOptions {
|
|
3540
|
+
export declare interface EditorOutlineOptions extends EditorLogicFeatureConfig {
|
|
2800
3541
|
/**
|
|
2801
3542
|
* 初始化编辑器时是否显示大纲目录,
|
|
2802
3543
|
* 默认为 false。
|
|
@@ -2804,23 +3545,59 @@ export declare interface EditorOutlineOptions {
|
|
|
2804
3545
|
visible?: boolean;
|
|
2805
3546
|
}
|
|
2806
3547
|
|
|
2807
|
-
export declare interface
|
|
3548
|
+
export declare interface EditorPasteLimitationOptions {
|
|
2808
3549
|
/**
|
|
2809
|
-
*
|
|
2810
|
-
* @param
|
|
3550
|
+
* 检查粘贴内容的规则
|
|
3551
|
+
* @param content
|
|
3552
|
+
* @returns
|
|
2811
3553
|
*/
|
|
2812
|
-
|
|
3554
|
+
checkContent?: (params: EditorPasteLimitationOptionsCheckFunctionParams) => Promise<{
|
|
3555
|
+
limited: true;
|
|
3556
|
+
message: string;
|
|
3557
|
+
} | {
|
|
3558
|
+
limited: false;
|
|
3559
|
+
}>;
|
|
3560
|
+
/**
|
|
3561
|
+
* 获取最大粘贴数据大小,单位为MB
|
|
3562
|
+
*/
|
|
3563
|
+
getMaxDataSize?: () => Promise<number | undefined>;
|
|
2813
3564
|
}
|
|
2814
3565
|
|
|
2815
|
-
export declare interface
|
|
3566
|
+
export declare interface EditorPasteLimitationOptionsCheckFunctionParams {
|
|
3567
|
+
content: string;
|
|
3568
|
+
}
|
|
3569
|
+
|
|
3570
|
+
/**
|
|
3571
|
+
* 粘贴相关设置
|
|
3572
|
+
*/
|
|
3573
|
+
export declare interface EditorPasteOptions extends EditorFeatureConfig {
|
|
2816
3574
|
/**
|
|
2817
|
-
*
|
|
3575
|
+
* 是否禁用远程图片粘贴, turbo暂时不支持远程图片粘贴
|
|
2818
3576
|
*/
|
|
2819
|
-
|
|
3577
|
+
isRemoteImgDisabled?: boolean;
|
|
2820
3578
|
/**
|
|
2821
|
-
*
|
|
3579
|
+
* 粘贴内容限制规则
|
|
2822
3580
|
*/
|
|
2823
|
-
|
|
3581
|
+
limitations?: EditorPasteLimitationOptions;
|
|
3582
|
+
}
|
|
3583
|
+
|
|
3584
|
+
export declare interface EditorPerformanceOptions {
|
|
3585
|
+
/**
|
|
3586
|
+
* 记录性能指标
|
|
3587
|
+
* @param mark 性能指标名称
|
|
3588
|
+
*/
|
|
3589
|
+
record?: (mark: 'first_page' | 'first_editable_page') => void;
|
|
3590
|
+
}
|
|
3591
|
+
|
|
3592
|
+
export declare interface EditorPickedFile {
|
|
3593
|
+
/**
|
|
3594
|
+
* 文件大小
|
|
3595
|
+
*/
|
|
3596
|
+
size: number;
|
|
3597
|
+
/**
|
|
3598
|
+
* 文件名
|
|
3599
|
+
*/
|
|
3600
|
+
name: string;
|
|
2824
3601
|
/**
|
|
2825
3602
|
* 文件路径,仅显示有意义的相对路径,可用在上传文件夹和识别文件使用
|
|
2826
3603
|
*/
|
|
@@ -2835,6 +3612,17 @@ export declare interface EditorPickedFile {
|
|
|
2835
3612
|
raw: File;
|
|
2836
3613
|
}
|
|
2837
3614
|
|
|
3615
|
+
export declare interface EditorPresentation {
|
|
3616
|
+
/**
|
|
3617
|
+
* 进入演示模式
|
|
3618
|
+
*/
|
|
3619
|
+
start: () => Promise<void>;
|
|
3620
|
+
/**
|
|
3621
|
+
* 退出演示模式
|
|
3622
|
+
*/
|
|
3623
|
+
quit: () => Promise<void>;
|
|
3624
|
+
}
|
|
3625
|
+
|
|
2838
3626
|
/**
|
|
2839
3627
|
* 编辑器打印设置
|
|
2840
3628
|
*/
|
|
@@ -2859,6 +3647,13 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
|
|
|
2859
3647
|
raw?: never;
|
|
2860
3648
|
}
|
|
2861
3649
|
|
|
3650
|
+
export declare interface EditorRenderOptions {
|
|
3651
|
+
/**
|
|
3652
|
+
* 用于定位的锚点
|
|
3653
|
+
*/
|
|
3654
|
+
hash?: string;
|
|
3655
|
+
}
|
|
3656
|
+
|
|
2862
3657
|
/**
|
|
2863
3658
|
* 编辑器通用接口
|
|
2864
3659
|
*/
|
|
@@ -2911,6 +3706,62 @@ export declare abstract class EditorSDK {
|
|
|
2911
3706
|
* 部分环境不存在,如离线客户端
|
|
2912
3707
|
*/
|
|
2913
3708
|
abstract get version(): EditorVersion | undefined;
|
|
3709
|
+
/**
|
|
3710
|
+
* 编辑器菜单栏相关接口
|
|
3711
|
+
*/
|
|
3712
|
+
abstract get menu(): EditorMenu | undefined;
|
|
3713
|
+
/**
|
|
3714
|
+
* 编辑器演示模式相关接口
|
|
3715
|
+
*/
|
|
3716
|
+
abstract get presentation(): EditorPresentation | undefined;
|
|
3717
|
+
}
|
|
3718
|
+
|
|
3719
|
+
export declare interface EditorShareOptions extends EditorLogicFeatureConfig {
|
|
3720
|
+
/**
|
|
3721
|
+
* 当前文件是否为共享文件
|
|
3722
|
+
*/
|
|
3723
|
+
isShared?: boolean;
|
|
3724
|
+
}
|
|
3725
|
+
|
|
3726
|
+
export declare interface EditorShortcutOptions {
|
|
3727
|
+
/**
|
|
3728
|
+
* 自定义快捷键
|
|
3729
|
+
*/
|
|
3730
|
+
customShortcuts?: ShortcutConfig[];
|
|
3731
|
+
/**
|
|
3732
|
+
* 禁用的快捷键
|
|
3733
|
+
* 桌面客户端需要禁用ctrl+s,ctrl+shift+s
|
|
3734
|
+
* 极速sdk需要禁用ctrl+s
|
|
3735
|
+
* sdk2.0需要禁用ctrl+shift+e
|
|
3736
|
+
*/
|
|
3737
|
+
disabledShortcuts?: string[];
|
|
3738
|
+
}
|
|
3739
|
+
|
|
3740
|
+
/**
|
|
3741
|
+
* 编辑器 socket 接口, 用于评论、跟随模式、远程演示等场景
|
|
3742
|
+
* 实际类型为 socketIO.client
|
|
3743
|
+
*/
|
|
3744
|
+
export declare interface EditorSocket {
|
|
3745
|
+
/**
|
|
3746
|
+
* 监听事件
|
|
3747
|
+
*/
|
|
3748
|
+
on: (event: string, callback: (...args: unknown[]) => void) => unknown;
|
|
3749
|
+
/**
|
|
3750
|
+
* 监听事件, 只监听一次
|
|
3751
|
+
*/
|
|
3752
|
+
once: (event: string, callback: (...args: unknown[]) => void) => unknown;
|
|
3753
|
+
/**
|
|
3754
|
+
* 移除事件
|
|
3755
|
+
*/
|
|
3756
|
+
off: (event: string, callback: (...args: unknown[]) => void) => unknown;
|
|
3757
|
+
/**
|
|
3758
|
+
* 发送事件
|
|
3759
|
+
*/
|
|
3760
|
+
emit: (event: string, ...args: unknown[]) => unknown;
|
|
3761
|
+
/**
|
|
3762
|
+
* 断开连接
|
|
3763
|
+
*/
|
|
3764
|
+
disconnect: () => unknown;
|
|
2914
3765
|
}
|
|
2915
3766
|
|
|
2916
3767
|
/**
|
|
@@ -3100,6 +3951,12 @@ export declare interface EditorToolbarOptions<TName extends string> {
|
|
|
3100
3951
|
* 自定义按钮
|
|
3101
3952
|
*/
|
|
3102
3953
|
custom?: EditorToolbarFeatureButtonConfig<string>;
|
|
3954
|
+
/**
|
|
3955
|
+
* 工具栏挂载的容器dom,配置后则挂载到指定的容器上
|
|
3956
|
+
*
|
|
3957
|
+
* 如果不配置则按照套件的默认方式挂载。
|
|
3958
|
+
*/
|
|
3959
|
+
container?: HTMLElement;
|
|
3103
3960
|
}
|
|
3104
3961
|
|
|
3105
3962
|
/**
|
|
@@ -3137,13 +3994,17 @@ export declare interface EditorUiOptions {
|
|
|
3137
3994
|
/**
|
|
3138
3995
|
* 显示升级弹窗
|
|
3139
3996
|
*/
|
|
3140
|
-
showModal?: (options: ShowUpgradeModalProps) => Promise<ShowUpgradeModalResponse>;
|
|
3997
|
+
showModal?: (options: ShowUpgradeModalProps) => Promise<ShowUpgradeModalResponse | undefined>;
|
|
3141
3998
|
};
|
|
3142
3999
|
notification?: {
|
|
3143
4000
|
/**
|
|
3144
4001
|
* 渲染通知条
|
|
3145
4002
|
*/
|
|
3146
4003
|
render?: (params: RenderNotificationProps) => void;
|
|
4004
|
+
/**
|
|
4005
|
+
* 是否禁用通知条
|
|
4006
|
+
*/
|
|
4007
|
+
disabled?: boolean;
|
|
3147
4008
|
};
|
|
3148
4009
|
/**
|
|
3149
4010
|
* 用户名片
|
|
@@ -3157,6 +4018,20 @@ export declare interface EditorUiOptions {
|
|
|
3157
4018
|
* 渲染用户卡片
|
|
3158
4019
|
*/
|
|
3159
4020
|
render?: (params: RenderUserCardProps) => RenderUserCardResult;
|
|
4021
|
+
/**
|
|
4022
|
+
* 是否禁用用户卡片
|
|
4023
|
+
* jd需要禁用
|
|
4024
|
+
*/
|
|
4025
|
+
disabled?: boolean;
|
|
4026
|
+
};
|
|
4027
|
+
/**
|
|
4028
|
+
* 登录提示
|
|
4029
|
+
*/
|
|
4030
|
+
loginNotice?: {
|
|
4031
|
+
/**
|
|
4032
|
+
* 显示登录提示
|
|
4033
|
+
*/
|
|
4034
|
+
show?: () => void;
|
|
3160
4035
|
};
|
|
3161
4036
|
/**
|
|
3162
4037
|
* toast
|
|
@@ -3170,6 +4045,10 @@ export declare interface EditorUiOptions {
|
|
|
3170
4045
|
* 是否禁用toast
|
|
3171
4046
|
*/
|
|
3172
4047
|
disabled?: boolean;
|
|
4048
|
+
/**
|
|
4049
|
+
* 自定义toast提示文本配置
|
|
4050
|
+
*/
|
|
4051
|
+
tips?: ToastTipsConfig;
|
|
3173
4052
|
};
|
|
3174
4053
|
/**
|
|
3175
4054
|
* confirm
|
|
@@ -3184,9 +4063,48 @@ export declare interface EditorUiOptions {
|
|
|
3184
4063
|
*/
|
|
3185
4064
|
disabled?: boolean;
|
|
3186
4065
|
};
|
|
4066
|
+
/**
|
|
4067
|
+
* 全屏配置
|
|
4068
|
+
*/
|
|
4069
|
+
fullscreen?: EditorFeatureConfig;
|
|
4070
|
+
/**
|
|
4071
|
+
* 演示模式配置
|
|
4072
|
+
*/
|
|
4073
|
+
presentation?: EditorFeatureConfig;
|
|
4074
|
+
/**
|
|
4075
|
+
* 帮助中心配置
|
|
4076
|
+
*/
|
|
4077
|
+
helpCenter?: EditorFeatureConfig;
|
|
4078
|
+
/**
|
|
4079
|
+
* 新功能提醒相关配置
|
|
4080
|
+
*/
|
|
4081
|
+
newFeature?: {
|
|
4082
|
+
/**
|
|
4083
|
+
* 是否不展示新功能提醒(包括任何形式的)
|
|
4084
|
+
*/
|
|
4085
|
+
hidden?: boolean;
|
|
4086
|
+
};
|
|
4087
|
+
/**
|
|
4088
|
+
* 图片查看器配置
|
|
4089
|
+
*/
|
|
4090
|
+
imageViewer?: {
|
|
4091
|
+
/**
|
|
4092
|
+
* 右键菜单配置
|
|
4093
|
+
*/
|
|
4094
|
+
contextMenu?: EditorMenuOptions<'copy' | 'download'>;
|
|
4095
|
+
/**
|
|
4096
|
+
* 操作配置
|
|
4097
|
+
*/
|
|
4098
|
+
operations?: {
|
|
4099
|
+
/**
|
|
4100
|
+
* 下载图片
|
|
4101
|
+
*/
|
|
4102
|
+
download: EditorFeatureConfig;
|
|
4103
|
+
};
|
|
4104
|
+
};
|
|
3187
4105
|
}
|
|
3188
4106
|
|
|
3189
|
-
export declare type EditorUploadableFile = EditorLocalUploadableFile;
|
|
4107
|
+
export declare type EditorUploadableFile = EditorLocalUploadableFile | EditorRemoteUploadableFile;
|
|
3190
4108
|
|
|
3191
4109
|
/**
|
|
3192
4110
|
* 文件开始上传入参
|
|
@@ -3252,10 +4170,23 @@ export declare interface EditorUserOptions {
|
|
|
3252
4170
|
export declare interface EditorVersion {
|
|
3253
4171
|
/**
|
|
3254
4172
|
* 保存版本
|
|
4173
|
+
* @param name 版本名称
|
|
4174
|
+
*/
|
|
4175
|
+
createRevision: (name?: string) => void;
|
|
4176
|
+
/**
|
|
4177
|
+
* 显示版本(侧边栏或其他形式)
|
|
4178
|
+
* 区别于历史侧边栏,在应用表格里表现为打开历史侧边栏切换到版本 tab
|
|
4179
|
+
*/
|
|
4180
|
+
show?: () => void;
|
|
4181
|
+
/**
|
|
4182
|
+
* 隐藏版本(侧边栏或其他形式)
|
|
4183
|
+
* 区别于历史侧边栏,在应用表格里表现为打开历史侧边栏切换到版本 tab
|
|
3255
4184
|
*/
|
|
3256
|
-
|
|
4185
|
+
hide?: () => void;
|
|
3257
4186
|
}
|
|
3258
4187
|
|
|
4188
|
+
export declare type EditorVersionOptions = EditorFeatureConfig;
|
|
4189
|
+
|
|
3259
4190
|
/**
|
|
3260
4191
|
* 编辑器外部水印信息
|
|
3261
4192
|
*/
|
|
@@ -3263,7 +4194,12 @@ export declare interface EditorWatermarkOptions {
|
|
|
3263
4194
|
/**
|
|
3264
4195
|
* 获取用作初始化使用的默认水印
|
|
3265
4196
|
*/
|
|
3266
|
-
getWatermark
|
|
4197
|
+
getWatermark?: () => MaybePromiseValue<EditorWatermarkResource | null>;
|
|
4198
|
+
/**
|
|
4199
|
+
* 获取文件导出水印
|
|
4200
|
+
* @param exportType 导出类型 图片/pdf/纯图pdf
|
|
4201
|
+
*/
|
|
4202
|
+
getExportWatermark?: (exportType: 'image' | 'pdf' | 'image_pdf') => Promise<string[] | undefined>;
|
|
3267
4203
|
/**
|
|
3268
4204
|
* 是否必须,如果为 true,编辑器将在初始化时强制渲染水印,
|
|
3269
4205
|
* 水印配置信息加载失败将导致编辑器初始化失败
|
|
@@ -3279,19 +4215,17 @@ export declare type EditorWatermarkResource = {
|
|
|
3279
4215
|
url: string;
|
|
3280
4216
|
};
|
|
3281
4217
|
|
|
3282
|
-
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
|
|
3287
|
-
/**
|
|
3288
|
-
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
|
|
3293
|
-
*/
|
|
3294
|
-
Disabled = 2
|
|
4218
|
+
/**
|
|
4219
|
+
* 错误信息接口
|
|
4220
|
+
* 定义了表格组件中可能发生的错误信息结构
|
|
4221
|
+
*/
|
|
4222
|
+
export declare interface EventError {
|
|
4223
|
+
/** 错误代码,用于标识错误类型 */
|
|
4224
|
+
code: string;
|
|
4225
|
+
/** 错误消息,提供错误的详细描述 */
|
|
4226
|
+
data: {
|
|
4227
|
+
message: string;
|
|
4228
|
+
};
|
|
3295
4229
|
}
|
|
3296
4230
|
|
|
3297
4231
|
export declare interface FileLinkParams {
|
|
@@ -3300,7 +4234,7 @@ export declare interface FileLinkParams {
|
|
|
3300
4234
|
*/
|
|
3301
4235
|
fileGuid: string;
|
|
3302
4236
|
/**
|
|
3303
|
-
*
|
|
4237
|
+
* 文件类型
|
|
3304
4238
|
*/
|
|
3305
4239
|
type: string;
|
|
3306
4240
|
/**
|
|
@@ -3428,6 +4362,24 @@ export declare type GridMenuItemName = BaseMenuItemName
|
|
|
3428
4362
|
/** 展开父任务 */
|
|
3429
4363
|
| 'parentRecord';
|
|
3430
4364
|
|
|
4365
|
+
/**
|
|
4366
|
+
* 引导数据
|
|
4367
|
+
*/
|
|
4368
|
+
export declare interface GuideData {
|
|
4369
|
+
type: number;
|
|
4370
|
+
id: number;
|
|
4371
|
+
}
|
|
4372
|
+
|
|
4373
|
+
/**
|
|
4374
|
+
* 高亮单元格结构
|
|
4375
|
+
*/
|
|
4376
|
+
export declare interface HighLight {
|
|
4377
|
+
/** 记录ID */
|
|
4378
|
+
recordGuid: string;
|
|
4379
|
+
/** 字段ID */
|
|
4380
|
+
fieldGuid: string;
|
|
4381
|
+
}
|
|
4382
|
+
|
|
3431
4383
|
/**
|
|
3432
4384
|
* 请求、响应头
|
|
3433
4385
|
*/
|
|
@@ -3544,27 +4496,6 @@ export declare type KanbanMenuItemName = BaseMenuItemName
|
|
|
3544
4496
|
/** 移除分组 */
|
|
3545
4497
|
| 'removeGroup';
|
|
3546
4498
|
|
|
3547
|
-
export declare interface Limitation {
|
|
3548
|
-
/**
|
|
3549
|
-
* 限制原因(错误码)
|
|
3550
|
-
*/
|
|
3551
|
-
code?: number;
|
|
3552
|
-
/**
|
|
3553
|
-
* 单位(不参与计算,仅作显示)
|
|
3554
|
-
* minutes、MB
|
|
3555
|
-
*/
|
|
3556
|
-
unit?: string;
|
|
3557
|
-
/**
|
|
3558
|
-
* 描述
|
|
3559
|
-
*/
|
|
3560
|
-
desc?: string;
|
|
3561
|
-
/**
|
|
3562
|
-
* min/max int64 默认表示 MB/个/分钟/行
|
|
3563
|
-
*/
|
|
3564
|
-
max?: number;
|
|
3565
|
-
min?: number;
|
|
3566
|
-
}
|
|
3567
|
-
|
|
3568
4499
|
/**
|
|
3569
4500
|
* 列表视图菜单项
|
|
3570
4501
|
*/
|
|
@@ -3582,6 +4513,44 @@ export declare type ListMenuItemName = BaseMenuItemName
|
|
|
3582
4513
|
|
|
3583
4514
|
export declare type MaybePromiseValue<T> = T | Promise<T>;
|
|
3584
4515
|
|
|
4516
|
+
export declare interface MentionEventPayload {
|
|
4517
|
+
/**
|
|
4518
|
+
* 距离页面左边的距离
|
|
4519
|
+
*/
|
|
4520
|
+
x: number;
|
|
4521
|
+
/**
|
|
4522
|
+
* 距离页面顶部的距离
|
|
4523
|
+
*/
|
|
4524
|
+
y: number;
|
|
4525
|
+
/**
|
|
4526
|
+
* mention信息
|
|
4527
|
+
*/
|
|
4528
|
+
mentionInfo: MentionInfo;
|
|
4529
|
+
}
|
|
4530
|
+
|
|
4531
|
+
export declare interface MentionInfo {
|
|
4532
|
+
/** 用户 Id */
|
|
4533
|
+
userId?: number;
|
|
4534
|
+
/** 文件 Id */
|
|
4535
|
+
fileId?: string;
|
|
4536
|
+
/**
|
|
4537
|
+
* mention区域宽度
|
|
4538
|
+
*/
|
|
4539
|
+
width?: number;
|
|
4540
|
+
/**
|
|
4541
|
+
* mention区域高度
|
|
4542
|
+
*/
|
|
4543
|
+
height?: number;
|
|
4544
|
+
/**
|
|
4545
|
+
* mention区域左上角距离页面左边的距离
|
|
4546
|
+
*/
|
|
4547
|
+
left?: number;
|
|
4548
|
+
/**
|
|
4549
|
+
* mention区域左上角距离页面顶部的距离
|
|
4550
|
+
*/
|
|
4551
|
+
top?: number;
|
|
4552
|
+
}
|
|
4553
|
+
|
|
3585
4554
|
export declare enum MentionTypes {
|
|
3586
4555
|
Comment = "comment",
|
|
3587
4556
|
Mention = "mention_at",
|
|
@@ -3592,7 +4561,23 @@ export declare enum MentionTypes {
|
|
|
3592
4561
|
* 升级弹窗类型
|
|
3593
4562
|
* 个人版或企业版
|
|
3594
4563
|
*/
|
|
3595
|
-
export declare type OpenType = 'personal' | 'enterprise';
|
|
4564
|
+
export declare type OpenType = 'personal' | 'enterprise' | 'pendingOrder';
|
|
4565
|
+
|
|
4566
|
+
export declare interface OperationToastConfig {
|
|
4567
|
+
/**
|
|
4568
|
+
* 成功提示文本
|
|
4569
|
+
*/
|
|
4570
|
+
success?: string;
|
|
4571
|
+
/**
|
|
4572
|
+
* 失败提示文本
|
|
4573
|
+
*/
|
|
4574
|
+
failed?: string;
|
|
4575
|
+
/**
|
|
4576
|
+
* 权限不足提示文本
|
|
4577
|
+
* 桌面客户端安全模式下需要提供【当前账号未获得此项能力授权。】
|
|
4578
|
+
*/
|
|
4579
|
+
noPermission?: string;
|
|
4580
|
+
}
|
|
3596
4581
|
|
|
3597
4582
|
/**
|
|
3598
4583
|
* pdf 工具栏一级菜单
|
|
@@ -3671,6 +4656,12 @@ export declare interface PdfPages {
|
|
|
3671
4656
|
* 获取指定页面
|
|
3672
4657
|
*/
|
|
3673
4658
|
getPage: (page: number) => Promise<PdfPage | null>;
|
|
4659
|
+
/**
|
|
4660
|
+
* 获取指定页面的文本范围
|
|
4661
|
+
* @param page
|
|
4662
|
+
* @returns
|
|
4663
|
+
*/
|
|
4664
|
+
getPageRange: (page: number) => Promise<PdfRange | null>;
|
|
3674
4665
|
}
|
|
3675
4666
|
|
|
3676
4667
|
/**
|
|
@@ -3844,6 +4835,112 @@ export declare enum PermissionLevel {
|
|
|
3844
4835
|
Private = 2
|
|
3845
4836
|
}
|
|
3846
4837
|
|
|
4838
|
+
export declare interface PresentationAnonymousOptions extends EditorAnonymousOptions {
|
|
4839
|
+
/**
|
|
4840
|
+
* 是否在移动设备上显示登录
|
|
4841
|
+
*/
|
|
4842
|
+
isShowLoginBarInMobileDevice?: boolean;
|
|
4843
|
+
}
|
|
4844
|
+
|
|
4845
|
+
/**
|
|
4846
|
+
* 辅助面板相关设置
|
|
4847
|
+
*/
|
|
4848
|
+
export declare interface PresentationAssistantOptions {
|
|
4849
|
+
/**
|
|
4850
|
+
* 辅助面板入口
|
|
4851
|
+
*/
|
|
4852
|
+
entry?: {
|
|
4853
|
+
/**
|
|
4854
|
+
* 辅助面板入口是否隐藏
|
|
4855
|
+
*/
|
|
4856
|
+
hidden?: boolean;
|
|
4857
|
+
/**
|
|
4858
|
+
* 辅助面板入口是否禁用
|
|
4859
|
+
*/
|
|
4860
|
+
disabled?: boolean;
|
|
4861
|
+
/**
|
|
4862
|
+
* 辅助面板入口文本
|
|
4863
|
+
*/
|
|
4864
|
+
text?: string;
|
|
4865
|
+
/**
|
|
4866
|
+
* 辅助面板入口图标
|
|
4867
|
+
*/
|
|
4868
|
+
icon?: string;
|
|
4869
|
+
};
|
|
4870
|
+
/**
|
|
4871
|
+
* 辅助面板
|
|
4872
|
+
*/
|
|
4873
|
+
panel: {
|
|
4874
|
+
/**
|
|
4875
|
+
* 触发方式, 默认click
|
|
4876
|
+
*/
|
|
4877
|
+
trigger: 'click' | 'hover';
|
|
4878
|
+
/**
|
|
4879
|
+
* 隐藏提示
|
|
4880
|
+
*/
|
|
4881
|
+
hideTip?: boolean;
|
|
4882
|
+
};
|
|
4883
|
+
}
|
|
4884
|
+
|
|
4885
|
+
export declare interface PresentationChartOptions extends EditorFeatureConfig {
|
|
4886
|
+
/**
|
|
4887
|
+
* 生成表格
|
|
4888
|
+
*/
|
|
4889
|
+
generateSheet?: (options?: Record<string, string | number>) => Promise<{
|
|
4890
|
+
url: string;
|
|
4891
|
+
sheetId: string;
|
|
4892
|
+
}>;
|
|
4893
|
+
}
|
|
4894
|
+
|
|
4895
|
+
/**
|
|
4896
|
+
* 幻灯片评论接口
|
|
4897
|
+
*/
|
|
4898
|
+
export declare interface PresentationComments extends EditorComments {
|
|
4899
|
+
/**
|
|
4900
|
+
* 开始插入评论
|
|
4901
|
+
*/
|
|
4902
|
+
startInsert: () => void;
|
|
4903
|
+
/**
|
|
4904
|
+
* 结束插入评论
|
|
4905
|
+
*/
|
|
4906
|
+
endInsert: () => void;
|
|
4907
|
+
/**
|
|
4908
|
+
* 显示评论
|
|
4909
|
+
*/
|
|
4910
|
+
show: () => void;
|
|
4911
|
+
/**
|
|
4912
|
+
* 隐藏评论
|
|
4913
|
+
*/
|
|
4914
|
+
hide: () => void;
|
|
4915
|
+
}
|
|
4916
|
+
|
|
4917
|
+
/**
|
|
4918
|
+
* 幻灯片图示设置
|
|
4919
|
+
*/
|
|
4920
|
+
export declare interface PresentationDiagramOptions extends EditorFeatureConfig {
|
|
4921
|
+
/**
|
|
4922
|
+
* 隐藏限免
|
|
4923
|
+
*/
|
|
4924
|
+
hideTimeLimitedFree?: boolean;
|
|
4925
|
+
}
|
|
4926
|
+
|
|
4927
|
+
export declare interface PresentationEventSubscription {
|
|
4928
|
+
/**
|
|
4929
|
+
* 添加错误事件监听器
|
|
4930
|
+
*/
|
|
4931
|
+
addErrorListener: (listener: (error: {
|
|
4932
|
+
code: number | string;
|
|
4933
|
+
message?: string;
|
|
4934
|
+
}) => void) => () => void;
|
|
4935
|
+
}
|
|
4936
|
+
|
|
4937
|
+
export declare interface PresentationExportOptions extends EditorExportOptions {
|
|
4938
|
+
/**
|
|
4939
|
+
* 隐藏限时免费
|
|
4940
|
+
*/
|
|
4941
|
+
hideTimeLimitedFree?: boolean;
|
|
4942
|
+
}
|
|
4943
|
+
|
|
3847
4944
|
/**
|
|
3848
4945
|
* 幻灯片可导出类型
|
|
3849
4946
|
*/
|
|
@@ -3864,6 +4961,10 @@ export declare interface PresentationFontsList {
|
|
|
3864
4961
|
|
|
3865
4962
|
export declare interface PresentationFontsOptions {
|
|
3866
4963
|
list: PresentationFontsList;
|
|
4964
|
+
/**
|
|
4965
|
+
* 是否启用模糊匹配
|
|
4966
|
+
*/
|
|
4967
|
+
fuzzyMatch?: boolean;
|
|
3867
4968
|
}
|
|
3868
4969
|
|
|
3869
4970
|
/**
|
|
@@ -3883,48 +4984,143 @@ export declare type PresentationMenuFeatureButtonName = 'edit' | 'insert' | 'for
|
|
|
3883
4984
|
|
|
3884
4985
|
export declare type PresentationMenuOptions = EditorMenuOptions<PresentationMenuFeatureButtonName>;
|
|
3885
4986
|
|
|
3886
|
-
|
|
4987
|
+
/**
|
|
4988
|
+
* 幻灯片演示模式接口
|
|
4989
|
+
*/
|
|
4990
|
+
export declare interface PresentationOfPresentation {
|
|
3887
4991
|
/**
|
|
3888
|
-
*
|
|
4992
|
+
* 进入演示模式
|
|
4993
|
+
* @param index 幻灯片索引,如果不传或者为0,则是从头演示
|
|
3889
4994
|
*/
|
|
3890
|
-
|
|
4995
|
+
start: (index?: number) => Promise<void>;
|
|
3891
4996
|
/**
|
|
3892
|
-
*
|
|
4997
|
+
* 从当前幻灯片开始演示
|
|
3893
4998
|
*/
|
|
3894
|
-
|
|
4999
|
+
startFromCurrent: () => Promise<void>;
|
|
3895
5000
|
/**
|
|
3896
|
-
*
|
|
5001
|
+
* 进入远程演示模式
|
|
3897
5002
|
*/
|
|
3898
|
-
|
|
5003
|
+
startRemoteLive: () => Promise<void>;
|
|
3899
5004
|
/**
|
|
3900
|
-
*
|
|
5005
|
+
* 退出演示模式
|
|
3901
5006
|
*/
|
|
3902
|
-
|
|
5007
|
+
quit: () => Promise<void>;
|
|
5008
|
+
/**
|
|
5009
|
+
* 进入演讲者视图
|
|
5010
|
+
*/
|
|
5011
|
+
startSpeakerView: () => Promise<void>;
|
|
3903
5012
|
}
|
|
3904
5013
|
|
|
3905
5014
|
/**
|
|
3906
|
-
*
|
|
3907
|
-
* 表示窗口中的当前选定内容。
|
|
3908
|
-
* 选定内容表示幻灯片中的选定(或突出显示)区域,或者代表插入点(如果未选择幻灯片中的任何内容)。
|
|
5015
|
+
* 幻灯片远程模式设置项
|
|
3909
5016
|
*/
|
|
3910
|
-
export declare interface
|
|
5017
|
+
export declare interface PresentationRemoteLiveOptions extends EditorFeatureConfig {
|
|
3911
5018
|
/**
|
|
3912
|
-
*
|
|
3913
|
-
* 如果没有指定范围,则返回当前选区的范围。
|
|
3914
|
-
* 如果指定了范围,则返回指定范围的选区。
|
|
3915
|
-
* 如果选区不存在,则返回 null。
|
|
3916
|
-
* @returns
|
|
5019
|
+
* 是否进入远程模式, 默认false
|
|
3917
5020
|
*/
|
|
3918
|
-
|
|
5021
|
+
isEnterRemoteLiveMode?: boolean;
|
|
5022
|
+
/** */
|
|
3919
5023
|
/**
|
|
3920
|
-
*
|
|
3921
|
-
*
|
|
3922
|
-
*
|
|
3923
|
-
* @param value
|
|
5024
|
+
* 获取远程演示的 socket 对象
|
|
5025
|
+
* @param roomId 房间 id
|
|
5026
|
+
* @returns 远程演示的 socket 对象
|
|
3924
5027
|
*/
|
|
3925
|
-
|
|
5028
|
+
getSocket?: (roomId: string) => Promise<EditorSocket | undefined>;
|
|
3926
5029
|
/**
|
|
3927
|
-
*
|
|
5030
|
+
* 是否根据不同文件名语音显示不同的url文本
|
|
5031
|
+
* 暂留,如果各环境实现了getLiveUrl,此属性可移除
|
|
5032
|
+
*/
|
|
5033
|
+
isDiffUrlTextByTitleLang?: boolean;
|
|
5034
|
+
/**
|
|
5035
|
+
* 获取远程演示url
|
|
5036
|
+
*/
|
|
5037
|
+
getLiveUrl?: (params: {
|
|
5038
|
+
roomId: string;
|
|
5039
|
+
}) => Promise<string | undefined>;
|
|
5040
|
+
}
|
|
5041
|
+
|
|
5042
|
+
export declare interface PresentationSDKOptions extends EditorOptions {
|
|
5043
|
+
/**
|
|
5044
|
+
* 字体配置
|
|
5045
|
+
*/
|
|
5046
|
+
fonts?: PresentationFontsOptions;
|
|
5047
|
+
/**
|
|
5048
|
+
* 菜单栏相关设置
|
|
5049
|
+
*/
|
|
5050
|
+
menu?: PresentationMenuOptions;
|
|
5051
|
+
/**
|
|
5052
|
+
* 工具栏相关设置
|
|
5053
|
+
*/
|
|
5054
|
+
toolbar?: PresentationToolbarOptions;
|
|
5055
|
+
/**
|
|
5056
|
+
* 文本格式相关设置
|
|
5057
|
+
*/
|
|
5058
|
+
text?: PresentationTextOptions;
|
|
5059
|
+
/**
|
|
5060
|
+
* 远程演示相关设置
|
|
5061
|
+
*/
|
|
5062
|
+
remoteLive?: PresentationRemoteLiveOptions;
|
|
5063
|
+
/**
|
|
5064
|
+
* 渲染相关设置
|
|
5065
|
+
*/
|
|
5066
|
+
render?: EditorRenderOptions;
|
|
5067
|
+
/**
|
|
5068
|
+
* 图表相关设置
|
|
5069
|
+
*/
|
|
5070
|
+
chart?: PresentationChartOptions;
|
|
5071
|
+
/**
|
|
5072
|
+
* 主题相关设置
|
|
5073
|
+
*/
|
|
5074
|
+
theme?: PresentationThemeOptions;
|
|
5075
|
+
/**
|
|
5076
|
+
* 图示相关设置
|
|
5077
|
+
*/
|
|
5078
|
+
diagram?: PresentationDiagramOptions;
|
|
5079
|
+
/**
|
|
5080
|
+
* 协作者设置
|
|
5081
|
+
*/
|
|
5082
|
+
collaborators?: EditorCollaboratorsOptions;
|
|
5083
|
+
/**
|
|
5084
|
+
* 辅助面板设置
|
|
5085
|
+
*/
|
|
5086
|
+
assistant?: PresentationAssistantOptions;
|
|
5087
|
+
/**
|
|
5088
|
+
* 幻灯片窗格设置,即幻灯片界面左侧那一列缩略图的区域
|
|
5089
|
+
*/
|
|
5090
|
+
slidesPane?: PresentationSlidesPaneOptions;
|
|
5091
|
+
/**
|
|
5092
|
+
* 幻灯片导出设置
|
|
5093
|
+
*/
|
|
5094
|
+
export?: PresentationExportOptions;
|
|
5095
|
+
/**
|
|
5096
|
+
* 匿名用户设置
|
|
5097
|
+
*/
|
|
5098
|
+
anonymous?: PresentationAnonymousOptions;
|
|
5099
|
+
}
|
|
5100
|
+
|
|
5101
|
+
/**
|
|
5102
|
+
* 选区(Selection)
|
|
5103
|
+
* 表示窗口中的当前选定内容。
|
|
5104
|
+
* 选定内容表示幻灯片中的选定(或突出显示)区域,或者代表插入点(如果未选择幻灯片中的任何内容)。
|
|
5105
|
+
*/
|
|
5106
|
+
export declare interface PresentationSelection {
|
|
5107
|
+
/**
|
|
5108
|
+
* 获取选区的区域范围,
|
|
5109
|
+
* 如果没有指定范围,则返回当前选区的范围。
|
|
5110
|
+
* 如果指定了范围,则返回指定范围的选区。
|
|
5111
|
+
* 如果选区不存在,则返回 null。
|
|
5112
|
+
* @returns
|
|
5113
|
+
*/
|
|
5114
|
+
getTextRange: (value?: PresentationTextRangeValue) => PresentationTextRange | null;
|
|
5115
|
+
/**
|
|
5116
|
+
* 设置选区的区域范围,
|
|
5117
|
+
* 设置后,选区会自动选中指定范围。
|
|
5118
|
+
* 如果设置为 null,则清空选区。
|
|
5119
|
+
* @param value
|
|
5120
|
+
*/
|
|
5121
|
+
setTextRange: (value: PresentationTextRangeValue | null) => void;
|
|
5122
|
+
/**
|
|
5123
|
+
* 获取当前选中的形状,
|
|
3928
5124
|
* 如果没有选中形状,则返回 null。
|
|
3929
5125
|
* 如果指定了 value,则返回指定形状。
|
|
3930
5126
|
* @param ids 指定的形状 id
|
|
@@ -4026,6 +5222,33 @@ export declare interface PresentationSlides {
|
|
|
4026
5222
|
setSelectedSlides: (ids: string[]) => void;
|
|
4027
5223
|
}
|
|
4028
5224
|
|
|
5225
|
+
/**
|
|
5226
|
+
* 幻灯片窗格
|
|
5227
|
+
*/
|
|
5228
|
+
export declare interface PresentationSlidesPaneOptions {
|
|
5229
|
+
/**
|
|
5230
|
+
* 是否禁用, 默认false
|
|
5231
|
+
*/
|
|
5232
|
+
disabled?: boolean;
|
|
5233
|
+
/**
|
|
5234
|
+
* 宽度设置
|
|
5235
|
+
*/
|
|
5236
|
+
width?: {
|
|
5237
|
+
/**
|
|
5238
|
+
* 初始宽度
|
|
5239
|
+
*/
|
|
5240
|
+
initValue?: number;
|
|
5241
|
+
/**
|
|
5242
|
+
* 宽度调整设置
|
|
5243
|
+
*/
|
|
5244
|
+
resize: {
|
|
5245
|
+
disabled?: boolean;
|
|
5246
|
+
min?: number;
|
|
5247
|
+
max?: number;
|
|
5248
|
+
};
|
|
5249
|
+
};
|
|
5250
|
+
}
|
|
5251
|
+
|
|
4029
5252
|
/**
|
|
4030
5253
|
* 演示文稿文本接口
|
|
4031
5254
|
*/
|
|
@@ -4088,6 +5311,13 @@ export declare interface PresentationTextRangeValue {
|
|
|
4088
5311
|
end: string;
|
|
4089
5312
|
}
|
|
4090
5313
|
|
|
5314
|
+
export declare interface PresentationThemeOptions extends EditorFeatureConfig {
|
|
5315
|
+
/**
|
|
5316
|
+
* 是否禁用图片缓存, 默认不禁用
|
|
5317
|
+
*/
|
|
5318
|
+
isImageCacheDisabled?: boolean;
|
|
5319
|
+
}
|
|
5320
|
+
|
|
4091
5321
|
/**
|
|
4092
5322
|
* 幻灯片工具栏功能按钮
|
|
4093
5323
|
*/
|
|
@@ -4145,6 +5375,18 @@ export declare interface PresentationZoom {
|
|
|
4145
5375
|
zoomOut: () => void;
|
|
4146
5376
|
}
|
|
4147
5377
|
|
|
5378
|
+
/**
|
|
5379
|
+
* 数据源读取来源枚举
|
|
5380
|
+
*/
|
|
5381
|
+
export declare enum ReadFrom {
|
|
5382
|
+
/** 未知来源 */
|
|
5383
|
+
UNKNOWN = 0,
|
|
5384
|
+
/** 远程来源,适用于SAAS */
|
|
5385
|
+
REMOTE = 1,
|
|
5386
|
+
/** 本地来源,适用于极速SDK */
|
|
5387
|
+
LOCAL = 2
|
|
5388
|
+
}
|
|
5389
|
+
|
|
4148
5390
|
export declare interface RemoveRangeLocksParams {
|
|
4149
5391
|
sheetId?: string;
|
|
4150
5392
|
ranges?: SheetCellRange[];
|
|
@@ -4174,91 +5416,80 @@ export declare interface RenderUserCardProps {
|
|
|
4174
5416
|
height: number;
|
|
4175
5417
|
hasReducedHeaderHeight?: boolean;
|
|
4176
5418
|
};
|
|
4177
|
-
position?: 'top' | 'left' | 'right' | 'bottom' | 'left_top' | 'left_bottom' | 'right_top' | '
|
|
4178
|
-
trigger
|
|
5419
|
+
position?: 'top' | 'left' | 'right' | 'bottom' | 'left_top' | 'left_bottom' | 'right_top' | 'right_bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right';
|
|
5420
|
+
trigger?: 'hover' | 'click';
|
|
4179
5421
|
}
|
|
4180
5422
|
|
|
4181
5423
|
export declare interface RenderUserCardResult {
|
|
4182
5424
|
/**
|
|
4183
5425
|
* 关闭用户卡片
|
|
4184
5426
|
*/
|
|
4185
|
-
close
|
|
5427
|
+
close?: (force?: boolean) => void;
|
|
4186
5428
|
}
|
|
4187
5429
|
|
|
4188
5430
|
/**
|
|
4189
|
-
*
|
|
5431
|
+
* 资源API接口基础结构
|
|
4190
5432
|
*/
|
|
4191
5433
|
export declare interface ResourceApi {
|
|
4192
5434
|
/**
|
|
4193
5435
|
* 获取请求URL
|
|
4194
|
-
* @returns
|
|
5436
|
+
* @returns 接口请求URL
|
|
4195
5437
|
*/
|
|
4196
5438
|
getUrl: () => string;
|
|
4197
|
-
/**
|
|
4198
|
-
* 请求方法
|
|
4199
|
-
*/
|
|
5439
|
+
/** 请求方法 */
|
|
4200
5440
|
method?: HTTPMethod;
|
|
4201
|
-
/**
|
|
4202
|
-
* 请求头信息
|
|
4203
|
-
*/
|
|
5441
|
+
/** 请求头信息 */
|
|
4204
5442
|
headers?: HTTPHeaders;
|
|
4205
5443
|
}
|
|
4206
5444
|
|
|
4207
5445
|
/**
|
|
4208
5446
|
* 表格资源相关API接口集合
|
|
4209
|
-
* 定义了表格应用中所需的各种网络请求接口
|
|
4210
5447
|
*/
|
|
4211
5448
|
export declare interface ResourceApis {
|
|
4212
5449
|
/**
|
|
4213
|
-
*
|
|
5450
|
+
* 获取表格基础文件数据
|
|
4214
5451
|
*/
|
|
4215
5452
|
fetchBase: Omit<ResourceApi, 'getUrl'> & {
|
|
4216
5453
|
/**
|
|
4217
|
-
*
|
|
4218
|
-
* @
|
|
4219
|
-
* @returns 返回API请求URL
|
|
5454
|
+
* @param fileId 文件ID
|
|
5455
|
+
* @returns 请求URL
|
|
4220
5456
|
*/
|
|
4221
5457
|
getUrl: (fileId: string) => string;
|
|
4222
5458
|
};
|
|
4223
5459
|
/**
|
|
4224
|
-
* 获取表格Motable文件URL
|
|
4225
|
-
*
|
|
5460
|
+
* 获取表格Motable文件URL
|
|
5461
|
+
* 主要在切换视图时调用
|
|
4226
5462
|
*/
|
|
4227
5463
|
fetchMotableUrls: Omit<ResourceApi, 'getUrl'> & {
|
|
4228
5464
|
/**
|
|
4229
|
-
*
|
|
4230
|
-
* @param
|
|
4231
|
-
* @
|
|
4232
|
-
* @returns 返回API请求URL
|
|
5465
|
+
* @param fileId 文件ID
|
|
5466
|
+
* @param sheetId 工作表ID
|
|
5467
|
+
* @returns 请求URL
|
|
4233
5468
|
*/
|
|
4234
5469
|
getUrl: (fileId: string, sheetId: string) => string;
|
|
4235
5470
|
};
|
|
4236
5471
|
/**
|
|
4237
|
-
*
|
|
5472
|
+
* 获取仪表盘数据
|
|
4238
5473
|
*/
|
|
4239
5474
|
fetchDashboard: Omit<ResourceApi, 'getUrl'> & {
|
|
4240
5475
|
/**
|
|
4241
|
-
*
|
|
4242
|
-
* @param
|
|
4243
|
-
* @
|
|
4244
|
-
* @returns 返回API请求URL
|
|
5476
|
+
* @param fileId 文件ID
|
|
5477
|
+
* @param dashboardId 仪表盘ID
|
|
5478
|
+
* @returns 请求URL
|
|
4245
5479
|
*/
|
|
4246
5480
|
getUrl: (fileId: string, dashboardId: string) => string;
|
|
4247
5481
|
};
|
|
4248
5482
|
/**
|
|
4249
|
-
*
|
|
4250
|
-
* 用于获取日历中的节假日信息
|
|
5483
|
+
* 获取节假日信息
|
|
4251
5484
|
*/
|
|
4252
5485
|
fetchYearHolidays: ResourceApi;
|
|
4253
5486
|
/**
|
|
4254
|
-
*
|
|
4255
|
-
* 用于保存表格的所有更改
|
|
5487
|
+
* 保存表格更改
|
|
4256
5488
|
*/
|
|
4257
5489
|
saveChanges: Omit<ResourceApi, 'getUrl'> & {
|
|
4258
5490
|
/**
|
|
4259
|
-
*
|
|
4260
|
-
* @
|
|
4261
|
-
* @returns 返回API请求URL
|
|
5491
|
+
* @param fileId 文件ID
|
|
5492
|
+
* @returns 请求URL
|
|
4262
5493
|
*/
|
|
4263
5494
|
getUrl: (fileId: string) => string;
|
|
4264
5495
|
};
|
|
@@ -4448,23 +5679,93 @@ export declare type SheetChecklistOptions = EditorFeatureConfig;
|
|
|
4448
5679
|
export declare interface SheetCombineSheetsOptions extends EditorFeatureConfig {
|
|
4449
5680
|
/**
|
|
4450
5681
|
* 是否隐藏通过链接进行合并的入口
|
|
5682
|
+
* sdk2.0需要禁用
|
|
4451
5683
|
*/
|
|
4452
5684
|
isCombineByUrlHidden?: boolean;
|
|
4453
5685
|
/**
|
|
4454
5686
|
* 是否隐藏生成合并工作表的位置配置入口
|
|
5687
|
+
* sdk2.0需要禁用
|
|
4455
5688
|
*/
|
|
4456
5689
|
isCombinedLocationHidden?: boolean;
|
|
4457
5690
|
}
|
|
4458
5691
|
|
|
4459
|
-
export declare interface
|
|
5692
|
+
export declare interface SheetDateMentionOptions extends EditorFeatureConfig {
|
|
5693
|
+
/**
|
|
5694
|
+
* 是否禁用日期提醒规则设置
|
|
5695
|
+
* 桌面客户端需要禁止
|
|
5696
|
+
*/
|
|
5697
|
+
disableRuleSetting?: boolean;
|
|
5698
|
+
}
|
|
5699
|
+
|
|
5700
|
+
export declare interface SheetEventSubscription {
|
|
5701
|
+
/**
|
|
5702
|
+
* 添加视图区域大小变化监听器
|
|
5703
|
+
*/
|
|
5704
|
+
addViewportSizeChangedListener: (listener: (size: {
|
|
5705
|
+
width: number;
|
|
5706
|
+
height: number;
|
|
5707
|
+
}) => void) => () => void;
|
|
5708
|
+
/**
|
|
5709
|
+
* 添加保存状态变化监听器
|
|
5710
|
+
*/
|
|
5711
|
+
addSaveStatusChangedListener: (listener: (status: string) => void) => () => void;
|
|
5712
|
+
/**
|
|
5713
|
+
* 添加错误事件监听器
|
|
5714
|
+
*/
|
|
5715
|
+
addErrorListener: (listener: (error: {
|
|
5716
|
+
code: number | string;
|
|
5717
|
+
message?: string;
|
|
5718
|
+
}) => void) => () => void;
|
|
5719
|
+
/**
|
|
5720
|
+
* 添加URL变化监听器
|
|
5721
|
+
*/
|
|
5722
|
+
addUrlChangedListener: (listener: (params: FileLinkParams & {
|
|
5723
|
+
sheetId: string;
|
|
5724
|
+
}) => void) => () => void;
|
|
5725
|
+
/**
|
|
5726
|
+
* 添加鼠标移动监听器
|
|
5727
|
+
*/
|
|
5728
|
+
addMouseMoveListener: (listener: (params: {
|
|
5729
|
+
x: number;
|
|
5730
|
+
y: number;
|
|
5731
|
+
mentionInfo?: MentionInfo;
|
|
5732
|
+
}) => void) => () => void;
|
|
5733
|
+
/**
|
|
5734
|
+
* 添加鼠标点击监听器
|
|
5735
|
+
*/
|
|
5736
|
+
addHorizontalScrollListener: (listener: () => void) => () => void;
|
|
5737
|
+
/**
|
|
5738
|
+
* 添加垂直滚动监听器
|
|
5739
|
+
*/
|
|
5740
|
+
addVerticalScrollListener: (listener: () => void) => () => void;
|
|
5741
|
+
}
|
|
5742
|
+
|
|
5743
|
+
/**
|
|
5744
|
+
* 导出回调接口
|
|
5745
|
+
*/
|
|
5746
|
+
export declare interface SheetExportCallbacks {
|
|
4460
5747
|
/**
|
|
4461
|
-
*
|
|
5748
|
+
* 导出开始时的回调
|
|
4462
5749
|
*/
|
|
4463
|
-
|
|
5750
|
+
onStart: () => void;
|
|
4464
5751
|
/**
|
|
4465
|
-
*
|
|
5752
|
+
* 公式计算超时时的回调
|
|
5753
|
+
* @param downloadUrl - 下载链接
|
|
5754
|
+
* @param message - 超时的提示信息
|
|
5755
|
+
* @returns 是否继续导出
|
|
4466
5756
|
*/
|
|
4467
|
-
|
|
5757
|
+
onFormulaCalculateTimeout: (downloadUrl: string, message: string) => Promise<boolean>;
|
|
5758
|
+
/**
|
|
5759
|
+
* 导出成功时的回调
|
|
5760
|
+
* @param downloadUrl - 下载链接
|
|
5761
|
+
* @param message - 导出的提示信息
|
|
5762
|
+
*/
|
|
5763
|
+
onSuccess: (downloadUrl: string, message?: string) => void;
|
|
5764
|
+
/**
|
|
5765
|
+
* 导出失败时的回调
|
|
5766
|
+
* @param error - 错误信息
|
|
5767
|
+
*/
|
|
5768
|
+
onError: (error?: unknown) => void;
|
|
4468
5769
|
}
|
|
4469
5770
|
|
|
4470
5771
|
export declare interface SheetExportOptions extends EditorExportOptions {
|
|
@@ -4472,43 +5773,110 @@ export declare interface SheetExportOptions extends EditorExportOptions {
|
|
|
4472
5773
|
* 导出单个sheet的方法
|
|
4473
5774
|
* @param type - 导出类型,支持 'csv' 或 'xlsx' 格式
|
|
4474
5775
|
* @param sheetId - 表格ID,用于指定要导出的特定表格
|
|
5776
|
+
* @param options - 导出回调选项
|
|
4475
5777
|
*/
|
|
4476
|
-
exportSheet?: (type: 'csv' | 'xlsx', sheetId: string) => Promise<void>;
|
|
5778
|
+
exportSheet?: (type: 'csv' | 'xlsx', sheetId: string, callbacks: SheetExportCallbacks) => Promise<void>;
|
|
4477
5779
|
}
|
|
4478
5780
|
|
|
4479
|
-
|
|
5781
|
+
/**
|
|
5782
|
+
* 关注选区配置
|
|
5783
|
+
*/
|
|
5784
|
+
export declare type SheetFollowSelectionOptions = EditorFeatureConfig;
|
|
5785
|
+
|
|
5786
|
+
export declare interface SheetFormOptions extends EditorFeatureConfig {
|
|
5787
|
+
/**
|
|
5788
|
+
* 填写页相关配置
|
|
5789
|
+
*/
|
|
5790
|
+
fill?: {
|
|
5791
|
+
/**
|
|
5792
|
+
* 是否禁止填写
|
|
5793
|
+
*/
|
|
5794
|
+
disabled?: boolean;
|
|
5795
|
+
};
|
|
5796
|
+
/**
|
|
5797
|
+
* 创建表单文件
|
|
5798
|
+
* 有guid的是sdk2.0的接口,没有guid的是sass的接口
|
|
5799
|
+
*/
|
|
5800
|
+
createFile: (params: {
|
|
5801
|
+
content: string;
|
|
5802
|
+
name: string;
|
|
5803
|
+
guid: string;
|
|
5804
|
+
folder?: string;
|
|
5805
|
+
}) => Promise<{
|
|
5806
|
+
guid: string;
|
|
5807
|
+
id: number;
|
|
5808
|
+
}>;
|
|
4480
5809
|
/**
|
|
4481
|
-
*
|
|
5810
|
+
* 获取表单文件的父级文件
|
|
5811
|
+
* sass需要提供
|
|
4482
5812
|
*/
|
|
4483
|
-
|
|
5813
|
+
getFileAncestors?: (fileGuid: string) => Promise<EditorFileOptions[]>;
|
|
4484
5814
|
}
|
|
4485
5815
|
|
|
4486
|
-
export declare interface
|
|
5816
|
+
export declare interface SheetFormulaOptions {
|
|
4487
5817
|
/**
|
|
4488
|
-
*
|
|
5818
|
+
* 公式缓存设置
|
|
4489
5819
|
*/
|
|
4490
|
-
|
|
5820
|
+
cache?: {
|
|
5821
|
+
/**
|
|
5822
|
+
* 禁用公式缓存
|
|
5823
|
+
*/
|
|
5824
|
+
disabled?: boolean;
|
|
5825
|
+
/**
|
|
5826
|
+
* 是否公式缓存, 需通过内容接口response header获取
|
|
5827
|
+
*/
|
|
5828
|
+
hasFormulaCache?: MaybePromiseValue<boolean>;
|
|
5829
|
+
};
|
|
4491
5830
|
}
|
|
4492
5831
|
|
|
4493
|
-
export declare interface
|
|
5832
|
+
export declare interface SheetImportOptions extends EditorImportOptions {
|
|
4494
5833
|
/**
|
|
4495
|
-
*
|
|
5834
|
+
* 获取图片导入状态
|
|
5835
|
+
* 导入包含大量图片的sheet时,导入成功状态将不再包含图片上传的状态
|
|
5836
|
+
* 第一次打开导入的表格时,图片有可能是没有上传到服务器,为了避免发送不必要的图片请求,需要将图片地址替换成loading状态图标
|
|
4496
5837
|
*/
|
|
4497
|
-
|
|
5838
|
+
getImageImportStatus?: () => Promise<{
|
|
5839
|
+
pending: string[];
|
|
5840
|
+
failed: string[];
|
|
5841
|
+
}>;
|
|
4498
5842
|
}
|
|
4499
5843
|
|
|
4500
5844
|
export declare interface SheetImportRangeOptions extends EditorFeatureConfig {
|
|
4501
5845
|
/**
|
|
4502
|
-
*
|
|
4503
|
-
|
|
4504
|
-
|
|
5846
|
+
* 是否正在进行引用范围选择
|
|
5847
|
+
*/
|
|
5848
|
+
isSelectingRange?: boolean;
|
|
5849
|
+
/**
|
|
5850
|
+
* 跨表格引用限制
|
|
5851
|
+
*/
|
|
5852
|
+
limitations?: {
|
|
5853
|
+
/**
|
|
5854
|
+
* 是否检查跨表引用文件信息是否超限
|
|
5855
|
+
* 私有部署环境需要开启
|
|
5856
|
+
*/
|
|
5857
|
+
enableFileStatsCheck?: boolean;
|
|
5858
|
+
/**
|
|
5859
|
+
* 获取最大引用数量
|
|
5860
|
+
*/
|
|
5861
|
+
getMaxReferencesCount?: () => Promise<number | undefined>;
|
|
5862
|
+
};
|
|
5863
|
+
/**
|
|
5864
|
+
* 推送跨表格引用更新事件的 socket 对象
|
|
5865
|
+
*/
|
|
5866
|
+
socket?: EditorSocket;
|
|
5867
|
+
}
|
|
5868
|
+
|
|
5869
|
+
export declare interface SheetIndependentViewportOptions extends EditorFeatureConfig {
|
|
5870
|
+
/**
|
|
5871
|
+
* 是否禁用复制独立视图链接
|
|
4505
5872
|
*/
|
|
4506
|
-
|
|
5873
|
+
isCopyViewportLinkDisabled?: boolean;
|
|
4507
5874
|
}
|
|
4508
5875
|
|
|
4509
5876
|
export declare interface SheetLockOptions extends EditorFeatureConfig {
|
|
4510
5877
|
/**
|
|
4511
5878
|
* 添加锁定列表的占位文案
|
|
5879
|
+
* 部分客户需要自定义
|
|
4512
5880
|
*/
|
|
4513
5881
|
lockListInputPlaceholder?: string;
|
|
4514
5882
|
/**
|
|
@@ -4517,6 +5885,7 @@ export declare interface SheetLockOptions extends EditorFeatureConfig {
|
|
|
4517
5885
|
isBatchLockHidden?: boolean;
|
|
4518
5886
|
/**
|
|
4519
5887
|
* 是否禁止通过手机号查找锁定名单
|
|
5888
|
+
* sdk2.0需要禁用
|
|
4520
5889
|
*/
|
|
4521
5890
|
isSearchByPhoneNumberDisabled?: boolean;
|
|
4522
5891
|
/**
|
|
@@ -4527,13 +5896,13 @@ export declare interface SheetLockOptions extends EditorFeatureConfig {
|
|
|
4527
5896
|
|
|
4528
5897
|
export declare interface SheetLocks {
|
|
4529
5898
|
/**
|
|
4530
|
-
*
|
|
5899
|
+
* 显示锁定(侧边栏或其他形式)
|
|
4531
5900
|
*/
|
|
4532
|
-
|
|
5901
|
+
show: () => void;
|
|
4533
5902
|
/**
|
|
4534
|
-
*
|
|
5903
|
+
* 隐藏锁定(侧边栏或其他形式)
|
|
4535
5904
|
*/
|
|
4536
|
-
|
|
5905
|
+
hide: () => void;
|
|
4537
5906
|
/**
|
|
4538
5907
|
* 添加单元格锁定
|
|
4539
5908
|
*/
|
|
@@ -4550,6 +5919,10 @@ export declare interface SheetLocks {
|
|
|
4550
5919
|
* 移除工作表锁定
|
|
4551
5920
|
*/
|
|
4552
5921
|
removeSheetLock: (params: RemoveSheetLockParams) => void;
|
|
5922
|
+
/**
|
|
5923
|
+
* 是否包含不可见锁定
|
|
5924
|
+
*/
|
|
5925
|
+
containsPrivateLock: () => boolean;
|
|
4553
5926
|
}
|
|
4554
5927
|
|
|
4555
5928
|
export declare interface SheetMention {
|
|
@@ -4578,6 +5951,28 @@ export declare type SheetMenuFeatureButtonName = 'edit' | 'insert' | 'format' |
|
|
|
4578
5951
|
|
|
4579
5952
|
export declare type SheetMenuOptions = EditorMenuOptions<SheetMenuFeatureButtonName>;
|
|
4580
5953
|
|
|
5954
|
+
export declare interface SheetOleOptions extends EditorFeatureConfig {
|
|
5955
|
+
/**
|
|
5956
|
+
* 预览按钮提示文本
|
|
5957
|
+
* 桌面客户端需要提供
|
|
5958
|
+
*/
|
|
5959
|
+
previewTooltip?: string;
|
|
5960
|
+
}
|
|
5961
|
+
|
|
5962
|
+
export declare interface SheetPasteLimitationOptions extends EditorPasteLimitationOptions {
|
|
5963
|
+
/**
|
|
5964
|
+
* 获取允许粘贴的最大单元格数量
|
|
5965
|
+
*/
|
|
5966
|
+
getMaxCellsCount?: () => Promise<number | undefined>;
|
|
5967
|
+
}
|
|
5968
|
+
|
|
5969
|
+
export declare interface SheetPasteOptions extends EditorPasteOptions {
|
|
5970
|
+
/**
|
|
5971
|
+
* 粘贴限制
|
|
5972
|
+
*/
|
|
5973
|
+
limitations?: SheetPasteLimitationOptions;
|
|
5974
|
+
}
|
|
5975
|
+
|
|
4581
5976
|
/**
|
|
4582
5977
|
* 表格区域对象,
|
|
4583
5978
|
* 用于表示表格中被选中的单元格区域,
|
|
@@ -4709,7 +6104,7 @@ export declare type SheetRangeValue = {
|
|
|
4709
6104
|
type: `${SheetRangeType.Sheet}`;
|
|
4710
6105
|
};
|
|
4711
6106
|
|
|
4712
|
-
export declare interface SheetRenderOptions {
|
|
6107
|
+
export declare interface SheetRenderOptions extends EditorRenderOptions {
|
|
4713
6108
|
/**
|
|
4714
6109
|
* 激活的工作表 ID
|
|
4715
6110
|
*/
|
|
@@ -4718,13 +6113,18 @@ export declare interface SheetRenderOptions {
|
|
|
4718
6113
|
* 是否显示表格标题(oppo tt移动端专用)
|
|
4719
6114
|
*/
|
|
4720
6115
|
showSheetTitle?: boolean;
|
|
6116
|
+
/**
|
|
6117
|
+
* 是否禁止自动聚焦
|
|
6118
|
+
* 不自动聚焦需要用鼠标单击选中单元格后才能使用键盘编辑
|
|
6119
|
+
*/
|
|
6120
|
+
disableAutoFocus?: boolean;
|
|
4721
6121
|
}
|
|
4722
6122
|
|
|
4723
6123
|
export declare interface SheetSDKOptions extends EditorOptions {
|
|
4724
6124
|
/**
|
|
4725
6125
|
* 字体配置
|
|
4726
6126
|
*/
|
|
4727
|
-
fonts?:
|
|
6127
|
+
fonts?: EditorFontsOptions;
|
|
4728
6128
|
/**
|
|
4729
6129
|
* 菜单栏相关设置
|
|
4730
6130
|
*/
|
|
@@ -4795,6 +6195,38 @@ export declare interface SheetSDKOptions extends EditorOptions {
|
|
|
4795
6195
|
* 公式
|
|
4796
6196
|
*/
|
|
4797
6197
|
formula?: SheetFormulaOptions;
|
|
6198
|
+
/**
|
|
6199
|
+
* 表格UI相关设置
|
|
6200
|
+
*/
|
|
6201
|
+
ui?: SheetUiOptions;
|
|
6202
|
+
/**
|
|
6203
|
+
* 独立视图相关设置
|
|
6204
|
+
*/
|
|
6205
|
+
independentViewport?: SheetIndependentViewportOptions;
|
|
6206
|
+
/**
|
|
6207
|
+
* 关注选区相关设置
|
|
6208
|
+
*/
|
|
6209
|
+
followSelection?: SheetFollowSelectionOptions;
|
|
6210
|
+
/**
|
|
6211
|
+
* 导入设置
|
|
6212
|
+
*/
|
|
6213
|
+
import?: SheetImportOptions;
|
|
6214
|
+
/**
|
|
6215
|
+
* 表格sheet栏相关设置
|
|
6216
|
+
*/
|
|
6217
|
+
sheetTab?: SheetTabOptions;
|
|
6218
|
+
/**
|
|
6219
|
+
* 日期提醒设置
|
|
6220
|
+
*/
|
|
6221
|
+
dateMention?: SheetDateMentionOptions;
|
|
6222
|
+
/**
|
|
6223
|
+
* OLE对象设置
|
|
6224
|
+
*/
|
|
6225
|
+
ole?: SheetOleOptions;
|
|
6226
|
+
/**
|
|
6227
|
+
* 粘贴设置
|
|
6228
|
+
*/
|
|
6229
|
+
paste?: SheetPasteOptions;
|
|
4798
6230
|
}
|
|
4799
6231
|
|
|
4800
6232
|
/**
|
|
@@ -4825,6 +6257,16 @@ export declare interface SheetSensitizationOptions extends EditorFeatureConfig {
|
|
|
4825
6257
|
isLowestPermissionMode?: boolean;
|
|
4826
6258
|
}
|
|
4827
6259
|
|
|
6260
|
+
/**
|
|
6261
|
+
* 表格底部sheet栏配置
|
|
6262
|
+
*/
|
|
6263
|
+
export declare interface SheetTabOptions extends EditorFeatureConfig {
|
|
6264
|
+
/**
|
|
6265
|
+
* 是否显示演示按钮
|
|
6266
|
+
*/
|
|
6267
|
+
showPresentationButton?: boolean;
|
|
6268
|
+
}
|
|
6269
|
+
|
|
4828
6270
|
/**
|
|
4829
6271
|
* 电子表格文本接口
|
|
4830
6272
|
*/
|
|
@@ -4862,6 +6304,46 @@ export declare type SheetToolbarOptions = EditorToolbarOptions<SheetToolbarFeatu
|
|
|
4862
6304
|
|
|
4863
6305
|
export declare type SheetToTableOptions = EditorFeatureConfig;
|
|
4864
6306
|
|
|
6307
|
+
export declare interface SheetUiOptions extends EditorUiOptions {
|
|
6308
|
+
/**
|
|
6309
|
+
* 移动端顶部栏配置
|
|
6310
|
+
*/
|
|
6311
|
+
mobileHeaderBar?: {
|
|
6312
|
+
/**
|
|
6313
|
+
* 是否固定移动端顶部栏
|
|
6314
|
+
* sdk2.0需要固定
|
|
6315
|
+
*/
|
|
6316
|
+
isFixed?: boolean;
|
|
6317
|
+
};
|
|
6318
|
+
/**
|
|
6319
|
+
* 表格fx栏配置
|
|
6320
|
+
*/
|
|
6321
|
+
fxEditor?: EditorFeatureConfig;
|
|
6322
|
+
/**
|
|
6323
|
+
* 表格右键菜单配置
|
|
6324
|
+
*/
|
|
6325
|
+
contextMenu?: {
|
|
6326
|
+
/**
|
|
6327
|
+
* 复制范围链接配置
|
|
6328
|
+
* 桌面客户端需要禁用
|
|
6329
|
+
*/
|
|
6330
|
+
copyRangeLink?: EditorFeatureConfig;
|
|
6331
|
+
};
|
|
6332
|
+
/**
|
|
6333
|
+
* 工作表菜单配置
|
|
6334
|
+
*/
|
|
6335
|
+
sheetMenu?: {
|
|
6336
|
+
/**
|
|
6337
|
+
* 下载工作表配置
|
|
6338
|
+
*/
|
|
6339
|
+
downloadSheet?: EditorFeatureConfig;
|
|
6340
|
+
/**
|
|
6341
|
+
* 移动工作表配置
|
|
6342
|
+
*/
|
|
6343
|
+
moveSheet?: EditorFeatureConfig;
|
|
6344
|
+
};
|
|
6345
|
+
}
|
|
6346
|
+
|
|
4865
6347
|
/**
|
|
4866
6348
|
* 工作表集合对象
|
|
4867
6349
|
*/
|
|
@@ -4991,6 +6473,22 @@ export declare interface SheetWorksheet {
|
|
|
4991
6473
|
* 粘贴
|
|
4992
6474
|
*/
|
|
4993
6475
|
paste: (params: ClipboardPasteParams) => void;
|
|
6476
|
+
/**
|
|
6477
|
+
* 结束编辑
|
|
6478
|
+
*/
|
|
6479
|
+
endEdit: () => void;
|
|
6480
|
+
}
|
|
6481
|
+
|
|
6482
|
+
export declare interface ShortcutConfig {
|
|
6483
|
+
/**
|
|
6484
|
+
* 快捷键,例如保存快捷键windows为ctrl+s, mac系统则为meta+s
|
|
6485
|
+
* 如果不想区分系统则为mod+s
|
|
6486
|
+
*/
|
|
6487
|
+
key: string;
|
|
6488
|
+
/**
|
|
6489
|
+
* 快捷键回调
|
|
6490
|
+
*/
|
|
6491
|
+
callback: () => void;
|
|
4994
6492
|
}
|
|
4995
6493
|
|
|
4996
6494
|
export declare interface ShowConfirmOptions {
|
|
@@ -5012,6 +6510,10 @@ export declare interface ShowConfirmOptions {
|
|
|
5012
6510
|
cancelButton?: ConfirmButtonConfig;
|
|
5013
6511
|
}
|
|
5014
6512
|
|
|
6513
|
+
export declare interface ShowTemplateModalProps {
|
|
6514
|
+
applyTemplate: (options: TemplateProps) => void;
|
|
6515
|
+
}
|
|
6516
|
+
|
|
5015
6517
|
export declare interface ShowToastOptions {
|
|
5016
6518
|
/**
|
|
5017
6519
|
* toast标题
|
|
@@ -5070,6 +6572,27 @@ export declare interface Speaker {
|
|
|
5070
6572
|
avatar: string;
|
|
5071
6573
|
}
|
|
5072
6574
|
|
|
6575
|
+
/**
|
|
6576
|
+
* 表格编辑器状态枚举
|
|
6577
|
+
* 定义了表格编辑器可能处于的各种状态
|
|
6578
|
+
*/
|
|
6579
|
+
export declare enum Status {
|
|
6580
|
+
/** 离线模式 - 无法连接服务器 */
|
|
6581
|
+
Offline = "offline",
|
|
6582
|
+
/** 在线模式 - 已连接服务器 */
|
|
6583
|
+
Online = "online",
|
|
6584
|
+
/** 保存中 - 正在将更改提交到服务器 */
|
|
6585
|
+
OnlineSaving = "onlineSaving",
|
|
6586
|
+
/** 保存成功 - 更改已成功保存到服务器 */
|
|
6587
|
+
OnlineSaved = "onlineSaved",
|
|
6588
|
+
/** 保存失败 - 向服务器提交更改时发生错误 */
|
|
6589
|
+
OnlineSaveFailed = "onlineSaveFailed",
|
|
6590
|
+
/** 已应用其他用户的改动 - 本地已合并远程更改 */
|
|
6591
|
+
ServerChangeApplied = "serverChangeApplied",
|
|
6592
|
+
/** 禁止离线编辑 - 需等待网络恢复后才能继续编辑 */
|
|
6593
|
+
OfflineDisabled = "offlineDisabled"
|
|
6594
|
+
}
|
|
6595
|
+
|
|
5073
6596
|
export declare interface SyncContext {
|
|
5074
6597
|
clientId: string;
|
|
5075
6598
|
timestamp: number;
|
|
@@ -5092,21 +6615,69 @@ export declare interface SyncStatusDelegation {
|
|
|
5092
6615
|
onError: (error: unknown, context: SyncContext) => void;
|
|
5093
6616
|
}
|
|
5094
6617
|
|
|
5095
|
-
export declare interface
|
|
6618
|
+
export declare interface TableCombineTablesOptions {
|
|
5096
6619
|
/**
|
|
5097
|
-
*
|
|
6620
|
+
* 是否禁用
|
|
6621
|
+
* @default false
|
|
5098
6622
|
*/
|
|
5099
|
-
|
|
6623
|
+
disabled?: boolean;
|
|
5100
6624
|
/**
|
|
5101
|
-
*
|
|
5102
|
-
* @param listener
|
|
6625
|
+
* 隐藏了解更多提示
|
|
5103
6626
|
*/
|
|
5104
|
-
|
|
5105
|
-
|
|
5106
|
-
|
|
5107
|
-
|
|
5108
|
-
|
|
5109
|
-
|
|
6627
|
+
hideMoreInfoTip?: boolean;
|
|
6628
|
+
limitations?: {
|
|
6629
|
+
/**
|
|
6630
|
+
* 获取每个文件支持合并的最大表格数量
|
|
6631
|
+
* @returns 最大表格数量
|
|
6632
|
+
*/
|
|
6633
|
+
getPerFileMaxTableCount?: () => number | undefined;
|
|
6634
|
+
/**
|
|
6635
|
+
* 获取每个表格支持合并的最大表格数量
|
|
6636
|
+
* @returns 最大表格数量
|
|
6637
|
+
*/
|
|
6638
|
+
getPerTableMaxTableCount?: () => number | undefined;
|
|
6639
|
+
};
|
|
6640
|
+
/**
|
|
6641
|
+
* 是否需要改变关联引用表的链接 origin
|
|
6642
|
+
* @default false
|
|
6643
|
+
* 在 sdk 环境中需要匹配对文件应真实的 url 地址
|
|
6644
|
+
*/
|
|
6645
|
+
changeRefLinkOrigin?: boolean;
|
|
6646
|
+
}
|
|
6647
|
+
|
|
6648
|
+
/**
|
|
6649
|
+
* 复制功能配置
|
|
6650
|
+
*
|
|
6651
|
+
* 控制表格中复制功能的行为
|
|
6652
|
+
*/
|
|
6653
|
+
export declare type TableCopyOptions = EditorCopyOptions;
|
|
6654
|
+
|
|
6655
|
+
/**
|
|
6656
|
+
* 表格仪表盘配置选项
|
|
6657
|
+
*/
|
|
6658
|
+
export declare interface TableDashboardOptions {
|
|
6659
|
+
/**
|
|
6660
|
+
* 是否禁用仪表盘功能
|
|
6661
|
+
* @default false
|
|
6662
|
+
*/
|
|
6663
|
+
disabled?: boolean;
|
|
6664
|
+
}
|
|
6665
|
+
|
|
6666
|
+
export declare interface TableEditorContent {
|
|
6667
|
+
/**
|
|
6668
|
+
* 保存当前活文件的所有修改
|
|
6669
|
+
*/
|
|
6670
|
+
save: () => Promise<void>;
|
|
6671
|
+
/**
|
|
6672
|
+
* 添加监听,当内容发生变化时触发监听,传入 Delta
|
|
6673
|
+
* @param listener
|
|
6674
|
+
*/
|
|
6675
|
+
addChangeListener: (listener: (changes: TableEditorDelta[]) => void) => () => void;
|
|
6676
|
+
}
|
|
6677
|
+
|
|
6678
|
+
export declare interface TableEditorDelta {
|
|
6679
|
+
action: TableEditorDeltaActionName;
|
|
6680
|
+
extraData: Record<string, unknown>;
|
|
5110
6681
|
data: Record<string, unknown>;
|
|
5111
6682
|
uuid: string;
|
|
5112
6683
|
attrs?: {
|
|
@@ -5120,7 +6691,91 @@ export declare type TableEditorDeltaActionName = 'CreateTable' | 'UpdateTableNam
|
|
|
5120
6691
|
/**
|
|
5121
6692
|
* 表格编辑器选项
|
|
5122
6693
|
*/
|
|
5123
|
-
export declare type TableEditorOptions = Omit<EditorOptions, 'content'>;
|
|
6694
|
+
export declare type TableEditorOptions = Omit<EditorOptions, 'content' | 'fonts' | 'collaboration'>;
|
|
6695
|
+
|
|
6696
|
+
export declare interface TableExplainPageOptions {
|
|
6697
|
+
/**
|
|
6698
|
+
* 是否禁用
|
|
6699
|
+
* @default false
|
|
6700
|
+
*/
|
|
6701
|
+
disabled?: boolean;
|
|
6702
|
+
/**
|
|
6703
|
+
* 样式
|
|
6704
|
+
*/
|
|
6705
|
+
style: {
|
|
6706
|
+
/**
|
|
6707
|
+
* 顶部位置
|
|
6708
|
+
*/
|
|
6709
|
+
topPosition?: number;
|
|
6710
|
+
};
|
|
6711
|
+
}
|
|
6712
|
+
|
|
6713
|
+
/**
|
|
6714
|
+
* 表格导出回调接口
|
|
6715
|
+
* 定义了导出过程中各个阶段的回调函数
|
|
6716
|
+
*/
|
|
6717
|
+
export declare interface TableExportCallbacks {
|
|
6718
|
+
/**
|
|
6719
|
+
* 导出开始时的回调函数
|
|
6720
|
+
*/
|
|
6721
|
+
onStart?: () => void;
|
|
6722
|
+
/**
|
|
6723
|
+
* 导出进度更新时的回调函数
|
|
6724
|
+
* @param progress - 当前导出进度百分比(0-100)
|
|
6725
|
+
*/
|
|
6726
|
+
onProgress?: (progress: number) => void;
|
|
6727
|
+
/**
|
|
6728
|
+
* 导出成功时的回调函数
|
|
6729
|
+
* @param downloadUrl - 导出文件的下载链接
|
|
6730
|
+
* @param message - 成功提示信息
|
|
6731
|
+
*/
|
|
6732
|
+
onSuccess: (downloadUrl: string, message?: string) => void;
|
|
6733
|
+
/**
|
|
6734
|
+
* 导出失败时的回调函数
|
|
6735
|
+
* @param error - 错误信息
|
|
6736
|
+
*/
|
|
6737
|
+
onError: (error?: unknown) => void;
|
|
6738
|
+
}
|
|
6739
|
+
|
|
6740
|
+
/**
|
|
6741
|
+
* 表格导出配置选项
|
|
6742
|
+
* 扩展自EditorExportOptions基础导出配置
|
|
6743
|
+
*/
|
|
6744
|
+
export declare interface TableExportOptions extends EditorExportOptions {
|
|
6745
|
+
/**
|
|
6746
|
+
* 是否禁用导出功能
|
|
6747
|
+
* @default false
|
|
6748
|
+
*/
|
|
6749
|
+
disabled?: boolean;
|
|
6750
|
+
/**
|
|
6751
|
+
* 导出为石墨表格文件配置
|
|
6752
|
+
*/
|
|
6753
|
+
exportSheets?: {
|
|
6754
|
+
/**
|
|
6755
|
+
* 是否禁用表格导出功能
|
|
6756
|
+
* @default false
|
|
6757
|
+
*/
|
|
6758
|
+
disabled?: boolean;
|
|
6759
|
+
};
|
|
6760
|
+
/**
|
|
6761
|
+
* 导出为Excel文件配置
|
|
6762
|
+
*/
|
|
6763
|
+
exportExcel?: {
|
|
6764
|
+
/**
|
|
6765
|
+
* 是否禁用Excel导出功能
|
|
6766
|
+
* @default false
|
|
6767
|
+
*/
|
|
6768
|
+
disabled?: boolean;
|
|
6769
|
+
/**
|
|
6770
|
+
* 导出Excel文件方法
|
|
6771
|
+
* @param fileGuid - 文件唯一标识符,用于标记导出的文件
|
|
6772
|
+
* @param callbacks - 导出过程回调函数集合
|
|
6773
|
+
* @param inMotable - 是否使用motable数据结构导出
|
|
6774
|
+
* @returns Promise对象
|
|
6775
|
+
*/
|
|
6776
|
+
export?: (fileGuid: string, inMotable: boolean, callbacks: TableExportCallbacks) => Promise<void>;
|
|
6777
|
+
};
|
|
6778
|
+
}
|
|
5124
6779
|
|
|
5125
6780
|
export declare type TableFieldContextMenuEntryConfig = EditorMenuEntryConfig<TableFieldContextMenuFeatureButtonName>;
|
|
5126
6781
|
|
|
@@ -5152,8 +6807,278 @@ export declare type TableFieldContextMenuFeatureButtonName =
|
|
|
5152
6807
|
|
|
5153
6808
|
export declare type TableFieldContextMenuOptions = EditorMenuOptions<TableFieldContextMenuFeatureButtonName>;
|
|
5154
6809
|
|
|
6810
|
+
/**
|
|
6811
|
+
* 表格字段配置选项
|
|
6812
|
+
*/
|
|
6813
|
+
export declare interface TableFieldOptions {
|
|
6814
|
+
/**
|
|
6815
|
+
* 群组字段配置
|
|
6816
|
+
*/
|
|
6817
|
+
group?: {
|
|
6818
|
+
/**
|
|
6819
|
+
* 是否启用群组字段
|
|
6820
|
+
* @default false
|
|
6821
|
+
*/
|
|
6822
|
+
enabled?: boolean;
|
|
6823
|
+
/**
|
|
6824
|
+
* IM应用唤起配置
|
|
6825
|
+
*/
|
|
6826
|
+
imProps?: {
|
|
6827
|
+
/**
|
|
6828
|
+
* 是否禁用唤起
|
|
6829
|
+
* @default false
|
|
6830
|
+
*/
|
|
6831
|
+
disabled?: boolean;
|
|
6832
|
+
/**
|
|
6833
|
+
* 应用唤起参数
|
|
6834
|
+
*/
|
|
6835
|
+
startOptions: {
|
|
6836
|
+
/** 应用名称(唯一键值) */
|
|
6837
|
+
name: string;
|
|
6838
|
+
/** 应用协议方案(如"myapp://") */
|
|
6839
|
+
scheme: string;
|
|
6840
|
+
/** 应用内部路径 */
|
|
6841
|
+
path: string;
|
|
6842
|
+
/** 默认参数 */
|
|
6843
|
+
defaultParams: Record<string, string>;
|
|
6844
|
+
};
|
|
6845
|
+
/**
|
|
6846
|
+
* 是否禁用静默唤起
|
|
6847
|
+
* @default false
|
|
6848
|
+
*/
|
|
6849
|
+
noSilent?: boolean;
|
|
6850
|
+
};
|
|
6851
|
+
};
|
|
6852
|
+
/**
|
|
6853
|
+
* 关联引用记录配置
|
|
6854
|
+
*/
|
|
6855
|
+
referenceRecord?: {
|
|
6856
|
+
/**
|
|
6857
|
+
* 是否禁用引用记录
|
|
6858
|
+
* @default false
|
|
6859
|
+
*/
|
|
6860
|
+
disabled?: boolean;
|
|
6861
|
+
/**
|
|
6862
|
+
* 禁用他表引入
|
|
6863
|
+
* @default false
|
|
6864
|
+
*/
|
|
6865
|
+
disableExternalRefTable?: boolean;
|
|
6866
|
+
};
|
|
6867
|
+
/**
|
|
6868
|
+
* 关联引用公式配置
|
|
6869
|
+
*/
|
|
6870
|
+
refRecordRollUp?: {
|
|
6871
|
+
/**
|
|
6872
|
+
* 是否禁用引用记录聚合
|
|
6873
|
+
* @default false
|
|
6874
|
+
*/
|
|
6875
|
+
disabled?: boolean;
|
|
6876
|
+
};
|
|
6877
|
+
/**
|
|
6878
|
+
* 最后修改人配置
|
|
6879
|
+
*/
|
|
6880
|
+
lastModifiedBy?: {
|
|
6881
|
+
/**
|
|
6882
|
+
* 是否禁用最后修改人
|
|
6883
|
+
* @default false
|
|
6884
|
+
*/
|
|
6885
|
+
disabled?: boolean;
|
|
6886
|
+
};
|
|
6887
|
+
/**
|
|
6888
|
+
* 首次修改人配置
|
|
6889
|
+
*/
|
|
6890
|
+
firstModifiedBy?: {
|
|
6891
|
+
/**
|
|
6892
|
+
* 是否禁用首次修改人
|
|
6893
|
+
* @default false
|
|
6894
|
+
*/
|
|
6895
|
+
disabled?: boolean;
|
|
6896
|
+
};
|
|
6897
|
+
/**
|
|
6898
|
+
* 协作人配置
|
|
6899
|
+
*/
|
|
6900
|
+
collaborator?: {
|
|
6901
|
+
/**
|
|
6902
|
+
* 是否禁用协作人
|
|
6903
|
+
* @default false
|
|
6904
|
+
*/
|
|
6905
|
+
disabled?: boolean;
|
|
6906
|
+
};
|
|
6907
|
+
/**
|
|
6908
|
+
* 日期提醒
|
|
6909
|
+
*/
|
|
6910
|
+
dateMention?: {
|
|
6911
|
+
/**
|
|
6912
|
+
* 是否禁用日期提醒
|
|
6913
|
+
* @default false
|
|
6914
|
+
*/
|
|
6915
|
+
disabled?: boolean;
|
|
6916
|
+
};
|
|
6917
|
+
/**
|
|
6918
|
+
* 自动编号
|
|
6919
|
+
*/
|
|
6920
|
+
autoNumber?: {
|
|
6921
|
+
/**
|
|
6922
|
+
* 是否禁用自动编号
|
|
6923
|
+
* @default false
|
|
6924
|
+
*/
|
|
6925
|
+
disabled?: boolean;
|
|
6926
|
+
};
|
|
6927
|
+
}
|
|
6928
|
+
|
|
6929
|
+
export declare interface TableFormOptions {
|
|
6930
|
+
/**
|
|
6931
|
+
* 是否禁用表单功能
|
|
6932
|
+
* @default false
|
|
6933
|
+
*/
|
|
6934
|
+
disabled?: boolean;
|
|
6935
|
+
/**
|
|
6936
|
+
* 仅企业用户可以填写
|
|
6937
|
+
*/
|
|
6938
|
+
onlyEnterpriseUser?: boolean;
|
|
6939
|
+
/**
|
|
6940
|
+
* 创建表单文件
|
|
6941
|
+
* 有guid的是sdk2.0的接口,没有guid的是sass的接口
|
|
6942
|
+
*/
|
|
6943
|
+
createFile?: (params: {
|
|
6944
|
+
content: string;
|
|
6945
|
+
name: string;
|
|
6946
|
+
guid: string;
|
|
6947
|
+
folder?: string;
|
|
6948
|
+
}) => Promise<{
|
|
6949
|
+
guid: string;
|
|
6950
|
+
id: number;
|
|
6951
|
+
}>;
|
|
6952
|
+
/**
|
|
6953
|
+
* 获取表单文件的父级文件
|
|
6954
|
+
* sass需要提供
|
|
6955
|
+
*/
|
|
6956
|
+
getFileAncestors?: (fileGuid: string) => Promise<EditorFileOptions[]>;
|
|
6957
|
+
}
|
|
6958
|
+
|
|
6959
|
+
/**
|
|
6960
|
+
* 表格公式配置选项
|
|
6961
|
+
*/
|
|
6962
|
+
export declare interface TableFormulaOptions {
|
|
6963
|
+
/**
|
|
6964
|
+
* 是否禁用
|
|
6965
|
+
* @default false
|
|
6966
|
+
*/
|
|
6967
|
+
disabled?: boolean;
|
|
6968
|
+
/**
|
|
6969
|
+
* 前端本地的公式计算配置
|
|
6970
|
+
*/
|
|
6971
|
+
localCalculation?: {
|
|
6972
|
+
/**
|
|
6973
|
+
* 是否启用
|
|
6974
|
+
* @default false
|
|
6975
|
+
*/
|
|
6976
|
+
enabled?: boolean;
|
|
6977
|
+
};
|
|
6978
|
+
}
|
|
6979
|
+
|
|
6980
|
+
/**
|
|
6981
|
+
* 表格历史记录配置选项
|
|
6982
|
+
*/
|
|
6983
|
+
export declare interface TableHistoryOptions extends EditorHistoryOptions {
|
|
6984
|
+
/**
|
|
6985
|
+
* 单元格历史记录配置
|
|
6986
|
+
*/
|
|
6987
|
+
cellHistory?: {
|
|
6988
|
+
/**
|
|
6989
|
+
* 是否禁用单元格历史
|
|
6990
|
+
* @default false
|
|
6991
|
+
*/
|
|
6992
|
+
disabled?: boolean;
|
|
6993
|
+
};
|
|
6994
|
+
}
|
|
6995
|
+
|
|
6996
|
+
/**
|
|
6997
|
+
* 表格导入回调接口
|
|
6998
|
+
* 定义了导入过程中各个阶段的回调函数
|
|
6999
|
+
*/
|
|
7000
|
+
export declare interface TableImportCallbacks {
|
|
7001
|
+
/**
|
|
7002
|
+
* 导入开始时的回调函数
|
|
7003
|
+
*/
|
|
7004
|
+
onStart?: () => void;
|
|
7005
|
+
/**
|
|
7006
|
+
* 导入进度更新时的回调函数
|
|
7007
|
+
* @param progress - 当前导入进度百分比(0-100)
|
|
7008
|
+
*/
|
|
7009
|
+
onProgress?: (progress: number) => void;
|
|
7010
|
+
/**
|
|
7011
|
+
* 导入成功时的回调函数
|
|
7012
|
+
* @param message - 成功提示信息
|
|
7013
|
+
*/
|
|
7014
|
+
onSuccess: (message?: string) => void;
|
|
7015
|
+
/**
|
|
7016
|
+
* 导入失败时的回调函数
|
|
7017
|
+
* @param error - 错误信息
|
|
7018
|
+
*/
|
|
7019
|
+
onError: (error?: unknown) => void;
|
|
7020
|
+
}
|
|
7021
|
+
|
|
7022
|
+
/**
|
|
7023
|
+
* 表格导入配置选项
|
|
7024
|
+
* 扩展自EditorImportOptions基础导入配置
|
|
7025
|
+
*/
|
|
7026
|
+
export declare interface TableImportOptions extends EditorImportOptions {
|
|
7027
|
+
/**
|
|
7028
|
+
* 是否禁用导入功能
|
|
7029
|
+
* @default false
|
|
7030
|
+
*/
|
|
7031
|
+
disabled?: boolean;
|
|
7032
|
+
/**
|
|
7033
|
+
* 是否启用motable数据结构导入
|
|
7034
|
+
* @default false
|
|
7035
|
+
*/
|
|
7036
|
+
enableMotableImport?: Boolean;
|
|
7037
|
+
/**
|
|
7038
|
+
* 导入Excel文件
|
|
7039
|
+
* @param file - 要导入的Excel文件
|
|
7040
|
+
* @param fileGuid - 文件唯一标识符
|
|
7041
|
+
* @param fileUrl - 文件URL地址
|
|
7042
|
+
* @param callbacks - 导入过程回调函数集合
|
|
7043
|
+
* @returns Promise对象
|
|
7044
|
+
*/
|
|
7045
|
+
importExcel?: (file: File, fileGuid: string, fileUrl: string, callbacks: TableImportCallbacks) => Promise<void>;
|
|
7046
|
+
}
|
|
7047
|
+
|
|
5155
7048
|
export declare type TableListBarButtonName = 'tableMenu' | 'addTable' | 'tabLeft' | 'tabRight' | 'exportToExcel';
|
|
5156
7049
|
|
|
7050
|
+
export declare type TableListBarContextMenuEntryConfig = EditorMenuEntryConfig<TableListBarContextMenuFeatureButtonName>;
|
|
7051
|
+
|
|
7052
|
+
export declare type TableListBarContextMenuFeatureButtonConfig = EditorMenuEntryConfig<TableListBarContextMenuFeatureButtonName>;
|
|
7053
|
+
|
|
7054
|
+
export declare type TableListBarContextMenuFeatureButtonName =
|
|
7055
|
+
/**
|
|
7056
|
+
* 重命名
|
|
7057
|
+
*/
|
|
7058
|
+
'rename'
|
|
7059
|
+
/**
|
|
7060
|
+
* 删除
|
|
7061
|
+
*/
|
|
7062
|
+
| 'delete'
|
|
7063
|
+
/**
|
|
7064
|
+
* 添加描述
|
|
7065
|
+
*/
|
|
7066
|
+
| 'addDescription'
|
|
7067
|
+
/**
|
|
7068
|
+
* 复制
|
|
7069
|
+
*/
|
|
7070
|
+
| 'copy'
|
|
7071
|
+
/**
|
|
7072
|
+
* 管理引用表
|
|
7073
|
+
*/
|
|
7074
|
+
| 'manageCombineTable'
|
|
7075
|
+
/**
|
|
7076
|
+
* 更新引用表
|
|
7077
|
+
*/
|
|
7078
|
+
| 'updateCombineTable';
|
|
7079
|
+
|
|
7080
|
+
export declare type TableListBarContextMenuOptions = EditorContextMenuOptions<TableListBarContextMenuFeatureButtonName>;
|
|
7081
|
+
|
|
5157
7082
|
export declare type TableListBarCustomButtonConfig = Record<string, Omit<EditorToolbarFeatureButton<string>, 'label' | 'icon' | 'tooltip'> & {
|
|
5158
7083
|
icon: string;
|
|
5159
7084
|
tooltip: string;
|
|
@@ -5165,11 +7090,75 @@ export declare type TableListBarOptions = Omit<EditorToolbarOptions<TableListBar
|
|
|
5165
7090
|
custom?: TableListBarCustomButtonConfig;
|
|
5166
7091
|
};
|
|
5167
7092
|
|
|
5168
|
-
|
|
7093
|
+
/**
|
|
7094
|
+
* 表格提及功能配置选项
|
|
7095
|
+
*/
|
|
7096
|
+
export declare interface TableMentionOptions extends EditorMentionOptions {
|
|
5169
7097
|
/**
|
|
5170
|
-
*
|
|
7098
|
+
* 支持的文件类型
|
|
7099
|
+
* @default ['table', 'folder', 'space']
|
|
5171
7100
|
*/
|
|
5172
|
-
|
|
7101
|
+
mentionAcceptFileTypes?: ('table' | 'folder' | 'space')[];
|
|
7102
|
+
/**
|
|
7103
|
+
* 输入框占位文本
|
|
7104
|
+
*/
|
|
7105
|
+
inputPlaceholder?: string;
|
|
7106
|
+
}
|
|
7107
|
+
|
|
7108
|
+
/**
|
|
7109
|
+
* Motable配置选项
|
|
7110
|
+
*/
|
|
7111
|
+
export declare interface TableMotableOptions {
|
|
7112
|
+
/**
|
|
7113
|
+
* 是否启用
|
|
7114
|
+
* @default false
|
|
7115
|
+
*/
|
|
7116
|
+
enabled?: boolean;
|
|
7117
|
+
/**
|
|
7118
|
+
* 读取来源
|
|
7119
|
+
* @default ReadFrom.UNKNOWN
|
|
7120
|
+
*/
|
|
7121
|
+
readFrom?: ReadFrom;
|
|
7122
|
+
/**
|
|
7123
|
+
* 是否禁用Motable文件校验
|
|
7124
|
+
* @default false
|
|
7125
|
+
*/
|
|
7126
|
+
disableCheckIsMotableFile?: boolean;
|
|
7127
|
+
/**
|
|
7128
|
+
* 是否启用升级弹窗
|
|
7129
|
+
* @default false
|
|
7130
|
+
*/
|
|
7131
|
+
enableUpgradeModal?: boolean;
|
|
7132
|
+
}
|
|
7133
|
+
|
|
7134
|
+
export declare interface TablePasteLimitationOptions extends EditorPasteLimitationOptions {
|
|
7135
|
+
/**
|
|
7136
|
+
* 获取表格能支持的最大行数
|
|
7137
|
+
* @returns 最大行数
|
|
7138
|
+
*/
|
|
7139
|
+
getMaxRowCount?: () => number | undefined;
|
|
7140
|
+
}
|
|
7141
|
+
|
|
7142
|
+
export declare interface TablePasteOptions extends EditorPasteOptions {
|
|
7143
|
+
limitations?: TablePasteLimitationOptions;
|
|
7144
|
+
}
|
|
7145
|
+
|
|
7146
|
+
export declare interface TableRenderOptions {
|
|
7147
|
+
/** 当前 table Guid */
|
|
7148
|
+
table?: string;
|
|
7149
|
+
/** 渲染类型,固定为 'table' */
|
|
7150
|
+
type?: string;
|
|
7151
|
+
/** 当前视图的唯一标识符 */
|
|
7152
|
+
view?: string;
|
|
7153
|
+
/** 视图分享模式的唯一标识符 */
|
|
7154
|
+
shareViewGuid?: string;
|
|
7155
|
+
/** 哈希值,从中获取渲激活的区域相关配置 */
|
|
7156
|
+
hash?: string;
|
|
7157
|
+
/** 初始化后需要开始编辑的记录行标识符 */
|
|
7158
|
+
recordGuid?: string;
|
|
7159
|
+
}
|
|
7160
|
+
|
|
7161
|
+
export declare interface TableSDKOptions extends TableEditorOptions {
|
|
5173
7162
|
/**
|
|
5174
7163
|
* 接口资源配置
|
|
5175
7164
|
*/
|
|
@@ -5182,6 +7171,10 @@ export declare interface TableSDKOptions extends TableEditorOptions {
|
|
|
5182
7171
|
* 列表栏相关配置
|
|
5183
7172
|
*/
|
|
5184
7173
|
listBar?: TableListBarOptions;
|
|
7174
|
+
/**
|
|
7175
|
+
* 列表栏右键菜单相关配置
|
|
7176
|
+
*/
|
|
7177
|
+
listBarContextMenu?: TableListBarContextMenuOptions;
|
|
5185
7178
|
/**
|
|
5186
7179
|
* 字段上下文菜单相关配置
|
|
5187
7180
|
*/
|
|
@@ -5190,6 +7183,102 @@ export declare interface TableSDKOptions extends TableEditorOptions {
|
|
|
5190
7183
|
* 表格上下文菜单相关配置
|
|
5191
7184
|
*/
|
|
5192
7185
|
viewContextMenu?: TableViewContextMenuOptions;
|
|
7186
|
+
/**
|
|
7187
|
+
* 协作者设置
|
|
7188
|
+
*/
|
|
7189
|
+
collaborators?: EditorCollaboratorsOptions;
|
|
7190
|
+
/**
|
|
7191
|
+
* 协作设置
|
|
7192
|
+
*/
|
|
7193
|
+
collaboration?: Omit<EditorCollaborationOptions, 'rev'>;
|
|
7194
|
+
/**
|
|
7195
|
+
* @override
|
|
7196
|
+
* 表格UI相关设置
|
|
7197
|
+
*/
|
|
7198
|
+
ui?: TableUiOptions;
|
|
7199
|
+
/**
|
|
7200
|
+
* 公式
|
|
7201
|
+
*/
|
|
7202
|
+
formula?: TableFormulaOptions;
|
|
7203
|
+
/**
|
|
7204
|
+
* 视图
|
|
7205
|
+
*/
|
|
7206
|
+
view?: TableViewOptions;
|
|
7207
|
+
/**
|
|
7208
|
+
* 仪表盘
|
|
7209
|
+
*/
|
|
7210
|
+
dashboard?: TableDashboardOptions;
|
|
7211
|
+
/**
|
|
7212
|
+
* 模板
|
|
7213
|
+
*/
|
|
7214
|
+
template?: TableTemplateOptions;
|
|
7215
|
+
/**
|
|
7216
|
+
* 字段
|
|
7217
|
+
*/
|
|
7218
|
+
field?: TableFieldOptions;
|
|
7219
|
+
/**
|
|
7220
|
+
* 新数据储存文件
|
|
7221
|
+
*/
|
|
7222
|
+
motable?: TableMotableOptions;
|
|
7223
|
+
/**
|
|
7224
|
+
* @override
|
|
7225
|
+
* 工具箱
|
|
7226
|
+
*/
|
|
7227
|
+
toolbox?: TableToolboxOptions;
|
|
7228
|
+
/**
|
|
7229
|
+
* 复制
|
|
7230
|
+
*/
|
|
7231
|
+
copy?: TableCopyOptions;
|
|
7232
|
+
/**
|
|
7233
|
+
* 粘贴
|
|
7234
|
+
*/
|
|
7235
|
+
paste?: TablePasteOptions;
|
|
7236
|
+
/**
|
|
7237
|
+
* 引用数据表
|
|
7238
|
+
*/
|
|
7239
|
+
combineTables?: TableCombineTablesOptions;
|
|
7240
|
+
/**
|
|
7241
|
+
* 快捷键
|
|
7242
|
+
*/
|
|
7243
|
+
shortcuts?: TableShortcutsOptions;
|
|
7244
|
+
/**
|
|
7245
|
+
* @override
|
|
7246
|
+
* 导入设置
|
|
7247
|
+
*/
|
|
7248
|
+
import?: TableImportOptions;
|
|
7249
|
+
/**
|
|
7250
|
+
* @override
|
|
7251
|
+
* 导出设置
|
|
7252
|
+
*/
|
|
7253
|
+
export?: TableExportOptions;
|
|
7254
|
+
/**
|
|
7255
|
+
* 历史
|
|
7256
|
+
*/
|
|
7257
|
+
history?: TableHistoryOptions;
|
|
7258
|
+
/**
|
|
7259
|
+
* 版本
|
|
7260
|
+
*/
|
|
7261
|
+
version?: TableVersionOptions;
|
|
7262
|
+
/**
|
|
7263
|
+
* 提及
|
|
7264
|
+
*/
|
|
7265
|
+
mention?: TableMentionOptions;
|
|
7266
|
+
/**
|
|
7267
|
+
* 表单配置
|
|
7268
|
+
*/
|
|
7269
|
+
form?: TableFormOptions;
|
|
7270
|
+
/**
|
|
7271
|
+
* 说明页
|
|
7272
|
+
*/
|
|
7273
|
+
explainPage?: TableExplainPageOptions;
|
|
7274
|
+
/**
|
|
7275
|
+
* 快照配置
|
|
7276
|
+
*/
|
|
7277
|
+
snapshot?: TableSnapshotOptions;
|
|
7278
|
+
/**
|
|
7279
|
+
* 初始化页面渲染的时候需要的配置
|
|
7280
|
+
*/
|
|
7281
|
+
render?: TableRenderOptions;
|
|
5193
7282
|
}
|
|
5194
7283
|
|
|
5195
7284
|
export declare interface TableSelection {
|
|
@@ -5314,6 +7403,94 @@ export declare type TableSelectionValue = {
|
|
|
5314
7403
|
columnCount: number;
|
|
5315
7404
|
};
|
|
5316
7405
|
|
|
7406
|
+
/**
|
|
7407
|
+
* 表格快捷键功能类型
|
|
7408
|
+
*/
|
|
7409
|
+
export declare type TableShortcutsFeatureType =
|
|
7410
|
+
/** 内容搜索 */
|
|
7411
|
+
'contentSearch';
|
|
7412
|
+
|
|
7413
|
+
/**
|
|
7414
|
+
* 表格快捷键配置选项
|
|
7415
|
+
*/
|
|
7416
|
+
export declare interface TableShortcutsOptions extends EditorShortcutOptions {
|
|
7417
|
+
/**
|
|
7418
|
+
* 禁用的快捷键
|
|
7419
|
+
* 桌面客户端/极速SDK通常需要禁用ctrl+s
|
|
7420
|
+
*/
|
|
7421
|
+
disabledShortcuts?: TableShortcutsFeatureType[];
|
|
7422
|
+
}
|
|
7423
|
+
|
|
7424
|
+
/**
|
|
7425
|
+
* 表格快照配置
|
|
7426
|
+
* 应用表格在预览指定版本时会显示 Header 用于显示创建时间等信息,预览模式时需要隐藏
|
|
7427
|
+
*/
|
|
7428
|
+
export declare interface TableSnapshotOptions {
|
|
7429
|
+
/**
|
|
7430
|
+
* 快照id
|
|
7431
|
+
*/
|
|
7432
|
+
snapshotId?: string;
|
|
7433
|
+
/**
|
|
7434
|
+
* 是否禁用快照头部
|
|
7435
|
+
*/
|
|
7436
|
+
disableSnapshotHeader?: boolean;
|
|
7437
|
+
}
|
|
7438
|
+
|
|
7439
|
+
/**
|
|
7440
|
+
* 表格订阅接口
|
|
7441
|
+
* 提供了一系列方法用于监听表格组件中的各种事件
|
|
7442
|
+
*/
|
|
7443
|
+
export declare interface TableSubscription {
|
|
7444
|
+
/**
|
|
7445
|
+
* 添加URL变化监听器
|
|
7446
|
+
* @param listener 监听器函数,接收包含fileGuid, table, view和hash的参数
|
|
7447
|
+
* @returns 解绑函数,调用后移除该监听器
|
|
7448
|
+
*/
|
|
7449
|
+
addUrlChangedListener?: (listener: (params: UrlParams) => void) => () => void;
|
|
7450
|
+
/**
|
|
7451
|
+
* 添加协作跟踪事件监听器
|
|
7452
|
+
* @param listener 监听器函数,接收包含事件type和message的对象
|
|
7453
|
+
* @returns 解绑函数,调用后移除该监听器
|
|
7454
|
+
*/
|
|
7455
|
+
addCollaborationTrackListener?: (listener: (track: {
|
|
7456
|
+
type: string;
|
|
7457
|
+
message: string;
|
|
7458
|
+
}) => void) => () => void;
|
|
7459
|
+
/**
|
|
7460
|
+
* 添加保存状态变化监听器
|
|
7461
|
+
* @param listener 监听器函数,接收当前状态和保存操作令牌
|
|
7462
|
+
* @returns 解绑函数,调用后移除该监听器
|
|
7463
|
+
*/
|
|
7464
|
+
addSaveStatusChangedListener?: (listener: (status: Status, token: string) => void) => () => void;
|
|
7465
|
+
/**
|
|
7466
|
+
* 添加错误事件监听器
|
|
7467
|
+
* @param listener 监听器函数,接收包含code和message的错误对象
|
|
7468
|
+
* @returns 解绑函数,调用后移除该监听器
|
|
7469
|
+
*/
|
|
7470
|
+
addErrorListener?: (listener: (error: EventError) => void) => () => void;
|
|
7471
|
+
/**
|
|
7472
|
+
* 添加历史记录侧边栏状态变化监听器
|
|
7473
|
+
* @param listener 监听器函数,接收当前状态
|
|
7474
|
+
* @returns 解绑函数,调用后移除该监听器
|
|
7475
|
+
*/
|
|
7476
|
+
addHistorySidebarStatusChangedListener?: (listener: (open: boolean) => void) => () => void;
|
|
7477
|
+
/**
|
|
7478
|
+
* 添加内容变化监听器
|
|
7479
|
+
* @param listener 监听器函数,接收内容变化事件
|
|
7480
|
+
* @returns 解绑函数,调用后移除该监听器
|
|
7481
|
+
*/
|
|
7482
|
+
addContentChangedListener?: (listener: (isUndo: boolean) => void) => () => void;
|
|
7483
|
+
}
|
|
7484
|
+
|
|
7485
|
+
export declare interface TableTemplateOptions extends EditorFeatureConfig {
|
|
7486
|
+
/**
|
|
7487
|
+
* 打开弹窗模板
|
|
7488
|
+
* @param options
|
|
7489
|
+
* @returns
|
|
7490
|
+
*/
|
|
7491
|
+
showModal?: (options: ShowTemplateModalProps) => void;
|
|
7492
|
+
}
|
|
7493
|
+
|
|
5317
7494
|
export declare type TableToolbarCalendarButtonName = 'calendarSettings' | 'calendarPendingItems';
|
|
5318
7495
|
|
|
5319
7496
|
export declare type TableToolbarCommonButtonName =
|
|
@@ -5344,7 +7521,9 @@ export declare type TableToolbarCommonButtonName =
|
|
|
5344
7521
|
/** 全屏 */
|
|
5345
7522
|
| 'fullscreen'
|
|
5346
7523
|
/** 表单 */
|
|
5347
|
-
| 'form'
|
|
7524
|
+
| 'form'
|
|
7525
|
+
/** 分享视图 */
|
|
7526
|
+
| 'shareView';
|
|
5348
7527
|
|
|
5349
7528
|
export declare type TableToolbarFeatureButtonConfig = EditorToolbarFeatureButtonConfig<TableToolbarFeatureButtonName>;
|
|
5350
7529
|
|
|
@@ -5360,6 +7539,302 @@ export declare type TableToolbarOptions = Omit<EditorToolbarOptions<TableToolbar
|
|
|
5360
7539
|
|
|
5361
7540
|
export declare type TableToolbarTimelineButtonName = 'timelineSettings';
|
|
5362
7541
|
|
|
7542
|
+
/**
|
|
7543
|
+
* 表格工具箱配置选项
|
|
7544
|
+
*/
|
|
7545
|
+
export declare interface TableToolboxOptions extends EditorToolboxOptions {
|
|
7546
|
+
/**
|
|
7547
|
+
* 是否禁用下载功能
|
|
7548
|
+
* @default false
|
|
7549
|
+
*/
|
|
7550
|
+
disableDownload?: boolean;
|
|
7551
|
+
}
|
|
7552
|
+
|
|
7553
|
+
export declare interface TableUiOptions extends EditorUiOptions {
|
|
7554
|
+
/**
|
|
7555
|
+
* 表格统计条
|
|
7556
|
+
*/
|
|
7557
|
+
gridSummaryBar?: {
|
|
7558
|
+
/**
|
|
7559
|
+
* 是否禁用
|
|
7560
|
+
* @default false
|
|
7561
|
+
*/
|
|
7562
|
+
disabled?: boolean;
|
|
7563
|
+
};
|
|
7564
|
+
/**
|
|
7565
|
+
* 菜单栏
|
|
7566
|
+
*/
|
|
7567
|
+
menu?: {
|
|
7568
|
+
/**
|
|
7569
|
+
* 当滚动的时候自动隐藏
|
|
7570
|
+
* @default false
|
|
7571
|
+
*/
|
|
7572
|
+
autoHide?: boolean;
|
|
7573
|
+
};
|
|
7574
|
+
/**
|
|
7575
|
+
* 全局样式
|
|
7576
|
+
*/
|
|
7577
|
+
globalStyle?: {
|
|
7578
|
+
/**
|
|
7579
|
+
* 禁用 vendor 前缀
|
|
7580
|
+
* styleComponent StyleSheetManager 禁用自动前缀。渲染出来的 CSS 就不会再自动加前缀了。
|
|
7581
|
+
* @default false
|
|
7582
|
+
*/
|
|
7583
|
+
disableVendorPrefixes?: boolean;
|
|
7584
|
+
/**
|
|
7585
|
+
* 禁用 body 滚动(默认开启)
|
|
7586
|
+
*/
|
|
7587
|
+
enableBodyScroll?: boolean;
|
|
7588
|
+
};
|
|
7589
|
+
/**
|
|
7590
|
+
* 侧边栏样式
|
|
7591
|
+
*/
|
|
7592
|
+
sidebar?: {
|
|
7593
|
+
/**
|
|
7594
|
+
* 样式
|
|
7595
|
+
*/
|
|
7596
|
+
style?: {
|
|
7597
|
+
/**
|
|
7598
|
+
* 宽度
|
|
7599
|
+
* @default 320
|
|
7600
|
+
*/
|
|
7601
|
+
width?: number;
|
|
7602
|
+
/**
|
|
7603
|
+
* 是否不固定
|
|
7604
|
+
* @default false
|
|
7605
|
+
*/
|
|
7606
|
+
notFixed?: boolean;
|
|
7607
|
+
/**
|
|
7608
|
+
* 禁用动画
|
|
7609
|
+
* @default false
|
|
7610
|
+
*/
|
|
7611
|
+
disableAnimation?: boolean;
|
|
7612
|
+
/**
|
|
7613
|
+
* 移除容器右上角 padding
|
|
7614
|
+
*/
|
|
7615
|
+
containerRemovePaddingRightTop?: boolean;
|
|
7616
|
+
};
|
|
7617
|
+
/**
|
|
7618
|
+
* 打开使用指南/快捷键侧边栏
|
|
7619
|
+
* @deprecated 类型兼容性写法,使用 history 替代
|
|
7620
|
+
*/
|
|
7621
|
+
open?: (activeKey: 'userGuide' | 'shortcut') => void;
|
|
7622
|
+
/**
|
|
7623
|
+
* 版本信息栏样式
|
|
7624
|
+
*/
|
|
7625
|
+
versionInfo?: {
|
|
7626
|
+
/**
|
|
7627
|
+
* 高度
|
|
7628
|
+
* @default 51
|
|
7629
|
+
*/
|
|
7630
|
+
height?: number;
|
|
7631
|
+
};
|
|
7632
|
+
/**
|
|
7633
|
+
* 当历史版本出现时,应用表格渲染的外层容器(即整个应用表格,不包含外部的壳)app container 的样式
|
|
7634
|
+
*/
|
|
7635
|
+
appContainerStyle?: {
|
|
7636
|
+
/**
|
|
7637
|
+
* 右侧 padding
|
|
7638
|
+
* @default 同侧边栏宽度一致
|
|
7639
|
+
*/
|
|
7640
|
+
paddingRight?: string;
|
|
7641
|
+
/**
|
|
7642
|
+
* 顶部 padding
|
|
7643
|
+
* @default 同版本信息栏高度
|
|
7644
|
+
*/
|
|
7645
|
+
paddingTop?: string;
|
|
7646
|
+
/**
|
|
7647
|
+
* 宽度
|
|
7648
|
+
* @default 容器宽度减去侧边栏宽度
|
|
7649
|
+
*/
|
|
7650
|
+
width?: string;
|
|
7651
|
+
};
|
|
7652
|
+
};
|
|
7653
|
+
/**
|
|
7654
|
+
* 内联工具栏
|
|
7655
|
+
*/
|
|
7656
|
+
inlineToolbar?: {
|
|
7657
|
+
/**
|
|
7658
|
+
* 容器背景颜色
|
|
7659
|
+
*/
|
|
7660
|
+
containerBackgroundColor?: string;
|
|
7661
|
+
/**
|
|
7662
|
+
* 是否启用添加视图下拉遮罩
|
|
7663
|
+
*/
|
|
7664
|
+
enableAddViewDropdownMask?: boolean;
|
|
7665
|
+
/**
|
|
7666
|
+
* 禁用视图权限
|
|
7667
|
+
* TODO: 这个地方需要二次确定一下,是否可以跟 view 权限合并
|
|
7668
|
+
*/
|
|
7669
|
+
disableViewPermission?: boolean;
|
|
7670
|
+
/**
|
|
7671
|
+
* 禁用工具栏搜索
|
|
7672
|
+
*/
|
|
7673
|
+
disableToolbarSearch?: boolean;
|
|
7674
|
+
};
|
|
7675
|
+
/**
|
|
7676
|
+
* 工具栏下拉菜单
|
|
7677
|
+
*/
|
|
7678
|
+
toolbarDropdown?: {
|
|
7679
|
+
/**
|
|
7680
|
+
* 对齐方式
|
|
7681
|
+
*/
|
|
7682
|
+
popupAlignRight?: boolean;
|
|
7683
|
+
};
|
|
7684
|
+
/**
|
|
7685
|
+
* 分组右键菜单
|
|
7686
|
+
* TODO: 暂未实现
|
|
7687
|
+
*/
|
|
7688
|
+
groupContextMenu?: EditorFeatureConfig;
|
|
7689
|
+
/**
|
|
7690
|
+
* 字段统计菜单
|
|
7691
|
+
* TODO: 暂未实现
|
|
7692
|
+
*/
|
|
7693
|
+
fieldStatisticsMenu?: EditorFeatureConfig;
|
|
7694
|
+
/**
|
|
7695
|
+
* 侧边栏编辑器,包含评论与动态
|
|
7696
|
+
*/
|
|
7697
|
+
sidebarEditor?: {
|
|
7698
|
+
/**
|
|
7699
|
+
* 禁用生成记录链接
|
|
7700
|
+
* @default false
|
|
7701
|
+
*/
|
|
7702
|
+
disableGenerateRecordLink?: boolean;
|
|
7703
|
+
};
|
|
7704
|
+
}
|
|
7705
|
+
|
|
7706
|
+
export declare interface TableVersionOptions extends EditorVersionOptions {
|
|
7707
|
+
/**
|
|
7708
|
+
* 禁止创建副本
|
|
7709
|
+
*/
|
|
7710
|
+
disableCreateCopy?: boolean;
|
|
7711
|
+
}
|
|
7712
|
+
|
|
7713
|
+
/**
|
|
7714
|
+
* 表格视图操作接口
|
|
7715
|
+
*/
|
|
7716
|
+
export declare interface TableView {
|
|
7717
|
+
/**
|
|
7718
|
+
* 展开或关闭搜索面板
|
|
7719
|
+
*/
|
|
7720
|
+
toggleSearch: () => void;
|
|
7721
|
+
/**
|
|
7722
|
+
* 执行内容搜索
|
|
7723
|
+
* @param params - 搜索参数对象
|
|
7724
|
+
* @param params.searchText - 搜索文本内容
|
|
7725
|
+
*/
|
|
7726
|
+
search: (params: {
|
|
7727
|
+
searchText: string;
|
|
7728
|
+
}) => void;
|
|
7729
|
+
/**
|
|
7730
|
+
* 获取所有视图列表
|
|
7731
|
+
* @returns 当前表格的所有视图对象数组
|
|
7732
|
+
*/
|
|
7733
|
+
getViews: () => TableView[];
|
|
7734
|
+
/**
|
|
7735
|
+
* 获取当前激活的视图ID
|
|
7736
|
+
* @returns 当前激活视图的唯一标识符
|
|
7737
|
+
*/
|
|
7738
|
+
getActiveViewId: () => string;
|
|
7739
|
+
/**
|
|
7740
|
+
* 插入新视图
|
|
7741
|
+
* @param params - 视图类型或包含视图类型的参数对象
|
|
7742
|
+
* @param params.viewType - 要插入的视图类型
|
|
7743
|
+
* @param params.tableGuid - 可选,目标表格ID,不传则使用当前表格
|
|
7744
|
+
* @returns 新创建的视图对象
|
|
7745
|
+
*/
|
|
7746
|
+
insertView: (params: {
|
|
7747
|
+
viewType: ViewType;
|
|
7748
|
+
tableGuid?: string;
|
|
7749
|
+
} | ViewType) => TableView;
|
|
7750
|
+
/**
|
|
7751
|
+
* 删除视图
|
|
7752
|
+
* @param params - 可选的删除参数
|
|
7753
|
+
* @param params.tableGuid - 可选,目标表格ID,不传则使用当前表格
|
|
7754
|
+
* @param params.viewGuids - 可选,要删除的视图ID数组,不传则删除当前视图
|
|
7755
|
+
*/
|
|
7756
|
+
deleteView: (params?: {
|
|
7757
|
+
tableGuid?: string;
|
|
7758
|
+
viewGuids?: string[];
|
|
7759
|
+
}) => void;
|
|
7760
|
+
/**
|
|
7761
|
+
* 复制视图
|
|
7762
|
+
* @param params - 复制参数
|
|
7763
|
+
* @param params.viewGuid - 要复制的视图ID
|
|
7764
|
+
* @param params.tableGuid - 可选,目标表格ID,不传则使用当前表格
|
|
7765
|
+
*/
|
|
7766
|
+
duplicateView: (params: {
|
|
7767
|
+
viewGuid: string;
|
|
7768
|
+
tableGuid?: string;
|
|
7769
|
+
}) => void;
|
|
7770
|
+
/**
|
|
7771
|
+
* 更新视图名称
|
|
7772
|
+
* @param params - 更新参数
|
|
7773
|
+
* @param params.name - 新的视图名称
|
|
7774
|
+
* @param params.tableGuid - 可选,目标表格ID,不传则使用当前表格
|
|
7775
|
+
* @param params.viewGuid - 可选,目标视图ID,不传则使用当前视图
|
|
7776
|
+
*/
|
|
7777
|
+
updateViewName: (params: {
|
|
7778
|
+
name: string;
|
|
7779
|
+
tableGuid?: string;
|
|
7780
|
+
viewGuid?: string;
|
|
7781
|
+
}) => void;
|
|
7782
|
+
/**
|
|
7783
|
+
* 更新视图类型
|
|
7784
|
+
* @param params - 更新参数
|
|
7785
|
+
* @param params.viewType - 新的视图类型
|
|
7786
|
+
* @param params.tableGuid - 可选,目标表格ID,不传则使用当前表格
|
|
7787
|
+
* @param params.viewGuid - 可选,目标视图ID,不传则使用当前视图
|
|
7788
|
+
*/
|
|
7789
|
+
updateViewType: (params: {
|
|
7790
|
+
viewType: ViewType;
|
|
7791
|
+
tableGuid?: string;
|
|
7792
|
+
viewGuid?: string;
|
|
7793
|
+
}) => void;
|
|
7794
|
+
/**
|
|
7795
|
+
* 更新视图描述
|
|
7796
|
+
* @param params - 更新参数
|
|
7797
|
+
* @param params.description - 新的视图描述
|
|
7798
|
+
* @param params.tableGuid - 可选,目标表格ID,不传则使用当前表格
|
|
7799
|
+
* @param params.viewGuid - 可选,目标视图ID,不传则使用当前视图
|
|
7800
|
+
*/
|
|
7801
|
+
updateViewDescription: (params: {
|
|
7802
|
+
description: string;
|
|
7803
|
+
tableGuid?: string;
|
|
7804
|
+
viewGuid?: string;
|
|
7805
|
+
}) => void;
|
|
7806
|
+
/**
|
|
7807
|
+
* 更新视图排序
|
|
7808
|
+
* @param params - 更新参数
|
|
7809
|
+
* @param params.sort - 新的排序值
|
|
7810
|
+
* @param params.tableGuid - 可选,目标表格ID,不传则使用当前表格
|
|
7811
|
+
* @param params.viewGuid - 可选,目标视图ID,不传则使用当前视图
|
|
7812
|
+
*/
|
|
7813
|
+
updateViewSort: (params: {
|
|
7814
|
+
sort: number;
|
|
7815
|
+
tableGuid?: string;
|
|
7816
|
+
viewGuid?: string;
|
|
7817
|
+
}) => void;
|
|
7818
|
+
/**
|
|
7819
|
+
* 批量设置高亮单元格
|
|
7820
|
+
* @param params - 高亮参数
|
|
7821
|
+
* @param params.highLights - 要高亮的单元格数组
|
|
7822
|
+
*/
|
|
7823
|
+
setHighLights: (params: {
|
|
7824
|
+
highLights: HighLight[];
|
|
7825
|
+
}) => void;
|
|
7826
|
+
/**
|
|
7827
|
+
* 设置当前激活的高亮单元格
|
|
7828
|
+
* @param params - 高亮参数
|
|
7829
|
+
* @param params.highLight - 要高亮的单元格
|
|
7830
|
+
* @param params.scrollIntoView - 可选,是否将高亮单元格滚动到可视区域,默认为true
|
|
7831
|
+
*/
|
|
7832
|
+
setActiveHighLight: (params: {
|
|
7833
|
+
highLight: HighLight;
|
|
7834
|
+
scrollIntoView?: boolean;
|
|
7835
|
+
}) => void;
|
|
7836
|
+
}
|
|
7837
|
+
|
|
5363
7838
|
export declare type TableViewContextMenuEntryConfig = EditorMenuEntryConfig<TableViewContextMenuFeatureButtonName>;
|
|
5364
7839
|
|
|
5365
7840
|
export declare type TableViewContextMenuFeatureButtonConfig = EditorMenuEntryConfig<TableViewContextMenuFeatureButtonName>;
|
|
@@ -5372,6 +7847,214 @@ export declare type TableViewContextMenuFeatureButtonName = GridMenuItemName | K
|
|
|
5372
7847
|
|
|
5373
7848
|
export declare type TableViewContextMenuOptions = EditorMenuOptions<TableViewContextMenuFeatureButtonName>;
|
|
5374
7849
|
|
|
7850
|
+
/**
|
|
7851
|
+
* 表格视图配置选项
|
|
7852
|
+
*/
|
|
7853
|
+
export declare interface TableViewOptions {
|
|
7854
|
+
/**
|
|
7855
|
+
* 视图侧边栏配置
|
|
7856
|
+
*/
|
|
7857
|
+
viewSideBar?: {
|
|
7858
|
+
/**
|
|
7859
|
+
* 是否禁用视图权限
|
|
7860
|
+
* @default false
|
|
7861
|
+
*/
|
|
7862
|
+
disableViewPermission?: boolean;
|
|
7863
|
+
/**
|
|
7864
|
+
* 是否隐藏创建人信息
|
|
7865
|
+
* @default false
|
|
7866
|
+
*/
|
|
7867
|
+
hideViewCreator?: boolean;
|
|
7868
|
+
/**
|
|
7869
|
+
* 是否隐藏设置按钮
|
|
7870
|
+
* @default false
|
|
7871
|
+
*/
|
|
7872
|
+
hideViewSettingButton?: boolean;
|
|
7873
|
+
/**
|
|
7874
|
+
* 关注视图配置
|
|
7875
|
+
*/
|
|
7876
|
+
focus?: {
|
|
7877
|
+
/**
|
|
7878
|
+
* 是否禁用
|
|
7879
|
+
* @default false
|
|
7880
|
+
*/
|
|
7881
|
+
disabled?: boolean;
|
|
7882
|
+
};
|
|
7883
|
+
/**
|
|
7884
|
+
* 分享视图配置
|
|
7885
|
+
*/
|
|
7886
|
+
share?: {
|
|
7887
|
+
/**
|
|
7888
|
+
* 是否启用
|
|
7889
|
+
* @default false
|
|
7890
|
+
*/
|
|
7891
|
+
enabled?: boolean;
|
|
7892
|
+
/**
|
|
7893
|
+
* 互联网公开
|
|
7894
|
+
* @default false
|
|
7895
|
+
*/
|
|
7896
|
+
disablePublicShare?: boolean;
|
|
7897
|
+
/**
|
|
7898
|
+
* 组织架构 tab 可见
|
|
7899
|
+
* @default false
|
|
7900
|
+
*/
|
|
7901
|
+
disableOrgnizationPanelTab?: boolean;
|
|
7902
|
+
};
|
|
7903
|
+
/**
|
|
7904
|
+
* 个人视图配置
|
|
7905
|
+
*/
|
|
7906
|
+
personalSetting?: {
|
|
7907
|
+
/**
|
|
7908
|
+
* 是否禁用
|
|
7909
|
+
* @default false
|
|
7910
|
+
*/
|
|
7911
|
+
disabled?: boolean;
|
|
7912
|
+
};
|
|
7913
|
+
/**
|
|
7914
|
+
* 复制视图配置
|
|
7915
|
+
*/
|
|
7916
|
+
copy?: {
|
|
7917
|
+
/**
|
|
7918
|
+
* 是否禁用
|
|
7919
|
+
* @default false
|
|
7920
|
+
*/
|
|
7921
|
+
disabled?: boolean;
|
|
7922
|
+
};
|
|
7923
|
+
/**
|
|
7924
|
+
* 删除视图配置
|
|
7925
|
+
*/
|
|
7926
|
+
delete?: {
|
|
7927
|
+
/**
|
|
7928
|
+
* 是否禁用
|
|
7929
|
+
* @default false
|
|
7930
|
+
*/
|
|
7931
|
+
disabled?: boolean;
|
|
7932
|
+
};
|
|
7933
|
+
};
|
|
7934
|
+
/**
|
|
7935
|
+
* 视图特性配置
|
|
7936
|
+
*/
|
|
7937
|
+
viewConfig?: {
|
|
7938
|
+
/**
|
|
7939
|
+
* 画廊视图配置
|
|
7940
|
+
*/
|
|
7941
|
+
gallery?: {
|
|
7942
|
+
/**
|
|
7943
|
+
* 是否禁用布局配置
|
|
7944
|
+
* @default false
|
|
7945
|
+
*/
|
|
7946
|
+
disableLayoutConfig?: boolean;
|
|
7947
|
+
};
|
|
7948
|
+
};
|
|
7949
|
+
}
|
|
7950
|
+
|
|
7951
|
+
export declare interface TableWindow {
|
|
7952
|
+
/**
|
|
7953
|
+
* 维持编辑器焦点
|
|
7954
|
+
*
|
|
7955
|
+
* 防止点击iframe外部时编辑弹窗意外关闭
|
|
7956
|
+
* @returns {boolean} 是否成功
|
|
7957
|
+
*/
|
|
7958
|
+
keepFocus: () => boolean;
|
|
7959
|
+
/**
|
|
7960
|
+
* 触发外部点击事件
|
|
7961
|
+
*
|
|
7962
|
+
* 解决iframe外部点击无法响应问题,确保内容正确保存
|
|
7963
|
+
*/
|
|
7964
|
+
clickOutside: () => void;
|
|
7965
|
+
}
|
|
7966
|
+
|
|
7967
|
+
export declare interface TemplateProps {
|
|
7968
|
+
/**
|
|
7969
|
+
* 模板信息
|
|
7970
|
+
*/
|
|
7971
|
+
template: {
|
|
7972
|
+
/**
|
|
7973
|
+
* 模板 guid
|
|
7974
|
+
*/
|
|
7975
|
+
guid?: string;
|
|
7976
|
+
/**
|
|
7977
|
+
* 模板名称
|
|
7978
|
+
*/
|
|
7979
|
+
name: string;
|
|
7980
|
+
/**
|
|
7981
|
+
* 是否是自定义模板
|
|
7982
|
+
*/
|
|
7983
|
+
isCustom?: boolean;
|
|
7984
|
+
/**
|
|
7985
|
+
* 是否是空白模板
|
|
7986
|
+
*/
|
|
7987
|
+
isBlank?: boolean;
|
|
7988
|
+
/**
|
|
7989
|
+
* 模板额外信息
|
|
7990
|
+
*/
|
|
7991
|
+
extra?: {
|
|
7992
|
+
extraObject: any;
|
|
7993
|
+
};
|
|
7994
|
+
};
|
|
7995
|
+
}
|
|
7996
|
+
|
|
7997
|
+
/**
|
|
7998
|
+
* Toast提示文本配置接口
|
|
7999
|
+
*/
|
|
8000
|
+
export declare interface ToastTipsConfig {
|
|
8001
|
+
/**
|
|
8002
|
+
* 复制相关提示文本
|
|
8003
|
+
*/
|
|
8004
|
+
copy?: OperationToastConfig;
|
|
8005
|
+
/**
|
|
8006
|
+
* 粘贴相关提示文本
|
|
8007
|
+
*/
|
|
8008
|
+
paste?: OperationToastConfig;
|
|
8009
|
+
/**
|
|
8010
|
+
* 剪切相关提示文本
|
|
8011
|
+
*/
|
|
8012
|
+
cut?: OperationToastConfig;
|
|
8013
|
+
/**
|
|
8014
|
+
* 打印相关提示文本
|
|
8015
|
+
*/
|
|
8016
|
+
print?: OperationToastConfig;
|
|
8017
|
+
/**
|
|
8018
|
+
* 导出相关提示文本
|
|
8019
|
+
*/
|
|
8020
|
+
export?: OperationToastConfig;
|
|
8021
|
+
/**
|
|
8022
|
+
* 编辑相关提示文本
|
|
8023
|
+
*/
|
|
8024
|
+
edit?: OperationToastConfig;
|
|
8025
|
+
/**
|
|
8026
|
+
* 下载相关提示文本
|
|
8027
|
+
*/
|
|
8028
|
+
download?: {
|
|
8029
|
+
/**
|
|
8030
|
+
* 图片下载提示文本
|
|
8031
|
+
*/
|
|
8032
|
+
image?: OperationToastConfig;
|
|
8033
|
+
/**
|
|
8034
|
+
* 附件下载提示文本
|
|
8035
|
+
*/
|
|
8036
|
+
attachment?: OperationToastConfig;
|
|
8037
|
+
};
|
|
8038
|
+
/**
|
|
8039
|
+
* 预览相关提示文本
|
|
8040
|
+
*/
|
|
8041
|
+
preview?: {
|
|
8042
|
+
/**
|
|
8043
|
+
* 图片预览提示文本
|
|
8044
|
+
*/
|
|
8045
|
+
image?: OperationToastConfig;
|
|
8046
|
+
/**
|
|
8047
|
+
* 附件预览提示文本
|
|
8048
|
+
*/
|
|
8049
|
+
attachment?: OperationToastConfig;
|
|
8050
|
+
};
|
|
8051
|
+
/**
|
|
8052
|
+
* 创建版本相关提示文本
|
|
8053
|
+
* sdk2.0需要提供
|
|
8054
|
+
*/
|
|
8055
|
+
createVersion?: OperationToastConfig;
|
|
8056
|
+
}
|
|
8057
|
+
|
|
5375
8058
|
/**
|
|
5376
8059
|
* 工具箱工具项接口
|
|
5377
8060
|
*/
|
|
@@ -5431,4 +8114,41 @@ export declare enum ToolTypes {
|
|
|
5431
8114
|
STT = "audioToText"
|
|
5432
8115
|
}
|
|
5433
8116
|
|
|
8117
|
+
/**
|
|
8118
|
+
* URL参数接口
|
|
8119
|
+
* 定义了表格组件URL中包含的关键参数
|
|
8120
|
+
*/
|
|
8121
|
+
export declare interface UrlParams {
|
|
8122
|
+
/** 文件ID,用于唯一标识一个文档 */
|
|
8123
|
+
fileGuid: string;
|
|
8124
|
+
/** 表格ID,用于标识文档中的特定表格 */
|
|
8125
|
+
table: string;
|
|
8126
|
+
/** 视图ID,用于标识表格的特定视图 */
|
|
8127
|
+
view: string;
|
|
8128
|
+
/** URL哈希值,可包含额外导航信息 */
|
|
8129
|
+
hash: string;
|
|
8130
|
+
}
|
|
8131
|
+
|
|
8132
|
+
/**
|
|
8133
|
+
* 视图类型枚举
|
|
8134
|
+
*/
|
|
8135
|
+
export declare enum ViewType {
|
|
8136
|
+
/** 网格视图 */
|
|
8137
|
+
Grid = "Grid",
|
|
8138
|
+
/** 表单视图 */
|
|
8139
|
+
Form = "Form",
|
|
8140
|
+
/** 看板视图 */
|
|
8141
|
+
Kanban = "Kanban",
|
|
8142
|
+
/** 画廊视图 */
|
|
8143
|
+
Gallery = "Gallery",
|
|
8144
|
+
/** 日历视图 */
|
|
8145
|
+
Calendar = "Calendar",
|
|
8146
|
+
/** 甘特图视图 */
|
|
8147
|
+
Gantt = "Gantt",
|
|
8148
|
+
/** 任务视图 */
|
|
8149
|
+
Task = "Task",
|
|
8150
|
+
/** 列表视图 */
|
|
8151
|
+
List = "List"
|
|
8152
|
+
}
|
|
8153
|
+
|
|
5434
8154
|
export { }
|