开发者版 ONLYOFFICE 文档 7.5:API 和文档生成器更新


随着版本 7.5 中新功能的发布,ONLYOFFICE 更新了编辑器、文档生成器、插件和桌面应用程序的 API。阅读本文查看所有详细信息。

ONLYOFFICE Docs 7.5 for developers: API and Doc Builder updates

用于处理表单的 API

隐藏/显示提交表单按钮:使用 editorConfig.customization.submitForm 参数,可以定义 OFORM 文件的顶部工具栏上是否显示或隐藏“提交”按钮。

var docEditor = new DocsAPI.DocEditor("placeholder", { 
"editorConfig": { 
"customization": {
...
"submitForm": true,

强制保存的更多参数在版本7.5中,ONLYOFFICE 为回调处理程序的forcesavetype参数添加了3类型。如果应用,则每次提交表单时(例如,单击“提交”按钮时)都会执行强制保存请求。

{
 "changesurl": "https://documentserver/url-to-changes.zip", 
"forcesavetype": 3,
....

用于处理文档的 API

更改外部数据源:当用户尝试通过单击编辑器中的“更改源”按钮来更改外部数据源时,将调用新添加的 events.onRequestReferenceSource 事件。具有唯一文件数据和文件路径或名称的对象在数据参数中发送。

单击该按钮时,必须调用 setReferenceSource方法来更改外部数据的来源。调用该方法时,必须添加token来验证参数。如果未声明事件,则不会显示“更改源”按钮。

var onRequestReferenceSource = function () 
{ var referenceData =event.data.referenceData; 
var path = event.data.path; 
...
docEditor.setReferenceSource({
"fileType": "xlsx", 
"path": "sample.xlsx", 
"referenceData": { 
"fileKey": "BCFA2CED", 
"instanceId": "https://example.com", 
"key": "Khirz6zTPdfd7"
},

关键字段添加到 document.referenceData 参数的关键字段定义了服务用于从共同编辑会话获取数据的唯一文档标识符。

如果发送已知密钥,将从缓存中获取文档。每次编辑并保存文档时,都必须重新生成密钥。

可以使用文档 URL 作为密钥,但不能包含特殊字符,且长度限制为 128 个符号。

var docEditor = new DocsAPI.DocEditor("placeholder", { 
"document": { 
"fileType": "docx", 
"key": "Khirz6zTPdfd7", 
"referenceData": { 
"fileKey": "BCFA2CED", 
"instanceId": "https://example.com", 
"key": "Khirz6zTPdfd7"
},

转换API

转换 API 已扩展,当转换器无法自动确定输出文件格式时,会出现 -9 错误代码

此错误意味着客户端必须明确指定文件应转换为哪种格式 – 文本文档或电子表格。它用于在 XML 类型未知的情况下将 XML 转换为 OOXML。

{ 
"error": -9 
}

其他更新

  • events.onRequestOpen 事件用于显示开源按钮。
  • deleteForgotten、 getForgotten 和  getForgottenList 命令可用于处理忘记的文件。
  •  events.onRequestSelectSpreadsheet事件而不是已弃用的 events.onRequestMailMergeRecipients
  • setRequestedSpreadsheet 方法而不是已弃用的 setMailMergeRecipients
  •  events.onRequestSelectDocument 事件而不是已弃用的 events.onRequestCompareFile
  • setRequestedDocument 方法而不是已弃用的 setRevisedFile

此外,在桌面应用程序API中,ONLYOFFICE 在 portal:login 命令中添加了uiTheme参数,该参数定义了将桌面编辑器连接到云端时的编辑器主题设置。

插件 API 优化

ShowButton方法新添加的align参数指示按钮是显示在窗口的右侧还是左侧。默认值为“left”。

window.Asc.plugin.executeMethod ("ShowButton", ["back", false, "right"]);

文档生成器的 API 更新

文档生成器 API 中,ONLYOFFICE 添加了多个新的水印和组合框和下拉列表内容控制方法,多个全局和幻灯片方法,包括以下方法:

  • ApiBlockLvlSdt/GetDropdownList
  • ApiContentControlList/Add
  • ApiDocument/GetWatermarkSettings
  • ApiWatermarkSettings/GetDirection
  • ApiSlide/GetVisible

查看新方法的完整列表

请注意:文档生成器 v7.5 稍后将可供下载。

相关链接

ONLYOFFICE 文档 7.5 中的新增功能: / 视频

面向开发人员的 ONLYOFFICE

ONLYOFFICE 文档生成器

API 文档

文档 API 变更日志

插件和宏变更日志

文档生成器变更日志


相關推薦

2023-10-19

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

2023-11-10

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

2024-06-28

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

2023-06-16

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

2024-10-19

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

2024-07-03

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

2023-12-05

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

2023-08-01

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

2023-10-04

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

2022-09-25

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

2022-11-09

默认输出带 7位 的毫秒值 4.7.1 aeda902 文档 [新增] IIS 回收问题解决方案文档 [新增] 远程请求获取 Cookies 文档 [更新] 日志记录文档、定时任务文档、远程请求文档

2024-07-30

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

2023-02-02

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

2022-08-21

une 7.5 发布了,此版本附带Debian 11.4(“Bullseye”)提供的更新,在安全性方面提供了保障。另外将Linux 内核更新到 5.18 版,为现代硬件提供更好的支持,并修复现有硬件支持的一些错误。 Neptune 7.5 还为完整的系统备份提供了一