定制

描述

自定义部分允许自定义编辑器界面,使其看起来像您的其他产品(如果有),并更改是否出现附加按钮、链接、更改徽标和编辑器所有者详细信息。

示例

example.com 是安装文档管理器文档存储服务的服务器的名称。 请参阅工作原理部分,了解有关文档服务器服务客户端与服务器交互的更多信息。

如果您还有任何疑问,请通过以下方式联系我们: integration@onlyoffice.com


请注意,只有以下参数可用于移动编辑器:feedbackgobackhelp宏模式mobileForceView
参数
名称 描述 类型 示例
添加对匿名名称的请求:
  • request - 定义是否发送请求。 默认值为 true
    类型:boolean,
    示例:true;
  • label - 添加到用户名的后缀。 默认值为 Guest
    类型:string,
    示例:"Guest";
object { "request": true, "label": "Guest" }
定义 自动保存 菜单选项是启用还是禁用。 如果设置为 false,则只能选择 Strict 共同编辑模式,因为 Fast 在没有自动保存的情况下不起作用。 默认值为 true boolean true
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.autosave 参数发送的任何值。
定义 聊天 菜单按钮是显示还是隐藏。 请注意,如果您隐藏 聊天 按钮,相应的聊天功能也将被禁用。 默认值为 true。 自 7.1 版起已弃用,请改用 document.permissions.chat 参数。 boolean true
定义用户是否只能编辑和删除他的评论。 默认值为 false。 自 6.3 版起已弃用,请改用 document.permissions.editCommentAuthorOnlydocument.permissions.deleteCommentAuthorOnly 字段。 boolean true
定义 注释 菜单按钮是显示还是隐藏。 请注意,如果您隐藏 评论 按钮,则相应的评论功能将仅供查看,无法添加和编辑评论。 默认值为 true boolean true
定义附加操作按钮是显示在编辑器窗口标题的上部靠近徽标 (false) 还是显示在工具栏 (true) 中,使标题更紧凑。 默认值为 false boolean false
定义显示的顶部工具栏类型是完整的 (false) 还是紧凑的 (true)。 默认值为 false boolean false
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.compactToolbar 参数发送的任何值。
定义仅与 OOXML 格式兼容的功能的使用。 例如,不要对整个文档使用注释。 默认值为 false boolean false
包含将在编辑器 关于 部分中显示的信息,并对所有编辑器用户可见。 该对象具有以下参数:
  • address - 允许访问编辑或编辑作者的公司或个人的邮政地址,
    类型:字符串,
    示例:"My City, 123a-45";
  • info - 关于您希望其他人知道的公司或个人的一些附加信息,
    类型:字符串,
    示例:"Some additional information";
  • logo - 图片 logo 的路径(这个文件没有特别推荐,但是如果是透明背景的 .png 格式会更好)。 图片必须具有以下尺寸:432x70,
    类型:string,
    示例:"https://example.com/logo-big.png"。
  • logoDark - 深色主题图像徽标的路径(此文件没有特别建议,但如果是透明背景的 .png 格式会更好)。 图片必须具有以下尺寸:432x70,
    类型:string,
    示例:"https://example.com/dark-logo-big.png"。
  • mail - 允许访问编辑或编辑作者的公司或个人的电子邮件地址,
    类型:string,
    示例:"john@example.com".
  • name - 授予编辑或编辑作者访问权限的公司或个人的名称,
    类型:string,
    示例:"John Smith and Co.";
  • phone-允许访问编辑或编辑作者的公司或个人的电话,
    类型:string,
    示例:"123456789";
  • www - 上述公司或个人的主页地址,
    类型:string,
    示例:"example.com"。
对象 { "address": "My City, 123a-45", "info": "Some additional information", "logo": "https://example.com/logo-big.png", "logoDark": "https://example.com/dark-logo-big.png", "mail": "john@example.com", "name": "John Smith and Co.", "phone": "123456789", "www": "example.com" }
如果可能,定义用户可以禁用或自定义的参数:
  • spellcheck - 定义在加载编辑器时拼写检查器是自动打开还是关闭。 如果此参数为布尔值,则将其设置为初始拼写检查值,并且不会隐藏拼写检查设置。 默认值为 true
    类型:object 或 boolean,
    例如:true;
  • spellcheck.mode - 定义在加载编辑器时拼写检查器是自动打开还是关闭。 此参数仅适用于文档编辑器和演示文稿编辑器,
    类型:boolean,
    示例:true;
