Описание
Файл config.json — это файл конфигурации плагина, содержащий информацию об основных данных плагина, необходимых для регистрации плагина в редакторах.
| Название |
Описание |
Тип |
Пример |
| baseUrl |
Путь к плагину. Все остальные пути рассчитываются относительно этого пути. В случае, если плагин установлен на сервере, туда добавляется дополнительный параметр (путь к плагинам). Если baseUrl == «», будет использоваться путь ко всем плагинам. |
строковый |
«» |
| guid |
Идентификатор плагина. Он должен быть типа asc.{UUID}. |
строковый |
«asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}» |
| minVersion |
Минимальная поддерживаемая версия редактора. |
строковый |
«6.3.0» |
| version |
Версия плагина. |
строковый |
«1.0» |
| help |
Путь к странице описания плагина. Если параметр указан, в окне плагина отображается кнопка помощи. Когда пользователь нажимает кнопку, он переходит по ссылке на страницу описания плагина. |
строковый |
«» |
| name |
Имя плагина, которое будет отображаться на панели инструментов плагина. |
строковый |
«plugin name» |
| nameLocale |
Переводы поля имени. Ключи объектов — это двухбуквенные коды языков (ru, de, it и т. д.), а значения — это перевод названия плагина для каждого языка. |
объект |
|
| variations |
Вариации плагинов или субплагины, которые создаются внутри исходного плагина. Более подробную информацию вы можете найти здесь. |
массив объектов |
|
| variations.buttons |
Список кнопок плагинов с изменяемым оформлением, используемых в интерфейсе плагина (используется только для визуальных плагинов с собственным окном, т. е. isVisual == true && isInsideMode == false). Объект кнопки может иметь следующие параметры:
- текст — метка, которая отображается на кнопке,
тип: строковый,
пример: «Cancel»;
- primary — определяет, является ли кнопка основной или нет. Основной флаг влияет только на оформление кнопки,
тип: логический,
пример: true;
- isViewer -определяет, будет ли кнопка отображаться только в режиме просмотра или нет,
тип: логический,
пример: false;
- textLocale — переводы для текстового поля. Ключи объектов — это двухбуквенные коды языков (ru, de, it и т. д.), а значения — перевод меток кнопок для каждого языка.
тип: объект
|
массив объектов |
|
| variations.description |
Описание, то есть то, что лучше всего описывает ваш плагин. |
строковый |
«plugin description» |
| variations.descriptionLocale |
Переводы для поля описания. Ключи объектов — это двухбуквенные коды языков (ru, de, it и т. д.), а значения — это перевод описания плагина для каждого языка. |
объект |
|
| Редакторы, для которых доступен плагин (word — редактор текстовых документов, ячейка — редактор электронных таблиц, слайд — редактор презентаций). |
массив строк |
|
| variations.icons |
Файлы изображений значков плагинов, используемые в редакторах. Более подробную информацию вы можете найти здесь. |
массив строк |
|
| variations.initData |
Обычно равен «» — это данные, которые отправляются из редактора в плагин при запуске плагина (например, если initDataType == «text», плагин при запуске получит выделенный текст). Это также может быть эквивалентно шифрованию в плагинах шифрования. |
строковый |
«» |
| variations.initDataType |
Тип данных, выбираемый в редакторе и отправляемый в плагин: text — текстовые данные, html — код в формате HTML, ole — данные объекта OLE, desktop — данные десктопного редактора, destop-external — данные главной страницы десктопного приложения (системные сообщения), none — в плагин не будут отправляться данные из редактора. |
строковый |
«ole» |
| variations.initOnSelectionChanged |
Указывает, отслеживает ли плагин события выделения текста в окне редактора. |
логический |
true |
| variations.cryptoMode |
Идентификатор плагина шифрования, так как существует несколько плагинов шифрования. |
строковый |
«1» |
| variations.isDisplayedInViewer |
Указывает, будет ли плагин отображаться в режиме просмотра, а также в режиме редактирования (isDisplayedInViewer == true) или только в режиме редактирования (isDisplayedInViewer == false). |
логический |
true |
| variations.isInsideMode |
Указывает, должен ли плагин отображаться внутри панели редактора вместо собственного окна. |
логический |
true |
| variations.isModal |
Указывает, является ли открытое окно плагина модальным (используется только для визуальных плагинов, и если isInsideMode не равно true). |
логический |
true |
| variations.isCustomWindow |
Указывает, использует ли плагин пользовательское окно без стандартных полей и кнопок (используется только для модальных плагинов). |
логический |
true |
| variations.isSystem |
Указывает, если плагин не отображается в интерфейсе редактора и запускается в фоновом режиме с сервером (или запускаются десктопные редакторы), не мешая другим плагинам, чтобы они могли работать одновременно. |
логический |
false |
| variations.isUpdateOleOnResize |
Указывает, должен ли объект OLE перерисовываться при изменении размера в редакторе с использованием типа рисования векторного объекта или нет (используется только для объектов OLE, т. е. initDataType == «ole»). |
boolean |
true |
| variations.isViewer |
Указывает, работает ли плагин, когда документ доступен только в режиме просмотра или нет. Значение по умолчанию false. |
логический |
false |
| variations.isVisual |
Указывает, является ли плагин визуальным (откроет окно для какого-либо действия или внесет некоторые дополнения в интерфейс панели редактора) или невизуальным (предоставит кнопку (или кнопки), которая будет применять некоторые преобразования или манипуляции к документу). |
логический |
true |
| variations.url |
Точка входа плагина, т.е. файл HTML, который подключает файл plugin.js (базовый файл, необходимый для работы с плагинами) и запускает код плагина. См. раздел index.html для получения подробной информации. |
строковый |
«index.html» |
| variations.size |
Размер плагинного окна. |
массив целых чисел |
|
| variations.events |
События плагина? |
массив строк |
|
| variations.cryptoDisabledForInternalCloud |
Указывает, отключено ли шифрование для облаков Р7. |
строковый |
«true» |
| variations.cryptoDisabledForExternalCloud |
Указывает, отключено ли шифрование для сторонних облаков. |
строковый |
«true» |
| variations.cryptoDisabledOnStart |
Указывает, сбрасывается ли режим при перезапуске или нет. |
строковый |
«true» |
{
"baseUrl": "",
"guid": "asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
"version": "1.0",
"minVersion": "6.3.0",
"help": "",
"name": "plugin name",
"nameLocale": {
"fr": "french plugin name",
"es": "spanish plugin name"
},
"variations": [
{
"buttons": [
{
"text": "Cancel",
"primary": false,
"isviewer": false,
"textLocale": {
"fr": "Annuler",
"es": "Cancelar"
}
}
],
"description": "plugin description",
"descriptionLocale": {
"fr": "french plugin description",
"es": "spanish plugin description"
},
"EditorsSupport": ["word", "cell", "slide"],
"icons": [
{
"100%": { "normal": "icon.png" },
"125%": { "normal": "icon@1.25.png" },
"150%": { "normal": "icon@1.5x.png" },
"175%": { "normal": "icon@1.75.png" },
"200%": { "normal": "icon@2x.png" }
},
{
"style" : "dark"
}
],
"initData": "",
"initDataType": "ole",
"initOnSelectionChanged": true,
"cryptoMode": "1",
"isDisplayedInViewer": true,
"isInsideMode": false,
"isModal": true,
"isCustomWindow": true,
"isSystem": false,
"isUpdateOleOnResize": true,
"isViewer": true,
"isVisual": false,
"url": "index.html",
"size": [600, 700],
"events": ["onClick"],
"cryptoDisabledForInternalCloud": "true",
"cryptoDisabledForExternalCloud": "true",
"cryptoDisabledOnStart": "true"
}
]
};
|
