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

news2024/10/2 6:42:53

随着版本 7.5 中新功能的发布，我们更新了编辑器、文档生成器、插件和桌面应用程序的 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中，我们为回调处理程序的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中，我们在 portal:login 命令中添加了uiTheme参数，该参数定义了将桌面编辑器连接到云端时的编辑器主题设置。

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

立即下载

插件 API 优化

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

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

文档生成器的 API 更新

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

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

查看新方法的完整列表。

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