HostConfig とは

  • [アーティクル]

HostConfig は、アダプティブ カード レンダラーが UI を生成する方法を指定するクロスプラットフォーム構成オブジェクトです。

これにより、プラットフォームに依存しないプロパティをさまざまなプラットフォームやデバイス上のレンダラー間で共有できます。 また、ツールを作成して、特定の環境に対してカードが持つルック アンド フィールを把握することもできます。

サンプルの hostconfig. json を参照し、その内容を把握してください。

カードの構成

AdaptiveCardConfig

AdaptiveCards の最上位のオプション

プロパティ Type 必須 説明 Version
allowCustomStyle boolean X、既定値: true カスタム スタイルを許可するかどうかを制御します 1.0
supportsInteractivity boolean X、既定値: true 対話型 Action を呼び出すことを許可するかどうかを制御します 1.0
imageBaseUrl string いいえ リソースを読み込むときに使用するベース URL 1.0
fontFamily string X、既定値: "Calibri" テキストをレンダリングするときに使用するフォント フェイス 1.0
actions object X Action のオプション 1.0
adaptiveCard object X AdaptiveCards の最上位のオプション 1.0
containerStyles object X 既定のコンテナーと強調のコンテナーのスタイルを制御します 1.0
imageSizes object X Image のサイズを制御します 1.0
imageSet object X ImageSet を表示する方法を制御します 1.0
factSet object X FactSet の表示を制御します 1.0
fontSizes object X 異なるテキスト スタイルのフォント サイズのメトリックを制御します 1.0
fontWeights object X フォントの太さのメトリックを制御します 1.0
spacing object X 要素のレイアウト方法を制御します 1.0
separator object X 区切り記号の表示方法を制御します 1.0
media object いいえ Media 要素の表示と動作を制御します 1.1

ActionsConfig

Action のオプション

プロパティ Type 必須 説明 Version
actionsOrientation string X、既定値: "horizontal" ボタンのレイアウト方法を制御します 1.0
actionAlignment string X、既定値: "stretch" ボタンのレイアウトを制御します 1.0
buttonSpacing integer X、既定値: 10 ボタン間に使用するスペースの量を制御します 1.0
maxActions integer X、既定値: 5 合計で許可されるアクションの数を制御します 1.0
spacing string X、既定値: "default" アクション要素の全体の間隔を制御します 1.0
showCard object いいえ Action.ShowCard の動作とスタイルを制御します 1.0
iconPlacement string X、既定値: "aboveTitle" アクション アイコンを配置する場所を制御します 1.0
iconSize integer X、既定値: 30 アクション アイコンのサイズを制御します 1.0

ContainerStylesConfig

既定のコンテナーと強調のコンテナーのスタイルを制御します

プロパティ Type 必須 説明 Version
default object X 既定のコンテナー スタイル 1.0
emphasis object いいえ 強調に使用するコンテナー スタイル 1.0

FactSetConfig

FactSet の表示を制御します

プロパティ Type 必須 説明 Version
title object X、既定値: {"weight":"bolder","size":"default","color":"default","isSubtle":false,"wrap":true,"maxWidth":150} テキストの表示を制御するパラメーター 1.0
value object X、既定値: {"weight":"default","size":"default","color":"default","isSubtle":false,"wrap":true,"maxWidth":0} テキストの表示を制御するパラメーター 1.0
spacing integer X、既定値: 10   1.0

FontSizesConfig

異なるテキスト スタイルのフォント サイズのメトリックを制御します

プロパティ Type 必須 説明 Version
small integer X、既定値: 10 小さいフォント サイズ 1.0
default integer X、既定値: 12 既定のフォント サイズ 1.0
medium integer X、既定値: 14 中程度のフォント サイズ 1.0
large integer X、既定値: 17 大きいフォント サイズ 1.0
extraLarge integer X、既定値: 20 特大フォント サイズ 1.0

FontWeightsConfig

フォントの太さのメトリックを制御します

プロパティ Type 必須 説明 Version
lighter integer X、既定値: 200   1.0
default integer X、既定値: 400   1.0
bolder integer X、既定値: 800   1.0

ForegroundColorsConfig

さまざまなフォントの色を制御します

プロパティ Type 必須 説明 Version
default object X、既定値: {"default":"#FF000000","subtle":"#B2000000"}   1.0
accent object X、既定値: {"default":"#FF0000FF","subtle":"#B20000FF"}   1.0
dark object X、既定値: {"default":"#FF101010","subtle":"#B2101010"}   1.0
light object X、既定値: {"default":"#FFFFFFFF","subtle":"#B2FFFFFF"}   1.0
good object X、既定値: {"default":"#FF008000","subtle":"#B2008000"}   1.0
warning object X、既定値: {"default":"#FFFFD700","subtle":"#B2FFD700"}   1.0
attention object X、既定値: {"default":"#FF8B0000","subtle":"#B28B0000"}   1.0

