進捗カード

リング、バー、または温度計で目標の進捗、残り、残り日数を表示します。

大きな金額またはパーセントがリング、バー、または募金用温度計の横に表示され、残りの金額と残り日数が一目でわかります。画面全体に表示され、任意の長方形にフィットし、中央に配置されたり、隅に収まったり、隅の一行として表示されたり、端に沿って帯状に伸びたりします。タイトル、現在値、目標を設定し、締め切りとマイルストーンを追加し、全画面用にリング、バー、または温度計を選択します。

ライブカード

このカードはブラウザでプレーヤーと同じコードで描画され、サンプルデータを使用します。

カテゴリ: 運用。タグ: 数値と指標、チャートとゲージ。

レイアウト

このコアカードはすべてのレイアウトに適合します:全画面、中央、ワイド、コーナー、チップ、ストリップ、または任意の自由な長方形。

レイアウト:フル、フリー、センター、ワイド、コーナー、チップ、ストリップ。フォーム:ランドスケープ、ポートレート。

カードレイアウト、テーマ、公開。カードを閲覧。

データとプライバシー

このカードは設定されたプロパティとライブカードデータを使用します。

プロパティ

テーマ、背景、アクセント、位置については共通プロパティを参照してください。

カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。

静的プロパティ

名前タイプデフォルト値と制限説明
titlestring""maxLength:60
prefixstring""maxLength:3すべての金額の前に、例えば $。
unitstring""maxLength:12すべての量の後に付けます。例:kgや「食事」など。
decimalsinteger0最小値:0;最大値:2
stylestring"ring", "bar", "thermometer"フルスクリーンのグラフィックです:リング(未設定時)、バー、または温度計。センター、ストリップ、チップは常にバーを描画します。コーナーはバーの上にパーセントを描くか、リングの場合はリングを描きます。
timeZone文字列、nullnull
herostring"amount""amount", "percent"大きな数字:集まった金額またはパーセント。もう一方は小さな数字です。
presencestring"always""always", "milestone", "deadline-soon"マイルストーン:マイルストーンや目標を達成した後、presenceWindow分間カードが表示されます。締切間近:締切がsoonDays日以内の場合のみ表示されます。
presenceWindowinteger10最小値:1;最大値:1440マイルストーンまたは目標を過ぎた後にカードが表示され続ける分数(出席マイルストーン)。
soonDaysinteger3最小値:0;最大値:60締切の何日前にカードが表示されるか(締切間近の通知)。
backgroundColor文字列、nullnullパターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"カードの背景とプレートをフラットなCSS順序の色で上書きします。#RRGGBBAAは不透明度を指定します。background noneが優先されます。
textColor文字列、nullnullパターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。

動的プロパティ

名前タイプデフォルト値と制限説明
valuenumber必須
goalnumber最小値:1e-06;必須
deadline文字列、nullnullISO 8601の日付または瞬間。ローカル日付はゾーン内。
milestonesarray[]maxItems:8
previous数値、nullnullchangedAtで変化する前の値;塗りつぶしはそこから現在の値まで続きます。
changedAt文字列、nullnull値が変わったISO 8601時刻。その数秒以内にカードが瞬間を再生します:previousから塗りが進み、通過したマイルストーンが点滅し、達成した目標がバーストします。

キャンバス例

静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。

{
  "theme": "neomustard"
}
screenrig card create --type progress --major 1 --file params.json

このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。

{
  "id": "progress",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

ライブデータを書き込む

カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。

ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。

{
  "value": 1,
  "goal": 1,
  "deadline": null,
  "milestones": [],
  "previous": null,
  "changedAt": null
}
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":{"value":1,"goal":1,"deadline":null,"milestones":[],"previous":null,"changedAt":null}}'