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

Общие параметры для всех типов

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

Пример
"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"
    }
]

Общие атрибуты описания настройки для всех типов

id

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

Идентификатор настройки

Пример
"id": "export"

name

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

Отображаемое наименование настройки

Пример
"name": "Экспорт"

desc

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

Дополнительная информация настройки

Пример
"desc": "Настройки для экспорта файлов"

type

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

Тип настройки. В зависимости от типа настройки добавляются разные дополнительные аттрибуты (можно посмотреть в описании типа).

Простые типы:

Специальные типы:

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

mandatory

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

Обязательность настройки

Пример
"mandatory": 0

hint

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

Всплывающая подсказка

Пример
"hint": "Настройки для экспорта файлов"

val

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

Введенное или выбранное значение

Пример
"val": "42"

isExperimental

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

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

Пример
"isExperimental": 0