API 汇总：ONLYOFFICE 文档最新更新

我们对 ONLYOFFICE 文档 API 进行了一系列更新，以提升兼容性、自定义能力和安全性。无论您是希望构建自定义工作流程、实现安全的文档协作，还是集成高级 API 功能，这些更新都能为您提供更多可能性。以下是新增功能和改进的具体介绍。

扩展文件格式支持

文档 API 现在支持更多文件格式，提供更广泛的兼容性，确保用户在使用各种文件类型时获得流畅的体验。其中包括 Apple iWork 和 Hancom Office 格式：

• pages
• key
• numbers
• hwp
• hwpx

可以使用 documentType 属性指定格式，例如：

const config = {
  documentType: "pages",

更多自定义选项

开发者现在可以定制编辑器的行为和外观。主要更新包括：

• 隐藏功能提示

editorConfig.customization.features.featuresTips 参数允许在更新后首次加载编辑器时启用或禁用有关新功能的工具提示。默认值为 true。

• 显示电子表格滚动条

从 8.3 版本开始，可以定义在加载电子表格编辑器时是否自动显示或隐藏水平/垂直滚动条。查看 editorConfig.customization.showHorizontalScroll 和 editorConfig.customization.showVerticalScroll 来控制这些参数。

• 演示文稿幻灯片背景

使用 editorConfig.customization.slidePlayerBackground 参数以 HEX、RGB 或 RGBA 格式定义幻灯片背景颜色。例如，#ff0000、rgb(255, 0, 0)、rgba(255, 0, 0, 0.5)。

showHorizontalScroll: true,
      showVerticalScroll: true,
      slidePlayerBackground: "#000000",

• 文档标题颜色

使用 editorConfig.customization.wordHeadingsColor 参数自定义文档编辑器中的标题样式，并允许使用HEX 颜色规范。

• 移动编辑器中的信息按钮

使用 editorConfig.customization.mobile.info 切换移动编辑器中“文档信息”按钮的显示。默认值为 false。

• 指针模式

使用 editorConfig.customization.pointerMode 参数调整演示文稿查看器中的指针模式（选择或手形）。默认值为 select。

• 查看器的紧凑工具栏

editorConfig.customization.compactToolbar 参数现在支持查看器模式，允许在完整工具栏和紧凑工具栏之间切换。查看模式的默认值为 true。

改进安全功能

文档 API 新增了 events.onUserActionRequired 事件，用于处理受密码保护的文件。当用户需要执行以下操作才能打开文档时，系统会调用该函数：

• 用户需要输入密码才能打开受保护的文档；
• 用户需要为 TXT 文件选择编码；
• 用户需要为 CSV 文件选择编码和分隔符。

以下是该事件功能的示例：

function onUserActionRequired() {
  console.log("Enter a password")
};
const config = {
  events: {
    onUserActionRequired,
  },
};
const docEditor = new DocsAPI.DocEditor("placeholder", config);

另外，您现在可以使用 drop 命令禁止特定用户编辑文档：

{
  "c": "drop",
  "key": "Khirz6zTPdfd7",
  "users": ["6d5a81d0"]
}

完整的文档 API 更新日志可在此处查看。

获取最新版本的 ONLYOFFICE 文档开发者版：

立即下载

新的 Office API 方法

Office API 迎来重大更新，旨在更好地管理文档，具体包括：

• 书签
• 内容控件
• 章节
• 自动筛选
• 选择
• 等等

这些增强功能带来了更丰富的交互和编辑体验。有关命令的详细分解，请参阅 Office API 更新日志。

插件 API 更新

一些新的方法和属性扩展了插件的功能：

• 内容检索

GetSelectedContent 方法可以按指定格式检索选定的内容。

expression.GetSelectedContent(prop);

• 错误消息

ShowError 方法使插件能够显示错误或警告消息。

expression.ShowError(error, level);

• 优化内容控制属性

新属性 Shd（背景阴影）和 Border 优化了 ContentControlProperties 对象，以实现更佳的视觉自定义效果。

• 面板激活

isActivated 参数可指定创建的插件面板在加载时是展开 (true) 还是折叠 (true)。

查看插件 API 更新的完整列表。