图表卡片

柱状图、条形图、折线图、面积图或环形图,包含一个主数据,少量网格线和直接标签。

柱状图、条形图、折线图、面积图或环形图用于距离显示,包含一个主数据,少量网格线和直接标签。它可以填满整个屏幕,居中显示在盒子内,缩小为角落的小方块,作为角落的一条线运行,或沿边缘拉伸为带状。你可以选择柱状图、条形图、折线图、面积图或环形图,是否堆叠系列,主数据为最新值、第一系列总和或峰值,水平目标线,以及哪个变化方向为好。

直播卡片

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

类别:运营。标签:图表与仪表,数字与指标,办公室与工作场所。

布局

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

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

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

数据与隐私

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

属性

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

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

静态属性

名称类型默认数值和限制描述
titlestring""maxLength:60
subtitlestring""maxLength:80
kindstring"column""column", "bar", "line", "area", "donut"柱状图:垂直条;条形图:水平条;甜甜圈图使用第一系列。
prefixstring""maxLength:3每个数值前,例如$。
unitstring""maxLength:6每个数值后,例如%或k。
decimalsinteger0最小值:0;最大值:4
stackedbooleanfalse堆叠系列(柱状图和条形图)。
showValuesbooleantrue
targetLabelstring"Target"maxLength:24
heroValuestring"auto""auto", "latest", "total", "max", "none"主角数字:最新值(堆栈的最后总数)、第一系列的总数、峰值或无。auto为最新值,水平条的为总数,其类别非序列。甜甜圈图为其总数(当值为百分比时为最大份额)。
showChangebooleantrue显示最新值相对于前一个点的变化。
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})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
seriesarrayminItems:1;maxItems:4;必填
series[].namestring""maxLength:32
series[].valuesarrayminItems:1;maxItems:31;必填
labelsarray[]maxItems:31每个值对应一个类别标签。
target数字,空值null一条水平目标线。
changedAt字符串,空值null最新点到达的 ISO 8601 时间点。从此时间点起,英雄在所有屏幕上从之前的数字计数到新的数字。

画布示例

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

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

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

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

写入实时数据

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

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

{
  "series": [
    {
      "values": [
        1
      ]
    }
  ],
  "labels": [],
  "target": null,
  "changedAt": 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":{"series":[{"values":[1]}],"labels":[],"target":null,"changedAt":null}}'