object { "spellcheck": { "mode": true } }
请注意,如果在编辑器界面中更改 拼写检查 设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.features.spellcheck 参数发送的任何值。
定义 反馈和支持 菜单按钮的设置。 可以是布尔值(仅显示或隐藏 反馈和支持 菜单按钮)或对象。 在对象类型的情况下,以下参数可用:
  • url - 单击 反馈和支持 菜单按钮时将打开的网站绝对URL,
    类型:string,
    示例:"https://example.com";
  • visible - 显示或隐藏 反馈和支持 菜单按钮,
    类型:boolean,
    示例:true。
默认值为 false
boolean 或 object true
请注意,此参数也适用于移动编辑器。
文档编辑服务 中保存文档时(例如单击 保存 按钮等),将文件强制保存请求添加到 回调处理程序。 默认值为 false boolean false
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.forcesave 参数发送的任何值。
定义 打开文件位置 菜单按钮和右上角按钮的设置。 该对象具有以下参数:
  • Blank - 单击 打开文件位置按钮时,在新浏览器选项卡/窗口(如果值设置为 true)或当前选项卡(如果值设置为 false )中打开网站。 默认值为 true
    类型:boolean,
    示例:true;
  • requestClose - 定义如果单击打开文件位置按钮,将调用 events.onRequestClose 事件而不是打开浏览器选项卡或窗口。 默认值为 false
    类型:boolean,
    示例:false;
  • text - 打开文件位置 菜单按钮和右上角按钮显示的文本(也就是说,不是 转到文档),
    类型:string,
    例如:"打开文件位置";
  • url - 单击 打开文件位置 菜单按钮时将打开的网站绝对 URL,
    类型:string,
    例如:"https://example.com"。
boolean 或 object true
请注意,此参数也适用于移动编辑器。
定义 帮助 菜单按钮是显示还是隐藏。 默认值为 true boolean true
请注意,此参数也适用于移动编辑器。
定义注释面板在首次加载时是显示还是隐藏。 默认值为 false。此参数仅适用于演示文稿编辑器。 boolean false
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.hideNotes 参数发送的任何值。
定义第一次加载时是否显示或隐藏右侧菜单。 默认值为 false boolean false
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.hideRightMenu 参数发送的任何值。
定义编辑器标尺是显示还是隐藏。 此参数可用于文档和演示文稿编辑器。文档编辑器的默认值为 false,演示文稿的默认值为 true boolean false
定义将编辑器嵌入网页的模式。 embed 值禁止在加载编辑器框架时滚动到编辑器框架,因为焦点未被捕获。 string embed
更改编辑器标题左上角的图像文件。 推荐的图像高度为 20 像素。 该对象具有以下参数:
  • image - 用于在通用工作模式(即所有编辑器的查看和编辑模式)或嵌入模式(请参阅 配置 部分以了解如何定义 嵌入 文档类型)中显示的图像文件的路径。 图片必须具有以下尺寸:172x40,172x40,
    类型:string,
    示例:"https://example.com/logo.png";
  • imageDark - 用于深色主题的图像文件的路径。 图片必须具有以下尺寸:172x40,172x40,
    类型:string,
    示例:"https://example.com/dark-logo.png";
  • imageEmbedded - 用于以嵌入模式显示的图像文件的路径(请参阅 配置 部分以了解如何定义 嵌入 文档类型)。 图片必须具有以下尺寸:248x40。 自 7.0 版起已弃用,请改用 图像 字段,
    类型:string,
    示例:"https://example.com/logo_em.png";
  • url - 当有人单击徽标图像时将使用的绝对 URL(可用于访问您的网站等)。 保留为空字符串或 null 以使徽标不可点击,
    类型:string,
    示例:"https://example.com"。
对象 { "image": "https://example.com/logo.png", "imageDark": "https://example.com/dark-logo.png", "url": "https://example.com" }
定义当编辑器打开时是否自动运行文档宏。 默认值为 truefalse值对用户隐藏宏设置 boolean true
定义启用自动开始时的宏运行模式。 可以取以下值:
  • disable - 不自动运行所有宏;
  • enable - 自动运行所有宏;
  • warn - 对运行宏发出警告并请求运行它们的权限。
