ONLYOFFICE 文档 8.1 现已更新,新增 Office API 板块


随着版本 8.1 新功能的发布,我们更新了编辑器、文档生成器和插件的 API,并添加了 Office API 板块。阅读下文了解详情。

ONLYOFFICE 文档开发者版 8.1:API 更新

PDF 表单

从 8.1 版本开始,我们完全切换到 PDF 表单。若要创建和编辑表单,用户不再需要其他格式,以前用于创建表单模板的 docxf 格式现在已被弃用。

API 做出了以下更新:

  • docxf 和 oform 格式的 documentType 更改为 pdf
  •  pdf field 添加到转换请求中
  •  formsubmit 操作添加到 WOPI 发现中
  •  docs_api_config 参数添加到 WOPI 宿主页的 form 元素中

表单提交

成功提交表单后,将调用新添加的 onSubmit 事件,让用户的表单提交操作更加直观。

在下面的代码示例中,成功提交表单后,将向控制台打印一条消息。例如,您可以向用户显示提示“您的表单已成功提交”之类的内容。

var onSubmit = function (event) {
console.log("The form was submitted.");
};
var docEditor = new DocsAPI.DocEditor("placeholder", {
"events": {
"onSubmit": onSubmit,
...
},
...
});

收件人角色管理

默认情况下,会启用管理角色功能,让您可以按需灵活地分配角色和颜色。如果收件人角色和其匹配的颜色对您来说不是必需的,那么可以禁用此功能。

为此,请使用添加到 editorConfig.customization.features 参数的 roles 字段。它定义是否将在 PDF 表单中禁用角色设置。如果该参数设置为 false,则角色管理器将处于隐藏状态,并禁用通过角色来查看表单。在这种情况下,将不会显示“表单”选项卡上的“管理角色”和“查看表单”按钮,以及右侧面板中设置字段角色的下拉列表。

扩展自动化 API

自动化 API 可以与外部文件进行交互,增加了几种新方法:

  • addContextMenuItem – 将项目添加到上下文菜单中
  • addToolbarMenuItem – 将项目添加到工具栏菜单
  • updateContextMenuItem – 使用指定的项目,更新上下文菜单中的项目

例如,如果要更新上下文菜单项,请使用 updateContextMenuItem 方法。在这里,传递一个包含新项的数组作为参数,为每个项指定所有必要的参数。在下面的代码示例中,我们将传递一个具有“onConvert”ID 和“Convert to Markdown or HTML”文本的元素。

var items: [
{
"id": "onConvert",
"text": getMessage("Convert to Markdown or HTML")
}
]
connector.updateContextMenuItem(items);

自定义

使用新添加的参数来调整编辑器的界面。

editorConfig.customization.layout.header.editMode 参数,定义切换模式按钮是否显示在标题中。

请注意:此 API 参数适用于具有扩展文档开发人员许可证的用户。要访问此功能,请提交您的请求

ONLYOFFICE 文档开发者版 8.1:API 更新

editorConfig.customization.logo 参数的 visible 字段,能够显示或隐藏 logo(编辑器标题左上角的图像文件)。此外,它现在也可用于移动编辑器。

ONLYOFFICE 文档开发者版 8.1:API 更新

可靠集群的分片

之前版本中引入的 WOPISrc 查询参数,从浏览器到服务器,均已被添加至请求中。这样您可以创建 ONLYOFFICE 的多个独立实例。使用 WOPISrc 对请求进行负载均衡可确保协作编辑正常工作:编辑同一文档的所有用户都由同一服务器提供服务。针对 WOPI,使用了由积分器发送的参数。针对 Docs API,使用了新的 Shard key 参数。

shardkey 参数被添加到 URL QueryString 时,将发送请求至文档命令服务文档转换服务文档生成器服务key 字段会被用作一个值。例如,?shardkey=Khirz6zTPdfd7。如果正文中没有键,您也不需要发送(例如,在 getForgottenList 命令中)。

