Настройка образа в YAML

В этой статье

Настройка образа в YAML

Параметры образа задаются в нескольких блоках:

metadata — базовые настройки образа
widgetsSetting — общие настройки виджетов
inputs — переменные Входящие значения
filters — преднастроенные фильтры

Ключ metadata

В таблице описаны ключи для задания базовых настроек образа через ключ metadata.

Ключ	Тип	Определение
maxWidth	number	Максимальная ширина образа Если параметр не задан, то максимальная ширина не ограничена
autoUpdate	—	Автообновление
spacing	enum	Отображение отступов между виджетами в просмотре
color	enum	Цвет фона образа в просмотре: - `AUTO` — авто - `BASE` — базовый
apiVersion	string	Версия образа Зависит от версии системы

Ключ autoUpdate

Блок с ключом autoUpdate принимает значения из таблицы ниже.

Ключ	Тип	Определение
enabled	boolean	Вкл/Выкл автообновление
minutes	boolean	Значение в минутах

Ключ widgetsSetting

В блоке с ключом widgetsSetting указываются общие настройки для всех виджетов в образе.

Ключ	Тип	Определение
appearance	—	Расширенные настройки отображения
titleSize	number	Размер заголовка
titleColor	—	Цвет заголовка: - `AUTO` — авто - `BASE` — базовый
titleWeight	enum	Толщина шрифта: - `NORMAL` — обычная - `BOLD` — большая
textSize	number	Размер текста
filterMode	enum	Режим фильтрации: - `DEFAULT` — базовый - `SINGLE` — единичный выбор - `MULTI` — множественный выбор - `DISABLED` — отключено
ignoreFilters	boolean	Игнорировать фильтры
stateName	string	Состояние

Ключ inputs

В таблице описаны ключи для задания входящих значений через ключ inputs.

Ключ	Тип	Определение
name	string	Название переменной
dbDataType	enum	Тип данных переменной: - `STRING` — строка - `INTEGER` — целое число - `DATE` — дата - `DATETIME` — дата и время
multipleChoice	boolean	Массив данных в переменной
defaultValue	string	Значение по умолчанию Задается формулой

Ключ filters

К образам можно применять предустановленные фильтры. В блоке с ключом filters используются следующие ключи:

name — название фильтра
formula — используемая формула
dbDataType — тип данных формулы
format — формат
filteringMethod — метод фильтрации
checkedValues — выбранные значения
formValues — для значений, заданных вручную (значения указываются в блоке с ключом numberRange)

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

filters:
  - dbDataType: UInt64
    format: NUMBER
    formula: '"events"."id"'
    name: id
    formValues:
      numberRange:
        - 100
        - 200
    filteringMethod: NONEMPTY
  - dbDataType: String
    format: STRING
    formula: '"events"."action"'
    name: action
    checkedValues:
      - Согласование с Клиентом предложений
      - Ввод полной формы Заявки
    filteringMethod: INCLUDE

Настройка сетки образа в YAML

Ключ layout

Структуру образа составляет сетка из строк и колонок — layout. В блоке с этим ключом используется ключ rows, необходимый для настройки и добавления строк.

Ключ rows

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

Ключ	Тип	Определение
columns	—	Колонки
mode	enum	Тип содержимого колонки
widgetKey	string	Ключ виджета который будет отображаться в колонке Только для типа `WIDGET` (виджет)
placeholder	—	Плейсхолдер Только для типа `PLACEHOLDER` (плейсхолдер)
innerLayout	—	Внутренняя вложенность Та же структура, что и в `layout` Только для типа `INNER_LAYOUT` Доступные типы содержимого колонок: - `EMPTY` — нет (пустая колонка) - `WIDGET` — виджет - `PLACEHOLDER` — плейсхолдер
height	—	Высота колонки
width	—	Ширина колонки Не применяется для типа содержимого колонки `DIVIDER` (разделитель)

Ключ height

В блоке с ключом height настраивается высота колонки.

Ключ	Тип	Определение
mode	enum	Режим расчета высоты колонки: - `FIXED` — фиксированная (в пикселях) - `PERCENT` — динамическая (в процентах, рассчитывается относительно экрана)
value	number	Значение высоты Ошибка при удалении значения в режиме `PERCENT`

Ключ width

В блоке с ключом width настраивается ширина колонки.