ImageSetConfig

ImageSet を表示する方法を制御します

プロパティ Type 必須 説明 Version
imageSize string X、既定値: "auto" 個々のイメージのサイズを制御します 1.0
maxImageHeight integer X、既定値: 100 イメージの高さをこの値に制限します 1.0

ImageSizesConfig

Image のサイズを制御します

プロパティ Type 必須 説明 Version
small integer X、既定値: 80 小さいイメージ サイズの値 1.0
medium integer X、既定値: 120 中程度のイメージ サイズの値 1.0
large integer X、既定値: 180 大きいイメージ サイズの値 1.0

InputsConfig

ラベルとエラー メッセージを表示する方法を制御します

プロパティ Type 必須 説明 Version
label LabelConfig いいえ ラベルを表示する方法を制御します 1.3
errorMessage ErrorMessageConfig いいえ エラー メッセージを表示する方法を制御します 1.3

LabelConfig

ラベルを表示する方法を制御します

プロパティ Type 必須 説明 Version
requiredInputs InputLabelConfig いいえ 必須の入力のラベルを表示する方法を制御します 1.3
optionalInputs InputLabelConfig いいえ オプションの入力のラベルを表示する方法を制御します 1.3
spacing string X、既定値: "default" ラベルと入力の間隔 1.3

InputLabelConfig

必須またはオプションのラベルを表示する方法を制御します

プロパティ Type 必須 説明 Version
color string X、既定値: "default" ラベルのフォントの色 (サフィックスは常に attention の色で表示されます) 1.3
isSubtle bool X、既定値: false subtle 前景色を使用するかどうかを定義します 1.3
size string X、既定値: "default" 表示するラベルのフォント サイズ 1.3
suffix string X、既定値: "*" 必須の入力に対するラベルの末尾に表示されるサフィックス。 未定義の場合は、アスタリスク (*) がラベルに追加されます 1.3
weight string X、既定値: "default" ラベルのフォントの太さ 1.3

ErrorMessageConfig

エラー メッセージを表示する方法を制御します。 エラー メッセージは常に attention の色で表示されます。

プロパティ Type 必須 説明 Version
spacing string X、既定値: "default" 入力とエラー メッセージの間隔 1.3
size string X、既定値: "default" エラー メッセージのフォント サイズ 1.3
weight string X、既定値: "default" エラー メッセージのフォントの太さ 1.3

MediaConfig

Media 要素の表示と動作を制御します

バージョン 1.1 で導入されました

プロパティ Type 必須 説明 Version
defaultPoster string いいえ 再生ボタンが呼び出されていないときに表示するイメージへの URI 1.1
playButton string いいえ 再生ボタンとして表示するイメージ 1.1
allowInlinePlayback boolean X、既定値: true メディアをインラインで表示するか、外部で呼び出すか 1.1

SeparatorConfig

区切り記号の表示方法を制御します

プロパティ Type 必須 説明 Version
lineThickness integer X、既定値: 1 区切り線の太さ 1.0
lineColor string,null X、既定値: #B2000000 区切り線を描画するときに使用する色 1.0

ShowCardConfig

Action.ShowCard の動作とスタイルを制御します

プロパティ Type 必須 説明 Version
actionMode string X、既定値: "inline" カードの表示方法を制御します 1.0
style object X、既定値: emphasis コンテナーのスタイルを制御します 1.0
inlineTopMargin integer X、既定値: 16 カードを表示するときに使用する余白の量 1.0

SpacingsConfig

要素のレイアウト方法を制御します

プロパティ Type 必須 説明 Version
small integer X、既定値: 3 小さい間隔の値 1.0
default integer X、既定値: 8 既定の間隔の値 1.0
medium integer X、既定値: 20 中程度の間隔の値 1.0
large integer X、既定値: 30 大きい間隔の値 1.0
extraLarge integer X、既定値: 40 特大の間隔の値 1.0
padding integer X、既定値: 20 パディングの値 1.0

TextBlockConfig

テキストの表示を制御するパラメーター

プロパティ Type 必須 説明 Version
size string X、既定値: "default" カードで指定されていない場合に使用するフォント サイズ 1.0
weight string X、既定値: "normal" カードで指定されていない場合に使用するフォントの太さ 1.0
color string X、既定値: "default" カードで指定されていない場合に使用するフォントの色 1.0
isSubtle boolean X、既定値: false カードで指定されていない場合、テキストを不透明にする必要があるかどうか 1.0
wrap boolean X、既定値: true カードで指定されていない場合、テキストを折り返す必要があるかどうか 1.0
maxWidth integer X、既定値: 0 カードで指定されていない場合に使用する最大の幅 1.0