跳到主要内容

插件

plugins 部分定义运行时插件参数。

autostart​

类型： string[]

在编辑器打开时自动启动的 config.json 文件中的插件标识符。插件按列出的顺序依次运行。

示例: ["asc.{7327FC95-16DA-41D9-9AF2-0E7F449F6800}"]

disable​

类型： string[]

config.json 文件中在加载时将被禁用的插件标识符。指定的插件将被阻止加载，并且在编辑器界面中不可用。

示例: ["asc.{7327FC95-16DA-41D9-9AF2-0E7F449F6800}"]

options​

类型： object

插件的外部配置设置。设置可以针对所有插件或特定插件——例如传递授权令牌。

备注

您还可以使用 Automation API 的 SetPluginsOptions 方法将此对象传递给插件。

示例:

{
  "all": {},
  "pluginGuid": {}
}

options.all​

类型： object

应用于所有插件的参数。

示例:

{
  "all": {
    "keyAll": "valueAll"
  }
}

options.pluginGuid​

类型： object

特定插件的参数，通过 asc.{UUID} 格式的 GUID 标识。

示例:

{
  "asc.{38E022EA-AD92-45FC-B22B-49DF39746DB4}": {
    "keyYoutube": "valueYoutube"
  }
}

pluginsData​

类型： string[]

插件 config.json 文件的绝对 URL。

示例: ["https://example.com/plugins/chess-plugin/config.json"]

插件插件

示例​

const config = {
  // ...
  editorConfig: {
    // ...
    plugins: {
      autostart: [
        "asc.{7327FC95-16DA-41D9-9AF2-0E7F449F6800}",
      ],
      disable: [
        "asc.{CFE4BE46-3F85-4B79-B96E-B5AAF0EC9BC3}",
      ],
      options: {
        "all": {
          keyAll: "valueAll",
        },
        "asc.{38E022EA-AD92-45FC-B22B-49DF39746DB4}": {
          keyYoutube: "valueYoutube",
        },
      },
      pluginsData: [
        "https://example.com/plugins/chess-plugin/config.json",
      ],
    },
  },
};

const docEditor = new DocsAPI.DocEditor("placeholder", config);

此处的 example.com 表示安装文档管理器和文档存储服务以及插件的服务器名称。要深入了解ONLYOFFICE 文档服务的客户端-服务器交互机制，请参阅工作原理章节。