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

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

KPI:

• Панель с показателями
• Показатель

Процессные:

• Воронка
• Карта процесса
• Сфера процессов

Таблицы:

• Сводная таблица
• Таблица

Диаграммы:

• Гистограмма
• Кольцевая диаграмма
• Комбинированная диаграмма
• Ленточный график (beta)
• Линейный график
• Столбиковая диаграмма

Вспомогательные:

• Кнопка
• Параметр
• Текст
• Фильтр

Общие параметры

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

Пример:

widgets:
  - key: barchart-123
    type: BAR_CHART
    apiVersion: "7"
    settings:

Версия API проставляется для виджетов автоматически при сохранении изменений в YAML-редакторе.

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

Общие параметры виджетов:

• Цвет
• Сортировка
• Предустановленные фильтры
• Легенда
• Условие отображения

Цвет

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

color:
  mode: ЗНАЧЕНИЕ

Для ключа mode используются следующие значения:

• DISABLED — отключено
• AUTO — авто
• BASE — базовый
• GRADIENT — по градиенту
• FORMULA — настроить
• RULE — по правилу
• VALUES— по значениям

Ниже представлены примеры использования ключа.

Заливка одним цветом

Чтобы задать цвет виджета или фона образа, используйте ключ mode со значением BASE. Пример:

color:
  mode: BASE
  value: "#000000"

Ключ value используется только с режимом цвета Базовый. В значении указывается HEX-код цвета.

Использование градиента

Чтобы применить градиент к виджету, используйте ключ mode со значением GRADIENT. Пример:

color:
  mode: GRADIENT
  startValue: "#D6D6D6"
  endValue: "#292929"
  classCount: 5

В значении ключа startValue указывается HEX-код первого цвета в градиенте, в значении endValue — второго. Ключ classCount поддерживает значения от 3 до 10. Значение определяет количество оттенков для градиента.

Использование формул

Использовать формулы можно с тремя режимами настройки цвета:

• Настроить
• По правилу
• По значениям

Чтобы настроить цвет по формуле, используйте ключ mode со значением FORMULA. Пример:

color:
  mode: FORMULA
  formula: "'#D6D6D6'"

Для режима По правилу (RULE) в ключе formula укажите необходимое правило:

color:
  mode: RULE
  formula: 'link: "Общее"."Правило 1"'

Название правила необходимо указывать в формате link: "Название группы, в которой создано правило"."Название правила".

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

color:
  mode: VALUES
  items:
    - value: Значение 1
    color:
      mode: BASE
      value: "#000000"
    - value: Значение 2
      color:
        mode: RULE
        formula: 'link."Правило 2"'

Сортировка

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

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

• name — название сортировки. По умолчанию используется название разреза, по которому происходит сортировка, или формула
• value — значение сортировки. В нем указывается:
  • mode — режим сортировки. Доступны режимы FORMULA или IN_WIDGET
  • formula — используемая формула
  • group — название группы (ключа), из которой берется показатель (только для режима IN_WIDGET)
  • index — индекс показателя, положение в списке. Начинается с 0 (только для режима IN_WIDGET)
• direction — сортировка по возрастанию (ASC) или убыванию (DESC)

Ниже представлены примеры использования ключа.

Сортировка значений в колонке таблицы

sorting:
  - name: Обращения
  value:
    mode: IN_WIDGET
    group: dimensionsAndMeasures
    index: 0
  direction: DESC

Сортировка таблицы по формуле с использованием функции sum

sorting:
  name: sum(“table”.”column”)
  value:
    mode: FORMULA
    formula: sum(“table”.”column”)
  direction: DESC

Предустановленные фильтры

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

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

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

filters:
  - name: case_id
    formula: '"case_table"."case_id"'
    datatype: STRING
    format: STRING
    filteringMethod: INCLUDE
    checkedValues: 
      - 'Value_1'
      - 'Value_2'
      - 'Value_3'
    formValues: {}
  - name: duration
    formula: '"hist_all"."duration"'
    datatype: INTEGER
    format: NUMBER
    filteringMethod: IN_RANGE
    checkedValues: []
    formValues:
      numberRange:
        - 0
        - 100
  - formula: '"hist_all"."duration"'

Тип данных формулы

В формулах поддерживаются разные типы данных. С ключом dataType используются значения:

