Перейти к содержанию

Описание манифеста

Описание параметров на примере блока "Таблица"
{
    "name": "Таблица",
    "id": "8e8f4eae-f950-4b7a-a0dd-e7867a90dc06",
    "desc": "Таблица",
    "package": "vmtables",
    "module": "table",
    "version": 32,
    "visualizer": 1,
    "preset": 1,
    "presetWizard": 1,
    "customInputs": 1,
    "customInputTypes": [
        "object"
    ],
    "type": "timeseriestable",
    "settings": [
        ...
    ],
    "inputs": [
        ...
    ],
    "outputs": [
        ...
    ],
    "settingsRules": [
        ...
    ],
    "style": {
        "icon": "fas fa-table"
    },
    "_name_locale_id": "$G_TABLE_NAME",
    "_desc_locale_id": "$G_TABLE_DESC"
}

Описание параметров манифеста

name

(Строка, Обязательный)

Наименование типа блока.

Пример
"name": "Таблица"
Визуальное отображение на графе

img.png


desc

(Строка, Обязательный)

Описание типа блока. Всплывающая подсказка при наведении мышки на название блока.

Пример
"desc": "Таблица"
Визуальное отображение на графе

img.png


tag

(Строка, Обязательный)

Уникальное наименование блока

Важная информация

Если пользовательский блок является визуализатором, то:

- ОБЯЗАТЕЛЬНО должен быть - (минус) в названии тега
- нижнее подчеркивание (_) использовать ЗАПРЕЩЕНО
Пример
"tag": "vismind-table"

package

(Строка, Обязательный)

Название пакета, откуда будет вызываться функции для выполнения блока

У пользовательских компонентов в package должно быть указано vmcustom

Пример
"package": "vmtables"

module

(Строка, Обязательный)

Наименование функции, которая будет вызываться из "package" описания блока

У пользовательских компонентов в module должно быть указано python

Пример
"module": "table"

version

(Строка, Обязательный)

Версия блока

Пример
"version": "1.3.2"

versionApp

(Строка, Необязательный)

Версия приложения с которой блок будет использоваться. Если версия не указана, то блок используется во всех версиях

Пример
"versionApp": "1.1.0"

visualizer

(Флаг, Необязательный)

Флаг, отвечающий за то, является ли блок визуализатором.

Значение по умолчанию

"visualizer": 0

Пример
"visualizer": 1

type

(Строка, Необязательный)

Описание типа блока. Задается только для блоков визуализаторов.

Значение по умолчанию

"type": "custom"

Пример
"type": "timeseriestable"

settings

(Список, Обязательный)

Описание настроек блока

Описание формирования настроек описаны в отдельном разделе

Настройки, которые описывать в манифесте не надо, они подставятся автоматически

Разделы "Основные свойства", "Настройки визуализатора" и "Общие настройки блока"

