图钉地图卡片

在您提供的地图或楼层平面图上放置编号目的地。

使用校准的图像尺寸和提供的相对标记位置显示项目-媒体地图,并可选“你在这里”标记。附近标记在稳定编号下聚集,带有分页图例中的名称和备注;每个标记保持在地图上,当前页高亮显示。长名称和备注自动换行。关闭的目的地仍标记。黄金时段添加错落入场和缓慢地图折线效果,计划保持静止。

直播卡片

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

类别:公共信息。标签:导向和目录,大堂和接待处,活动和场馆。

布局

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

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

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

数据与隐私

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

场馆地图和目的地信息;位置标记由您提供,不进行跟踪。

属性

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

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

静态属性

名称类型默认数值和限制描述
titlestring"Find your way"maxLength:100
perPageinteger6最小值:3;最大值:8
pageSecondsinteger12最小值:8;最大值:120
clusterDistancenumber0.035最小值:0;最大值:0.1集群距离为较长计划维度的分数;位置相对于提供的计划保持不变。
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})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
plan对象,空值nulladditionalProperties:false
plan.imagestringmaxLength:2048;必填
plan.widthinteger最小值:1;最大值:32768;必填
plan.heightinteger最小值:1;最大值:32768;必填
plan.namestring""maxLength:120
plan.creditstring""maxLength:160
plan.updatedAtstring""maxLength:64
plan.here对象,空值nulladditionalProperties:false
plan.here.xnumber最小值:0;最大值:1;必填
plan.here.ynumber最小值:0;最大值:1;必填
plan.pinsarraymaxItems:64;必填
plan.pins[].idstringminLength:1;maxLength:48;必填
plan.pins[].namestringminLength:1;maxLength:120;必填
plan.pins[].xnumber最小值:0;最大值:1;必填
plan.pins[].ynumber最小值:0;最大值:1;必填
plan.pins[].detailstring""maxLength:200
plan.pins[].statusstring"normal""normal", "attention", "closed"

画布示例

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

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

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

{
  "id": "pin-map",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

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

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

{
  "plan": 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":{"plan":null}}'