初始化配置项
... 2023-5-22 大约 1 分钟
# 初始化配置项
在全局命名空间中注入在线预览 SDK，使用 .init() 方法初始化文档对象
| 方法 | 类型 | 说明 |
|---|---|---|
| init | InitData | 初始化文档 |
// 创建实例
const instance = TencentDocsSDK.init({
appId: 'xxxxxx',
signature: {
sign: 'xxxxxx',
nonce: 'xxxxxx',
timeStamp: 'xxxxxx',
},
officeType: 'doc',
fileId: 'xxxxxx',
mode: 'simple'
})
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# InitData
| 方法 | 类型 | 说明 |
|---|---|---|
| appId* | string | 为接入方分配的应用 Id |
| signature* | signData | 身份验证签名，签名方式 |
| officeType* | string | 文档类型，ppt/pptx/xls/xlsx/doc/docx/pdf/txt |
| fileId* | string | 文件 id，用户自定义，只允许由数字、字母、下划线、中划线组成，且不能以下划线开头 |
| fileToken | string | tokenData | 文件 token，用户自定义，用于验证文件权限 |
| refreshToken | () => Promise<tokenData> | 搭配 fileToken 的 tokenData 使用，实现定时刷新 |
| mount | string | HTMLElement | 文档 iframe 的挂载节点，默认值为 document.body |
| endpoint | string | 默认值为docs.qq.com |
| customArgs | string | url 中携带额外参数，根据接入方业务场景可选配置 |
| mode | 'normal' | 'simple' | 显示模式，normal 展示标题栏和工具栏，simple 隐藏标题栏和工具栏 |
| commonOptions | CommonOptions{} | 组件通用选项 |
| wordOptions | WordOptions{} | 文字组件选项 |
| excelOptions | ExcelOptions{} | 表格组件选项 |
| pptOptions | PptOptions{} | 演示组件选项 |
| pdfOptions | PdfOptions{} | PDF 组件选项 |
# signData
| 方法 | 类型 | 说明 |
|---|---|---|
| sign | string | 签名 |
| nonce | string | 随机字符串 |
| timeStamp | number | 签名时间戳 |
# tokenData
| 方法 | 类型 | 说明 |
|---|---|---|
| token | string | 文件 token |
| timeout | string | token 过期时间，单位为毫秒 |