Пример
"settings": [
    {
        "name": "Настройки визуализатора",
        "id": "visualizerSettings",
        "type": "json",
        "desc": "",
        "mandatory": 0,
        "elements": [
            {
                "name": "Заголовок визуализатора",
                "id": "title",
                "type": "string",
                "desc": "",
                "hint": "Возможно формирование заголовка с помощью шаблона Jinja",
                "mandatory": 0,
                "default": "$S_VISUALIZER_SETTINGS_TITLE_DEFAULT",
                "maxlength": 128,
                "_name_locale_id": "$S_VISUALIZER_SETTINGS_TITLE_NAME",
                "_hint_locale_id": "$S_VISUALIZER_SETTINGS_TITLE_HINT"
            }
        ],
        "_name_locale_id": "$S_VISUALIZER_SETTINGS_NAME"
    },
    {
        "name": "Таблица",
        "id": "specificBlockParams",
        "type": "json",
        "desc": "",
        "mandatory": 0,
        "elements": [
            {
                "name": "Привязки",
                "id": "binding",
                "type": "json_str",
                "desc": "Привязки атрибутов объектов",
                "mandatory": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_BINDING_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_BINDING_DESC"
            },
            {
                "name": "Количество знаков после запятой",
                "id": "round",
                "type": "int",
                "desc": "Настройка количества знаков после запятой",
                "mandatory": 0,
                "default": 2,
                "min": 0,
                "max": 15,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_ROUND_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_ROUND_DESC"
            },
            {
                "name": "Использовать системные разделители",
                "id": "useSystemSeparator",
                "type": "bool",
                "desc": "",
                "mandatory": 0,
                "default": 1,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_USE_SYSTEM_SEPARATOR_NAME"
            },
            {
                "name": "Разделитель целой и дробной части",
                "id": "fractionalSeparator",
                "type": "string",
                "hint": "Значение разделителя не должно совпадать с настройкой \"Разделитель разрядов\". По умолчанию используется точка (.)",
                "desc": "",
                "mandatory": 0,
                "default": ".",
                "maxlength": 128,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_FRACTIONAL_SEPARATOR_NAME",
                "_hint_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_FRACTIONAL_SEPARATOR_HINT"
            },
            {
                "name": "Разделитель разрядов",
                "id": "separator",
                "type": "string",
                "hint": "Значение разделителя не должно совпадать с настройкой \"Разделитель целой и дробной части\". По умолчанию используется пробел ( )",
                "desc": "",
                "mandatory": 0,
                "default": " ",
                "maxlength": 128,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SEPARATOR_NAME",
                "_hint_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SEPARATOR_HINT"
            },
            {
                "name": "Поиск и фильтрация",
                "id": "IsSearchAvailable",
                "type": "bool",
                "desc": "Возможность поиска значений в таблице по колонкам",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_IS_SEARCH_AVAILABLE_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_IS_SEARCH_AVAILABLE_DESC"
            },
            {
                "name": "Возможность множественной отметки",
                "id": "isMultiSelect",
                "type": "bool",
                "desc": "Возможность множественной отметки для рядов таблицы",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_IS_MULTI_SELECT_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_IS_MULTI_SELECT_DESC"
            },
            {
                "name": "Выделять ряд целиком",
                "id": "fullRowSelect",
                "type": "bool",
                "desc": "Выделять ряд целиком",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_FULL_ROW_SELECT_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_FULL_ROW_SELECT_DESC"
            },
            {
                "name": "Скрывать данные в таблице",
                "id": "hideTableData",
                "type": "bool",
                "desc": "Скрыть данные в таблице",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_HIDE_TABLE_DATA_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_HIDE_TABLE_DATA_DESC"
            },
            {
                "name": "Скрыть номера строк",
                "id": "hideRowNumbers",
                "type": "bool",
                "desc": "Скрыть номера строк",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_HIDE_ROW_NUMBERS_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_HIDE_ROW_NUMBERS_DESC"
            },
            {
                "name": "Переносить текст",
                "id": "wrapText",
                "type": "bool",
                "desc": "Автоматический перенос текста",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_WRAP_TEXT_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_WRAP_TEXT_DESC"
            },
            {
                "name": "Выравнивание по правому краю",
                "id": "scrollRight",
                "type": "bool",
                "desc": "Выравнивание по правому краю",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SCROLL_RIGHT_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SCROLL_RIGHT_DESC"
            },
            {
                "name": "Отображать иерархию",
                "id": "showHierarchy",
                "type": "enum",
                "desc": "Отображать иерархию",
                "mandatory": 0,
                "default": 0,
                "multiselect": 0,
                "enum": [
                    {
                        "val": 0,
                        "name": "Нет",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_HIERARCHY_0_NAME"
                    },
                    {
                        "val": 1,
                        "name": "Отступы",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_HIERARCHY_1_NAME"
                    },
                    {
                        "val": 2,
                        "name": "Экспандеры",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_HIERARCHY_2_NAME"
                    },
                    {
                        "val": 3,
                        "name": "Экспандеры и отступы",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_HIERARCHY_3_NAME"
                    }
                ],
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_HIERARCHY_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_HIERARCHY_DESC"
            },
            {
                "name": "Раскрывать иерархию при открытии пресета",
                "id": "riseHierarchy",
                "type": "enum",
                "desc": "",
                "mandatory": 0,
                "default": "rise",
                "multiselect": 0,
                "enum": [
                    {
                        "val": "rise",
                        "name": "Раскрыть иерархию",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_RISE_HIERARCHY_RISE_NAME"
                    },
                    {
                        "val": "collapsed",
                        "name": "Свернуть иерархию",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_RISE_HIERARCHY_COLLAPSED_NAME"
                    }
                ],
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_RISE_HIERARCHY_NAME"
            },
            {
                "name": "Отступ иерархии",
                "id": "stepHierarchy",
                "type": "int",
                "desc": "Отступ иерархии",
                "mandatory": 0,
                "default": 4,
                "min": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_STEP_HIERARCHY_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_STEP_HIERARCHY_DESC"
            },
            {
                "name": "Событие по умолчанию",
                "id": "default_event",
                "type": "enum",
                "desc": "Поведение таблицы при вызове события по умолчанию",
                "mandatory": 1,
                "default": 0,
                "multiselect": 0,
                "enum": [
                    {
                        "val": 0,
                        "name": "Отображать первую строку",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_DEFAULT_EVENT_0_NAME"
                    },
                    {
                        "val": 1,
                        "name": "Отображать все элементы",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_DEFAULT_EVENT_1_NAME"
                    },
                    {
                        "val": 2,
                        "name": "Отображать выбранные элементы",
                        "desc": "Отображать элементы, указанные для отображения по умолчанию (поле ниже)",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_DEFAULT_EVENT_2_NAME",
                        "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_DEFAULT_EVENT_2_DESC"
                    }
                ],
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_DEFAULT_EVENT_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_DEFAULT_EVENT_DESC"
            },
            {
                "name": "Выбранные элементы (индексы)",
                "id": "default",
                "type": "json_str",
                "desc": "Строки, которые передаются в события по умолчанию",
                "mandatory": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_DEFAULT_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_DEFAULT_DESC"
            },
            {
                "name": "Отображение страниц",
                "id": "pagination",
                "type": "bool",
                "desc": "Отображение страниц",
                "hint": "Постраничное отображение данных в таблице",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_PAGINATION_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_PAGINATION_DESC",
                "_hint_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_PAGINATION_HINT"
            },
            {
                "name": "Объединение ячеек",
                "id": "mergeCells",
                "type": "bool",
                "desc": "Объединение ячеек",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_MERGE_CELLS_NAME",
                "_desc_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_MERGE_CELLS_DESC"
            },
            {
                "name": "Отображать меню",
                "id": "showToolbar",
                "type": "enum",
                "desc": "",
                "mandatory": 0,
                "default": 1,
                "multiselect": 0,
                "enum": [
                    {
                        "val": 0,
                        "name": "Не отображать",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_TOOLBAR_0_NAME"
                    },
                    {
                        "val": 1,
                        "name": "Отображать все",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_TOOLBAR_1_NAME"
                    },
                    {
                        "val": 2,
                        "name": "Редактирование",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_TOOLBAR_2_NAME"
                    },
                    {
                        "val": 3,
                        "name": "Стили",
                        "desc": "",
                        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_TOOLBAR_3_NAME"
                    }
                ],
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_TOOLBAR_NAME"
            },
            {
                "name": "Транспонирование данных",
                "id": "transpose",
                "type": "bool",
                "desc": "",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_TRANSPOSE_NAME"
            },
            {
                "name": "Сортировка столбцов данных",
                "id": "columnSorting",
                "type": "bool",
                "desc": "",
                "hint": "Возможность сортировки данных",
                "mandatory": 0,
                "default": 1,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_COLUMN_SORTING_NAME",
                "_hint_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_COLUMN_SORTING_HINT"
            },
            {
                "name": "Передавать информацию об отображении таблицы",
                "id": "showVisibleSeries",
                "type": "bool",
                "desc": "",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_VISIBLE_SERIES_NAME"
            },
            {
                "name": "Сохранять выделенные элементы при изменении таблицы",
                "id": "saveSelection",
                "type": "bool",
                "desc": "",
                "hint": "Попытка сохранения отметки при любых изменениях таблицы",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SAVE_SELECTION_NAME",
                "_hint_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SAVE_SELECTION_HINT"
            },
            {
                "name": "Отображать строку с номерами столбцов",
                "id": "showColumnNumbers",
                "type": "bool",
                "desc": "",
                "hint": "Для возможности сортировки и изменения ширины столбцов, если в последней строчке шапки есть объединенные ячейки",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_COLUMN_NUMBERS_NAME",
                "_hint_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_SHOW_COLUMN_NUMBERS_HINT"
            }
        ],
        "_name_locale_id": "$S_SPECIFIC_BLOCK_PARAMS_NAME"
    },
    {
        "name": "Экспорт",
        "id": "export",
        "desc": "Настройки для экспорта файлов",
        "type": "json",
        "mandatory": 0,
        "elements": [
            {
                "name": "Отображать как визуализатор",
                "id": "exportShowVis",
                "type": "bool",
                "desc": "",
                "hint": "Если настройка выключена таблица не будет отображаться на пресете, как правило это нужно для экспорта таблицы без ее отображения",
                "mandatory": 0,
                "default": 1,
                "_name_locale_id": "$S_EXPORT_EXPORT_SHOW_VIS_NAME",
                "_hint_locale_id": "$S_EXPORT_EXPORT_SHOW_VIS_HINT"
            },
            {
                "name": "При экспорте удалять HTML",
                "id": "exportDeleteHTML",
                "type": "bool",
                "desc": "",
                "hint": "Ячейки, содержащие HTML, будут приведены к стандартному формату",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_EXPORT_EXPORT_DELETE_HTML_NAME",
                "_hint_locale_id": "$S_EXPORT_EXPORT_DELETE_HTML_HINT"
            },
            {
                "name": "Выводить заголовок при экспорте",
                "id": "exportShowHeader",
                "type": "bool",
                "desc": "",
                "hint": "На первой строке таблицы будет добавлен заголовок",
                "mandatory": 0,
                "default": 0,
                "_name_locale_id": "$S_EXPORT_EXPORT_SHOW_HEADER_NAME",
                "_hint_locale_id": "$S_EXPORT_EXPORT_SHOW_HEADER_HINT"
            },
            {
                "name": "Текст заголовка",
                "id": "exportHeaderName",
                "type": "string",
                "desc": "",
                "hint": "Возможно формирование заголовка с помощью шаблона Jinja. Параметр: name. Пример: Заголовок таблицы: {{name}}",
                "mandatory": 0,
                "default": "",
                "visible": 1,
                "maxlength": 128,
                "_name_locale_id": "$S_EXPORT_EXPORT_HEADER_NAME_NAME",
                "_hint_locale_id": "$S_EXPORT_EXPORT_HEADER_NAME_HINT"
            },
            {
                "name": "Имя файла",
                "id": "exportFileName",
                "type": "string",
                "desc": "",
                "hint": "Имя файла, получаемого в результате экспорта",
                "mandatory": 0,
                "maxlength": 128,
                "_name_locale_id": "$S_EXPORT_EXPORT_FILE_NAME_NAME",
                "_hint_locale_id": "$S_EXPORT_EXPORT_FILE_NAME_HINT"
            },
            {
                "name": "Удалять скрытые столбцы",
                "id": "exportExcludeHiddenRows",
                "type": "bool",
                "desc": "",
                "hint": "При экспорте будут удалены скрытые столбцы таблицы",
                "mandatory": 0,
                "default": 1,
                "_name_locale_id": "$S_EXPORT_EXPORT_EXCLUDE_HIDDEN_ROWS_NAME",
                "_hint_locale_id": "$S_EXPORT_EXPORT_EXCLUDE_HIDDEN_ROWS_HINT"
            }
        ],
        "_name_locale_id": "$S_EXPORT_NAME",
        "_desc_locale_id": "$S_EXPORT_DESC"
    }
]
Визуальное отображение на графе

