ライブカード
カテゴリ: 運用。タグ: 数値と指標、チャートとゲージ、オフィスと職場。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "" | maxLength:60 | |
compact | boolean | false | ||
cycleSeconds | integer | 6 | 最小値:3;最大値:60 | チップビューは一度に1タイルを表示し、壁時計をオンにします。 |
backgroundColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | カードの背景とプレートをフラットなCSS順序の色で上書きします。#RRGGBBAAは不透明度を指定します。background noneが優先されます。 |
textColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
tiles | array | minItems:1;maxItems:12;必須 | ||
tiles[].label | string | maxLength:40;必須 | ||
tiles[].value | number | 必須 | ||
tiles[].unit | string | "" | maxLength:6 | 通貨記号は先頭に($1,280);他の単位は後に続きます(98.6%、120 ms)。 |
tiles[].decimals | 整数、null | null | 最小値:0;最大値:4 | null:整数は none、それ以外は one。 |
tiles[].compact | ブール値、null | null | 千、百万、十億を省略(12.4K、3.2M)。nullはカードのコンパクトに従う。 | |
tiles[].delta | 数値、null | null | ||
tiles[].deltaUnit | string | "%" | maxLength:6 | % はパーセンテージを示します。空文字列は数値のみを表示し、それ以外はその後に続きます。 |
tiles[].deltaLabel | string | "" | maxLength:30 | |
tiles[].goal | 数値、null | null | ||
tiles[].trend | array | [] | maxItems:60 | |
tiles[].invert | boolean | false | 数値が低いほど良い場合に真(待ち時間、コスト)。 | |
tiles[].changedAt | 文字列、null | null | 値が変わったISO 8601時刻。その数秒以内にタイルが瞬間を再生します:数字がパンチし、達成した目標や超過した制限がテイクオーバーとして表示されます。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type kpi --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "kpi",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"tiles": [
{
"label": "Example",
"value": 1
}
]
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json
またはAPIを直接呼び出します。APIは同じドキュメントをdocumentフィールドにラップします。エージェントトークンはすでにプロジェクト名を含むため、プロジェクトヘッダーは送信しません。ScreenRig-Projectを送信する場合はトークンのプロジェクトと一致する必要があります。API認証は環境変数で提供してください。詳細はAPI認証を参照。
curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "Content-Type: application/json" \
--data '{"document":{"tiles":[{"label":"Example","value":1}]}}'