Kap.regPluginBlock

Синтаксис

regPluginBlock({

    settings

});

Параметры

settings. JSON-объект с параметрами для регистрации плагина.

Доступны следующие параметры:

Имя параметра Тип Краткое описание
Обязательные параметры:
Id string Идентификатор блока плагина.
Name string Наименование блока плагина.
View string Имя класса визуализатора.
Master string Имя класса мастера.
Js string Путь к *.js-файлу для динамической загрузки скрипта с реализацией плагина.
Необязательные параметры:
Icon string Путь к пиктограмме (16*16) для плагина.
SourceClass number Значение типа объектов источника данных для фильтрации объектов при выборе источника.
По умолчанию задано значение 2827 - «Анализ временных рядов». Если значение не задано(null) или равно «-1», то плагин не использует источник данных.
Props object Дополнительные параметры плагина для установки значений по умолчанию.

Описание

Метод regPluginBlock осуществляет регистрацию плагина аналитической панели.

Комментарии

Используется для подключения плагина к аналитической панели в веб-приложении.

Для регистрации плагина:

  1. Убедитесь, что *.js файл плагина не содержит блок регистрации.

  2. Откройте аналитическую панель в веб-приложении.

  3. Выполните метод Kap.regPluginBlock в консоли браузера:

Kap.regPluginBlock({
    Id: "SOURCELABEL", //id, по которому происходит связка плагин-блока с его реализацией
    Name: "Sourcelabel", //наименование типа блока
    View: "PP.Ui.MyLabel", //класс визуализатора или имя класса визуализатора
    Master: "PP.Ui.MyMaster", //класс мастера или имя класса мастера
    Icon: "../build/img/app/MainIcon.png", //путь к пиктограмме (16*16) для плагина, необязательный параметр
    SourceClass: 2561, //код класса источника данных, если не задан, то КАП не предоставляет плагину источник
    Js: "http://test/fp_App_v10.x/plugins/SourceLabel.js " //для динамической загрузки скрипта с реализацией плагина

});

После выполнения действий плагин будет зарегистрирован в веб-приложении и подключен в момент вызова метода.

Важно. При регистрации плагина все изменения настроек аналитической панели действительны до обновления страницы браузера.

Пример

Использование метода приведено в разделе «Комментарии».

См. также:

Kap