编辑器的更多 API 更新

  • 系统会将 -10 错误代码(超出大小限制)添加到 Conversion API 中。
  • editorConfig.customization.hideRightMenu 参数的默认值更改为 true(即右侧菜单将在首次加载时隐藏)。
  • editorConfig.customization.layout.toolbar.home.mailmerge 字段已弃用,请改用 editorConfig.customization.layout.toolbar.collaboration.mailmerge 字段(因为“邮件合并”按钮已移至“协作”选项卡)。
  • editorConfig.customization.goback.requestClose 字段已弃用,请改用 editorConfig.customization.close 字段。

插件的 API 优化

从 8.1 版本开始,插件可以更改工具栏:创建自己的选项卡并填充它们、将按钮添加到标准选项卡。为此,请使用 AddToolbarMenuItem 方法。

ONLYOFFICE 文档开发者版 8.1:API 更新

var oToolbarMenuItem = {
"id": "MeaningItem",
"type": "button",
"text": "Meaning",
"hint": "Meaning",
"icons": "resources/light/icon.png",
"disabled": false,
"enableToggle": false,
"lockInViewMode": false,
"separator": true,
"split": true,
"items": [
{
"id": "onMeaningT",
"text": "Explain text in comment"
},
{
"id": "onFixSpelling",
"text": "Fix spelling & grammar"
},
{
"id": "onMakeLonger",
"text": "Make longer"
},
{
"id": "onMakeShorter",
"text": "Make shorter"
}
]
};
var oToolbarMenuTab = {
"id": "ChatGPT",
"text": "AI Assistant",
"items": [oToolbarMenuItem]
};
var oToolbarMenuMainItem = {
"guid": "asc.{9DC93CDB-B576-4F0C-B55E-FCC9C48DD007}",
"tabs": [oToolbarMenuTab]
};
window.Asc.plugin.executeMethod ("AddToolbarMenuItem", [[oToolbarMenuMainItem]]);

此外,插件现在不仅可以创建多个窗口,还可以创建多个左侧面板。variations.menu 参数指定插件的放置位置:在右侧或左侧面板上。

ONLYOFFICE 文档开发者版 8.1:API 更新

在新的插件方法中,您会发现:

  • onToolbarMenuClick
  • ActivateWindow
  • GetSelectedOleObjects
  • GetAllComments
  • 等等

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

档生成器的 Python 框架

对于 ONLYOFFICE 文档生成器,现在有一个 Python 生成器框架可用。它包含一系列库、类和函数,可以更轻松地在 Python 中快速开发具有文档创建功能的应用程序。

Office API

为了方便和更轻松的导航,我们将编辑器的 JavaScript 库移至一个单独的板块 – Office JavaScript API

在这里,我们还为 8.1 版本添加了许多新方法,包括:

  • 日期格式
  • 设置文本属性
  • 受保护的范围
  • 粘贴/剪切范围
  • 参考样式
  • 工作表功能
  • 自定义功能
  • 移动光标

查看新方法的完整列表

相关链接

ONLYOFFICE 文档 8.1的新功能:文章 / 视频

ONLYOFFICE 开发

ONLYOFFICE 文档生成器

API 文档

文档 API 更新日志

Office API 更新日志

插件和宏更新日志


相關推薦

2023-12-05

更新后的 ONLYOFFICE 协作空间新增诸多实用功能,全平台实现多项优化功能。请继续阅读,了解所有更新。 ONLYOFFICE 协作空间是什么 ONLYOFFICE 协作空间是一款开源效率平台,让您与同事、团队成员、客户、合作伙伴、承

2023-11-10

ONLYOFFICE 发布了 SuiteCRM 的集成连接器。现在,您可以在 SuiteCRM 文档模块中编辑和协作处理 Office 文件。继续阅读了解详情。 关于 ONLYOFFICE 文档 ONLYOFFICE 文档是一款全面的在线办公工具,提供了文本文档、电子表格和演示文稿

