Параметр

В этой статье

Параметр

Параметр — это виджет, в который можно добавить одну или несколько переменных. Если в режиме просмотра изменить значение переменной в Параметре, то изменятся и показатели виджетов, в которых используется переменная. Пример использования представлен на странице действия по клику Обновить переменную.

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

Помимо общих настроек, у виджета есть уникальные.

Настройка данных

Во вкладке настройки данных необходимо добавить одну или несколько переменных дашборда, созданных ранее. Нажмите + Переменная, чтобы увидеть их список.

Для добавленной переменной можно:

Включить или отключить отображение ее названия
Изменить ширину (в пикселях)

Настройка отображения

Помимо общих настроек отображения, для переменных в виджете доступны дополнительные:

Размер названий
Цвет названий
Толщина названий
Положение названий — слева от поля параметра или над ним
Ориентация — отображение переменных по горизонтали или вертикали
Ширина полей — устанавливается для всех полей виджета, кроме тех, для которых ширина настроена отдельно
Выравнивание названий — по левому или правому краю

Подробнее о виджете Параметр в видеокурсе.

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

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

Добавим переменную дашборда Вводимое значение с логическим типом данных. В значении укажем true.
Добавим в образ Параметр. Выберем для отображения созданную в предыдущем шаге переменную.
В настройках отображения разреза гистограммы выберем отображение по формуле, а в качестве формулы — созданную ранее переменную. Это удобнее сделать в редакторе формул.
Опубликуем дашборд и убедимся, что все работает.

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

Виджет можно редактировать не только в образе, но и в YAML-редакторе. В таблице ниже представлены ключи и значения, которые можно использовать для настройки. Подробнее о том, как работать с ключом value, описано на странице Значения разрезов и мер в YAML. Форматы данных, которые можно использовать, описаны на соответствующей странице. Общие параметры для виджетов описаны на странице Настройка виджетов в YAML.

Настройки данных в YAML

Ключ	Тип	Определение
title	string	Заголовок
showMarkdown	boolean	Описание
markdownText	string	Текст описания
markdownMeasures	—	Мера в описании
variables	string	Переменная

Переменные (блок variables)

Ключ	Тип	Определение
variable	string	Переменная
name	string	Название переменной
showName	boolean	Переключатель Отображать название
inputWidth	number	Ширина поля

Настройки отображения в YAML

Ключ	Тип	Определение
paddings	string	Отступы по сторонам
titleSize	number	Размер заголовка
titleColor	—	Цвет заголовка: - `AUTO` — авто - `BASE` — базовый
titleWeight	enum	Толщина заголовка: - `NORMAL` — обычная - `BOLD` — большая
markdownTextSize	number	Текст описания В параметре указывается размер текста описания в Markdown. Параметр доступен, если активен переключатель Описание
variableNameSize	number	Размер названий переменных
variableNameColor	—	Цвет названий переменных: - `AUTO` — авто - `BASE` — базовый
variableNameWeight	enum	Толщина шрифта названий переменных: - `NORMAL` — обычная - `BOLD` — большая
variableNamePosition	enum	Положение названий переменных: - `TOP` — сверху - `LEFT` — слева
orientation	enum	Ориентация переменных: - `HORIZONTAL` — по горизонтали - `VERTICAL` — по вертикали

Ориентация переменных (блок orientation)

Ключ	Тип	Определение
inputsWidth	number	Ширина полей
nameAlignment	enum	Выравнивание названий: - `LEFT` — по левому краю - `RIGHT` — по правому краю

Пример настроенного виджета в YAML-редакторе

widgets:
  - key: parameter
    apiVersion: "16"
    type: PARAMETER
    settings:
      paddings: 8
      titleSize: 14
      titleColor:
        mode: AUTO
      titleWeight: NORMAL
      title: ""
      showMarkdown: false
      markdownMeasures: []
      markdownText: ""
      markdownTextSize: 19
      variables:
        - name: Вводимое значение
          variable: Вводимое значение
          showName: true
        - name: Тип лимита по переменной
          variable: Тип лимита по переменной
          showName: true
      variableNameSize: 14
      variableNameColor:
        mode: AUTO
      variableNameWeight: NORMAL
      variableNamePosition: TOP
      orientation: HORIZONTAL

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

Да

Нет

Фильтр

Текст