Ключ	Тип	Определение
mode	enum	Режим расчета ширины колонки: - `FRACTION` — динамическая (в долях холста) - `FIXED` — фиксированная (в пикселях)
value	number	Значение ширины

Вкладки (ключ tabs)

Чтобы добавить в образ колонки, используйте блок с ключом tabs.

Ключ	Тип	Определение
label	string	Название вкладки
displayCondition	—	Отображать (условие отображения)
innerLayout	—	Внутренняя вложенность Доступные типы компонентов в колонке: `EMPTY` — пустая колонка `WIDGET` — виджет `PLACEHOLDER` — плейсхолдер

Пример использования вкладок:

layout:
  rows:
    - columns:
        - mode: TABS
          tabs:
            - label: Вкладка (1)
              displayCondition:
                mode: DISABLED
              innerLayout:
                rows:
                  - columns:
                      - mode: EMPTY
                        width:
                          mode: FRACTION
                          value: 1
            - label: Вкладка (2)
              displayCondition:
                mode: DISABLED
              innerLayout:
                rows:
                  - columns:
                      - mode: EMPTY
                        width:
                          mode: FRACTION
                          value: 1
          width:
            mode: FRACTION
            value: 1
    - columns:
        - mode: EMPTY
          width:
            mode: FRACTION
            value: 1

Пример использования виджета во вкладке:

layout:
  rows:
    - columns:
        - mode: WIDGET
          widgetKey: barchart-140c3362
          width:
            mode: FRACTION
            value: 1
    - columns:
        - mode: EMPTY
          width:
            mode: FRACTION
            value: 1

Пример использования плейсхолдера во вкладке:

layout:
  rows:
    - columns:
        - mode: PLACEHOLDER
          placeholder:
            name: Плейсхолдер
            mode: EXISTED_VIEW
            viewKey: view-140c3362
          width:
            mode: FRACTION
            value: 1
    - columns:
        - mode: EMPTY
          width:
            mode: FRACTION
            value: 1

Пример использования внутренней вложенности:

layout:
  rows:
    - columns:
        - mode: INNER_LAYOUT
          innerLayout:
            rows:
              - columns:
                  - mode:
                    width:
                      mode: FRACTION
                      value: 1
              - columns:
                  - mode:
                    width:
                      mode: FRACTION
                      value: 1
          width:
            mode: FRACTION
            value: 1

Условие отображения

Чтобы задать условие отображения вкладки, используйте блок с ключом displayCondition.

Ключ	Тип	Определение
mode	enum	Режим отображения `DISABLED` — всегда `VARIABLE` — по переменной `FORMULA` — по формуле
variableName	string	Название переменной (только для режима `VARIABLE`)
variableValue	string	Значение переменной (только для режима `VARIABLE`)
formula	string	Формула (только для режима `FORMULA`)

Пример отображения виджета по переменной:

displayCondition:
  mode: VARIABLE
  variableName: variable_1
  variableValue: “value_1”

Пример отображения виджета по формуле:

displayCondition:
  mode: FORMULA
  formula: if(quantile(0.75)("p1"."TTCR") > 10, true, false)

Настройка плейсхолдера в YAML

В образ можно добавить плейсхолдер с помощью ключа PLACEHOLDER. В таблице ниже представлены ключи, которые можно использовать для настройки плейсхолдера.

Ключ	Тип	Определение
name	string	Уникальное название плейсхолдера
mode	enum	Режим: - `EMPTY` — нет (пустой) - `EXISTED_VIEW` — созданный образ - `GENERATED_BY_SCRIPT` — образ, сгенерированный скриптом
viewKey	string	Ключ образа, который будет отображаться в колонке Только для режима `EXISTED_VIEW` (созданный образ)
scriptKey	string	Ключ скрипта Только для режима `GENERATED_BY_SCRIPT` (образ, сгенерированный скриптом)
parameters	—	Параметры скрипта Только для режима `GENERATED_BY_SCRIPT` (образ, сгенерированный скриптом)

Ключ parameters

В блоке с ключом parameters настраиваются параметры образа, сгенерированного скриптом.

Ключ	Тип	Определение
name	string	Название параметра
sourceVariable	string	Название переменной
inputMethod	enum	Способ ввода значения - `VARIABLE` — из переменной - `FORMULA` — по формуле

Была ли статья полезна?

Да

Нет

YAML-редактор

Настройка виджетов в YAML