2022-09-25

OnlyOffice 是一款免费开源的办公套件,结合了文本、电子表格和演示文稿编辑器,允许创建、查看和编辑本地文件。它与 .docx、.xlsx 和 .pptx 等 Office Open XML 格式完全兼容。OnlyOffice 支持 Windows、Linux 和 Mac。 OnlyOffice 7.2 近日正式发

2023-06-16

ONLYOFFICE发布了最新版本的文档编辑器了,更新的功能包括:绘图、雷达图、合并文档、将某个对象或者整个文档/工作表保存为图片、更强大的编辑区域保护等等。继续阅读本文了解所有的更新。 在编辑器中绘图 尽情发挥创

2023-10-19

(的前两天),相约开源PHP办公室,我们一起聊 AI!>>> ONLYOFFICE 开源办公套件已推出最新版的在线编辑器,整个套件具备多项增强功能。敬请继续阅读,了解所有更新。 全新 PDF 编辑器 PDF 是工作中很常见的文件格式

2023-10-26

随着版本 7.5 中新功能的发布,ONLYOFFICE 更新了编辑器、文档生成器、插件和桌面应用程序的 API。阅读本文查看所有详细信息。 用于处理表单的 API 隐藏/显示提交表单按钮:使用 editorConfig.customization.submitForm 参数

2023-02-02

OnlyOffice 是一款免费开源的办公套件,结合了文本、电子表格和演示文稿编辑器,允许创建、查看和编辑本地文件。它与 .docx、.xlsx 和 .pptx 等 Office Open XML 格式完全兼容。OnlyOffice 支持 Windows、Linux 和 Mac。 OnlyOffice 7.3 近日正式发

2024-07-30

🎉 亲爱的用户们,好消息来啦!onlyoffice插件现已更新至V1.27版本,专为追求高效与安全的您打造!这次更新,我们带来了哪些亮点呢?快来一睹为快吧! 🔍 新增文件与参数检测:再也不用担心文件丢失或参数错误带

2023-10-04

适用于 Box 的 ONLYOFFICE 集成应用程序可直接在 Box 前端中处理文件。 请继续阅读了解详情。 ONLYOFFICE 文档是什么 ONLYOFFICE 文档是一个功能强大的在线编辑器,用于文本文档、电子表格、演示文稿、表单和 PDF 阅读器,可以与任

2023-08-01

现在可以将 ONLYOFFICE 协作空间安装在私人服务器上了,您可以完全掌控所有数据,以及享受其他自托管的优点。目前用于 Linux 服务器安装的协作空间已发布,其他软件包将会陆续推出。请阅读下文了解详情。 关于 ONLYOFFICE 

2024-10-16

Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库,基于 ECMA-376,ISO/IEC 29500 国际标准。可以使用它来读取、写入由 Microsoft Excel™ 2007 及以上版本创建的电子表格文档。支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多种文档格式,高度

2024-07-03

ONLYOFFICE 发布了 2024 插件开发大赛:为 ONLYOFFICE 开发适合中国用户的插件,赢取税前5500 – 10000元的结项奖金与证书!阅读本文了解详情。 关于 ONLYOFFICE ONLYOFFICE 是一个国际开源项目,由领先的 IT 公司 Ascensio System SIA 开发

2022-08-19

新增用于搜索工作表名称的菜单项 IMPRESS 新增对文档主题的支持 互操作性 LibreOffice 7.4 基于 LibreOffice 技术平台在桌面、移动和云上实现个人生产力的功能,针对与 MS Office 共享文档或从 ​​MS Office 迁移的用户提供了

2024-10-19

ONLYOFFICE 在线编辑器最新版本已经发布,其中包含30多个新功能和500多个错误修复。阅读本文了解所有更新。 关于 ONLYOFFICE 文档 ONLYOFFICE 是一个开源项目,专注于高级和安全的文档处理。坐拥全球超过 1500 万用户,