Plugin object
Основной код плагина размещается в файле .js, который описывает, что и как должен делать плагин. Этот файл размещается в корневой папке плагина вместе с файлами config.json и index.html.
Как это работает
Любой плагин имеет объект window.Asc.plugin, который, в свою очередь, имеет несколько методов для взаимодействия с редакторами документов, таблиц и презентаций ONLYOFFICE.
Основной код плагина размещается в файле .js, который описывает, что и как должен делать плагин. Этот файл размещается в корневой папке плагина вместе с файлами config.json и index.html.
Как это работает
Любой плагин имеет объект window.Asc.plugin, который, в свою очередь, имеет несколько методов для взаимодействия с редакторами документов, таблиц и презентаций ONLYOFFICE.
Обратите внимание, что начиная с версии 7.1, доступ к объектам window и document, а также к функции alert ограничен из кода команд плагина, поскольку для скриптов плагина был применен режим "use strict". Не забудьте объявить переменные перед их использованием, чтобы плагины работали корректно.
Для работы плагина разработчик должен указать два обязательных события для объекта window.Asc.plugin: window.Asc.plugin.init и window.Asc.plugin.button. После этого метод window.Asc.plugin.callCommand используется для отправки данных в редакторы с использованием встроенных функций API ONLYOFFICE Document Builder.
Если плагин работает с OLE-объектом, метод window.Asc.plugin.callCommand используется для его управления.
Давайте посмотрим, как это делается в плагине helloworld.js:
Если плагин работает с OLE-объектом, метод window.Asc.plugin.callCommand используется для его управления.
Давайте посмотрим, как это делается в плагине helloworld.js:
Когда объект плагина инициализируется (window.Asc.plugin.init = function () {...}), редактор формирует абзац с фразой "Hello World" и затем использует API ONLYOFFICE Document Builder для создания документа с этим текстом (с помощью метода window.Asc.plugin.callCommand - this.callCommand(function() {...})).
Обратите внимание, что все функции ONLYOFFICE Document Builder уже включены во все версии (включая открытую версию) редакторов документов ONLYOFFICE, вот как плагины взаимодействуют с редакторами. Однако, автономная версия ONLYOFFICE Document Builder требуется, если вы хотите создавать документы без использования редакторов документов.
Единственная кнопка OK (window.Asc.plugin.button = function (id) {...}) используется для создания текста и завершения работы с плагином.
Больше примеров существующих открытых плагинов можно найти здесь.
Больше примеров существующих открытых плагинов можно найти здесь.