跳到主要内容

基础用法

配置参数​

ZOfficeSDK.mount(url, selector, bAsync, config)

挂载文档过程中可以通过第四个参数 config 来控制显示、隐藏页面组件以及其他自定义设置

UI组件显示状态控制​

uiConfig 参数用来控制显示、隐藏页面组件

可定制列表

CommandId可配置状态说明
WordCommentBox'defaultVisible'、'defaultInvisible'文档主体右侧批注区域（仅编辑模式下可用）
WordCommentMark'defaultVisible'、'defaultInvisible'批注标记（仅编辑模式可用）
WordRevisionMark'defaultVisible'、'defaultInvisible'修订标记（仅编辑模式下可用）
WordTableGridLine'defaultVisible'、'defaultInvisible'表格虚框（仅编辑模式下可用）
WordGridline'defaultVisible'、'defaultInvisible'网格线（仅编辑模式下可用）
CarriageReturn'defaultVisible'、'defaultInvisible'格式化标记（仅编辑模式下可用）
Bookmark'defaultVisible'、'defaultInvisible'书签标记（仅编辑模式下可用）
WordPermMark'defaultVisible'、'defaultInvisible'可编辑区域（仅编辑模式下可用）
NaviPanel'defaultVisible'、'defaultInvisible'导航栏
IsBestScaletrue、false、'true'、'false'是否以最佳比例显示
save'defaultEnable'、'defaultDisable'是否禁用保存('defaultDisable':禁用)
CommentSideBar'defaultVisible'、'defaultInvisible'文档主体右侧是否默认显示批注侧边栏（仅编辑模式下可用）
IntellBookmarkSideBar'defaultVisible'、'defaultInvisible'文档主体右侧是否默认显示智能书签侧边栏（仅编辑模式下可用）
FormEntryPanel'defaultVisible'、'defaultInvisible'文档主体右侧是否默认显示表单输入侧边栏（仅编辑模式下可用）
OperationRecordSideBar'defaultVisible'、'defaultInvisible'文档主体右侧是否默认显示协作记录侧边栏（仅编辑模式下可用）
ProtectSideBar'defaultVisible'、'defaultInvisible'文档主体右侧是否默认显示保护设置侧边栏（仅编辑模式下可用）
TrackChangeSideBar'defaultVisible'、'defaultInvisible'文档主体右侧是否默认显示修订记录侧边栏（仅编辑模式下可用）
EfficiencyMenu'defaultVisible'、'defaultInvisible'菜单栏是否显示效率菜单（仅编辑模式下可用）
AutoFormatMenuItem'defaultVisible'、'defaultInvisible'格式菜单是否显示一键排版菜单项（仅编辑模式下可用）
RevisionActions'forceVisible'、'forceInvisible'修订接受&拒绝是否显示（仅编辑模式下可用）
TrackChangeSwitch'forceDisable'修订开关是否可用（仅编辑模式下可用）
SideBar'defaultVisible'、'defaultInvisible'侧边栏
ToolBar'defaultVisible'、'defaultInvisible'工具栏
FormulaBar'defaultVisible'、'defaultInvisible'公式栏
PdfNaviPanel'defaultVisible'、'defaultInvisible'PDF 导航栏

可配置状态说明

状态说明
defaultVisible默认显示，不会修改用户配置；可手动修改
defaultInvisible默认隐藏，不会修改用户配置；可手动修改
forceVisible强制显示，不会修改用户配置；不可手动修改
forceInvisible强制隐藏，不会修改用户配置；不可手动修改
forceDisable强制禁用，不会修改用户配置；不可手动修改

示例

const Application = await ZOfficeSDK.mount('http://172.16.22.98/docs/app/thirdparty-rest/1347466381985058817/edit/content?zdocs_access_token=653b90d845a785e3c69aeba', '#doc1', true, {
    uiConfig: {
        WordCommentBox: 'defaultInvisible'	// 隐藏文档主体右侧批注区域
    }
});

公共​

SDK 版本​

通过 version 可以查看到当前 SDK 版本。

示例

const version = ZOfficeSDK.version;

所有文档类型应用对象​

获取挂载的所有文档对应的文档类型应用对象

Applications: Map<selector, Application>

  • selector: 挂载文档的DOM节点的selector，与mount时传入的selector一致
  • Application: 文档类型应用对象

示例

const Applications = ZOfficeSDK.Applications;
const Application1 = ZOfficeSDK.Applications.get('#doc1');  // '#doc1' 是挂载文档的DOM节点的selector
配置说明

UI组件配置可以帮助您根据业务需求定制文档编辑界面，提升用户体验。

最后于 更新