目录卡片

一栋楼的目录:租户、部门或人员及其楼层和套间,表格自动分页。

直播卡片

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

类别:人员。标签:导向和目录,大堂和接待处,办公室和工作场所,医疗保健。

布局

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

布局:全屏。表单:横向,纵向。

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

数据与隐私

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

属性

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

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

静态属性

名称类型默认数值和限制描述
titlestring"Directory"maxLength:40
orderstring"name""name", "floor", "listed"名称:A到Z。楼层:先最低楼层,然后A到Z。列表:按给定顺序。
rowsPerPageinteger6最小值:3;最大值:16完整视图页面上的行数,最多为表单所能容纳:横屏5行(无详情时7行),竖屏7行(无详情时10行)。列表均匀分布在各页。
pageSecondsinteger12最小值:4;最大值:60每页保持的秒数。
floorLabelstring"Floor"maxLength:12
suiteLabelstring"Suite"maxLength:12
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})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
entriesarray[]minItems:0;maxItems:200
entries[].namestringminLength:1;maxLength:60;必填
entries[].detailstring""maxLength:60名字下方的一行:行业、部门、职位。
entries[].floorstring""maxLength:12数字显示为“3楼”;其他文本(“底层”、“大堂”)按原样显示。
entries[].suitestring""maxLength:12带数字的套房显示为“Suite 305”;其他文本按原样显示。
entries[].highlightbooleanfalse保持此列表点亮(黄金时段):带有强调边缘和重复的光扫效果。无标记列表时,聚光灯沿页面移动。
footnotestring""maxLength:120

画布示例

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

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

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

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

写入实时数据

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

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

{
  "entries": [],
  "footnote": ""
}
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":{"entries":[],"footnote":""}}'