周排程卡片

一周概览:横向为天,纵向为小时,每节课、班次或预订按时长绘制并按组着色,今日以当前时间线标示;竖屏和方形视图显示为按天的日程表。

查看一周,天数横向排列,小时纵向排列。课程、班次和预订按持续时间绘制,并按组着色,标记今天和当前时间。纵向和方形形式显示从今天开始的议程,并按天分页。

直播卡片

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

类别:运营。标签:排程,办公室和工作场所,活动和场馆。

布局

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

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

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

数据与隐私

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

属性

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

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

静态属性

名称类型默认数值和限制描述
titlestring"This week"maxLength:30
daysinteger55, 6, 7从周一开始显示的天数:5 表示周一到周五,7 表示整周。
weekOffsetinteger0最小值:-8;最大值:80 表示本周,1 表示下周,-1 表示上周。
hour12booleanfalse时间显示为上午9:00,而非09:00。
startHourinteger最小值:0;最大值:23网格的第一小时;默认最早事件。
endHourinteger最小值:1;最大值:24网格结束时间;默认是最新事件。
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})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
eventsarray[]maxItems:200本周的课程、班次或预订,顺序不限。时间为 ISO 8601 格式;无时区偏移的时间为屏幕本地时间。
events[].idstring""maxLength:40为事件设置键值,已显示的事件不会再次动画。
events[].titlestringminLength:1;maxLength:60;必填
events[].startstringmaxLength:40;必填开始时间,例如2026-10-14T09:00。
events[].endstring""maxLength:40结束时间;为空表示开始后一小时。
events[].placestring""maxLength:40房间、工作室或地点。
events[].whostring""maxLength:40讲师、主持人或值班人员。
events[].groupstring""maxLength:30同一组的事件共享一种颜色,例如课程类型或团队。

画布示例

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

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

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

{
  "id": "week-schedule",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

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

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

{
  "events": []
}
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":{"events":[]}}'