直播卡片
类别:运营。标签:数字和指标,图表和仪表,办公室和工作场所。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
此卡使用其配置的属性和实时卡数据。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "" | maxLength:60 | |
compact | boolean | false | ||
cycleSeconds | integer | 6 | 最小值:3;最大值: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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
tiles | array | minItems:1;maxItems:12;必填 | ||
tiles[].label | string | maxLength:40;必填 | ||
tiles[].value | number | 必填 | ||
tiles[].unit | string | "" | maxLength:6 | 货币符号领先($1,280);其他单位跟随(98.6%,120 毫秒)。 |
tiles[].decimals | 整数,空值 | null | 最小值:0;最大值:4 | 空值:整数为无,其他为一。 |
tiles[].compact | 布尔值,空值 | null | 千、百万和十亿的缩写(12.4K,3.2M)。null遵循卡片的紧凑格式。 | |
tiles[].delta | 数字,空值 | null | ||
tiles[].deltaUnit | string | "%" | maxLength:6 | % 表示百分比;空字符串表示纯数字;其他内容跟随其后。 |
tiles[].deltaLabel | string | "" | maxLength:30 | |
tiles[].goal | 数字,空值 | null | ||
tiles[].trend | array | [] | maxItems:60 | |
tiles[].invert | boolean | false | 当数值越低越好(等待时间、成本)时为真。 | |
tiles[].changedAt | 字符串,空值 | null | 数值变化的 ISO 8601 时间点。几秒内图块播放其时刻:数字跳动,达成目标或突破限制时出现接管效果。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type kpi --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "kpi",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"tiles": [
{
"label": "Example",
"value": 1
}
]
}
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":{"tiles":[{"label":"Example","value":1}]}}'