Настройка образа в YAML
8 800 555-89-02
Войти
Документация
CTRL+K
Standalone2409
SaaS

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

В этой статье
  • Настройка образа в YAML
  • Настройка сетки образа в YAML
  • Настройка плейсхолдера в YAML

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

  • metadata — базовые настройки
  • inputs — переменные Входящее значение

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

КлючТипОпределение
maxWidthnumberМаксимальная ширина образа
Если параметр не задан, то максимальная ширина не ограничена
autoUpdateАвтообновление
enabled
booleanВкл/Выкл автообновление
minutes
booleanЗначение минут
spacingenumОтображение отступов между виджетами в просмотре
colorenumЦвет фона образа в просмотре:
- AUTO
- BASE
apiVersionstringВерсия образа
Зависит от версии системы

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

КлючТипОпределение
namestringНазвание переменной
dataTypeenumТип данных переменной:
- STRING
- INTEGER
- DATE
- DATETIME
multipleChoicebooleanМассив данных в переменной
defaultValuestringЗначение по умолчанию
Задается формулой

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

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

КлючТипОпределение
rowsСтроки
columns
Колонки
mode
enumТип содержимого колонки
widgetKey
stringКлюч виджета который будет отображаться в колонке
Только для типа WIDGET
placeholder
Плейсхолдер
Только для типа PLACEHOLDER
innerLayout
Внутренняя вложенность
Та же структура, что у layout
Только для типа INNER_LAYOUT
Доступные типы содержимого колонок:
- EMPTY
- WIDGET
- PLACEHOLDER
height
Высота колонки
mode
enumРежим расчета высоты колонки:
- FIXED
- PERCENT
value
numberЗначение высоты
Ошибка при удалении значения в режиме PERCENT
width
Ширина колонки
Не применяется для типа содержимого колонки DIVIDER
mode
enumРежим расчета ширины колонки:
- FRACTION
- FIXED
value
numberЗначение ширины

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

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

КлючТипОпределение
namestringНазвание плейсхолдера
Должно быть уникальным
modeenumРежим:
- EMPTY
- EXISTED_VIEW
- GENERATED_BY_SCRIPT
viewKeystringКлюч образа, который будет отображаться в колонке
Только для EXISTED_VIEW
scriptKeystringКлюч скрипта
Только для GENERATED_BY_SCRIPT
parametersПараметры скрипта
Только для GENERATED_BY_SCRIPT
name
stringНазвание параметра
sourceVariable
stringНазвание переменной

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

Да
Нет
Предыдущая
YAML-редактор
8 (800) 555-89-028 (495) 150-31-45team@infomaximum.com
Для бизнеса
© 20102024. ООО «Инфомаксимум»
Мы используем файлы cookies, чтобы сайт был лучше для вас.