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

В этой статье

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

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

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

Ключ metadata

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

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

Ключ dividersHeight

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

Ключ	Тип	Определение
mode	string	- `FIXED` — значение в пикселях - `PERCENT` — значение в процентах (чтобы использовать параметр Авто, не указывайте значение в ключе `value`)
value	number	Значение

Ключ autoUpdate

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

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

Ключ widgetsSetting

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

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

Ключ inputs

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

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

Ключ widgets

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

Пример:

widgets:
  - key: kpi-list
    apiVersion: "15"
    type: KPI_LIST
    settings:
      title: ""
      titleSize: 14
      titleColor:
        mode: AUTO
      titleWeight: NORMAL
      showMarkdown: false
      markdownMeasures: []
      markdownText: ""
      measures:
        - name: Кол-во магазинов
          value:
            mode: FORMULA
            formula: 'link: "Кол-во магазинов"'
          format: NUMBER
          formatting: AUTO
          color:
            mode: AUTO
          dbDataType: Int64
          showName: true
          displayCondition:
            mode: DISABLED
          filters: []
          onClick: []
        - name: Кол-во товаров
          value:
            mode: TEMPLATE
            tableName: product
            columnName: Товар
            templateName: countDistinct
          format: NUMBER
          formatting: AUTO
          color:
            mode: AUTO
          formattingTemplate: ""
          dbDataType: Int64
          showName: true
          displayCondition:
            mode: DISABLED
          filters: []
          onClick: []
        - name: Сумма продаж
          value:
            mode: TEMPLATE
            tableName: sale
            columnName: Сумма продаж
            templateName: sum
          format: NUMBER
          formatting: CUSTOM
          color:
            mode: BASE
            value: "#6636c0"
          formattingTemplate: "#,###[$]"
          dbDataType: Float64
          showName: true
          displayCondition:
            mode: DISABLED
          filters: []
          onClick: []
        - name: Рентабельность
          value:
            mode: FORMULA
            formula: (sum("sale"."Сумма продаж")  - sum("sale"."Себестоимость")) /
              sum("sale"."Сумма продаж") * 100
          format: NUMBER
          formatting: x.x[%]
          color:
            mode: BASE
            value: "#ff9f43"
          formattingTemplate: ""
          dbDataType: Float64
          showName: true
          displayCondition:
            mode: DISABLED
          filters: []
          onClick: []
      displaySign: HORIZONTAL
      stateName: null
      filters: []
      sorting: []
      position: TOP
      measuresTextWeight: NORMAL
      measuresTextSize: 30
      alignment: LEFT
      filterMode: DEFAULT
      ignoreFilters: false
      nameSize: 12
      maxRowsName: 1
      itemsAlignment: LEFT
      paddings: 8
      markdownTextSize: 14
    localApiVersion: "2"
  - key: filter (1)
    apiVersion: "15"
    type: FILTER
    settings:
      title: ""
      titleSize: 14
      titleColor:
        mode: AUTO
      titleWeight: NORMAL
      showMarkdown: false
      markdownMeasures: []
      markdownText: ""
      textSize: 12
      dimensionLimit: 50
      displaySign: SELECT
      dimensions:
        - name: Магазин
          value:
            mode: FORMULA
            formula: '"store"."Магазин"'
          format: STRING
          formatting: AUTO
          dbDataType: String
      filterMode: DEFAULT
      ignoreFilters: false
      stateName: null
      filters: []
      sorting: []
      paddings: 8
      markdownTextSize: 14

Ключ 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

Ключ actionButtons

В блок с ключом actionButtons добавляются кнопки действий. Подробности о том, как использовать кнопки действий, приведены на странице Образы.

Ключ	Тип	Определение
name	string	Название кнопки
buttonType	enum	Тип кнопки: - `primary` — основная - `primary-outlined` — второстепенная - `link` — ссылка
type	enum	Тип действия по клику: `EXECUTE_SCRIPT` Возможен только один тип действия
scriptKey	string	Ключ скрипта
parameters	—	Параметры скрипта (необязательный ключ)

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

Ключ layout

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

Ключ rows

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

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

Ключ columns

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

Ключ	Тип	Определение
mode	enum	Тип содержимого колонки
alignment	enum	Выравнивание колонки в строке - `left` — по левому краю - `center` — по центру - `right` — по правому краю - `full` — по ширине

Ключ 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` — плейсхолдер
likeViewBackground	boolean	Фон как у образа Параметр доступен, если в настройках образа отключены отступы в просмотре
alignment	enum	Выравнивание Доступные варианты: `left` — по левому краю `center` — по центру `right` — по правому краю
textSize	number	Размер шрифта

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

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 после пары ключ-значение mode: PLACEHOLDER. Пример:

layout:
  rows:
    - columns:
        - mode: PLACEHOLDER
          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` — из переменной - `AGGREGATION` — задать агрегацией
considerFilters	boolean	Переключатель Учитывать фильтры: - `true` — активен - `false` — отключен

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

Да

Нет

YAML-редактор

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