Dashboard nodes
Three nodes in the Display category exist for dashboards. Any node that can
publish a panel works with Export Dashboard (see the
Dashboards reference); these three are made for it.
Sources: backend/core/nodes/dashboard_parameter.py, kpi_nodes.py and
dashboard_text.py. Demo: projects/demo_project/dashboard/dashboard_parameters_demo.weave.
Nodes
| Node | What it does |
|---|---|
| Dashboard Parameter | A value the viewer of an exported dashboard can change. In the editor it just emits its Default |
| KPI Tile | Shows a single number as a big tile, with a label and optional unit. The value passes through unchanged |
| Dashboard Text | A heading, description or note, as plain text or Markdown. The text passes through unchanged |
Dashboard Parameter
Declares one input the viewer controls. In the exported dashboard it becomes a control, and pressing Recalculate re-runs the workflow with the value they chose.
| Field | Meaning |
|---|---|
| Name | The key the dashboard uses. Unique, and a valid identifier (letters, digits, underscore) |
| Label | Text shown next to the control. Blank uses the name |
| Type | float, int, str, bool or select; this decides the control |
| Default | The starting value, and the value used in the editor and in Python exports |
| Min / Max / Step | Shown for float and int only. Blank means no limit. Enforced by the backend |
| Options | Shown for select only. Comma-separated; the Default must be one of them |
The output is the parameter's value: the viewer's choice during a dashboard recalculation, otherwise the Default. In a Python export the node becomes its typed Default.
KPI Tile
| Field | Meaning |
|---|---|
| Label | The caption under the number (also the panel's title) |
| Unit (suffix) | Added after the number, for example % |
| Decimal places | How many decimals the tile in the editor shows |
Wire any number into it. Because the value passes through, a KPI Tile can sit in the middle of a chain.
Dashboard Text
| Field | Meaning |
|---|---|
| Title | The card title. Blank shows the text with no title bar |
| Format | markdown (default) or text (shown exactly as written) |
| Text | What to show. A wired-in string overrides it |
Markdown supports #, ## and ### headings, **bold**, *italic*,
`code`, bullet lists (- item), numbered lists (1. item) and
[links](https://example.com). Only http and https links are kept, and the
text is never treated as HTML, so pasted markup stays as written.
Because a wired-in string wins over the field, you can show a computed summary, for example the output of a formatting node, instead of typing it.
Equivalent Python
All three are exportable. In a Python export the parameter becomes its typed Default, and the KPI Tile and Dashboard Text return their input.