リーダーボードカード

トップ3の表彰台、スコア、順位変動、リーダーとの差を表示するランキングボード。

ライブカード

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

カテゴリ: 運用。タグ: リーダーボードと順位、オフィスと職場、店舗。

レイアウト

この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。

レイアウト:フル。フォーム:ランドスケープ、ポートレート。

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

データとプライバシー

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

プロパティ

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

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

静的プロパティ

名前タイプデフォルト値と制限説明
titlestring"Leaderboard"maxLength:60
unitstring""maxLength:12スコアの後に表示されます。例:pts。
showinteger10最小値:3;最大値:20
highlightstring""maxLength:40強調するエントリー名。
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})?$"メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。

動的プロパティ

名前タイプデフォルト値と制限説明
entriesarrayminItems:1;maxItems:50;必須
entries[].namestringminLength:1;maxLength:40;必須
entries[].scorenumber必須
entries[].previousRank整数、nullnull最小値:1前期間の順位。nullまたは未設定は新規エントリーを示します。
entries[].teamstring""maxLength:40
entries[].previousScore数値、nullnull最新の変更前のスコア(Primetimeはこれから新スコアまでをカウント)。nullまたは未設定の場合はスコアをそのままにします。
changedAtstring""maxLength:40ボードの最新変更のISO瞬間。Primetimeはこの瞬間から変更を再生します(行がスプリングで入れ替わり、スコアが新しい値にカウントされ、新しいナンバーワンが発表されます)。これがなければボードには瞬間がありません。

キャンバス例

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

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

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

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

ライブデータを書き込む

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

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

{
  "entries": [
    {
      "name": "Example",
      "score": 1
    }
  ],
  "changedAt": ""
}
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":{"entries":[{"name":"Example","score":1}],"changedAt":""}}'