• DATE — дата
• DATETIME — дата и время
• DATETIME64 — дата и время с субсекундной точностью
• FLOAT — дробные числа
• INTEGER — целые числа
• STRING — строки
• OTHER — другое

Формат

С ключом format используются следующие значения:

• DATE — дата
• NUMBER — число
• MONTH — месяц
• DATETIME — дата и время
• STRING — строка
• DAY_OF_WEEK — день недели
• DURATION — длительность
• HOUR — час
• MONTH_YEAR — месяц и год
• YEAR — год
• QUARTER — квартал
• QUARTER_YEAR — квартал и год
• DAY_OF_MONTH — день и месяц
• WEEK — неделя

Метод фильтрации

С ключом filteringMethod используются следующие значения:

• INCLUDE — выбрано
• EXCLUDE — исключено
• EQUAL_TO — равно
• NOT_EQUAL_TO — не равно
• STARTS_WITH — начинается на
• ENDS_WITH — заканчивается на
• CONTAINS — содержит
• NOT_CONTAINS — не содержит
• EMPTY — пустые значения
• NONEMPTY — непустые значения
• IN_RANGE — в диапазоне
• NOT_IN_RANGE — не в диапазоне
• GREATER_THAN — больше, чем
• LESS_THAN — меньше, чем
• GREATER_THAN_OR_EQUAL_TO — больше или равно
• LESS_THAN_OR_EQUAL_TO — меньше или равно
• LAST_TIME — последнее время

Выбранные значения

Ключ checkedValues используется для добавления или исключения нескольких значений в фильтре. Предварительно требуется указать метод фильтрации: INCLUDE или EXCLUDE. Пример:

filters:
  - name: Сотрудник
    formula: '"event_log"."responsible"'
    dataType: STRING
    format: STRING
    filteringMethod: INCLUDE
    checkedValues:
      - "Сотрудник #0008"
      - "Сотрудник #0031"
      - "Сотрудник #0038"
    formValues: {}

Заданные вручную значения

Ключ formValues используется для применения произвольных значений в фильтре. Ниже указаны возможные поля и их типы:

• date: string
• dateRange: [string , string]
• duration: string
• number: number
• numberRange: [number, number]
• string: string
• lastTimeValue: number
• lastTimeUnit: enum

Каждое из полей, используемое с ключом, может быть необязательным. Ключ можно использовать со всеми методами, кроме INCLUDE, EXCLUDE, EMPTY и NONEMPTY.

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

filters:
  - name: Длительность
    formula: '"event_log"."prev_duration"'
    dataType: INTEGER
    format: NUMBER
    filteringMethod: IN_RANGE
    checkedValues: []
    formValues:
      numberRange:
        - 0
        - 100

Легенда

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

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

Отображение легенды в виджете

Чтобы задать позицию легенды в виджете, используйте ключ position. Доступны следующие значения для отображения легенды:

• NONE — отключено
• LEFT — слева
• RIGHT — справа
• TOP — cверху
• BOTTOM — cнизу

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

legend:
    position: LEFT

Выравнивание

Чтобы задать выравнивание легенды в виджете, используйте ключ align. Для ключа доступны следующие значения:

• для позиций LEFT и RIGHT:
  • TOP — вверху
  • CENTER — по центру
  • BOTTOM — внизу
• для позиций TOP и BOTTOM:
  • LEFT — слева
  • CENTER — по центру
  • RIGHT — справа

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

legend:
  position: TOP
  align: LEFT

Ширина

Чтобы задать ширину легенды в виджете, используйте width. Для ключа используются следующие пары ключ-значение:

• mode — режим отображения
  • FIXED — авто (в пикселях)
  • PERCENT — в процентах

Пример автоматического выравнивания по ширине:

legend:
  position: LEFT
  align: TOP
  width:
    mode: FIXED

Пример выравнивания по ширине в процентах:

legend:
  position: LEFT
  align: TOP
  width:
    mode: PERCENT
    value: 20

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

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

• mode — режим отображения
  • DISABLED — всегда
  • VARIABLE — по переменной
  • FORMULA — по формуле
• variableName — название переменной (только для режима VARIABLE)
• variableValue — значение переменной (только для режима VARIABLE)
• formula — формула (только для режима FORMULA)

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

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

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

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