@officesdk/editor-sdk-core 0.0.0-14 → 0.0.0-16
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/docx/index.js +1 -1
- package/cjs/docx/menu.js +1 -1
- package/cjs/docx/sdk.js +1 -1
- package/cjs/docx/theme.js +1 -1
- package/cjs/docx/toolbar.js +3 -0
- package/cjs/presentation/export.js +14 -0
- package/cjs/presentation/index.js +4 -2
- package/cjs/presentation/sdk.js +1 -1
- package/cjs/shared/attachment.js +1 -1
- package/cjs/shared/checkpoints.js +19 -0
- package/cjs/shared/collaboration.js +3 -0
- package/cjs/shared/collaborators.js +3 -0
- package/cjs/shared/comments.js +1 -1
- package/cjs/shared/decryption.js +3 -0
- package/cjs/shared/download.js +3 -0
- package/cjs/shared/editor.js +1 -1
- package/cjs/shared/export.js +1 -1
- package/cjs/shared/feature.js +3 -0
- package/cjs/shared/file-picker.js +1 -1
- package/cjs/shared/file.js +50 -0
- package/cjs/shared/follow-mode.js +3 -0
- package/cjs/shared/history.js +3 -0
- package/cjs/shared/index.js +1 -1
- package/cjs/shared/link.js +1 -1
- package/cjs/shared/mention.js +3 -0
- package/cjs/shared/menu.js +1 -1
- package/cjs/shared/performance.js +3 -0
- package/cjs/shared/print.js +1 -1
- package/cjs/shared/render.js +3 -0
- package/cjs/shared/tool-box.js +40 -0
- package/cjs/shared/toolbar.js +1 -1
- package/cjs/shared/ui.js +18 -0
- package/cjs/shared/version.js +3 -0
- package/cjs/sheet/cell.js +29 -1
- package/cjs/sheet/chart.js +3 -0
- package/cjs/sheet/checklist.js +3 -0
- package/cjs/sheet/combine-sheets.js +3 -0
- package/cjs/sheet/comments.js +3 -0
- package/cjs/sheet/data-transfer.js +3 -0
- package/cjs/sheet/export.js +3 -0
- package/cjs/sheet/font.js +3 -0
- package/cjs/sheet/form.js +3 -0
- package/cjs/sheet/import-formula.js +3 -0
- package/cjs/sheet/index.js +4 -2
- package/cjs/sheet/lock.js +14 -0
- package/cjs/sheet/mention.js +13 -0
- package/cjs/sheet/range.js +1 -1
- package/cjs/sheet/render.js +3 -0
- package/cjs/sheet/sdk.js +1 -1
- package/cjs/sheet/sensitization.js +3 -0
- package/cjs/sheet/sheet2table.js +3 -0
- package/cjs/sheet/worksheet.js +1 -1
- package/cjs/table/sdk.js +1 -1
- package/esm/docx/index.js +1 -1
- package/esm/docx/menu.js +1 -1
- package/esm/docx/sdk.js +1 -1
- package/esm/docx/theme.js +1 -1
- package/esm/docx/toolbar.js +2 -0
- package/esm/presentation/export.js +11 -0
- package/esm/presentation/index.js +2 -1
- package/esm/presentation/sdk.js +1 -1
- package/esm/shared/attachment.js +1 -1
- package/esm/shared/checkpoints.js +16 -0
- package/esm/shared/collaboration.js +2 -0
- package/esm/shared/collaborators.js +2 -0
- package/esm/shared/comments.js +1 -1
- package/esm/shared/decryption.js +2 -0
- package/esm/shared/download.js +2 -0
- package/esm/shared/editor.js +1 -1
- package/esm/shared/export.js +1 -1
- package/esm/shared/feature.js +2 -0
- package/esm/shared/file-picker.js +1 -1
- package/esm/shared/file.js +47 -0
- package/esm/shared/follow-mode.js +2 -0
- package/esm/shared/history.js +2 -0
- package/esm/shared/index.js +1 -1
- package/esm/shared/link.js +1 -1
- package/esm/shared/mention.js +2 -0
- package/esm/shared/menu.js +1 -1
- package/esm/shared/performance.js +2 -0
- package/esm/shared/print.js +1 -1
- package/esm/shared/render.js +2 -0
- package/esm/shared/tool-box.js +37 -0
- package/esm/shared/toolbar.js +1 -1
- package/esm/shared/ui.js +15 -0
- package/esm/shared/version.js +2 -0
- package/esm/sheet/cell.js +28 -2
- package/esm/sheet/chart.js +2 -0
- package/esm/sheet/checklist.js +2 -0
- package/esm/sheet/combine-sheets.js +2 -0
- package/esm/sheet/comments.js +2 -0
- package/esm/sheet/data-transfer.js +2 -0
- package/esm/sheet/export.js +2 -0
- package/esm/sheet/font.js +2 -0
- package/esm/sheet/form.js +2 -0
- package/esm/sheet/import-formula.js +2 -0
- package/esm/sheet/index.js +2 -1
- package/esm/sheet/lock.js +11 -0
- package/esm/sheet/mention.js +10 -0
- package/esm/sheet/range.js +1 -1
- package/esm/sheet/render.js +2 -0
- package/esm/sheet/sdk.js +1 -1
- package/esm/sheet/sensitization.js +2 -0
- package/esm/sheet/sheet2table.js +2 -0
- package/esm/sheet/worksheet.js +1 -1
- package/esm/table/sdk.js +1 -1
- package/package.json +1 -1
- package/types/diagram.d.ts +769 -41
- package/types/docs.d.ts +769 -41
- package/types/docx.d.ts +878 -43
- package/types/pdf.d.ts +769 -41
- package/types/presentation.d.ts +783 -41
- package/types/shared.d.ts +769 -41
- package/types/sheet.d.ts +1238 -76
- package/types/table.d.ts +781 -48
package/types/table.d.ts
CHANGED
|
@@ -62,6 +62,55 @@ export declare abstract class AbstractedTableSDK implements Omit<EditorSDK, 'con
|
|
|
62
62
|
* 表格内容相关接口
|
|
63
63
|
*/
|
|
64
64
|
abstract get content(): TableEditorContent;
|
|
65
|
+
/**
|
|
66
|
+
* 编辑器历史相关接口
|
|
67
|
+
*/
|
|
68
|
+
abstract get history(): EditorHistory;
|
|
69
|
+
/**
|
|
70
|
+
* 编辑器协作者相关接口
|
|
71
|
+
*/
|
|
72
|
+
abstract get collaborators(): EditorCollaborators;
|
|
73
|
+
/**
|
|
74
|
+
* 编辑器版本相关接口
|
|
75
|
+
*/
|
|
76
|
+
abstract get version(): EditorVersion;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export declare type CheckLimitationResult = {
|
|
80
|
+
status: 'limited';
|
|
81
|
+
/**
|
|
82
|
+
* 被限制原因
|
|
83
|
+
*/
|
|
84
|
+
reason?: string;
|
|
85
|
+
} | {
|
|
86
|
+
status: 'unlimited';
|
|
87
|
+
};
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* 协作者信息接口
|
|
91
|
+
*/
|
|
92
|
+
export declare interface CollaboratorInfo {
|
|
93
|
+
/** 协作者唯一标识 */
|
|
94
|
+
id: number;
|
|
95
|
+
/** 协作者名称 */
|
|
96
|
+
name: string;
|
|
97
|
+
/** 协作者头像URL */
|
|
98
|
+
avatar: string;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export declare interface ConfirmButtonConfig {
|
|
102
|
+
/**
|
|
103
|
+
* 按钮文本
|
|
104
|
+
*/
|
|
105
|
+
label?: string;
|
|
106
|
+
/**
|
|
107
|
+
* 是否隐藏
|
|
108
|
+
*/
|
|
109
|
+
hidden?: boolean;
|
|
110
|
+
/**
|
|
111
|
+
* 按钮点击回调
|
|
112
|
+
*/
|
|
113
|
+
onClick?: () => void;
|
|
65
114
|
}
|
|
66
115
|
|
|
67
116
|
export declare interface DBTable {
|
|
@@ -218,8 +267,9 @@ export declare interface EditorAttachmentMaxSizeOptions {
|
|
|
218
267
|
* 编辑器附件信息
|
|
219
268
|
*/
|
|
220
269
|
export declare interface EditorAttachmentOptions {
|
|
221
|
-
|
|
222
|
-
|
|
270
|
+
picker?: EditorFilePicker;
|
|
271
|
+
uploader?: AbstractedEditorFileUploader;
|
|
272
|
+
download?: (url: string) => void;
|
|
223
273
|
/**
|
|
224
274
|
* 图片附件相关配置
|
|
225
275
|
*/
|
|
@@ -293,6 +343,80 @@ export declare interface EditorBrandOptions {
|
|
|
293
343
|
};
|
|
294
344
|
}
|
|
295
345
|
|
|
346
|
+
export declare interface EditorCheckpointsOptions {
|
|
347
|
+
/**
|
|
348
|
+
* 获取功能卡点限制
|
|
349
|
+
* undefined代表无限制
|
|
350
|
+
*/
|
|
351
|
+
getFeatureLimitation?: (key: string) => Limitation | undefined;
|
|
352
|
+
/**
|
|
353
|
+
* 检查是否超限
|
|
354
|
+
* @param key 功能卡点key
|
|
355
|
+
* @param value 功能卡点检查值,如文件大小/行列数量等
|
|
356
|
+
*/
|
|
357
|
+
checkFeatureLimitation?: (key: string, value: number) => CheckLimitationResult;
|
|
358
|
+
/**
|
|
359
|
+
* 获取功能卡点状态,如某功能入口是否开启
|
|
360
|
+
*/
|
|
361
|
+
getFeatureStatus?: (key: string) => FeatureStatus;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
export declare interface EditorCollaborationOptions {
|
|
365
|
+
/**
|
|
366
|
+
* 是否允许离线编辑
|
|
367
|
+
*/
|
|
368
|
+
offlineEditable: boolean;
|
|
369
|
+
/**
|
|
370
|
+
* 保存状态外部接口委托
|
|
371
|
+
*/
|
|
372
|
+
saveStatus: SaveStatusDelegation;
|
|
373
|
+
/**
|
|
374
|
+
* 同步状态外部接口委托(部分套件不支持离线编辑)
|
|
375
|
+
*/
|
|
376
|
+
syncStatus?: SyncStatusDelegation;
|
|
377
|
+
/**
|
|
378
|
+
* 是否使用严格的长度校验规则,默认关闭,在开启后如果出现长度校验失败会立刻禁止编辑器继续编写,并将保存状态设置为错误状态
|
|
379
|
+
*/
|
|
380
|
+
strictCLC?: boolean;
|
|
381
|
+
}
|
|
382
|
+
|
|
383
|
+
/**
|
|
384
|
+
* 编辑器协作者管理接口
|
|
385
|
+
*/
|
|
386
|
+
export declare interface EditorCollaborators {
|
|
387
|
+
/**
|
|
388
|
+
* 获取当前所有协作者列表
|
|
389
|
+
* @returns 返回所有协作者信息数组
|
|
390
|
+
*/
|
|
391
|
+
getCollaborators: () => CollaboratorInfo[];
|
|
392
|
+
/**
|
|
393
|
+
* 开始监听协作者状态变化
|
|
394
|
+
* 调用此方法后,将开始接收协作者进入/离开的事件
|
|
395
|
+
*/
|
|
396
|
+
start: () => void;
|
|
397
|
+
/**
|
|
398
|
+
* 停止监听协作者状态变化
|
|
399
|
+
* 调用此方法后,将不再接收协作者进入/离开的事件
|
|
400
|
+
*/
|
|
401
|
+
stop: () => void;
|
|
402
|
+
/**
|
|
403
|
+
* 添加协作者进入事件监听器
|
|
404
|
+
* @param listener - 监听器回调函数,参数如下:
|
|
405
|
+
* - allUsers: 当前所有协作者列表
|
|
406
|
+
* - enteredUsers: 新进入的协作者列表
|
|
407
|
+
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
408
|
+
*/
|
|
409
|
+
addUserEnterListener: (listener: (allUsers: CollaboratorInfo[], enteredUsers: CollaboratorInfo[]) => void) => () => void;
|
|
410
|
+
/**
|
|
411
|
+
* 添加协作者离开事件监听器
|
|
412
|
+
* @param listener - 监听器回调函数
|
|
413
|
+
* - allUsers: 当前所有协作者列表
|
|
414
|
+
* - leftUsers: 离开的协作者列表
|
|
415
|
+
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
416
|
+
*/
|
|
417
|
+
addUserLeaveListener: (listener: (allUsers: CollaboratorInfo[], leftUsers: CollaboratorInfo[]) => void) => () => void;
|
|
418
|
+
}
|
|
419
|
+
|
|
296
420
|
/**
|
|
297
421
|
* 单条评论数据
|
|
298
422
|
*/
|
|
@@ -359,7 +483,7 @@ export declare interface EditorComments {
|
|
|
359
483
|
/**
|
|
360
484
|
* 编辑器评论初始化配置
|
|
361
485
|
*/
|
|
362
|
-
export declare interface EditorCommentsOptions {
|
|
486
|
+
export declare interface EditorCommentsOptions extends EditorFeatureConfig {
|
|
363
487
|
/**
|
|
364
488
|
* 评论作者信息,如果这里的信息为空,将会使用 user 信息
|
|
365
489
|
*/
|
|
@@ -388,6 +512,12 @@ export declare interface EditorCommentsOptions {
|
|
|
388
512
|
*/
|
|
389
513
|
mode: 'none' | 'card';
|
|
390
514
|
};
|
|
515
|
+
/**
|
|
516
|
+
* 评论变化监听
|
|
517
|
+
* @param listener
|
|
518
|
+
* @returns 返回一个函数,调用该函数可以移除监听器
|
|
519
|
+
*/
|
|
520
|
+
addChangedListener?: (listener: (type: 'create' | 'update' | 'close', data: EditorCommentItem) => void) => () => void;
|
|
391
521
|
}
|
|
392
522
|
|
|
393
523
|
export declare interface EditorContent<Delta = EditorDelta> {
|
|
@@ -413,6 +543,19 @@ export declare interface EditorContent<Delta = EditorDelta> {
|
|
|
413
543
|
*/
|
|
414
544
|
export declare type EditorContextMenuOptions<TName extends string> = EditorMenuOptions<TName>;
|
|
415
545
|
|
|
546
|
+
/**
|
|
547
|
+
* 编辑器解密选项接口
|
|
548
|
+
* 用于配置编辑器中需要解密的内容的相关选项
|
|
549
|
+
*/
|
|
550
|
+
export declare interface EditorDecryptionOptions {
|
|
551
|
+
/**
|
|
552
|
+
* 图片附件解密函数
|
|
553
|
+
* @param buffer - 需要解密的二进制数据
|
|
554
|
+
* @returns 解密后的二进制数据
|
|
555
|
+
*/
|
|
556
|
+
decrypt?: (buffer: ArrayBuffer) => ArrayBuffer;
|
|
557
|
+
}
|
|
558
|
+
|
|
416
559
|
export declare interface EditorDelta {
|
|
417
560
|
compose: (other: EditorDelta, isDocument?: boolean) => EditorDelta;
|
|
418
561
|
transform: (other: EditorDelta, priority?: boolean) => EditorDelta;
|
|
@@ -472,16 +615,81 @@ export declare interface EditorEmbeddedObjectOptions {
|
|
|
472
615
|
export declare interface EditorExportOptions {
|
|
473
616
|
/**
|
|
474
617
|
* 可导出类型
|
|
475
|
-
* @description
|
|
476
618
|
*/
|
|
477
619
|
supportedTypes?: string[];
|
|
478
620
|
/**
|
|
479
621
|
* 导出文件
|
|
480
|
-
* @description
|
|
481
622
|
*/
|
|
482
623
|
exportFile: (type: string) => Promise<void>;
|
|
483
624
|
}
|
|
484
625
|
|
|
626
|
+
export declare interface EditorFeatureConfig {
|
|
627
|
+
/**
|
|
628
|
+
* 功能是否被禁用(入口还在)
|
|
629
|
+
*/
|
|
630
|
+
disabled?: boolean;
|
|
631
|
+
/**
|
|
632
|
+
* 功能入口是否被隐藏
|
|
633
|
+
*/
|
|
634
|
+
hidden?: boolean;
|
|
635
|
+
}
|
|
636
|
+
|
|
637
|
+
export declare interface EditorFileOptions {
|
|
638
|
+
/**
|
|
639
|
+
* 文件guid
|
|
640
|
+
*/
|
|
641
|
+
guid: string;
|
|
642
|
+
/**
|
|
643
|
+
* 文件名
|
|
644
|
+
*/
|
|
645
|
+
name?: string;
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
export declare interface EditorFilePicker {
|
|
649
|
+
open: (option: EditorFilePickerOpenOptions) => Promise<EditorPickedFile[]>;
|
|
650
|
+
}
|
|
651
|
+
|
|
652
|
+
export declare interface EditorFilePickerOpenOptions {
|
|
653
|
+
mimeTypes?: string[];
|
|
654
|
+
maxSize?: number;
|
|
655
|
+
extensions?: string[];
|
|
656
|
+
multiple?: boolean;
|
|
657
|
+
directory?: boolean;
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
export declare interface EditorFollowMode {
|
|
661
|
+
/**
|
|
662
|
+
* 演讲者/跟随者进入跟随模式
|
|
663
|
+
* 当演讲者调用此方法时,其他用户将可以开始跟随该演讲者
|
|
664
|
+
*/
|
|
665
|
+
enter: () => void;
|
|
666
|
+
/**
|
|
667
|
+
* 当前是否处于跟随模式
|
|
668
|
+
* @returns 返回布尔值,true表示正在跟随,false表示未在跟随
|
|
669
|
+
*/
|
|
670
|
+
isFollowModeActive: () => boolean;
|
|
671
|
+
/**
|
|
672
|
+
* 获取当前演讲者信息
|
|
673
|
+
* @returns 返回包含演讲者ID、姓名和头像信息的对象
|
|
674
|
+
*/
|
|
675
|
+
getSpeaker: () => Speaker;
|
|
676
|
+
/**
|
|
677
|
+
* 添加跟随状态变化的监听器
|
|
678
|
+
* @param listener 状态变化时的回调函数
|
|
679
|
+
* @returns 返回一个用于移除监听器的函数
|
|
680
|
+
*/
|
|
681
|
+
addChangedListener: (listener: () => void) => () => void;
|
|
682
|
+
}
|
|
683
|
+
|
|
684
|
+
export declare interface EditorFollowModeOptions extends EditorFeatureConfig {
|
|
685
|
+
/**
|
|
686
|
+
* 推送跟随消息的 socket 对象
|
|
687
|
+
* 实际类型为socketIO.client
|
|
688
|
+
* TODO: 抽象为接口
|
|
689
|
+
*/
|
|
690
|
+
socket?: unknown;
|
|
691
|
+
}
|
|
692
|
+
|
|
485
693
|
export declare interface EditorFontFace {
|
|
486
694
|
/**
|
|
487
695
|
* 字体的名称,用于在用户界面上显示的名称
|
|
@@ -560,6 +768,19 @@ export declare interface EditorFontsOptions {
|
|
|
560
768
|
list: EditorFontsList;
|
|
561
769
|
}
|
|
562
770
|
|
|
771
|
+
export declare interface EditorHistory {
|
|
772
|
+
/**
|
|
773
|
+
* 显示历史记录侧边栏
|
|
774
|
+
*/
|
|
775
|
+
showSidebar: () => void;
|
|
776
|
+
/**
|
|
777
|
+
* 隐藏历史记录侧边栏
|
|
778
|
+
*/
|
|
779
|
+
hideSidebar: () => void;
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
export declare type EditorHistoryOptions = EditorFeatureConfig;
|
|
783
|
+
|
|
563
784
|
/**
|
|
564
785
|
* i18n 相关设置
|
|
565
786
|
*/
|
|
@@ -580,13 +801,39 @@ export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'cen
|
|
|
580
801
|
* 链接配置,抽象打开链接等操作
|
|
581
802
|
*/
|
|
582
803
|
export declare interface EditorLinkOptions {
|
|
804
|
+
/**
|
|
805
|
+
* 链接识别配置
|
|
806
|
+
*/
|
|
807
|
+
detection?: {
|
|
808
|
+
/**
|
|
809
|
+
* 支持识别的链接格式
|
|
810
|
+
*/
|
|
811
|
+
pattern?: string | RegExp | (string | RegExp)[];
|
|
812
|
+
/**
|
|
813
|
+
* 是否启用链接识别,默认关闭
|
|
814
|
+
*/
|
|
815
|
+
enabled?: boolean;
|
|
816
|
+
};
|
|
583
817
|
/**
|
|
584
818
|
* 打开链接,如果取消了打开链接操作,返回 false
|
|
585
819
|
* @param url
|
|
586
820
|
* @param target
|
|
587
821
|
* @returns
|
|
588
822
|
*/
|
|
589
|
-
open
|
|
823
|
+
open?: (url: string, target: string) => Promise<boolean>;
|
|
824
|
+
/**
|
|
825
|
+
* 根据文件guid以及其他参数生成链接
|
|
826
|
+
*/
|
|
827
|
+
generate?: (params: FileLinkParams) => Promise<string>;
|
|
828
|
+
/**
|
|
829
|
+
* 从文档链接中解析得到文件guid等参数
|
|
830
|
+
*/
|
|
831
|
+
parse?: (url: string) => Promise<FileLinkParams | undefined>;
|
|
832
|
+
/**
|
|
833
|
+
* 生成sdk2.0内部链接
|
|
834
|
+
* 使用场景:专业表格跨表格引用
|
|
835
|
+
*/
|
|
836
|
+
generateInternal?: (params: FileLinkParams) => Promise<string>;
|
|
590
837
|
}
|
|
591
838
|
|
|
592
839
|
/**
|
|
@@ -671,29 +918,27 @@ export declare interface EditorMenuEntryMenuItemConfig<TName extends string> ext
|
|
|
671
918
|
/**
|
|
672
919
|
* 菜单功能按钮配置
|
|
673
920
|
*/
|
|
674
|
-
export declare interface EditorMenuFeatureConfig {
|
|
921
|
+
export declare interface EditorMenuFeatureConfig extends EditorFeatureConfig {
|
|
675
922
|
/**
|
|
676
|
-
*
|
|
923
|
+
* 按钮标签(显示文本)一般工具栏上的按钮不会显示文本,如果需要显示文本,配置此项。
|
|
677
924
|
*/
|
|
678
|
-
|
|
925
|
+
label?: string;
|
|
679
926
|
/**
|
|
680
|
-
*
|
|
927
|
+
* 按钮图标,可以是 base64 的图片信息,也可以是图片 url
|
|
681
928
|
*/
|
|
682
|
-
|
|
683
|
-
}
|
|
684
|
-
|
|
685
|
-
/**
|
|
686
|
-
* 菜单功能按钮配置
|
|
687
|
-
*/
|
|
688
|
-
export declare interface EditorMenuFeatureConfig {
|
|
929
|
+
icon?: string;
|
|
689
930
|
/**
|
|
690
|
-
*
|
|
931
|
+
* 按钮点击事件.接受一个函数,可以自定义点击事件。
|
|
691
932
|
*/
|
|
692
|
-
|
|
933
|
+
callback?: () => void;
|
|
693
934
|
/**
|
|
694
|
-
*
|
|
935
|
+
* 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
|
|
695
936
|
*/
|
|
696
|
-
|
|
937
|
+
tooltip?: string;
|
|
938
|
+
/**
|
|
939
|
+
* 按钮在工具栏中位置,不设置则按照默认位置
|
|
940
|
+
*/
|
|
941
|
+
index?: number;
|
|
697
942
|
}
|
|
698
943
|
|
|
699
944
|
/**
|
|
@@ -751,9 +996,9 @@ export declare interface EditorMenuOptions<TName extends string> {
|
|
|
751
996
|
entries?: EditorMenuEntryConfig<TName>[];
|
|
752
997
|
/**
|
|
753
998
|
* 菜单栏功能按钮配置
|
|
754
|
-
*
|
|
999
|
+
* 更加间接的配置项
|
|
755
1000
|
*/
|
|
756
|
-
features?: Record<TName, EditorMenuFeatureConfig
|
|
1001
|
+
features?: Partial<Record<TName, EditorMenuFeatureConfig>>;
|
|
757
1002
|
/**
|
|
758
1003
|
* 自定义按钮配置
|
|
759
1004
|
*/
|
|
@@ -823,6 +1068,10 @@ export declare interface EditorOptions {
|
|
|
823
1068
|
* 匿名用户的缺省信息
|
|
824
1069
|
*/
|
|
825
1070
|
anonymous?: EditorAnonymousOptions;
|
|
1071
|
+
/**
|
|
1072
|
+
* 当前文件信息
|
|
1073
|
+
*/
|
|
1074
|
+
file?: EditorFileOptions;
|
|
826
1075
|
/**
|
|
827
1076
|
* i18n 相关设置
|
|
828
1077
|
*/
|
|
@@ -830,13 +1079,13 @@ export declare interface EditorOptions {
|
|
|
830
1079
|
/**
|
|
831
1080
|
* 品牌相关设置
|
|
832
1081
|
*/
|
|
833
|
-
brand?: EditorBrandOptions
|
|
1082
|
+
brand?: MaybePromiseValue<EditorBrandOptions>;
|
|
834
1083
|
/**
|
|
835
1084
|
* 编辑器内部资源请求配置
|
|
836
1085
|
*/
|
|
837
1086
|
assets?: EditorAssetsOptions;
|
|
838
1087
|
/**
|
|
839
|
-
*
|
|
1088
|
+
* 编辑器链接相关配置
|
|
840
1089
|
*/
|
|
841
1090
|
link?: EditorLinkOptions;
|
|
842
1091
|
/**
|
|
@@ -863,6 +1112,38 @@ export declare interface EditorOptions {
|
|
|
863
1112
|
* 导出设置
|
|
864
1113
|
*/
|
|
865
1114
|
export?: EditorExportOptions;
|
|
1115
|
+
/**
|
|
1116
|
+
* 解密设置
|
|
1117
|
+
*/
|
|
1118
|
+
decryption?: EditorDecryptionOptions;
|
|
1119
|
+
/**
|
|
1120
|
+
* 网络请求设置
|
|
1121
|
+
*/
|
|
1122
|
+
http?: HTTPProxy;
|
|
1123
|
+
/**
|
|
1124
|
+
* 编辑器渲染设置项
|
|
1125
|
+
*/
|
|
1126
|
+
render?: EditorRenderOptions;
|
|
1127
|
+
/**
|
|
1128
|
+
* 编辑器 UI 相关
|
|
1129
|
+
*/
|
|
1130
|
+
ui?: EditorUiOptions;
|
|
1131
|
+
/**
|
|
1132
|
+
* 编辑器卡点限制
|
|
1133
|
+
*/
|
|
1134
|
+
checkpoints?: EditorCheckpointsOptions;
|
|
1135
|
+
/**
|
|
1136
|
+
* 编辑器工具箱设置
|
|
1137
|
+
*/
|
|
1138
|
+
toolbox?: EditorToolboxOptions;
|
|
1139
|
+
/**
|
|
1140
|
+
* 编辑器历史设置
|
|
1141
|
+
*/
|
|
1142
|
+
history?: EditorHistoryOptions;
|
|
1143
|
+
/**
|
|
1144
|
+
* 编辑器协作相关
|
|
1145
|
+
*/
|
|
1146
|
+
collaboration?: EditorCollaborationOptions;
|
|
866
1147
|
}
|
|
867
1148
|
|
|
868
1149
|
/**
|
|
@@ -923,10 +1204,33 @@ export declare interface EditorOutlineOptions {
|
|
|
923
1204
|
visible?: boolean;
|
|
924
1205
|
}
|
|
925
1206
|
|
|
1207
|
+
export declare interface EditorPickedFile {
|
|
1208
|
+
/**
|
|
1209
|
+
* 文件大小
|
|
1210
|
+
*/
|
|
1211
|
+
size: number;
|
|
1212
|
+
/**
|
|
1213
|
+
* 文件名
|
|
1214
|
+
*/
|
|
1215
|
+
name: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* 文件路径,仅显示有意义的相对路径,可用在上传文件夹和识别文件使用
|
|
1218
|
+
*/
|
|
1219
|
+
path?: string;
|
|
1220
|
+
/**
|
|
1221
|
+
* 文件类型,mime-type
|
|
1222
|
+
*/
|
|
1223
|
+
type: string;
|
|
1224
|
+
/**
|
|
1225
|
+
* 文件原始数据,用于给上传控件使用
|
|
1226
|
+
*/
|
|
1227
|
+
raw: File;
|
|
1228
|
+
}
|
|
1229
|
+
|
|
926
1230
|
/**
|
|
927
1231
|
* 编辑器打印设置
|
|
928
1232
|
*/
|
|
929
|
-
export declare interface EditorPrintOptions {
|
|
1233
|
+
export declare interface EditorPrintOptions extends EditorFeatureConfig {
|
|
930
1234
|
/**
|
|
931
1235
|
* 部分套件如果绕过了编辑器预设的打印接口,直接通过拉起了浏览器的打印页面,这时打印页面无法获取到编辑器的内容,
|
|
932
1236
|
* 这种情况下就会 fallback 到这个 options 上,显示一个提示信息。
|
|
@@ -934,10 +1238,6 @@ export declare interface EditorPrintOptions {
|
|
|
934
1238
|
fallback?: {
|
|
935
1239
|
message: string;
|
|
936
1240
|
};
|
|
937
|
-
/**
|
|
938
|
-
* 是否禁用打印功能
|
|
939
|
-
*/
|
|
940
|
-
disabled?: boolean;
|
|
941
1241
|
}
|
|
942
1242
|
|
|
943
1243
|
/**
|
|
@@ -951,6 +1251,13 @@ export declare interface EditorRemoteUploadableFile extends EditorBaseUploadable
|
|
|
951
1251
|
raw?: never;
|
|
952
1252
|
}
|
|
953
1253
|
|
|
1254
|
+
export declare interface EditorRenderOptions {
|
|
1255
|
+
/**
|
|
1256
|
+
* 渲染的容器
|
|
1257
|
+
*/
|
|
1258
|
+
container?: HTMLElement;
|
|
1259
|
+
}
|
|
1260
|
+
|
|
954
1261
|
/**
|
|
955
1262
|
* 编辑器通用接口
|
|
956
1263
|
*/
|
|
@@ -985,8 +1292,24 @@ export declare abstract class EditorSDK {
|
|
|
985
1292
|
abstract get mode(): EditorMode;
|
|
986
1293
|
/**
|
|
987
1294
|
* 编辑器评论相关接口
|
|
1295
|
+
* 部分环境不存在,如离线客户端
|
|
988
1296
|
*/
|
|
989
|
-
abstract get comments(): EditorComments;
|
|
1297
|
+
abstract get comments(): EditorComments | undefined;
|
|
1298
|
+
/**
|
|
1299
|
+
* 编辑器协作者相关接口
|
|
1300
|
+
* 部分环境不存在,如离线客户端
|
|
1301
|
+
*/
|
|
1302
|
+
abstract get collaborators(): EditorCollaborators | undefined;
|
|
1303
|
+
/**
|
|
1304
|
+
* 编辑器历史相关接口
|
|
1305
|
+
* 部分环境不存在,如离线客户端
|
|
1306
|
+
*/
|
|
1307
|
+
abstract get history(): EditorHistory | undefined;
|
|
1308
|
+
/**
|
|
1309
|
+
* 编辑器版本相关接口
|
|
1310
|
+
* 部分环境不存在,如离线客户端
|
|
1311
|
+
*/
|
|
1312
|
+
abstract get version(): EditorVersion | undefined;
|
|
990
1313
|
}
|
|
991
1314
|
|
|
992
1315
|
/**
|
|
@@ -1122,11 +1445,11 @@ export declare interface EditorTextOptions<Color = string> {
|
|
|
1122
1445
|
/**
|
|
1123
1446
|
* 工具栏功能按钮配置(包括内置按钮和自定义按钮)
|
|
1124
1447
|
*/
|
|
1125
|
-
export declare interface EditorToolbarFeatureButton<TName extends string> {
|
|
1448
|
+
export declare interface EditorToolbarFeatureButton<TName extends string> extends EditorFeatureConfig {
|
|
1126
1449
|
/**
|
|
1127
1450
|
* 按钮的唯一标识,用以确定配置的是哪个按钮。
|
|
1128
1451
|
*/
|
|
1129
|
-
name
|
|
1452
|
+
name?: TName;
|
|
1130
1453
|
/**
|
|
1131
1454
|
* 按钮标签(显示文本)一般工具栏上的按钮不会显示文本,如果需要显示文本,配置此项。
|
|
1132
1455
|
*/
|
|
@@ -1135,14 +1458,6 @@ export declare interface EditorToolbarFeatureButton<TName extends string> {
|
|
|
1135
1458
|
* 按钮图标,可以是 base64 的图片信息,也可以是图片 url
|
|
1136
1459
|
*/
|
|
1137
1460
|
icon?: string;
|
|
1138
|
-
/**
|
|
1139
|
-
* 按钮是否隐藏,设置为true则隐藏按钮
|
|
1140
|
-
*/
|
|
1141
|
-
hidden?: boolean;
|
|
1142
|
-
/**
|
|
1143
|
-
* 按钮是否禁用,设置为true则变为灰色不可点击
|
|
1144
|
-
*/
|
|
1145
|
-
disabled?: boolean;
|
|
1146
1461
|
/**
|
|
1147
1462
|
* 按钮点击事件.接受一个函数,可以自定义点击事件。
|
|
1148
1463
|
*/
|
|
@@ -1186,6 +1501,90 @@ export declare interface EditorToolbarOptions<TName extends string> {
|
|
|
1186
1501
|
custom?: EditorToolbarFeatureButtonConfig<string>;
|
|
1187
1502
|
}
|
|
1188
1503
|
|
|
1504
|
+
/**
|
|
1505
|
+
* 编辑器工具箱配置选项接口
|
|
1506
|
+
*/
|
|
1507
|
+
export declare interface EditorToolboxOptions {
|
|
1508
|
+
/**
|
|
1509
|
+
* 获取工具箱配置
|
|
1510
|
+
* @param attachGuidList - 附件GUID列表
|
|
1511
|
+
* @returns 返回工具箱工具项列表
|
|
1512
|
+
*/
|
|
1513
|
+
getToolbox?: (attachGuidList: string[]) => Promise<{
|
|
1514
|
+
tools: ToolboxToolItem[];
|
|
1515
|
+
}>;
|
|
1516
|
+
}
|
|
1517
|
+
|
|
1518
|
+
/**
|
|
1519
|
+
* 编辑器UI选项接口
|
|
1520
|
+
* 定义了编辑器可以使用的UI相关功能
|
|
1521
|
+
*/
|
|
1522
|
+
export declare interface EditorUiOptions {
|
|
1523
|
+
/**
|
|
1524
|
+
* 侧边栏
|
|
1525
|
+
*/
|
|
1526
|
+
sidebar?: {
|
|
1527
|
+
/**
|
|
1528
|
+
* 打开使用指南/快捷键侧边栏
|
|
1529
|
+
*/
|
|
1530
|
+
open?: (activeKey: 'userGuide' | 'shortcut') => void;
|
|
1531
|
+
};
|
|
1532
|
+
/**
|
|
1533
|
+
* 升级弹窗
|
|
1534
|
+
*/
|
|
1535
|
+
upgrade?: {
|
|
1536
|
+
/**
|
|
1537
|
+
* 显示升级弹窗
|
|
1538
|
+
*/
|
|
1539
|
+
showModal?: (options: ShowUpgradeModalProps) => Promise<ShowUpgradeModalResponse>;
|
|
1540
|
+
};
|
|
1541
|
+
notification?: {
|
|
1542
|
+
/**
|
|
1543
|
+
* 渲染通知条
|
|
1544
|
+
*/
|
|
1545
|
+
render?: (params: RenderNotificationProps) => void;
|
|
1546
|
+
};
|
|
1547
|
+
/**
|
|
1548
|
+
* 用户名片
|
|
1549
|
+
*/
|
|
1550
|
+
userCard?: {
|
|
1551
|
+
/**
|
|
1552
|
+
* 需要排除的用户卡片字段(不会在用户卡片中展示)
|
|
1553
|
+
*/
|
|
1554
|
+
excludeFields?: string[];
|
|
1555
|
+
/**
|
|
1556
|
+
* 渲染用户卡片
|
|
1557
|
+
*/
|
|
1558
|
+
render?: (params: RenderUserCardProps) => RenderUserCardResult;
|
|
1559
|
+
};
|
|
1560
|
+
/**
|
|
1561
|
+
* toast
|
|
1562
|
+
*/
|
|
1563
|
+
toast?: {
|
|
1564
|
+
/**
|
|
1565
|
+
* 显示自定义toast
|
|
1566
|
+
*/
|
|
1567
|
+
show?: (options: ShowToastOptions) => void;
|
|
1568
|
+
/**
|
|
1569
|
+
* 是否禁用toast
|
|
1570
|
+
*/
|
|
1571
|
+
disabled?: boolean;
|
|
1572
|
+
};
|
|
1573
|
+
/**
|
|
1574
|
+
* confirm
|
|
1575
|
+
*/
|
|
1576
|
+
confirm?: {
|
|
1577
|
+
/**
|
|
1578
|
+
* 显示自定义confirm
|
|
1579
|
+
*/
|
|
1580
|
+
show?: (options: ShowConfirmOptions) => void;
|
|
1581
|
+
/**
|
|
1582
|
+
* 是否禁用confirm
|
|
1583
|
+
*/
|
|
1584
|
+
disabled?: boolean;
|
|
1585
|
+
};
|
|
1586
|
+
}
|
|
1587
|
+
|
|
1189
1588
|
export declare type EditorUploadableFile = EditorLocalUploadableFile;
|
|
1190
1589
|
|
|
1191
1590
|
/**
|
|
@@ -1249,6 +1648,13 @@ export declare interface EditorUserOptions {
|
|
|
1249
1648
|
defaultAvatar?: string;
|
|
1250
1649
|
}
|
|
1251
1650
|
|
|
1651
|
+
export declare interface EditorVersion {
|
|
1652
|
+
/**
|
|
1653
|
+
* 保存版本
|
|
1654
|
+
*/
|
|
1655
|
+
createRevision: () => void;
|
|
1656
|
+
}
|
|
1657
|
+
|
|
1252
1658
|
/**
|
|
1253
1659
|
* 编辑器外部水印信息
|
|
1254
1660
|
*/
|
|
@@ -1272,6 +1678,86 @@ export declare type EditorWatermarkResource = {
|
|
|
1272
1678
|
url: string;
|
|
1273
1679
|
};
|
|
1274
1680
|
|
|
1681
|
+
export declare enum FeatureStatus {
|
|
1682
|
+
/**
|
|
1683
|
+
* 隐藏
|
|
1684
|
+
*/
|
|
1685
|
+
Hidden = 0,
|
|
1686
|
+
/**
|
|
1687
|
+
* 正常
|
|
1688
|
+
*/
|
|
1689
|
+
Normal = 1,
|
|
1690
|
+
/**
|
|
1691
|
+
* 禁用
|
|
1692
|
+
*/
|
|
1693
|
+
Disabled = 2
|
|
1694
|
+
}
|
|
1695
|
+
|
|
1696
|
+
export declare interface FileLinkParams {
|
|
1697
|
+
/**
|
|
1698
|
+
* 文件guid
|
|
1699
|
+
*/
|
|
1700
|
+
fileGuid: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* 文件类型,如docs,sheets
|
|
1703
|
+
*/
|
|
1704
|
+
type: string;
|
|
1705
|
+
/**
|
|
1706
|
+
* 用于定位到 mention、评论等位置。
|
|
1707
|
+
*/
|
|
1708
|
+
hash?: string;
|
|
1709
|
+
/**
|
|
1710
|
+
* 其他自定义字段
|
|
1711
|
+
*/
|
|
1712
|
+
[key: string]: unknown;
|
|
1713
|
+
}
|
|
1714
|
+
|
|
1715
|
+
/**
|
|
1716
|
+
* 文件子类型枚举
|
|
1717
|
+
*/
|
|
1718
|
+
export declare enum FileSubtype {
|
|
1719
|
+
/** 专业版幻灯片 */
|
|
1720
|
+
ProSlide = -10,
|
|
1721
|
+
/** 白板 */
|
|
1722
|
+
Whiteboard = -9,
|
|
1723
|
+
/** 表单 */
|
|
1724
|
+
Form = -8,
|
|
1725
|
+
/** 思维导图 */
|
|
1726
|
+
Mind = -7,
|
|
1727
|
+
/** 专业文档 */
|
|
1728
|
+
ProDoc = -6,
|
|
1729
|
+
/** 幻灯片 */
|
|
1730
|
+
Slide = -5,
|
|
1731
|
+
/** 新表格 */
|
|
1732
|
+
NewSheet = -4,
|
|
1733
|
+
/** 老表格 */
|
|
1734
|
+
Sheet = -3,
|
|
1735
|
+
/** 新文档 */
|
|
1736
|
+
NewDoc = -2,
|
|
1737
|
+
/** 老老表格 */
|
|
1738
|
+
OldSheet = -1,
|
|
1739
|
+
/** 旧文档 */
|
|
1740
|
+
OldDoc = 0,
|
|
1741
|
+
/** 文件夹 */
|
|
1742
|
+
Folder = 1,
|
|
1743
|
+
/** 协作 */
|
|
1744
|
+
Collaboration = 2
|
|
1745
|
+
}
|
|
1746
|
+
|
|
1747
|
+
/**
|
|
1748
|
+
* 文件类型枚举
|
|
1749
|
+
*/
|
|
1750
|
+
export declare enum FileType {
|
|
1751
|
+
/** 未知类型 */
|
|
1752
|
+
Unknown = 0,
|
|
1753
|
+
/** 文件夹或空间 */
|
|
1754
|
+
FolderOrSpace = 1,
|
|
1755
|
+
/** 石墨文件 */
|
|
1756
|
+
ShimoFile = 2,
|
|
1757
|
+
/** 云文件 */
|
|
1758
|
+
CloudFile = 3
|
|
1759
|
+
}
|
|
1760
|
+
|
|
1275
1761
|
/**
|
|
1276
1762
|
* 请求、响应头
|
|
1277
1763
|
*/
|
|
@@ -1379,8 +1865,66 @@ export declare interface HTTPResponse<Data = unknown> {
|
|
|
1379
1865
|
*/
|
|
1380
1866
|
export declare type HTTPResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';
|
|
1381
1867
|
|
|
1868
|
+
export declare interface Limitation {
|
|
1869
|
+
/**
|
|
1870
|
+
* 限制原因(错误码)
|
|
1871
|
+
*/
|
|
1872
|
+
code?: number;
|
|
1873
|
+
/**
|
|
1874
|
+
* 单位(不参与计算,仅作显示)
|
|
1875
|
+
* minutes、MB
|
|
1876
|
+
*/
|
|
1877
|
+
unit?: string;
|
|
1878
|
+
/**
|
|
1879
|
+
* 描述
|
|
1880
|
+
*/
|
|
1881
|
+
desc?: string;
|
|
1882
|
+
/**
|
|
1883
|
+
* min/max int64 默认表示 MB/个/分钟/行
|
|
1884
|
+
*/
|
|
1885
|
+
max?: number;
|
|
1886
|
+
min?: number;
|
|
1887
|
+
}
|
|
1888
|
+
|
|
1382
1889
|
export declare type MaybePromiseValue<T> = T | Promise<T>;
|
|
1383
1890
|
|
|
1891
|
+
/**
|
|
1892
|
+
* 升级弹窗类型
|
|
1893
|
+
* 个人版或企业版
|
|
1894
|
+
*/
|
|
1895
|
+
export declare type OpenType = 'personal' | 'enterprise';
|
|
1896
|
+
|
|
1897
|
+
export declare interface RenderNotificationProps {
|
|
1898
|
+
/**
|
|
1899
|
+
* 渲染的容器
|
|
1900
|
+
*/
|
|
1901
|
+
container: HTMLElement;
|
|
1902
|
+
/**
|
|
1903
|
+
* 自定义样式,实际类型为React.CSSProperties
|
|
1904
|
+
*/
|
|
1905
|
+
style?: Record<string, string | number>;
|
|
1906
|
+
}
|
|
1907
|
+
|
|
1908
|
+
export declare interface RenderUserCardProps {
|
|
1909
|
+
uid: string | number;
|
|
1910
|
+
rect: {
|
|
1911
|
+
left: number;
|
|
1912
|
+
top: number;
|
|
1913
|
+
width: number;
|
|
1914
|
+
height: number;
|
|
1915
|
+
hasReducedHeaderHeight?: boolean;
|
|
1916
|
+
};
|
|
1917
|
+
position?: 'top' | 'left' | 'right' | 'bottom' | 'left_top' | 'left_bottom' | 'right_top' | 'bottom_top' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right';
|
|
1918
|
+
trigger: 'hover' | 'click';
|
|
1919
|
+
}
|
|
1920
|
+
|
|
1921
|
+
export declare interface RenderUserCardResult {
|
|
1922
|
+
/**
|
|
1923
|
+
* 关闭用户卡片
|
|
1924
|
+
*/
|
|
1925
|
+
close: (force?: boolean) => void;
|
|
1926
|
+
}
|
|
1927
|
+
|
|
1384
1928
|
/**
|
|
1385
1929
|
* 表示资源API接口的基本结构
|
|
1386
1930
|
*/
|
|
@@ -1475,6 +2019,143 @@ export declare interface ResourceConfig extends Partial<ResourceApis> {
|
|
|
1475
2019
|
baseUrl?: string;
|
|
1476
2020
|
}
|
|
1477
2021
|
|
|
2022
|
+
/**
|
|
2023
|
+
* 升级操作结果类型枚举
|
|
2024
|
+
*/
|
|
2025
|
+
export declare enum ResultType {
|
|
2026
|
+
/** 操作成功 */
|
|
2027
|
+
Success = "success",
|
|
2028
|
+
/** 用户取消操作 */
|
|
2029
|
+
Cancel = "cancel",
|
|
2030
|
+
/** 发生错误 */
|
|
2031
|
+
Error = "error",
|
|
2032
|
+
/** 跳转(目前仅在企业版用户过期时返回) */
|
|
2033
|
+
Redirect = "redirect"
|
|
2034
|
+
}
|
|
2035
|
+
|
|
2036
|
+
export declare interface SaveContext {
|
|
2037
|
+
clientId: string;
|
|
2038
|
+
}
|
|
2039
|
+
|
|
2040
|
+
export declare interface SaveStatusDelegation {
|
|
2041
|
+
/**
|
|
2042
|
+
* 保存状态发生变化时触发回调
|
|
2043
|
+
* @param state
|
|
2044
|
+
* @returns
|
|
2045
|
+
*/
|
|
2046
|
+
onChangeState: (state: unknown, context: SaveContext) => void;
|
|
2047
|
+
/**
|
|
2048
|
+
* 出现致命错误时触发回调,出现致命错误后,编辑器将无法继续编辑
|
|
2049
|
+
* @param error
|
|
2050
|
+
* @returns
|
|
2051
|
+
*/
|
|
2052
|
+
onError: (error: unknown, context: SaveContext) => void;
|
|
2053
|
+
}
|
|
2054
|
+
|
|
2055
|
+
/**
|
|
2056
|
+
* 付费场景类型
|
|
2057
|
+
*/
|
|
2058
|
+
export declare type Scene = 'history' | 'version' | 'public' | 'search' | 'attachments';
|
|
2059
|
+
|
|
2060
|
+
export declare interface ShowConfirmOptions {
|
|
2061
|
+
/**
|
|
2062
|
+
* 确认框标题
|
|
2063
|
+
*/
|
|
2064
|
+
title: string;
|
|
2065
|
+
/**
|
|
2066
|
+
* 确认框描述
|
|
2067
|
+
*/
|
|
2068
|
+
description: string;
|
|
2069
|
+
/**
|
|
2070
|
+
* 确认按钮配置
|
|
2071
|
+
*/
|
|
2072
|
+
confirmButton?: ConfirmButtonConfig;
|
|
2073
|
+
/**
|
|
2074
|
+
* 取消按钮配置
|
|
2075
|
+
*/
|
|
2076
|
+
cancelButton?: ConfirmButtonConfig;
|
|
2077
|
+
}
|
|
2078
|
+
|
|
2079
|
+
export declare interface ShowToastOptions {
|
|
2080
|
+
/**
|
|
2081
|
+
* toast标题
|
|
2082
|
+
*/
|
|
2083
|
+
title: string;
|
|
2084
|
+
/**
|
|
2085
|
+
* toast类型
|
|
2086
|
+
*/
|
|
2087
|
+
type: 'success' | 'error' | 'warn' | 'info';
|
|
2088
|
+
/**
|
|
2089
|
+
* 显示时长,默认3s
|
|
2090
|
+
*/
|
|
2091
|
+
duration?: number;
|
|
2092
|
+
/**
|
|
2093
|
+
* 是否自动隐藏,默认true
|
|
2094
|
+
*/
|
|
2095
|
+
autoHide?: boolean;
|
|
2096
|
+
}
|
|
2097
|
+
|
|
2098
|
+
/**
|
|
2099
|
+
* 升级弹窗配置选项接口
|
|
2100
|
+
*/
|
|
2101
|
+
export declare interface ShowUpgradeModalProps {
|
|
2102
|
+
/** 打开个人升级弹窗还是企业弹窗 */
|
|
2103
|
+
openType: OpenType;
|
|
2104
|
+
/** 触发功能的Key值 */
|
|
2105
|
+
serviceKey: string;
|
|
2106
|
+
/** 文件类型(如果业务能够获取到则为必传) */
|
|
2107
|
+
fileType?: FileType;
|
|
2108
|
+
/** 文件子类型(如果业务能够获取到则为必传) */
|
|
2109
|
+
fileSubtype?: FileSubtype;
|
|
2110
|
+
/** 付费场景,用于升级弹窗的定制化文案显示 */
|
|
2111
|
+
scene?: Scene;
|
|
2112
|
+
}
|
|
2113
|
+
|
|
2114
|
+
/**
|
|
2115
|
+
* 升级弹窗响应接口
|
|
2116
|
+
*/
|
|
2117
|
+
export declare interface ShowUpgradeModalResponse {
|
|
2118
|
+
/** 操作结果 */
|
|
2119
|
+
result: ResultType;
|
|
2120
|
+
/** 错误信息(供开发人员查看) */
|
|
2121
|
+
errorMsg?: string;
|
|
2122
|
+
}
|
|
2123
|
+
|
|
2124
|
+
/**
|
|
2125
|
+
* 演讲者信息接口
|
|
2126
|
+
* 包含演讲者的基本信息
|
|
2127
|
+
*/
|
|
2128
|
+
export declare interface Speaker {
|
|
2129
|
+
/** 演讲者ID */
|
|
2130
|
+
id: number;
|
|
2131
|
+
/** 演讲者姓名 */
|
|
2132
|
+
name: string;
|
|
2133
|
+
/** 演讲者头像URL */
|
|
2134
|
+
avatar: string;
|
|
2135
|
+
}
|
|
2136
|
+
|
|
2137
|
+
export declare interface SyncContext {
|
|
2138
|
+
clientId: string;
|
|
2139
|
+
timestamp: number;
|
|
2140
|
+
}
|
|
2141
|
+
|
|
2142
|
+
export declare interface SyncStatusDelegation {
|
|
2143
|
+
/**
|
|
2144
|
+
* 同步状态发生变化时触发回调
|
|
2145
|
+
* @param state
|
|
2146
|
+
* @param context
|
|
2147
|
+
* @returns
|
|
2148
|
+
*/
|
|
2149
|
+
onChangeState: (state: unknown, context: SyncContext) => void;
|
|
2150
|
+
/**
|
|
2151
|
+
* 出现致命错误时触发回调,出现致命错误后,编辑器将无法继续编辑
|
|
2152
|
+
* @param error
|
|
2153
|
+
* @param context
|
|
2154
|
+
* @returns
|
|
2155
|
+
*/
|
|
2156
|
+
onError: (error: unknown, context: SyncContext) => void;
|
|
2157
|
+
}
|
|
2158
|
+
|
|
1478
2159
|
export declare interface TableEditorContent {
|
|
1479
2160
|
/**
|
|
1480
2161
|
* 保存当前活文件的所有修改
|
|
@@ -1514,13 +2195,6 @@ export declare interface TableSDKOptions extends TableEditorOptions {
|
|
|
1514
2195
|
* 接口资源配置
|
|
1515
2196
|
*/
|
|
1516
2197
|
resourceConfig?: ResourceConfig;
|
|
1517
|
-
/**
|
|
1518
|
-
* 文件信息
|
|
1519
|
-
*/
|
|
1520
|
-
file: {
|
|
1521
|
-
/** 文件 id */
|
|
1522
|
-
id: number;
|
|
1523
|
-
};
|
|
1524
2198
|
}
|
|
1525
2199
|
|
|
1526
2200
|
export declare interface TableSelection {
|
|
@@ -1645,4 +2319,63 @@ export declare type TableSelectionValue = {
|
|
|
1645
2319
|
columnCount: number;
|
|
1646
2320
|
};
|
|
1647
2321
|
|
|
2322
|
+
/**
|
|
2323
|
+
* 工具箱工具项接口
|
|
2324
|
+
*/
|
|
2325
|
+
export declare interface ToolboxToolItem {
|
|
2326
|
+
/** 工具类型 */
|
|
2327
|
+
type: ToolTypes;
|
|
2328
|
+
/** 工具名称 */
|
|
2329
|
+
name: string;
|
|
2330
|
+
/** 工具图标 */
|
|
2331
|
+
icon: string;
|
|
2332
|
+
/** 工具分组 */
|
|
2333
|
+
group: ToolGroupTypes;
|
|
2334
|
+
/** 分组名称 */
|
|
2335
|
+
groupName: string;
|
|
2336
|
+
/** 是否为测试版功能 */
|
|
2337
|
+
isBeta: boolean;
|
|
2338
|
+
/** 工具回调函数 */
|
|
2339
|
+
callback: () => Promise<{
|
|
2340
|
+
result: 'success' | 'failed';
|
|
2341
|
+
error?: unknown;
|
|
2342
|
+
}>;
|
|
2343
|
+
}
|
|
2344
|
+
|
|
2345
|
+
/**
|
|
2346
|
+
* 工具分组类型枚举
|
|
2347
|
+
*/
|
|
2348
|
+
export declare enum ToolGroupTypes {
|
|
2349
|
+
/** 转换工具组 */
|
|
2350
|
+
Convert = "convert",
|
|
2351
|
+
/** 处理工具组 */
|
|
2352
|
+
Processing = "processing",
|
|
2353
|
+
/** 智能工具组 */
|
|
2354
|
+
Intelligent = "intelligent"
|
|
2355
|
+
}
|
|
2356
|
+
|
|
2357
|
+
/**
|
|
2358
|
+
* 工具类型枚举
|
|
2359
|
+
*/
|
|
2360
|
+
export declare enum ToolTypes {
|
|
2361
|
+
/** PDF转Word */
|
|
2362
|
+
PdfToWord = "pdfToWord",
|
|
2363
|
+
/** PDF转Excel */
|
|
2364
|
+
PdfToExcel = "pdfToExcel",
|
|
2365
|
+
/** PDF转PPT */
|
|
2366
|
+
PdfToPpt = "pdfToPpt",
|
|
2367
|
+
/** 图片转PDF */
|
|
2368
|
+
ImgToPdf = "imgToPdf",
|
|
2369
|
+
/** PDF合并 */
|
|
2370
|
+
PdfMerge = "pdfMerge",
|
|
2371
|
+
/** PDF拆分 */
|
|
2372
|
+
PdfSplit = "pdfSplit",
|
|
2373
|
+
/** 文件内容提取 */
|
|
2374
|
+
FileContentExtraction = "fileContentExtraction",
|
|
2375
|
+
/** 图片转文字 */
|
|
2376
|
+
COR = "imgToText",
|
|
2377
|
+
/** 音频转文字 */
|
|
2378
|
+
STT = "audioToText"
|
|
2379
|
+
}
|
|
2380
|
+
|
|
1648
2381
|
export { }
|