数字卡片

一个带标签、前缀和后缀的主要数值,颜色各异,并显示变化。

一个带标签的大数值,设置为大号清晰,适合远距离阅读。可填满屏幕、居中、靠角、单行或沿边显示。标签、前缀和后缀各自设色,长数字可分组缩写,变化用箭头和好坏色调表示,并显示与前值的差异。

直播卡片

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

类别:运营。标签:数字和指标,价格和费率。

布局

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

布局:全屏,居中,宽屏,角落,芯片,条带。表单:横向,纵向,方形,条带。

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

数据与隐私

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

属性

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

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

静态属性

名称类型默认数值和限制描述
prefixstring""maxLength:6数字前绘制,较小:货币符号。
prefixColor字符串,空值null模式:"^(#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?|base|text|muted|faint|accent|accent2|accent3|onAccent|surface|surfaceStrong|stroke|highlight|danger|warning|success|cool|warm)$"调色板键(强调、柔和、文本、成功、危险、暖色……)或 #RRGGBB 颜色。null:强调色。
suffixstring""maxLength:8数字后绘制,较小:单位或百分号。
suffixColor字符串,空值null模式:"^(#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?|base|text|muted|faint|accent|accent2|accent3|onAccent|surface|surfaceStrong|stroke|highlight|danger|warning|success|cool|warm)$"调色板键或 #RRGGBB 颜色。null:柔和色。
decimals整数,空值null最小值:0;最大值:4小数点后的位数。null:根据数值需要,最多两位(缩写时为一位)。
groupingbooleantrue千位分隔符(1,284)。
compactstring"auto""auto", "always", "never"缩写千、百万、十亿和万亿(12.3k、3.4M)。auto 从 10,000 起缩写;always 从 1,000 起缩写。
signstring"auto""auto", "always", "negative"自动:负值显示负号(不四舍五入为零)。始终:正值也显示加号。负数:仅负值显示负号,如自动。
changeUnitstring"%"maxLength:6跟随变化:百分比或单位;空白表示纯数字。
goodWhenstring"up""up", "down"变化方向哪个更好(等待时间和成本为下降)。
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数字,空值null最小值:-1000000000000000.0;最大值:1000000000000000.0大数字。null 显示为破折号。
labelstring""maxLength:40数字含义。
change数字,空值null最小值:-1000000000000000.0;最大值:1000000000000000.0数值变动多少,用箭头和好坏语气显示。
changeLabelstring""maxLength:30变化对比:与上周相比。
previous数字,空值null最小值:-1000000000000000.0;最大值:1000000000000000.0变更前的值。使用 changedAt 时,每个屏幕一起从该值计数到当前值。
changedAt字符串,空值null数值变化的 ISO 8601 时间点。结合之前数值,从此时间点开始数字递增或递减。

画布示例

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

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

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

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

写入实时数据

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

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

{
  "value": null,
  "label": "",
  "change": null,
  "changeLabel": "",
  "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":null,"label":"","change":null,"changeLabel":"","previous":null,"changedAt":null}}'