跳至内容

Board 模板

一个由最多四个带标签磁贴组成的紧凑仪表板 — 每个磁贴都有数值、图标、趋势箭头和各自的点按目标 — 一目了然地呈现相关指标。

实时活动演示

Fields

FieldTypeDescription
templatestringRequired. Must be "board"
tilesarrayRequired. 1–4 tile objects (see below). Sending more than four is rejected with a validation error. Replaced wholesale on PATCH — re-send the full array and the board redraws in place (why)
statestringStatus text shown beside the activity name (e.g. "All systems nominal")
iconstringSF Symbol name (e.g. "server.rack") or MDI icon with mdi: prefix
accent_colorstringNamed color or hex used for the heading icon and tile values. Default: teal
background_colorstringBackground color override
text_colorstringText color override
将在应用版本 1.14.0 中推出

Tile object

Each entry in tiles is an object:

FieldTypeDescription
labelstringRequired. Tile caption. Max 32 characters
valuestringRequired. Primary value. Max 16 characters
unitstringUnit suffix shown after the value (e.g. "%", "GB"). Max 8 characters
iconstringSF Symbol or MDI icon shown beside the label
colorstringNamed color or hex for this tile's value. Falls back to accent_color
trendstringOne of up, down, flat — renders a trend arrow
url_actionobjectPer-tile tap target. Same shape as tap actions

Tiles share the ~4 KB APNs payload with the rest of the activity, so keep labels and values short.

Each tile can carry its own url_action, so one board can deep-link to several destinations — see Tap actions.

Example: Service Status Board

服务状态看板
{
  "state": "ongoing",
  "content": {
    "template": "board",
    "state": "All systems nominal",
    "icon": "server.rack",
    "accent_color": "green",
    "tiles": [
      { "label": "Uptime", "value": "99.98", "unit": "%", "icon": "checkmark.circle", "color": "green", "trend": "flat" },
      { "label": "CPU", "value": "47", "unit": "%", "icon": "cpu", "color": "cyan", "trend": "up" },
      { "label": "Memory", "value": "6.2", "unit": "GB", "color": "blue" },
      {
        "label": "Errors",
        "value": "3",
        "unit": "/h",
        "icon": "exclamationmark.triangle",
        "color": "orange",
        "trend": "down",
        "url_action": { "url": "https://grafana.example.com/errors", "foreground": true }
      }
    ]
  }
}

Use Cases

  • Infrastructure — uptime, CPU, memory, and error-rate at a glance
  • Smart home — room temperatures, energy use, device states
  • Media servers — active streams, queue depth, transcodes, library size
  • Sports & finance — scoreboards, portfolio tickers, KPI dashboards