适用于数字标牌屏幕的班级挑战卡片

直播卡片

此卡由浏览器绘制，使用与播放器相同的代码，带示例数据。

类别：学校。标签：学校和校园，排行榜和排名，表彰。

布局

此全屏卡在横屏或竖屏时填满整个屏幕，不作为角落、芯片或条带放置。

布局：全屏。表单：横向，纵向。

卡片布局、主题和发布。浏览卡片。

数据与隐私

此卡使用其配置的属性和实时卡数据。

班级是名称，绝非学生。

属性

有关主题、背景、强调色和位置，请参见通用属性。

创建卡片时，在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。

静态属性

名称	类型	默认	数值和限制	描述
`format`	string	`"number"`	`"number"`, `"percent"`, `"money"`	数值显示方式：带单位的数字、百分比或金额。
`unit`	string	`""`	maxLength：`12`	数字后的单位，例如分钟或书籍。
`currency`	string	`"$"`	maxLength：`3`	金额前的符号。
`scaleFrom`	number	`0`	最小值：`0`；最大值：`99999999`	条形图起点，使得接近的数值（出勤率 94% 到 98%）仍显示差异。
`showTotal`	boolean	`true`		显示所有类别的总计（百分比为平均值）和倒计时。
`timeZone`	字符串，空值	`null`
`backgroundColor`	字符串，空值	`null`	模式：`"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	用纯色 CSS 顺序覆盖卡片背景和底板。#RRGGBBAA 提供透明度。背景无则优先。
`textColor`	字符串，空值	`null`	模式：`"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称	类型	默认	数值和限制	描述
`title`	string	`"Class challenge"`	maxLength：`40`	标题，例如阅读挑战。
`classes`	array	`[]`	minItems：`0`；maxItems：`10`	班级及其值。排名、进度条长度和领导者来自数值。班级是名称，绝非学生。
`classes[].name`	string		minLength：`1`；maxLength：`48`；必填
`classes[].value`	number		最小值：`0`；最大值：`99999999`；必填
`classes[].color`	string		模式：`"^#[0-9A-Fa-f]{6}$"`	班级颜色，格式为 #RRGGBB。缺失时班级从主题中取色。
`classes[].prevValue`	number		最小值：`0`；最大值：`99999999`	班级在最新更新前的值（黄金时段）。直到 updatedAt 看板显示这些；之后进度条竞速至新值，领导者变化是瞬间事件。
`goal`	number	`0`	最小值：`0`；最大值：`99999999`	目标。0 表示无。
`goalFor`	string	`"each"`	`"each"`, `"total"`	每类：每个类别竞赛至目标。总计：各类别共同达到目标。
`endsAt`	string	`""`	maxLength：`40`	挑战结束的 ISO 8601 时间点（无偏移时间为屏幕所在时区的本地时间）。为空时不显示倒计时。
`updatedAt`	string	`""`	maxLength：`40`	最新得分更新的 ISO 8601 时间点，由所有屏幕共享（Primetime）。比赛和领先者变更从此时间点开始播放。为空时不播放。

画布示例

将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。

{
  "theme": "neomustard"
}

screenrig card create --type class-challenge --major 1 --file params.json

将此项目添加到播放列表页面的primitives中，并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。

{
  "id": "class-challenge",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

创建卡片后向其写入文档，之后替换该文档即可更新屏幕，无需重新发布。卡片会按其动态属性检查每次写入，并拒绝它不接受的文档。请使用与播放列表相同的项目。

将文档保存为card-data.json。CLI直接读取文档，无需包装：

{
  "title": "Class challenge",
  "classes": [],
  "goal": 0,
  "goalFor": "each",
  "endsAt": "",
  "updatedAt": ""
}

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":{"title":"Class challenge","classes":[],"goal":0,"goalFor":"each","endsAt":"","updatedAt":""}}'