Appearance
配置参数说明
以下是根据 文档服务官方配置文档 整理的完整配置参数中文注释说明，同时追加了文档服务中文增强版特有配置参数（*标部分）。配置对象会传入 DocsAPI.DocEditor 构造函数，用于控制文档编辑器的行为、界面和回调。
根配置 (config)
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
document | object | — | 文档参数（标题、URL、类型等） |
documentType | string | — | 文档类型："word"、"cell"、"slide"、"pdf" |
editorConfig | object | — | 编辑器界面参数（语言、模式、回调等） |
events | object | — | 事件处理函数（加载、保存、错误等） |
height | string | "100%" | 编辑器高度（如 "800px"、"100%"） |
token | string | — | JWT 令牌，用于安全验证 |
type | string | "desktop" | 平台类型："desktop"、"mobile"、"embedded" |
width | string | "100%" | 编辑器宽度 |
document 部分
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
fileType | string | — | 文件扩展名（如 "docx"、"xlsx"） |
isForm | boolean | false | 是否为表单文档 |
info | object | — | 文档元数据（见下表） |
key | string | — | 文档唯一标识符，修改文档内容时应更新 |
permissions | object | — | 文档访问权限（见权限表） |
referenceData | object | — | 文档存储参考数据（fileKey、instanceId） |
title | string | — | 文档标题（含扩展名） |
url | string | — | 文档资源的绝对 URL |
document.info 元数据
| 参数 | 类型 | 说明 |
|---|---|---|
favorite | boolean | 是否标记为星标（收藏） |
folder | string | 文档所在文件夹名称 |
owner | string | 文档所有者名称 |
sharingSettings | array | 共享设置列表（用户/链接权限） |
uploaded | string | 上传日期字符串 |
document.permissions 权限
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
chat | boolean | false | 是否允许内置聊天 |
comment | boolean | true | 是否允许添加评论 |
commentGroups | object | — | 按用户组控制评论编辑/删除权限 |
copy | boolean | true | 是否允许复制内容 |
copyOut* | boolean | true | 是否允许复制内容到外部 |
deleteCommentAuthorOnly | boolean | false | 仅作者可删除自己的评论 |
download | boolean | true | 是否允许下载文档 |
edit | boolean | true | 是否允许编辑（仅 edit 模式） |
editCommentAuthorOnly | boolean | false | 仅作者可编辑自己的评论 |
fillForms | boolean | false | 是否允许填写表单 |
modifyContentControl | boolean | false | 是否允许修改内容控件 |
modifyFilter | boolean | false | 是否允许修改表格筛选器 |
print | boolean | true | 是否允许打印 |
protect | boolean | true | 是否允许设置文档保护 |
review | boolean | true | 是否显示“审阅”菜单 |
reviewGroups | array | — | 允许审阅的用户组 ID 列表 |
userInfoGroups | array | — | 可查看用户信息的组 ID 列表 |
editorConfig 部分
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
actionLink | string | — | 用于连接动作的链接（如接受审阅） |
callbackUrl | string | — | 编辑器状态变化时的回调地址 |
coEditing | object | — | 协同编辑设置（mode: "fast"/"strict"；change: true/false） |
createUrl | string | — | 新建文档时的创建地址 |
customization | object | — | UI 定制选项（见下表） |
embedded | object | — | 嵌入模式控件行为（type 为 "embedded" 时使用） |
lang | string | "en" | 界面语言代码（如 "zh-CN"） |
mode | string | "edit" | 打开模式："edit" "view" "review" "comment""fillForms" "embedded" "blockcontent" |
plugins | object | — | 插件配置（autostart、options、pluginsData） |
recent | array | — | “最近打开”文件列表（folder, title, url） |
region | string | — | 区域设置（如 "en-US"） |
templates | array | — | 模板列表（image, title, url） |
user | object | — | 当前用户信息（id, name, image, group） |
editorConfig.customization UI 定制
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
about | boolean | true | 是否显示“关于”菜单项 |
anonymous | object | — | 匿名用户设置（request: 是否请求匿名用户名称；label: 标签） |
autosave | boolean | true | 是否显示自动保存选项 |
close | object | — | 关闭按钮配置（visible: 是否显示；text: 按钮文本） |
comments | boolean | true | 是否显示“评论”菜单按钮 |
compactHeader | boolean | false | 是否启用紧凑头部 |
compactToolbar | boolean | false | 是否启用紧凑工具栏 |
compatibleFeatures | boolean | false | 是否启用与旧版本的兼容功能 |
customer | object | — | 客户信息（名称、地址、logo 等） |
features | object | — | 功能开关（拼写检查、角色、标签样式等） |
feedback | object | — | 反馈按钮配置（url, visible） |
font | object | — | 编辑器字体（name, size） |
forcesave | boolean | false | 是否强制保存（忽略错误） |
forceWesternFontSize | boolean | false | 是否强制使用西方字体大小 |
goback | object | — | 返回按钮配置（blank: 新窗口打开；text: 文本；url: 链接） |
help | boolean | true | 是否显示帮助按钮 |
hideNotes | boolean | false | 是否隐藏注释 |
hideRightMenu | boolean | false | 是否隐藏右侧菜单 |
hideRulers | boolean | false | 是否隐藏标尺 |
integrationMode | string | — | 集成模式："embed"、"internal" |
layout | object | — | 布局组件显隐（头部、左菜单、右菜单、状态栏、工具栏各项） |
loaderLogo | string | — | 加载时显示的 logo 图片 URL |
loaderName | string | — | 加载时显示的文本 |
logo | object | — | 品牌 logo 配置（image, imageDark, imageLight, url, visible） |
macros | boolean | true | 是否允许使用宏 |
macrosMode | string | "warn" | 宏执行模式："disable"、"warn"、"enable" |
mentionShare | boolean | false | 是否允许 @ 提及共享 |
mobile | object | — | 移动端视图设置（forceView, info, standardView） |
plugins | boolean | true | 是否启用插件 |
pointerMode | string | "select" | 鼠标指针模式："select"、"hand" |
review | object | — | 审阅显示设置（隐藏显示、追踪更改等） |
showHorizontalScroll | boolean | true | 是否显示水平滚动条 |
showVerticalScroll | boolean | true | 是否显示垂直滚动条 |
slidePlayerBackground | string | "#000000" | 幻灯片播放时的背景色 |
submitForm | object | — | 表单提交按钮配置（visible, resultMessage） |
suggestFeature | boolean | true | 是否显示功能建议 |
toolbarHideFileName | boolean | false | 是否在工具栏隐藏文件名 |
uiTheme | string | "theme-classic" | 主题："theme-dark"、"theme-light"、"theme-classic"、"theme-contrast-dark" |
unit | string | "cm" | 单位："cm"、"pt"、"inch" |
wordHeadingsColor | string | — | 文档标题颜色（十六进制） |
zoom | number | 100 | 默认缩放百分比 |
polling* | boolean | false | 是否将 WebSocket 强制降级为长轮询（适配网闸环境） |
readOnly* | boolean | false | 用户只读模式 |
privateView* | boolean | false | 是否启用 Excel 筛选仅对自己可见(仍需要用户自己设置勾选对工作表生效) |
browserFonts* | boolean | false | 是否启用浏览器本地字体 |
miniToolbar* | boolean | false | 是否显示 Word 迷你工具栏 |
pluginsTab* | boolean | true | 是否显示插件标签页 |
waterMark* | object | - | 防截图水印（子参数见下表） |
waterMark 子参数
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
value | string | — | 水印文字内容，支持 \\n 换行，建议不超过 2 行 |
fillstyle | string | "rgba( 192, 192, 192, 0.6 )" | 水印颜色，支持 rgba 和 hex（如 "#ff0000"、"rgba(192,192,192,0.6)"） |
font | string | "20px Serif" | 字号和字体（如 "20px Arial"） |
rotate | number | -30 | 旋转角度，支持正负 120° 以内 |
horizontal | number | 30 | 水平间隔（像素） |
vertical | number | 30 | 垂直间隔（像素） |
opacity | number | 1 | 整体透明度，0~1 之间 |
editorConfig.embedded 嵌入模式
| 参数 | 类型 | 说明 |
|---|---|---|
embedUrl | string | 嵌入视图的 URL |
fullscreenUrl | string | 全屏视图的 URL |
saveUrl | string | 保存文档的 URL |
shareUrl | string | 分享文档的 URL |
toolbarDocked | string | 工具栏停靠位置："top"、"bottom" |
events 部分
所有事件均为回调函数，在特定操作时触发：
| 事件名 | 触发时机 |
|---|---|
onAppReady | 应用程序加载完成 |
onCollaborativeChanges | 协同编辑变更 |
onDocumentReady | 文档加载完成 |
onDocumentStateChange | 文档可保存状态变化 |
onDownloadAs | 用户下载文档 |
onError | 发生错误 |
onInfo | 一般信息事件 |
onMakeActionLink | 生成动作链接（如审阅链接） |
onMetaChange | 元数据变化（标题、收藏等） |
onOutdatedVersion | 客户端版本过旧 |
onPluginsReady | 插件加载完成 |
onRequestClose | 请求关闭编辑器 |
onRequestCreateNew | 请求创建新文档 |
onRequestEditRights | 请求编辑权限 |
onRequestHistory | 请求版本历史 |
onRequestHistoryClose | 关闭版本历史 |
onRequestHistoryData | 请求版本历史数据 |
onRequestInsertImage | 请求插入图片 |
onRequestMailMergeRecipients | 请求邮件合并收件人列表 |
onRequestOpen | 请求打开文档 |
onRequestReferenceData | 请求参考数据 |
onRequestReferenceSource | 请求参考来源 |
onRequestRefreshFile | 请求刷新文件 |
onRequestRename | 请求重命名 |
onRequestRestore | 请求恢复版本 |
onRequestSaveAs | 请求另存为 |
onRequestSelectDocument | 请求选择文档（一般） |
onRequestSelectSpreadsheet | 请求选择电子表格 |
onRequestSendNotify | 请求发送通知 |
onRequestSharingSettings | 请求共享设置 |
onRequestStartFilling | 请求开始填充表单 |
onRequestUsers | 请求用户列表 |
onSubmit | 表单提交 |
onUserActionRequired | 需要用户交互（如保存冲突） |
onWarning | 发生警告 |