适用于数字标牌屏幕的进度卡片

一个大数字或百分比显示在环形、条形或募捐温度计旁，剩余金额和剩余天数一目了然。它可以充满整个屏幕，适应任何矩形，居中显示，嵌入角落，作为一行显示在角落，或沿边缘拉伸成带状。你设置标题、当前值和目标，添加截止日期和里程碑，选择环形、条形或温度计以全屏显示。

直播卡片

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

类别：运营。标签：数字和指标，图表和仪表。

布局

此核心卡适用于所有布局：全屏、居中、宽屏、角落、芯片、条带或任何自由矩形。

布局：全屏，自由，居中，宽屏，角落，芯片，条带。表单：横向，纵向。

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

数据与隐私

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

属性

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

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

静态属性

名称	类型	默认	数值和限制	描述
`title`	string	`""`	maxLength：`60`
`prefix`	string	`""`	maxLength：`3`	每个金额前，例如$。
`unit`	string	`""`	maxLength：`12`	每个数量后，例如千克或“餐”。
`decimals`	integer	`0`	最小值：`0`；最大值：`2`
`style`	string		`"ring"`, `"bar"`, `"thermometer"`	全屏图形：一个环（未设置时）、条形或温度计。中心、条带和芯片总是绘制条形。角落显示条形上的百分比，或者当为环时显示环。
`timeZone`	字符串，空值	`null`
`hero`	string	`"amount"`	`"amount"`, `"percent"`	大数字：筹集金额或百分比。另一个是小数字。
`presence`	string	`"always"`	`"always"`, `"milestone"`, `"deadline-soon"`	里程碑：在达到里程碑或目标后的presenceWindow分钟内显示卡片。截止日期临近：仅在截止日期距离不超过soonDays天时显示。
`presenceWindow`	integer	`10`	最小值：`1`；最大值：`1440`	里程碑或目标达成后卡片持续显示的分钟数（出席里程碑）。
`soonDays`	integer	`3`	最小值：`0`；最大值：`60`	在截止日期前几天卡片出现（临近截止提醒）。
`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})?$"`	覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称	类型	默认	数值和限制	描述
`value`	number		必填
`goal`	number		最小值：`1e-06`；必填
`deadline`	字符串，空值	`null`		ISO 8601 日期或瞬时；本地日期使用该时区。
`milestones`	array	`[]`	maxItems：`8`
`previous`	数字，空值	`null`		变更前的值，发生在 `changedAt`；填充从该值延伸到当前值。
`changedAt`	字符串，空值	`null`		数值变化的 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}}'