默认值为 warn
string warn
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.macrosMode 参数发送的任何值。
请注意,此参数也适用于移动编辑器。
定义在评论中提及后描述事件的提示。 如果为 true,则提示表示用户将收到通知并访问文档。 如果为 false,则提示表示用户将仅收到提及通知。 默认值为 true boolean true
请注意,如果设置了 onRequestSendNotify 事件 ,它将仅可用于评论。
定义移动文档编辑器在启动时是否以查看/编辑模式打开。 默认值为true boolean true
请注意,此参数仅适用于移动编辑器。
定义 插件 是否将启动并可用。 默认值为 true boolean true
包含有关审阅模式的信息。 该对象具有以下参数:
  • hideReviewDisplay - 定义 显示模式 按钮是在 协作 选项卡上显示还是隐藏。 默认值为 false
    类型:boolean,
    示例:false;
  • hoverMode - 定义评论显示模式:通过悬停更改(true) 在工具提示中显示评论,或者通过单击更改(false)在气球中显示评论。 默认值为 false
    类型:boolean,
    示例:false;
  • reviewDisplay - 定义打开文档进行查看时将使用的审阅编辑模式。 如果 mode 设置为 view,它将仅对文档编辑器可用。 可以取以下值:
    - markup - 显示文档,并突出显示建议的更改;
    - simple - 显示文档并突出显示建议的更改,但气球已关闭;
    - final - 显示文档并应用了所有建议的更改;
    - original - 显示原始文档,没有建议的更改。
    默认值为 original,
    类型:string,
    示例:"original";
  • showReviewChanges - 定义在加载编辑器时是否自动显示或隐藏审阅更改面板。 默认值为 false
    类型:boolean,
    示例:false;
  • trackChanges - 无论 document.permissions.review 参数如何,定义是否以审阅编辑模式 (true) 打开文档 (false) (审阅模式仅针对当前用户更改)。 如果参数 未定义,则使用 document.permissions.review 值(对于所有文档用户),
    类型:boolean,
    示例:true。
object { "hideReviewDisplay": false, "showReviewChanges": false, "reviewDisplay": "original", "trackChanges": true, "hoverMode": false }
showReviewChanges, reviewDisplay, trackChanges参数自 7.0 版起已弃用。 请改用 review 参数。
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.review.hoverModeeditorConfig.customization.review.reviewDisplay 参数发送的任何值。
定义文档编辑器中的审阅编辑模式。 此参数可以采用以下值:
  • markup - 显示文档并突出显示建议的更改;
  • simple - 显示文档并突出显示建议的更改,但气球已关闭;
  • final - 显示文档并应用所有建议的更改;
  • original - 显示原始文档,没有建议的更改。
查看器的默认值是 original, 编辑器的默认值是 markup
string original
自 7.0 版起已弃用。请改用 review.reviewDisplay 参数。
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.reviewDisplay 参数发送的任何值。
定义加载编辑器时是否自动显示或隐藏审阅更改面板。 默认值为 false boolean false
自 7.0 版起已弃用。请改用 review.showReviewChanges 参数。
定义在加载编辑器时拼写检查器是自动打开还是关闭。 拼写检查器仅适用于文档编辑器和演示文稿编辑器。 默认值为 true boolean true
自 7.1 版起已弃用。请改用 features.spellcheck 参数。
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.spellcheck 参数发送的任何值。
定义顶部工具栏上是否显示或隐藏提交按钮。 按钮仅适用于 pdf 格式。 默认值为false boolean true
Submit button
定义文档标题在顶部工具栏上是可见的 (false) 还是隐藏的 (true)。 默认值为 false boolean false
请注意,当 compactHeadertoolbarNoTabs 参数设置为 true时使用此设置。
定义顶部工具栏选项卡是清晰显示 (false) 还是仅突出显示以查看选择了哪个 (true)。 默认值为 false boolean false
无论 document.permissions.review 参数如何, 定义是(true)否(false)以审阅编辑模式打开文档(仅针对当前用户更改审阅模式)。 如果参数是 未定义,则使用 document.permissions.review 值(对于所有文档用户)。 boolean true
自 7.0 版起已弃用。请改用 review.trackChanges 参数。
定义编辑器主题设置。 可以通过两种方式设置:
  • theme id - 用户通过其 id 设置主题参数(theme-light, theme-classic-light, theme-dark, theme-contrast-dark),
  • default theme - 将设置默认的深色或浅色主题值(default-darkdefault-light)。 默认的浅色主题是 theme-classic-light
第一个选项具有更高的优先级。

除了可用的编辑器主题外,用户还可以为应用程序界面自定义自己的颜色主题
string theme-dark
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.uiTheme 参数发送的任何值。
定义标尺和对话框中使用的测量单位。 可以取以下值:
  • cm - 厘米,
  • pt - 点,
  • inch - 英寸。
默认值为厘米 (cm)。
string cm
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.unit 参数发送的任何值。
定义以百分比测量的文档显示缩放值。 可以取大于 0的值。 对于文本文档和演示文稿,可以将此参数设置为 -1 (使文档适合页面选项)或 -2 (使文档页面宽度适合编辑器页面)。 默认值为 100 integer 100
请注意,如果在编辑器界面中更改此设置,它将存储在浏览器本地存储中,并将覆盖作为 editorConfig.customization.zoom 参数发送的任何值。
* - 仅适用于 ONLYOFFICE 开发者版的编辑