Что такое HostConfig?
HostConfig
— это кроссплатформенный объект конфигурации, указывающий, как отрисовщик адаптивных карточек создает пользовательский интерфейс.
Это позволяет отрисовщикам на разных платформах и устройствах использовать свойства, которые независимы от платформы. Кроме того, это позволяет создавать наборы инструментов, которые дают представление о внешнем виде и функциях карточки в конкретной среде.
Ознакомьтесь с примером HostConfig.JSON, чтобы изучить его содержимое.
AdaptiveCardConfig
: параметры верхнего уровня дляAdaptiveCards
.ActionsConfig
: параметры для объектовAction
.ContainerStylesConfig
: управляет стилем контейнера по умолчанию и контейнера выделения.FactSetConfig
: управляет отображением объектовFactSet
.FontSizesConfig
: управляет метриками размера шрифта для различных стилей текста.FontWeightsConfig
: управляет метриками насыщенности шрифта.ForegroundColorsConfig
: управляет различными цветами шрифтов.ImageSetConfig
: управляет отображением объектовImageSet
.ImageSizesConfig
: управляет размером объектовImage
.InputsConfig
: управляет отображением меток и сообщений об ошибках.LabelConfig
: управляет отображением меток.InputLabelConfig
: управляет отображением обязательных и необязательных меток.
ErrorMessageConfig
: управляет отображением сообщений об ошибках.
MediaConfig
: управляет отображением и поведением элементовMedia
.SeparatorConfig
: управляет отображением разделителей.ShowCardConfig
: управляет поведением и стилем объектовAction.ShowCard
.SpacingsConfig
: управляет расположением элементов.TextBlockConfig
: параметры, управляющие отображением текста.
Конфигурация карточки
AdaptiveCardConfig
Параметры верхнего уровня для AdaptiveCards
.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
allowCustomStyle | boolean |
Нет, значение по умолчанию: true . |
Определяет, разрешен ли пользовательский стиль. | 1.0 |
supportsInteractivity | boolean |
Нет, значение по умолчанию: true . |
Определяет, разрешен ли вызов интерактивных объектов Action . |
1.0 |
imageBaseUrl | string |
Нет | Базовый URL-адрес, используемый при загрузке ресурсов. | 1.0 |
fontFamily | string |
Нет, значение по умолчанию: "Calibri" . |
Начертание шрифта, используемое при отображении текста. | 1.0 |
actions | object |
Нет | Параметры для объектов Action . |
1.0 |
adaptiveCard | object |
Нет | Параметры верхнего уровня для AdaptiveCards . |
1.0 |
containerStyles | object |
Нет | Управляет стилем контейнера по умолчанию и контейнера выделения. | 1.0 |
imageSizes | object |
Нет | Управляет размером объектов Image . |
1.0 |
imageSet | object |
Нет | Управляет отображением объектов ImageSet . |
1.0 |
factSet | object |
Нет | Управляет отображением объектов FactSet . |
1.0 |
fontSizes | object |
Нет | Управляет метриками размера шрифта для различных стилей текста. | 1.0 |
fontWeights | object |
Нет | Управляет метриками насыщенности шрифта. | 1.0 |
spacing | object |
Нет | Управляет расположением элементов. | 1.0 |
separatorязательно, количество | object |
Нет | Управляет отображением разделителей. | 1.0 |
media | object |
Нет | Управляет отображением и поведением элементов Media . |
1,1 |
ActionsConfig
Параметры для объектов Action
.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
actionsOrientation | string |
Нет, значение по умолчанию: "horizontal" . |
Управляет расположением кнопок. | 1.0 |
actionAlignment | string |
Нет, значение по умолчанию: "stretch" . |
Управление макетом кнопок. | 1.0 |
buttonSpacing | integer |
Нет, значение по умолчанию: 10 . |
Определяет расстояние между кнопками. | 1.0 |
maxActions | integer |
Нет, значение по умолчанию: 5 . |
Определяет, сколько всего разрешено действий. | 1.0 |
spacing | string |
Нет, значение по умолчанию: "default" . |
Управляет общим расстоянием до элемента действия. | 1.0 |
showCard | object |
Нет | Управляет поведением и стилем Action.ShowCard . |
1.0 |
iconPlacement | string |
Нет, значение по умолчанию: "aboveTitle" . |
Управляет расположением значка действия. | 1.0 |
iconSize | integer |
Нет, значение по умолчанию: 30 . |
Определяет размер значка действия. | 1.0 |
ContainerStylesConfig
Управляет стилем контейнера по умолчанию и контейнера выделения.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
default | object |
Нет | Стиль контейнера по умолчанию. | 1.0 |
emphasis | object |
Нет | Стиль контейнера, используемый для выделения. | 1.0 |
FactSetConfig
Управляет отображением объектов FactSet
.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
title | object |
Нет, значение по умолчанию: {"weight":"bolder","size":"default","color":"default","isSubtle":false,"wrap":true,"maxWidth":150} . |
Параметры, управляющие отображением текста. | 1.0 |
value | object |
Нет, значение по умолчанию: {"weight":"default","size":"default","color":"default","isSubtle":false,"wrap":true,"maxWidth":0} . |
Параметры, управляющие отображением текста. | 1.0 |
spacing | integer |
Нет, значение по умолчанию: 10 . |
1.0 |
FontSizesConfig
Управляет метриками размера шрифта для различных стилей текста.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
small | integer |
Нет, значение по умолчанию: 10 . |
Мелкий размер шрифта. | 1.0 |
default | integer |
Нет, значение по умолчанию: 12 . |
Размер шрифта по умолчанию | 1.0 |
medium | integer |
Нет, значение по умолчанию: 14 . |
Средний размер шрифта. | 1.0 |
large | integer |
Нет, значение по умолчанию: 17 . |
Крупный размер шрифта. | 1.0 |
extraLarge | integer |
Нет, значение по умолчанию: 20 . |
Очень крупный размер шрифта. | 1.0 |
FontWeightsConfig
Управляет метриками насыщенности шрифта.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
lighter | integer |
Нет, значение по умолчанию: 200 . |
1.0 | |
default | integer |
Нет, значение по умолчанию: 400 . |
1.0 | |
bolder | integer |
Нет, значение по умолчанию: 800 . |
1.0 |
ForegroundColorsConfig
Управляет различными цветами шрифтов.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
default | object |
Нет, значение по умолчанию: {"default":"#FF000000","subtle":"#B2000000"} . |
1.0 | |
accent | object |
Нет, значение по умолчанию: {"default":"#FF0000FF","subtle":"#B20000FF"} . |
1.0 | |
dark | object |
Нет, значение по умолчанию: {"default":"#FF101010","subtle":"#B2101010"} . |
1.0 | |
light | object |
Нет, значение по умолчанию: {"default":"#FFFFFFFF","subtle":"#B2FFFFFF"} . |
1.0 | |
good | object |
Нет, значение по умолчанию: {"default":"#FF008000","subtle":"#B2008000"} . |
1.0 | |
warning | object |
Нет, значение по умолчанию: {"default":"#FFFFD700","subtle":"#B2FFD700"} . |
1.0 | |
attention | object |
Нет, значение по умолчанию: {"default":"#FF8B0000","subtle":"#B28B0000"} . |
1.0 |
ImageSetConfig
Управляет отображением объектов ImageSet
.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
imageSize | string |
Нет, значение по умолчанию: "auto" . |
Определяет размер отдельного изображения. | 1.0 |
maxImageHeight | integer |
Нет, значение по умолчанию: 100 . |
Позволяет ограничить высоту изображения до этого значения. | 1.0 |
ImageSizesConfig
Управляет размером объектов Image
.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
small | integer |
Нет, значение по умолчанию: 80 . |
Значение мелкого размера изображения. | 1.0 |
medium | integer |
Нет, значение по умолчанию: 120 . |
Значение среднего размера изображения. | 1.0 |
large | integer |
Нет, значение по умолчанию: 180 . |
Значение крупного размера изображения. | 1.0 |
InputsConfig
Управляет отображением меток и сообщений об ошибках.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
label | LabelConfig |
Нет | Управляет отображением меток. | 1,3 |
errorMessage | ErrorMessageConfig |
Нет | Управляет отображением сообщений об ошибках. | 1,3 |
LabelConfig
Управляет отображением меток.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
requiredInputs | InputLabelConfig |
Нет | Управляет отображением меток для обязательных входных данных. | 1,3 |
optionalInputs | InputLabelConfig |
Нет | Управляет отображением меток для необязательных входных данных. | 1,3 |
spacing | string |
Нет, значение по умолчанию: "default" . |
Определяет пробелы между меткой и входными данными. | 1,3 |
InputLabelConfig
Управляет отображением обязательных и необязательных меток.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
color | string |
Нет, значение по умолчанию: "default" . |
Определяет цвет шрифта для метки (суффикс всегда выделяется цветом attention ). |
1,3 |
isSubtle | bool |
Нет, значение по умолчанию: false . |
Определяет, нужно ли использовать цвет subtle для переднего плана. |
1,3 |
size | string |
Нет, значение по умолчанию: "default" . |
Определяет размер шрифта для отображаемой метки. | 1,3 |
suffix | string |
Нет, значение по умолчанию: "*" . |
Определяет суффикс, отображаемый в конце метки для обязательных входных данных. Если значение не определено, к метке добавляется звездочка * . |
1,3 |
weight | string |
Нет, значение по умолчанию: "default" . |
Определяет насыщенность шрифта для метки. | 1,3 |
ErrorMessageConfig
Управляет отображением сообщений об ошибках. Сообщения об ошибках всегда отображаются цветом attention
.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
spacing | string |
Нет, значение по умолчанию: "default" . |
Определяет пробел между входным полем и сообщением об ошибке. | 1,3 |
size | string |
Нет, значение по умолчанию: "default" . |
Определяет размер шрифта для сообщения об ошибке. | 1,3 |
weight | string |
Нет, значение по умолчанию: "default" . |
Определяет насыщенность шрифта для сообщения об ошибке. | 1,3 |
MediaConfig
Управляет отображением и поведением элементов Media
.
Представлено в версии 1.1.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
defaultPoster | string |
Нет | Универсальный код ресурса (URI) изображения, отображаемого, когда кнопка воспроизведения не была вызвана. | 1,1 |
playButton | string |
Нет | Изображение, отображаемое в качестве кнопки воспроизведения. | 1,1 |
allowInlinePlayback | boolean |
Нет, значение по умолчанию: true . |
Определяет, отображать ли данные мультимедиа во встроенном окне или использовать внешний вызов. | 1,1 |
SeparatorConfig
Управляет отображением разделителей.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
lineThickness | integer |
Нет, значение по умолчанию: 1 . |
Определяет толщину разделительной линии. | 1.0 |
lineColor | string,null |
Нет, значение по умолчанию: #B2000000 . |
Определяет цвет разделительной линии. | 1.0 |
ShowCardConfig
Управляет поведением и стилем Action.ShowCard
.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
actionMode | string |
Нет, значение по умолчанию: "inline" . |
Управляет отображением карточки. | 1.0 |
style | object |
Нет, значение по умолчанию: emphasis . |
Управляет стилями контейнера. | 1.0 |
inlineTopMargin | integer |
Нет, значение по умолчанию: 16 . |
Определяет ширину полей при отображении карточки. | 1.0 |
SpacingsConfig
Управляет расположением элементов.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
small | integer |
Нет, значение по умолчанию: 3 . |
Значение небольшого интервала. | 1.0 |
default | integer |
Нет, значение по умолчанию: 8 . |
Значение интервала по умолчанию. | 1.0 |
medium | integer |
Нет, значение по умолчанию: 20 . |
Значение среднего интервала. | 1.0 |
large | integer |
Нет, значение по умолчанию: 30 . |
Значение большого интервала. | 1.0 |
extraLarge | integer |
Нет, значение по умолчанию: 40 . |
Значение очень большого интервала. | 1.0 |
padding | integer |
Нет, значение по умолчанию: 20 . |
Определяет значение заполнения. | 1.0 |
TextBlockConfig
Параметры, управляющие отображением текста.
Свойство | Тип | Обязательно | Описание | Версия |
---|---|---|---|---|
size | string |
Нет, значение по умолчанию: "default" . |
Определяет размер шрифта, который используется, если размер шрифта не задан в карточке. | 1.0 |
weight | string |
Нет, значение по умолчанию: "normal" . |
Определяет насыщенность, которая используется, если насыщенность шрифта не задана в карточке. | 1.0 |
color | string |
Нет, значение по умолчанию: "default" . |
Определяет цвет шрифта, который используется, если цвет шрифта не задан в карточке. | 1.0 |
isSubtle | boolean |
Нет, значение по умолчанию: false . |
Определяет, должен ли текст быть менее заметным, если это не указано в карточке. | 1.0 |
wrap | boolean |
Нет, значение по умолчанию: true . |
Определяет, должен ли текст переноситься по словам, если это не указано в карточке. | 1.0 |
maxWidth | integer |
Нет, значение по умолчанию: 0 . |
Определяет максимальную ширину, если она не указана в карточке. | 1.0 |