配置参数
在初始化文档应用时,支持传入一些配置项,来对文档进行一些基本设置。
WPS多维表格常用配置:
javascript
WebOfficeSDK.config({
// embed 参数控制开启 WPS多维表格 适配过的嵌入模式,样式可以参考 智能文档嵌入 WPS多维表格
// disablePlugins 关闭插件, 公网适用
url: url + '?disablePlugins&' + (fullScreen ? 'embed-fullscreen=1' : 'embed=1'),
viewMode: 'Embed',
mode: 'embed',
fileType: 'd',
mount: container,
hideGuide: true,
debug,
commonOptions: {
isEnableChangeDocumentTitle: false,
isShowHeader: false,
disableSafeCs: true,
},
dbOptions: {
embed: {
commandBarSlotElm: slotElement,
enableChangingView: true,
enableToolBar: true,
},
enableRecordCooperation: false,
enableFavView: false,
// 字段白名单
fieldsWhiteList: [
'Checkbox',
'Complete',
'Contact',
'CreatedTime',
'Currency',
'Date',
'Email',
'MultiLineText',
'MultipleSelect',
'Number',
'Percentage',
'Phone',
'Rating',
'SingleLineText',
'SingleSelect',
'Time',
'Url',
'Attachment',
'ID'
],
// 视图菜单白名单
viewMenuFeatureWhiteList: [
'rename',
'addDesc',
'deleteView',
'copyView'
],
// 附件类型白名单
attachmentSuffixWhiteList: [
'pptx', 'ppt', 'pot', 'potx', 'pps', 'ppsx', 'dps', 'dpt', 'pptm', 'potm', 'ppsm', 'xls',
'xlt', 'et', 'ett', 'xlsx', 'ksheet', 'xltx', 'xlsb', 'xlsm', 'xltm', 'dbt', 'csv', 'lrc',
'c', 'cpp', 'h', 'asm', 'java', 'asp', 'bat', 'bas', 'prg', 'cmd', 'txt', 'log', 'xml',
'htm', 'html', 'pdf', 'doc', 'dot', 'wps', 'wpt', 'docx', 'dotx', 'docm', 'dotm', 'rtf',
'png', 'jpg', 'jpeg', 'bmp', 'gif', 'otl', 'kw', 'ofd', 'pom', 'pof', 'heic'
],
}
})
配置参数(config)列表
配置参数 | 类型 | 说明 |
---|---|---|
url | string | 在线文档预览编辑地址,如 https://www.kdocs.cn/l/cuI4w9PX4CwI |
mount | HTMLElement | 挂载节点,详见 挂载节点 |
mode | string | 显示模式,使用内嵌模式:embed |
viewMode | string | 视图模式,使用内嵌模式:Embed |
fileType | string | 文件类型,WPS多维表格使用 d |
commonOptions | object | 组件通用配置,详见 commonOptions |
dbOptions | object | WPS多维表格自定义配置,详见 dbOptions |
组件通用配置(commonOptions)列表
配置参数 | 类型 | 说明 |
---|---|---|
isEnableChangeDocumentTitle | boolean | 是否禁止修改页面标题 |
isShowHeader | boolean | 是否显示头部区域(顶部工具栏) |
disableSafeCs | boolean | 是否关闭嵌入子文档安全区域 |
WPS多维表格自定义配置(dbOptions)列表
配置参数 | 类型 | 说明 |
---|---|---|
embed | object | 嵌入模式下的配置,详见 embed |
enableRecordCooperation | boolean | 是否开启行协作功能 |
enableFavView | boolean | 是否屏蔽收藏视图功能 |
fieldsWhiteList | string[] | 字段白名单 |
viewMenuFeatureWhiteList | string[] | 视图菜单白名单 |
attachmentSuffixWhiteList | string[] | 附件类型白名单 |
embed配置(embed)列表
配置参数 | 类型 | 说明 |
---|---|---|
commandBarSlotElm | HTMLElement | 用户自定义传入的工具栏组件 |
enableChangingView | boolean | 是否开启切换视图 |
enableToolBar | boolean | 是否开启工具栏 |