settings.png


inputs

(Список, Обязательный)

Описание входов блока

Описание формирования входов описаны в отдельном разделе

Пример
"inputs": [
    {
        "name": "Данные",
        "id": "data",
        "desc": "Данные для отображения в таблице",
        "type": "series",
        "mandatory": 1,
        "array": 1,
        "dynamic": 1,
        "_name_locale_id": "$I_DATA_NAME",
        "_desc_locale_id": "$I_DATA_DESC"
    },
    {
        "name": "Привязки",
        "id": "binding",
        "desc": "Привязки атрибутов объектов",
        "type": "string",
        "mandatory": 0,
        "array": 0,
        "maxlength": 128,
        "_name_locale_id": "$I_BINDING_NAME",
        "_desc_locale_id": "$I_BINDING_DESC"
    },
    {
        "name": "Стили",
        "id": "style",
        "desc": "Стиль таблицы",
        "type": "json",
        "mandatory": 0,
        "array": 0,
        "_name_locale_id": "$I_STYLE_NAME",
        "_desc_locale_id": "$I_STYLE_DESC"
    },
    {
        "name": "Итоги",
        "id": "totals",
        "desc": "Итоги таблицы",
        "type": "json",
        "mandatory": 0,
        "array": 0,
        "_name_locale_id": "$I_TOTALS_NAME",
        "_desc_locale_id": "$I_TOTALS_DESC"
    },
    {
        "name": "Экспорт",
        "id": "export",
        "desc": "",
        "type": "json",
        "mandatory": 0,
        "array": 0,
        "_name_locale_id": "$I_EXPORT_NAME"
    }
]
Визуальное отображение на графе

