Описание
Файл config.json — это файл конфигурации плагина, содержащий информацию об основных данных плагина, необходимых для регистрации плагина в редакторах.
- guid
- version
- minVersion
- help
- name
- nameLocale
- variations
- buttons
- description
- descriptionLocale
- EditorsSupport
- icons
- initData
- initDataType
- initOnSelectionChanged
- cryptoMode
- isDisplayedInViewer
- isInsideMode
- isModal
- isCustomWindow
- isSystem
- isUpdateOleOnResize
- isViewer
- isVisual
- url
- size
- events
- cryptoDisabledForInternalCloud
- cryptoDisabledForExternalCloud
- cryptoDisabledOnStart
Параметры
| Название | Описание | Тип | Пример |
|---|---|---|---|
| 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 и т.д.), значения — перевод названия. | объект | |
| variations | Субплагины, создаваемые внутри исходного плагина. | массив объектов | |
| variations.description | Описание плагина. | строковый | «plugin description» |
| variations.EditorsSupport | Редакторы, для которых доступен плагин (word, ячейка, слайд). | массив строк | |
| variations.initData | Данные, отправляемые из редактора в плагин при запуске. | строковый | «» |
| variations.initDataType | Тип данных, отправляемых в плагин (text, html, ole, none и др.). | строковый | «ole» |
| variations.isVisual | Указывает, является ли плагин визуальным. | логический | true |
| variations.url | Точка входа плагина (HTML-файл, подключающий plugin.js). | строковый | «index.html» |
| variations.events | События плагина, используемые в коде. | массив строк | [«onClick», «onDocumentContentReady»] |
| 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"
}
]
}
