仪表卡片

一条朝目标填充的横杆或环,显示其数值、单位和可选标签。

一个空的条形或环形图向目标填充,数值以大数字显示,单位在旁,可选标签,使得从房间另一端一眼就能读出测量值。它可以充满屏幕,居中显示,嵌入角落,作为一行显示在角落,或沿边缘拉伸成带状。你设置数值、目标和可选标签,数字旁可带货币符号或单位。你选择条形或环形图,以及警告和危险级别,填充颜色在数值较高时变化,适用于数值越高越好或越坏的测量。

直播卡片

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

类别:运营。标签:数字和指标,图表和仪表。

布局

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

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

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

数据与隐私

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

属性

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

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

静态属性

名称类型默认数值和限制描述
prefixstring""maxLength:8数值前,小号:货币符号。
suffixstring""maxLength:12数值后,小号:单位(%,kW,GB)。
stylestring"bar""bar", "ring"盒子上的一条横杆或带内的数值环。
decimals整数,空值null最小值:0;最大值:4要显示的小数位数;空值仅显示实际需要的小数位,最多一位。
groupingbooleantrue千位数用逗号分隔。
tonestring"cool""success", "warm", "danger", "cool", "accent", "muted"填充颜色,调色板键,当未设置阈值时使用。
warnAt数字,空值null最小值:0;最大值:1000填充达到警告状态的目标百分比:当 goodWhen 上升时低于此值,下降时高于此值。
dangerAt数字,空值null最小值:0;最大值:1000填充达到危险状态的目标百分比:当 goodWhen 上升时低于此值,下降时高于此值。
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 显示为破折号和空条。
goalnumber100最大值:1000000000000000.0;exclusiveMinimum:0数值的参照标准:满条或满环。
previous数字,空值null最小值:-1000000000000000.0;最大值:1000000000000000.0最新变更前的值。使用 changedAt 时,每个屏幕一起从该值计数并填充到新值。
changedAt字符串,空值nullmaxLength:40数值变化的 ISO 8601 时间点。
labelstring""maxLength:40主题标签中度量的简短名称。

画布示例

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

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

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

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

写入实时数据

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

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

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