img.png


outputs

(Список, Обязательный)

Описание выходов блока

Описание формирования выходов описаны в отдельном разделе

Пример
"outputs": [
    {
        "id": "OnSelectionChange",
        "name": "Событие смены выделения",
        "type": "event",
        "mandatory": 0,
        "array": 0,
        "module": "on_selection_change",
        "elements": [
            {
                "name": "Временные ряды",
                "id": "series",
                "desc": "Данные временных рядов",
                "type": "series",
                "mandatory": 1,
                "array": 1,
                "_name_locale_id": "$O_ON_SELECTION_CHANGE_SERIES_NAME",
                "_desc_locale_id": "$O_ON_SELECTION_CHANGE_SERIES_DESC"
            }
        ],
        "_name_locale_id": "$O_ON_SELECTION_CHANGE_NAME"
    },
    {
        "id": "OnTableExport",
        "name": "Событие экспорта",
        "type": "event",
        "mandatory": 1,
        "array": 0,
        "module": "on_table_export",
        "execFromEventInInput": [
            "export"
        ],
        "elements": [
            {
                "name": "Экспорт",
                "id": "export",
                "desc": "",
                "type": "json",
                "mandatory": 1,
                "array": 1,
                "_name_locale_id": "$O_ON_TABLE_EXPORT_EXPORT_NAME"
            }
        ],
        "_name_locale_id": "$O_ON_TABLE_EXPORT_NAME"
    },
    {
        "id": "ExportSettings",
        "name": "Настройки таблицы",
        "type": "json",
        "module": "on_table_export",
        "_name_locale_id": "$O_EXPORT_SETTINGS_NAME"
    }
]
Визуальное отображение на графе

