Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы документов
Редакторы документов
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
ВКС и мессенджер
ВКС и мессенджер
Мобильные редакторы
Мобильные редакторы
Почтовый сервер
Почтовый сервер
Органайзер
Органайзер
Сервер лицензирования
Сервер лицензирования
Файл-Экспресс
Файл-Экспресс
Аналитика
Аналитика
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

config.json

Обновлено: 20.11.26

Инструкция актуальна для версий продукта: 2026.3.1.3296 – 2026.3.1.3906

config.json лежит в корне папки плагина и описывает плагин: название, идентификатор, в каких редакторах он работает, как выглядит его окно и какие данные он получает. Редактор читает файл при открытии документа: после правки config.json откройте новый документ.

Пример

{
    "name": "My plugin",
    "nameLocale": { "ru": "Мой плагин" },
    "guid": "asc.{6C8E0A2B-4D5F-4E7A-9B1C-3D5E7F9A1B2C}",
    "version": "1.0.0",
    "variations": [{
        "description": "My plugin",
        "descriptionLocale": { "ru": "Мой плагин" },
        "url": "index.html",
        "icons": ["resources/icon.png", "resources/icon@2x.png"],
        "EditorsSupport": ["word", "cell", "slide"],
        "isVisual": true,
        "isModal": true,
        "isInsideMode": false,
        "initDataType": "text",
        "initData": "",
        "size": [420, 260],
        "buttons": [
            { "text": "OK", "textLocale": { "ru": "Принять" }, "primary": true },
            { "text": "Cancel", "textLocale": { "ru": "Отмена" }, "primary": false }
        ],
        "events": []
    }]
}

Логические значения задавайте без кавычек: true и false, а не "true".

Параметры плагина

ПараметрТипОбязательныйОписание
nameстрокадаНазвание плагина: надпись кнопки на вкладке «Плагины», подсказка кнопки и заголовок окна плагина.
nameLocaleобъектнетПереводы названия, ключ — код языка: { "ru": "Мой плагин" }. Если перевода для языка интерфейса нет, берётся "en", затем name.
guidстрокадаИдентификатор плагина в формате asc.{UUID}. У каждого плагина свой.
versionстроканетВерсия плагина в формате X.Y.Z. Если два плагина с одним guid, редактор использует более новую версию.
minVersionстроканетМинимальная версия редактора. В Десктоп редакторах 2026.3.1 не действует: плагин показывается при любом значении.
baseUrlстроканетАдрес папки плагина. В config.json установленного плагина не указывается; обязателен в объекте для методов InstallPlugin ↗ и UpdatePlugin ↗.
groupобъектнетГруппа кнопки на вкладке «Плагины»: { "name": "Имя группы", "rank": 1 }. rank задаёт порядок групп.
variationsмассив объектовдаВариации плагина. Первая — основное окно, остальные — дополнительные окна, например «О программе» или настройки.

Параметры вариации

ПараметрТипПо умолчаниюОписание
urlстрока—Обязательный. HTML-файл плагина относительно его папки, обычно index.html ↗.
descriptionстрока—Описание вариации.
descriptionLocaleобъект—Переводы описания, как nameLocale.
EditorsSupportмассив строк—Редакторы, в которых доступна вариация: "word" — документы, "cell" — таблицы, "slide" — презентации.
iconsмассив строк—Иконки кнопки: ["resources/icon.png", "resources/icon@2x.png"] — для обычного экрана и для масштаба 200%.
icons2массив—Расширенное описание иконок (разные масштабы и темы). Если задан, используется вместо icons. Подробнее — в статье «Иконки плагина» ↗.
helpстрока—Адрес справки. Если задан, в заголовке окна плагина появляется кнопка «?».
isVisualлогическое—true — у плагина есть окно или панель. false — плагин работает в фоне без интерфейса; так делаются, например, плагины с помощником ввода.
isModalлогическоеfalsetrue — пока окно открыто, документ недоступен. false — с документом можно работать при открытом окне.
isInsideModeлогическоеfalsetrue — плагин открывается на панели слева, а не в отдельном окне.
sizeмассив [ширина, высота]—Размер области окна плагина в пикселях, без заголовка и кнопок.
buttonsмассив объектовOK и CancelКнопки внизу окна, см. таблицу ниже ↗. Нажатие приходит в обработчик button(id), id — номер кнопки с 0. Чтобы кнопок не было, укажите пустой массив.
initDataTypeстрока"none"Что редактор передаёт в init при запуске: "none" — значение initData; "text" — выделенный текст; "html" — выделенный фрагмент в HTML с оформлением; "ole" — данные OLE-объекта плагина.
initDataстрока""Данные для init при initDataType "none"
initOnSelectionChangedлогическоеfalsetrue — при каждой смене выделения редактор снова вызывает init с новыми данными. Имеет смысл для немодальных окон и панелей.
eventsмассив строк[]События редактора, которые получает плагин. Список событий — в статье «События» ↗.
isViewerлогическоеfalsetrue — плагин доступен, когда документ открыт только для просмотра.
isDisplayedInViewerлогическоеtruefalse — не показывать кнопку плагина в режиме просмотра, даже если isViewer равен true.
isSystemлогическоеfalsetrue — системный плагин: кнопки на вкладке нет, плагин запускается автоматически при открытии документа.
isUpdateOleOnResizeлогическоеfalseДля плагинов с OLE-объектами: true — при изменении размера объекта редактор запускает плагин, чтобы тот перерисовал объект.

Параметры кнопки

ПараметрТипОписание
textстрокаНадпись на кнопке.
textLocaleобъектПереводы надписи: { "ru": "Принять" }.
primaryлогическоеtrue — основная кнопка, выделена цветом.
isViewerлогическоеfalse — скрывать кнопку в режиме просмотра.

Параметры плагинов шифрования

Параметры cryptoMode, cryptoDisabledOnStart, cryptoDisabledForInternalCloud и cryptoDisabledForExternalCloud относятся только к плагинам сквозного шифрования. Обычным плагинам их указывать не нужно.

Была ли эта статья полезной?

Поделитесь пожалуйста своим мнением

      В статье есть ошибкиРекомендации не помоглиТекст трудно понятьСодержание статьи не соответствует заголовкуДругое