Appearance
初始化配置项
WebOffice 文档在初始化(调用 WebOfficeSDK.init()函数)时,除了 url
和 container
必须要传的参数之外,还支持传入一些额外的配置项。
总览
配置项 | 类型 | 说明 | 适用组件 |
---|---|---|---|
url | String | 在线编辑地址 | 所有 |
container | HTMLElement | 挂载容器 | 所有 |
mode | String | 显示模式 | 所有 |
auth | Boolean | 鉴权配置 | 所有 |
refreshToken | Function | 主动刷新令牌(token) | 所有 |
在线编辑地址
该地址由业务系统服务端返回,可用于编辑在线文档的地址,获取方式见 文档编辑链接
挂载容器
WebOffice 挂载到页面中的容器,需要是一个真实有效的 HTMLElement
显示模式
JSSDK
通过初始化配置选项,可以开启不同的显示模式:
js
const jssdk = WebOfficeSDK.init({
url: "http://your-document-edit-url",
container: document.querySelector("#outer"),
auth: true,
mode: "simple",
});
关于 mode
选项的说明:
选项值 | 说明 | 是否默认选项 |
---|---|---|
nomal | 普通模式,展示所有功能界面 | 是 |
simple | 极简模式,不显示头部和工具栏,不允许编辑、批注等。可用于发文等只读场景 | 否 |
鉴权
关于 auth
选项的说明:
选项值 | 说明 | 是否默认选项 |
---|---|---|
true | 服务端需要鉴权,用于确定用户身份及权限识别。当为 true 时会等待 setToken 成功才会执行后续逻辑 | 是 |
false | 服务端不需要鉴权 | 否 |
刷新令牌
用于 token 过期后主动刷新的方法,具体说明见 鉴权