img.png


settingsRules

(Список, Обязательный)

Описание правил для отображения настроек. Можно скрыть одни настройки, которые зависят от других настроек.

Описание формирования правил настроек описаны в отдельном разделе

Пример
"settingsRules": [
    {
        "id": "stepHierarchyShow",
        "name": "Показать иерархию",
        "conditions": {
            "equals": [
                {
                    "id": "specificBlockParams.showHierarchy",
                    "val": 1
                }
            ]
        },
        "results": [
            {
                "id": "specificBlockParams.stepHierarchy",
                "visible": 1
            },
            {
                "id": "specificBlockParams.riseHierarchy",
                "visible": 0
            }
        ]
    },
    {
        "id": "riseHierarchyShow",
        "name": "Отобразить настройки раскрытия иерархии",
        "conditions": {
            "equals": [
                {
                    "id": "specificBlockParams.showHierarchy",
                    "val": 2
                }
            ]
        },
        "results": [
            {
                "id": "specificBlockParams.stepHierarchy",
                "visible": 0
            },
            {
                "id": "specificBlockParams.riseHierarchy",
                "visible": 1
            }
        ]
    },
    {
        "id": "riseHierarchyStepHierarchyShow",
        "name": "Отобразить настройки раскрытия иерархии - оба пункта",
        "conditions": {
            "equals": [
                {
                    "id": "specificBlockParams.showHierarchy",
                    "val": 3
                }
            ]
        },
        "results": [
            {
                "id": "specificBlockParams.stepHierarchy",
                "visible": 1
            },
            {
                "id": "specificBlockParams.riseHierarchy",
                "visible": 1
            }
        ]
    },
    {
        "id": "stepHierarchyHide",
        "name": "Скрыть иерархию",
        "conditions": {
            "equals": [
                {
                    "id": "specificBlockParams.showHierarchy",
                    "val": 0
                }
            ]
        },
        "results": [
            {
                "id": "specificBlockParams.stepHierarchy",
                "visible": 0
            },
            {
                "id": "specificBlockParams.riseHierarchy",
                "visible": 0
            }
        ]
    }
]
Визуальное отображение на графе

При выборе типа отображения иерархии, меняются настройки блока:

img.png img.png img.png img.png


events

(Список, Необязательный)

Описание пользовательских событий. Данное событие можно вызвать с помощью апи. Событие рассчитывается и выдает результат. Блоки, следующие за блоком, не перерассчитываются

Описание формирования пользовательских событий описаны в отдельном разделе

