初始化 文档编辑器 后，您将获得可用于调用方法的对象。
var docEditor = new DocsAPI.DocEditor("placeholder", config);
createConnector* - 创建 连接器与外部的文本文档、电子表格、演示文稿和可填写表单进行交互。
docEditor.createConnector();
denyEditingRights - 拒绝编辑。 当您想让文档编辑不可用时，可以调用此方法。
docEditor.denyEditingRights(message);
| 参数 | 描述 | 类型 | 出现 |
| message | 定义对话的文本消息。 | string | 可选的 |
destroyEditor - 销毁 docEditor 对象。 当您想使用其他配置重新启动文档编辑器时，可以调用此方法。 从 4.3 版开始使用。
docEditor.destroyEditor();
downloadAs - 下载编辑后的文件。 只有在存在 onDownloadAs 事件 时才能调用该方法。 文档编辑服务 异步创建文档并使用参数中的链接触发 onDownloadAs 事件。
docEditor.downloadAs(format);
| 参数 | 描述 | 类型 | 出现 |
| format | 定义下载文件的格式。 您可以在 转换表中找到所有可能的格式。 但是您不能下载 bmp、 gif、 jpg、 png等图像格式的文件。 如果未定义该参数，则根据文件类型以OOXML格式下载文件。 | string | 可选的 |
insertImage - 将图像插入文件中。 从版本 7.0 开始，此方法允许用户插入多个图像。 图像 数组用于执行此操作。 此方法必须在 onRequestInsertImage 事件之后调用。
docEditor.insertImage({
"c": "add",
"images": [
{
"fileType": "png",
"url": "https://example.com/url-to-example-image1.png"
},
{
"fileType": "png",
"url": "https://example.com/url-to-example-image2.png"
},
...
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiYWRkIiwiaW1hZ2VzIjpbeyJmaWxlVHlwZSI6InBuZyIsInVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtaW1hZ2UxLnBuZyJ9LHsiZmlsZVR5cGUiOiJwbmciLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWltYWdlMi5wbmcifV19.JfSa__qPeY3MjUgdkJDjdfJWBgvCmEdLfFzjd3WgeUA"
});
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息，请参阅 它是如何运作的 部分。
| 参数 | 描述 | 类型 | 出现 |
| c | 从事件中定义一种图像插入类型。 可以是：添加、 更改、 填充、 水印、 幻灯片。 默认值为"添加"。 | string | 必需的 |
| fileType | 定义要插入文件的图像类型。 可以是：Bmp、 gif、 jpe、 jpeg、 jpg、 png。 自 7.0 版起已弃用，请改用 images.fileType 参数。 | string | 必需的 |
| images | 定义要插入的图像数组。 | 对象数组 | 必需的 |
| images.fileType | 定义要插入文件的图像类型。 可以是：Bmp、、 gif、 jpe、 jpeg、 jpg、 png。 | string | 必需的 |
| images.url | 定义存储源图像的绝对 URL。 使用本地链接时请务必添加 令牌。 | string | 必需的 |
| token | 定义以 令牌形式添加到参数的加密签名。 | string | 可选的 |
| url | 定义存储源图像的绝对 URL。 使用本地链接时请务必添加 令牌。 否则会出现错误。 自 7.0 版起已弃用，请改用 images.url 参数。 | string | 必需的 |
在 7.0 版本之前，此方法只允许插入一张图片，并具有以下参数：
docEditor.insertImage({
"c": "add",
"fileType": "png",
"url": "https://example.com/url-to-example-image.png"
});
请注意，此结构已弃用，下一个编辑器版本将不支持此结构。 请使用新的。
refreshHistory - 显示文档版本历史。 此方法必须在 onRequestHistory 事件之后调用。
docEditor.refreshHistory({
"currentVersion": 2,
"history": [
{
"created": "2010-07-06 10:13 AM",
"key": "af86C7e71Ca8",
"user": {
"id": "F89d8069ba2b",
"name": "Kate Cage"
},
"version": 1
},
{
"created": "2010-07-07 3:46 PM",
"key": "Khirz6zTPdfd7",
"user": {
"id": "78e1e841",
"name": "John Smith"
},
"version": 2
},
...
],
});
如果在编辑和保存文档后返回带有对象更改和 serverVersion的 历史记录 ，则在serverVersion参数 中发送 更改 和 serverVersion 中的对象更改。
docEditor.refreshHistory({
"currentVersion": 2,
"history": [
{
"created": "2010-07-06 10:13 AM",
"key": "af86C7e71Ca8",
"user": {
"id": "F89d8069ba2b",
"name": "Kate Cage"
},
"version": 1
},
{
"changes": changes,
"created": "2010-07-07 3:46 PM",
"key": "Khirz6zTPdfd7",
"serverVersion": serverVersion,
"user": {
"id": "78e1e841",
"name": "John Smith"
},
"version": 2
},
...
],
});
其中 changes 是保存文档后返回的 历史对象 的 更改 。
其中 serverVersion 是保存文档后返回的 历史对象 中的 serverVersion。
显示错误消息，解释为什么无法显示版本历史记录。
docEditor.refreshHistory({
"error": "Exception",
});
| 参数 | 描述 | 类型 | 出现 |
| currentVersion | 定义当前文档版本号。 | integer | 必需的 |
| error | 定义错误消息文本。 | string | 可选的 |
| history | 使用文档版本定义数组。 | array | 必需的 |
| history.changes | 定义保存文档后返回的 历史对象的 更改。 | 对象 | 可选的 |
| history.created | 定义文档版本创建日期。 | string | 必需的 |
| history.key | 定义服务用来识别文档的唯一文档标识符。 | string | 必需的 |
| history.serverVersion | 定义当前服务器版本号。 如果发送changes参数，则还需要发送serverVersion参数。 | integer | 可选的 |
| history.user | 定义作为文档版本作者的用户。 | 对象 | 可选的 |
| history.user.id | 定义作为文档版本作者的用户的标识符。 | string | 可选的 |
| history.user.name | 定义作为文档版本作者的用户的名称。 | string | 可选的 |
| history.version | 定义文档版本号。 | integer | 必需的 |
requestClose - 请求关闭编辑器。 建议在 destroyEditor 方法之前调用该方法来检查编辑器中是否有一些未保存的数据。 如果存在未保存的数据，则会显示对话框询问用户是否要继续编辑或关闭编辑器，丢失所有未保存的数据。 如果选择 关闭 选项，则将调用 onRequestClose 事件。
docEditor.requestClose();
setActionLink - 设置包含书签的文档的链接。 此方法必须在 onMakeActionLink 事件之后调用。 软件集成商必须处理从 文档编辑服务 接收到的 ACTION_DATA 以设置链接。 该链接由软件集成商创建，他们在 文档管理器中使用 ONLYOFFICE 文档服务器
docEditor.setActionLink(link);
| 参数 | 描述 | 类型 | 出现 |
| link | 定义允许滚动到文档中书签位置的链接。 | string | 必需的 |
setFavorite - 更改 收藏 图标状态。 此方法必须在onMetaChange事件之后调用。
docEditor.setFavorite(favorite);
| 参数 | 描述 | 类型 | 出现 |
| favorite | 定义 收藏夹 图标是否突出显示 (true) 或不突出显示 (false)。 | boolean | true |
setHistoryData - 发送文档链接以查看版本历史。 此方法必须在 onRequestHistoryData 事件之后调用。
docEditor.setHistoryData({
"fileType": "docx",
"key": "Khirz6zTPdfd7",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1kb2N1bWVudC5kb2N4IiwidmVyc2lvbiI6Mn0.iRcdHve235L5K1e29SmUBkuHcxb63WHRko51WMJlmS0",
"url": "https://example.com/url-to-example-document.docx",
"version": 2
});
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息，请参阅 它是如何运作的 部分。
如果在编辑和保存文档后，返回到包含更改数据的文件的 changesurl 链接，请通过此链接下载文件，并在 changesurl 参数中发送文件URL。 文档上一版本的绝对 URL 地址必须在 previous.url 参数中发送。
docEditor.setHistoryData({
"changesUrl": "https://example.com/url-to-changes.zip",
"fileType": "docx",
"key": "Khirz6zTPdfd7",
"previous": {
"fileType": "docx",
"key": "af86C7e71Ca8",
"url": "https://example.com/url-to-the-previous-version-of-the-document.docx"
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjaGFuZ2VzVXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tY2hhbmdlcy56aXAiLCJmaWxlVHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwicHJldmlvdXMiOnsiZmlsZVR5cGUiOiJkb2N4Iiwia2V5IjoiYWY4NkM3ZTcxQ2E4IiwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tdGhlLXByZXZpb3VzLXZlcnNpb24tb2YtdGhlLWRvY3VtZW50LmRvY3gifSwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1kb2N1bWVudC5kb2N4IiwidmVyc2lvbiI6Mn0.ril3Ol3rvYne3g0dG8TdKCiwJ7-7kkYGc6-XWMvp8FU",
"url": "https://example.com/url-to-example-document.docx",
"version": 2
});
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息，请参阅 它是如何运作的 部分。
发送错误消息，说明文档版本无法显示的原因。
docEditor.setHistoryData({
"error": "Exception",
"version": 2
});
| 参数 | 描述 | 类型 | 出现 |
| changesUrl | 定义带有文档更改数据的文件的url地址，可以通过 changesurl 链接从保存文档后返回的 JSON对象 中下载。 文件请求使用由文档服务器检查的令牌进行签名。 | string | 可选的 |
| error | 定义错误消息文本。 | string | 可选的 |
| fileType | 定义使用 url 参数指定的文档的扩展名。 | string | 可选的 |
| key | 定义文档标识符，用于明确标识文档文件。 | string | 必需的 |
| previous | 如果在保存文档后返回 changesUrl 地址，则定义上一版本文档的对象。 | 对象 | 可选的 |
| previous.fileType | 定义使用 previous.url 参数指定的文档的扩展。 | string | 可选的 |
| previous.key | 定义文档先前版本的文档标识符。 | string | 必需的 |
| previous.url | 定义上一版本文档的 url 地址。 | string | 必需的 |
| token | 定义以 令牌形式添加到参数的加密签名。 | string | 可选的 |
| url | 定义当前文档版本的 url 地址。 可以从保存文档后返回的 JSON 对象中的 url 链接下载。 使用本地链接时请务必添加 令牌。 否则会出现错误。 | string | 必需的 |
| version | 定义文档版本号。 | integer | 必需的 |
setMailMergeRecipients - 将邮件合并的收件人数据插入文件中。 此方法必须在 onRequestMailMergeRecipients 事件之后调用。 自版本 7.5 起已弃用，请改用 setRequestedSpreadsheet。
docEditor.setMailMergeRecipients({
"fileType": "xlsx",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLXJlY2lwaWVudHMueGxzeCJ9.P3TjOyX1Tv3xAVRAc8qtNb-uFLD6FH_WErag_rbI6nQ",
"url": "https://example.com/url-to-example-recipients.xlsx"
});
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息，请参阅 它是如何运作的 部分。
| 参数 | 描述 | 类型 | 出现 |
| fileType | 定义文件中邮件合并的电子表格类型。 可以是：csv、 fods、 ods、 ots、 xls、 xlsm、 xlsx、 xlt、 xltm、 xltx。 | string | 必需的 |
| token | 定义以 令牌形式添加到参数的加密签名。 | string | 可选的 |
| url | 定义存储源数据的绝对 URL。 使用本地链接时请务必添加 令牌。否则会出现错误。 | string | 必需的 |
setReferenceData - 通过指向文件的链接刷新数据, 该链接使用 referenceData、path 或 link 参数指定。 此方法必须在 onRequestReferenceData 事件之后调用。
docEditor.setReferenceData({
"fileType": "xlsx",
"path": "sample.xlsx",
"referenceData": {
"fileKey": "BCFA2CED",
"instanceId": "https://example.com",
"key": "Khirz6zTPdfd7"
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJwYXRoIjoic2FtcGxlLnhsc3giLCJyZWZlcmVuY2VEYXRhIjp7ImZpbGVLZXkiOiJCQ0ZBMkNFRCIsImluc3RhbmNlSWQiOiJodHRwczovL2V4YW1wbGUuY29tIn0sInVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQueGxzeCJ9.UXosmM-E_Cu9j9QGSlcj9FEoSu5m-zCS4b6FxO_2k7w",
"url": "https://example.com/url-to-example-document.xlsx"
});
其中，example.com 是安装了文档管理器 和文档存储服务 的服务器的名称。 请参阅它是如何运作的部分以了解有关文档服务器服务的客户端-服务器交互的更多信息。
显示错误消息，说明是否有错误发生：
docEditor.setReferenceData({
"error": "Exception",
});
| 参数 | 描述 | 类型 | 出现 |
| error | 定义错误消息文本。 | string | 可选的 |
| fileType | 定义用 url 参数指定的文档的扩展名。 | string | 可选的 |
| path | 定义公式编辑器的文件名或相对路径。 它用于在执行onRequestReferenceData 事件时识别文件。 | string | 必需的 |
| referenceData |
定义由集成商生成的对象，用于唯一标识其系统中的文件。
此数据必须与 document.referenceData 配置参数中的相同：
|
object | 可选的 |
| token | 定义以 token 形式添加到参数的加密签名。 | string | 可选的 |
| url | 定义下载当前文件的 URL 地址。 | string | 必需的 |
setReferenceSource - 更改外部数据源。 该方法可以在 onRequestReferenceSource 事件之后调用。
docEditor.setReferenceSource({
"fileType": "xlsx",
"path": "sample.xlsx",
"referenceData": {
"fileKey": "BCFA2CED",
"instanceId": "https://example.com",
"key": "Khirz6zTPdfd7"
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJwYXRoIjoic2FtcGxlLnhsc3giLCJyZWZlcmVuY2VEYXRhIjp7ImZpbGVLZXkiOiJCQ0ZBMkNFRCIsImluc3RhbmNlSWQiOiJodHRwczovL2V4YW1wbGUuY29tIn0sInVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQueGxzeCJ9.UXosmM-E_Cu9j9QGSlcj9FEoSu5m-zCS4b6FxO_2k7w",
"url": "https://example.com/url-to-example-document.xlsx"
});
其中 example.com 是安装文档管理器和文档存储服务的服务器的名称。 请参阅 工作原理 部分，了解有关文档服务器服务客户端与服务器交互的更多信息。
显示一条错误消息，解释是否发生任何错误：
docEditor.setReferenceSource({
"error": "Exception",
});
| 参数 | 描述 | 类型 | 存在 |
| error | 定义错误消息文本。 | string | 可选的 |
| fileType | 定义使用 url 参数指定的文档的扩展名。 | string | 可选的 |
| path | 定义公式编辑器的文件名或相对路径。 用于在执行 onRequestReferenceSource 事件时识别文件。 | string | 必需的 |
| referenceData |
定义由集成器生成的对象，用于唯一标识其系统中的文件。
此数据必须与 document.referenceData 配置参数中的数据相同：
|
object | 可选的 |
| token | 以 令牌 的形式定义添加到参数的加密签名。 | string | 可选的 |
| url | 定义下载当前文件的 URL 地址。 | string | 必需的 |
setRequestedDocument** - 选择要比较或合并的文档。 此方法必须在 onRequestSelectDocument 事件之后调用。
docEditor.setRequestedDocument({
"c": "compare",
"fileType": "docx",
"url": "https://example.com/url-to-example-document.docx",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6ImRvY3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.t8660n_GmxJIppxcwkr_mUxmXYtE8cg-jF2cTLMtuk8"
});
其中 example.com 是安装文档管理器和文档存储服务的服务器的名称。 请参阅 工作原理 部分，了解有关文档服务器服务客户端与服务器交互的更多信息。
| 参数 | 描述 | 类型 | 存在 |
| c | 定义从事件中选择的文档类型。 可以是：compare、combine。 默认值为"compare"。 | string | 必需的 |
| fileType | 您定义要选择的文档的类型。 可以是：doc、docm、docx、dot、dotm、dotx、epub、fodt、odt、ott、rtf，wps。 | string | 必需的 |
| token | 以 令牌 的形式定义添加到参数的加密签名。 | string | 可选的 |
| url | 定义存储源文档的绝对 URL。 使用本地链接时，请务必添加 令牌。 否则会出现错误。 | string | 必需的 |
setRequestedSpreadsheet - 将邮件合并的收件人数据插入到文件中。 必须在 onRequestSelectSpreadsheet 事件之后调用此方法。
docEditor.setRequestedSpreadsheet({
"c": "mailmerge";
"fileType": "xlsx",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLXJlY2lwaWVudHMueGxzeCJ9.P3TjOyX1Tv3xAVRAc8qtNb-uFLD6FH_WErag_rbI6nQ",
"url": "https://example.com/url-to-example-recipients.xlsx"
});
其中 example.com 是安装文档管理器和文档存储服务的服务器的名称。 请参阅 工作原理 部分，了解有关文档服务器服务客户端与服务器交互的更多信息。
| 参数 | 描述 | 类型 | 存在 |
| c | 定义从事件中选择的电子表格类型。 可以是mailmerge。 | string | 必需的 |
| fileType | 定义文件中邮件合并的电子表格类型。 可以是：csv、fods、ods、ots、xls、xlsm、xlsx、xlt、xltm、xltx。 | string | 必需的 |
| token | 定义以 令牌 形式添加到参数的加密签名。 | string | 可选的 |
| url | 定义存储源数据的绝对 URL。 使用本地链接时，请务必添加 令牌。 否则会出现错误。 | string | 必需的 |
setRevisedFile** - 选择一个文档进行比较。 此方法必须在 onRequestCompareFile 事件之后调用。 自版本 7.5 起已弃用，请改用 setRequestedDocument。
docEditor.setRevisedFile({
"fileType": "docx",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6ImRvY3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.t8660n_GmxJIppxcwkr_mUxmXYtE8cg-jF2cTLMtuk8",
"url": "https://example.com/url-to-example-document.docx"
});
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息，请参阅 它是如何运作的 部分。
| 参数 | 描述 | 类型 | 出现 |
| fileType | 定义要比较的文档类型。 可以是：doc、 docm、 docx、 dot、 dotm、 dotx、 epub、 fodt、 odt、 ott、 rtf、 wps. | string | 必需的 |
| token | 定义以 令牌形式添加到参数的加密签名。 | string | 可选的 |
| url | 定义存储源文档的绝对 URL。 使用本地链接时请务必添加 令牌。否则会出现错误。 | string | 必需的 |
setSharingSettings - 更新有关允许与其他用户共享文档的设置的 信息。 该方法可以在 onRequestSharingSettings 事件之后调用。
docEditor.setSharingSettings({
"sharingSettings": [
{
"permissions": "Full Access",
"user": "John Smith"
},
{
"isLink": true,
"permissions": "Read Only",
"user": "External link"
}
]
});
| 参数 | 描述 | 类型 | 出现 |
| sharingSettings | 定义允许与其他用户共享文档的设置。 | 对象数组 | 可选的 |
| sharingSettings.permissions | 定义具有上述名称的用户的访问权限。 | string | 可选的 |
| sharingSettings.user | 定义将与之共享文档的用户的名称。 | string | 可选的 |
setUsers - 设置用户列表,用以在评论中提及、授予编辑特定工作表范围的访问权限，或设置用户头像。 此方法必须在 onRequestUsers 事件之后调用。
docEditor.setUsers({
"c": "protect",
"users": [
{
"email": "john@example.com",
"id": "78e1e841",
"image": "https://example.com/url-to-user-avatar1.png",
"name": "John Smith"
},
{
"email": "kate@example.com",
"id": "F89d8069ba2b",
"image": "https://example.com/url-to-user-avatar2.png",
"name": "Kate Cage"
},
...
]
});
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息，请参阅 它是如何运作的 部分。
| 参数 | 描述 | 类型 | 出现 |
| c | 定义 onRequestUsers 事件的操作类型。 它可以采用以下值之一 - mention、protect或info。 默认值为mention。 | string | 必需的 |
| users | 定义用户列表。 | 字符串数组 | 可选的 |
| users.email | 定义用户的电子邮件地址。仅当 c 参数为 mention 时才使用此字段。 | string | 必需的 |
| users.id | 定义用户的身份。仅当c参数为protect时才使用该字段。 | string | 必需的 |
| users.image | 定义用户头像的路径。 仅当c参数为info时才使用此字段。 | string | 必需的 |
| users.name | 定义用户的全名。 | string | 必需的 |
showMessage - 显示带有消息的工具提示。 该方法只能在 onAppReady 事件之后调用。
docEditor.showMessage(message);
| 参数 | 描述 | 类型 | 出现 |
| message | 定义消息文本。 | string | 必需的 |