Пример
"events": [
    {
        "id": "OnCheckDate",
        "name": "Проверка даты",
        "type": "event",
        "mandatory": 0,
        "array": 0,
        "module": "event_on_check_date",
        "elements": []
    }
]

style

(JSON, Обязательный)

Описание стиля блока.

Иконку можно выбрать из тех, которые бесплатные (нет приставки PRO) (https://fontawesome.com/search?o=r)

Пример
"style": {
    "icon": "fas fa-table"
}

calc

(Флаг, Необязательный)

Флаг, отвечающий за то, можно запустить блок на расчет по кнопке "старт" на пресете

Специфическая настройка для блоков статистики

Пример
"calc": 0

changeshowinapp

(Флаг, Необязательный)

Флаг, отвечающий за то, что настройки блока можно увидеть на пресете

Пример
"changeshowinapp": 1

component

(Флаг, Необязательный)

Флаг, отвечающий за то, что блок является компонентом. Для такого блока отсутствует часть визуальных настроек

Пример
"component": 1

customInputs

(Флаг, Необязательный)

Флаг, отвечающий за то, что можно добавлять входы блока на графе (у входов появляется знак плюса). Список типов, которые можно создавать, перечисляется в параметре customInputTypes

Пример
"customInputs": 1
Визуальное отображение на графе

img.png


customInputTypes

(Список, Необязательный)

Список типов, которые будут использоваться если включен флаг customInputs

Пример
customInputTypes": [
    "int",
    "string",
    "series",
    "json",
    "bool",
    "float",
    "datetime",
    "date",
    "html",
    "object",
    "xml",
    "dbconnect",
    "mongoconnect",
    "kafkaconnect",
    "sapconnect",
    "soapconnect"
]

customOutputs

(Флаг, Необязательный)

Флаг, отвечающий за то, что можно добавлять выходы блока на графе (у выходов появляется знак плюса) Список типов, которые можно создавать, перечисляется в параметре customOutputTypes

Пример
"customOutputs": 1
Визуальное отображение на графе

У блока "Таблицы" данного флага нет, пример показан на блоке "Python"

img.png


customOutputTypes

(Список, Необязательный)

Список типов, которые будут использоваться если включен флаг customOutputs

Пример
customInputTypes": [
    "series",
    "json",
    "object"
]

dataprovider

(Флаг, Необязательный)

Флаг, определяющий возможность writeback для данных на выходе блока, опционально

Пример
"dataprovider": 0

deprecated

(Флаг, Необязательный)

Флаг, отвечающий за то, что блок устарел и будет выведен из эксплуатации

Пример
"deprecated": 1
Визуальное отображение на графе

В списке блоков, возле блока будет восклицательный знак.

У блока "Таблицы" данного флага нет, пример показан на блоке "Кольцо"

img.png


deprecatedDescription

(Строка, Необязательный)

Комментарии к флагу deprecated, если нужно

Пример
"deprecatedDescription": "Блок устарел, используйте визуализатор \"Спидометр/Кольцо\"",
Визуальное отображение на графе

В списке блоков, возле блока будет восклицательный знак.

У блока "Таблицы" данного флага нет, пример показан на блоке "Кольцо"

img.png


isOnlyOneOnGraph

(Флаг, Необязательный)

Флаг, отвечающий за то, что блок может быть только один на графе

Пример
"isOnlyOneOnGraph": 0

preset

(Флаг, Необязательный)

Флаг, отвечающий за то, что есть возможность быстрого добавления визуализатора на пресете

Пример
"preset": 1

presetWizard

(Флаг, Необязательный)

Флаг, отвечающий за то, что на пресете есть мастер при добавлении

Пример
"presetWizard": 1

results

(Флаг, Необязательный)

Флаг, используется в стат блоках, для вывода стат характеристик в дебаге

Пример
"results": 0

wizard

(Флаг, Необязательный)

Флаг, отвечающий за наличие мастера в графе

Пример
"wizard": 0

appliedSettings

(Список, Необязательный)

Описание настроек блока, которые не отображаются в настройках блока на графе

Пример
"appliedSettings": []

(Строка, Необязательный)

Относительная ссылка на документацию

Пример
"docLink": "/Документация_ЦП_УвП/12_Работа_пользователей/Библиотека_блоков/Визуализаторы/Таблицы/Блок_Таблица/"

isExperimental

(Флаг, Необязательный)

Является ли блок экспериментальным

Пример
"isExperimental": 0