Roles
All 248 roles, generated from the role registry (src/roles.rs). dashboard --roles prints the same list; dashboard --check flags an unknown one. Chart kinds have a page each.
Chart kinds
Section titled “Chart kinds”| Cast | Also | Meaning |
|---|---|---|
::BARCHART |
::BAR |
bar chart (dodged by CATEGORY) |
::BARCHART_STACKED |
::BAR_STACKED, ::STACKED_BAR |
stacked bars (by CATEGORY) |
::BARCHART_PERCENT |
::BAR_PERCENT |
dodged bars as % of each x’s total (fractions ≤ 1 are drawn as given) |
::BARCHART_STACKED_PERCENT |
::BAR_STACKED_PERCENT |
bars normalised to 100% per x |
::LINECHART |
::LINE |
line chart |
::LINECHART_PERCENT |
::LINE_PERCENT |
line chart, percent y-axis |
::STEP |
::STEPLINE, ::STEP_LINE |
step line |
::SMOOTH |
::TRENDLINE, ::TREND_LINE |
scatter + trend line (LOESS; ::SMOOTH_METHOD ‘lm’/‘gam’) |
::AREACHART |
::AREA |
area chart |
::AREACHART_STACKED |
::AREA_STACKED, ::STACKED_AREA |
stacked areas (by CATEGORY) |
::SCATTER |
::POINT, ::SCATTERCHART |
scatter; add a ::SIZE column for a bubble chart |
::BUBBLE |
::BUBBLECHART |
bubble chart: alone = the y measure (size via ::SIZE); beside a ::SCATTER = its size |
::JITTER |
::JITTERCHART, ::STRIP |
jittered scatter (reveals overlapping points) |
::PIE |
::PIECHART, ::PIECHART_PERCENT |
pie — slices by CATEGORY, sized by the measure |
::DONUTCHART |
::DONUT, ::DONUTCHART_PERCENT |
donut (pie with a hole) |
::GAUGE |
::GAUGE_PERCENT |
value as an arc toward ::RANGE ‘min,max’ (zones: ::COLORS, ::LABELS) |
::RADAR |
::SPIDER |
radar / spider chart — axes from XAXIS, one polygon per CATEGORY |
::WATERFALL |
::BRIDGE |
bridge from a start total through signed steps (NULL / ::CATEGORY ‘total’ rows = totals) |
::BULLET |
::BULLETCHART |
measure per XAXIS row vs a ::GOAL tick over ::RANGE bands ‘60,80,100’ |
::FUNNEL |
::FUNNELCHART |
ordered XAXIS stages, widths by value, conversion % from the previous stage |
::SANKEY |
::SANKEYCHART |
flows between stages: ::ORIGIN → ::DEST, link width by the measure; nodes stack in columns |
::TREEMAP |
::TREE_MAP |
part-to-whole tiles, area by the measure: ::XAXIS names a tile (its key; a ::LABEL then shows a name instead), ::CATEGORY nests tiles in groups |
::PARETO |
::PARETOCHART |
XAXIS categories as bars sorted largest first, with the cumulative share as a line on a 0–100 % right axis |
::GANTT |
::GANTTCHART, ::TIMELINE_BARS |
one bar per task (this column names it) from ::XMIN to ::XMAX (dates or numbers); ::CATEGORY colours the bars |
::DUMBBELL |
::DUMBBELLCHART, ::SLOPE |
two values per item (this column names it) joined by a line: ::XMIN → ::XMAX (before/after, plan/actual) |
::HISTOGRAM |
::HIST |
histogram of the measure; takes ::FLIP (horizontal, with ::FACET panels too), ::YFORMAT / ::YSCALE on its count axis, ::DATALABELS (each bin’s count, or share under ::HIST_NORM), ::ABLINE, ::XLINE |
::DENSITY |
::KDE |
kernel density curve (one per CATEGORY) |
::RIDGELINE |
::RIDGES, ::JOYPLOT |
one density of the measure per ::CATEGORY, stacked as overlapping ridges (distributions over time; the first category on top) |
::BOXPLOT |
::BOX_PLOT |
box plot — XAXIS groups, measure on y (raw rows) |
::VIOLIN |
::VIOLINPLOT |
violin plot — XAXIS groups, measure on y (raw rows) |
::QQ |
::QQPLOT |
normal quantile-quantile plot with a 95% pointwise band |
::HEATMAP |
::TILE, ::TILES |
tiles at XAXIS×YAXIS coloured by the measure (rows in SQL order; diverging around 0); a numeric measure sizes every tile alike regardless of how many x points each row has; a text measure (status words) takes ::COLORS as a level map for a categorical legend, like a ::CATEGORY column’s |
::CALENDAR |
::CALENDAR_HEATMAP, ::CAL_HEATMAP |
calendar heatmap (date XAXIS, ≤ 50 years) |
::CANDLESTICK |
::CANDLE, ::OHLC |
OHLC candlesticks: XAXIS + ::OPEN/::HIGH/::LOW, close as the measure |
::SPARKLINE |
::SPARK |
minimal trend line (no axes); a list() column in a table; on a map: a mini chart in each feature’s tooltip |
::SPARKBAR |
::SPARK_BAR |
minimal bar histogram (no axes); a table cell’s list(v ORDER BY i), or two overlaid series sharing one y scale from list({‘ref’: r, ‘cur’: c} ORDER BY i); on a map: a mini chart in each feature’s tooltip |
::MAP |
::GEOMETRY, ::GEO, ::CHOROPLETH |
WKT-geometry map, coloured by a measure |
::REGION |
::REGION_CODE, ::ISO_CODE |
a map region by code, drawn from the built-in boundaries: ISO 3166-1 (‘DE’, ‘DEU’), ISO 3166-2 (‘DE-BY’, ‘US-CA’: states and provinces everywhere), German AGS (‘09162’) or NUTS (‘DE212’), else a name |
::LAT |
::LATITUDE |
a map point’s latitude (degrees, WGS84), with ::LON |
::LON |
::LONGITUDE, ::LNG |
a map point’s longitude (degrees, WGS84), with ::LAT |
::ORIGIN |
::FROM_PLACE |
a flow map’s start: a region code (‘DE-BY’), a WKT POINT or {‘lon’: …, ‘lat’: …, ‘name’: …} — with ::DEST, width by ::SIZE |
::DEST |
::DESTINATION, ::TO_PLACE |
a flow map’s end (see ::ORIGIN) |
::BASEMAP |
::MAPBASE, ::BACKDROP |
a backdrop under a map: WKT, or a built-in layer ‘world’, ‘de-states’, ‘de-districts’ |
::DIAGRAM |
::NODE |
node/edge diagram, one row per node (this column = the id; ::LABEL, a KPI format, ::BADGE in the box; edges from ::UPSTREAM / ::EDGES) |
Encodings
Section titled “Encodings”| Cast | Also | Meaning |
|---|---|---|
::XAXIS |
::X |
x position |
::YAXIS |
::Y |
y position (a heatmap’s second axis) |
::CATEGORY |
::SERIES, ::COLOR, ::COLOUR |
grouping / colour series (discrete) |
::LABEL |
section heading when alone; chart title / per-mark or per-feature label otherwise (on a scatter: the tooltip heading, drawn on the chart when only some rows, at most 20, carry one) | |
::TITLE |
::HEADING |
a title bar above one panel |
::ALT |
::ALT_TEXT |
an image’s text alternative (‘’ = decorative); falls back to ::TITLE, then ::LABEL |
::SUBTITLE |
::SUBHEADING |
a line under the panel’s title (smaller, muted) |
::CLASS |
a class of the operator’s stylesheet on the panel (a name of a-z, 0-9 and -; the page adds ax-c-) | |
::INFO |
::DESCRIPTION, ::DEFINITION |
a definition behind an ⓘ on the panel’s title bar (hover, focus or click) |
::OPEN |
candlestick open price | |
::HIGH |
candlestick high price | |
::LOW |
candlestick low price | |
::SIZE |
bubble size for a scatter (maps a measure to point area); on a map a symbol’s area (graduated symbols) or a flow’s width; a constant (4::SIZE) sets the point size | |
::Q1 |
::QUARTILE1, ::LOWER_QUARTILE |
a box plot from statistics, one row per box: the lower quartile (with ::MEDIAN and ::Q3; no ::BOXPLOT) |
::MEDIAN |
::Q2 |
the median line of a box from statistics (see ::Q1) |
::Q3 |
::QUARTILE3, ::UPPER_QUARTILE |
the upper quartile of a box from statistics (see ::Q1) |
::WHISKER_LOW |
::WHISKER_LOWER, ::LOWER_WHISKER |
the lower whisker end of a box from statistics (without it: none) |
::WHISKER_HIGH |
::WHISKER_UPPER, ::UPPER_WHISKER |
the upper whisker end of a box from statistics |
::MEAN |
::AVERAGE |
a box’s mean from statistics, drawn as a dot |
::OUTLIERS |
::OUTLIER_LIST |
a box’s outliers from statistics: a list of numbers, drawn as open circles |
::YMIN |
::Y_MIN |
lower end of a y interval: a ::SCATTER becomes a pointrange, other measures get error bars |
::YMAX |
::Y_MAX |
upper end of a y interval (see ::YMIN) |
::XMIN |
::X_MIN |
lower end of a horizontal interval through each point |
::XMAX |
::X_MAX |
upper end of a horizontal interval (see ::XMIN) |
::FACET |
::FACET_WRAP, ::PANEL_BY |
small multiples: one panel per distinct value, shared axes; on a map: one map per value, sharing projection, extent, classes and one legend |
::FACET_FREE |
::FACET_WRAP_FREE |
small multiples with independent axes per panel (y only on a discrete x) |
::RANK |
::LABEL_RANK |
score ranking points for ::LABEL_TOP (higher = labelled first) |
::CENSOR |
::CENSORED, ::N_CENSOR |
censoring marks (+) on a ::STEP curve where the value is > 0 / true (Kaplan-Meier) |
::UPSTREAM |
::PARENTS |
a ::DIAGRAM node’s input(s): an id or a list of ids → edges into the row’s node |
::LANE |
::SWIMLANE |
a ::DIAGRAM node’s swimlane: nodes of one lane share a labelled band |
::BELIEF |
::NODE_BELIEF |
a ::DIAGRAM node’s belief: JSON {lo, hi, its: [[iteration, mean, sd], …], prior: [mean, sd]} — a density curve over the node, re-shaped per iteration by the message steps; the optional prior a dashed outline behind it |
::SHAPE |
::NODE_SHAPE |
a ::DIAGRAM node’s mark: box, circle, filled-circle, square, filled-square, terminal, text — or a factor graph’s kind (factor, variable, data, equality, delta, constant); shaped nodes make a factor graph: lanes as straight bands, undirected edges |
::EDGES |
a ::DIAGRAM’s edges: (SELECT list({‘from’: a, ‘to’: b, ‘value’: n, ‘label’: t, ‘style’: ‘flow’, ‘status’: ‘delayed’}) FROM e) — width by value, colour by status | |
::BIVARIATE |
::BIVAR |
a map’s second measure: regions coloured by tertiles of both (a 3×3 palette and legend) — with the measure column |
::FRAME |
::PLAY_BY, ::TIME_FRAME |
a time map’s (or a bar/line/area/scatter chart’s) frame key (a week, a date): one result holds every frame; Play steps through them with shared colours, classes, sizes and axes; static output shows the last frame |
::DIAGRAM_MODE |
::DIAGRAM_EDIT |
on a ::DIAGRAM: ‘edit’ lets the viewer add, connect, rename and remove nodes; the alias names the variable holding the edited graph as JSON {nodes:[{id,type,label}], edges:[{from,to}]} |
Modifiers
Section titled “Modifiers”| Cast | Also | Meaning |
|---|---|---|
::PARETO_TOTAL |
the grand total a ::PARETO’s cumulative share is of, for a top N of a longer list: the line ends at the top N’s share, not 100 % | |
::FLIP |
::COORD_FLIP, ::HORIZONTAL |
swap the axes (horizontal bars; the first row on top) |
::YFORMAT |
::YAXISFORMAT, ::YUNIT, ::YCURRENCY |
value format — y ticks, tooltips, data labels, heatmap legend: ‘€’, ‘$’, ‘percent’ (values 0–100), ‘comma’, ’ kg’… |
::CURRENCY_CODE |
::CURRENCYCODE, ::ISO_CURRENCY |
the panel’s currency as an ISO 4217 code beside the value: ‘EUR’, ‘USD’, ‘GBP’, ‘CHF’… — ::MONEY KPIs and table columns, and a chart’s y axis without its own ::YFORMAT; symbol and placement follow ::LOCALE (€1,234 / 1.234 €) |
::Y2 |
::SECONDARY_AXIS, ::RIGHT_AXIS |
the measure column (its header) drawn on a right-hand axis of its own: ‘margin_pct’ — revenue bars with a margin line; in the chart’s own SELECT |
::Y2FORMAT |
::Y2AXISFORMAT |
the ::Y2 axis’ value format, like ::YFORMAT: ‘percent’, ‘€’, ’ kg’… |
::XFORMAT |
::XAXISFORMAT, ::XUNIT, ::XCURRENCY |
x-axis tick format (continuous x), like ::YFORMAT; on a date/timestamp x a strftime pattern: ‘%H:%M’, ‘%-d %b’, ‘%b %Y’, ‘%a %H:%M’ |
::XSCALE |
::XTRANS |
x-axis transform: ‘log10’, ‘sqrt’ or ‘reverse’ |
::YSCALE |
::YTRANS |
y-axis transform: ‘log10’, ‘sqrt’ or ‘reverse’ |
::XBREAKS |
::X_BREAKS |
explicit x-axis tick positions, in data units — ‘100,1000,10000’; overrides the automatic ticks (and, under ::XSCALE, their log/sqrt round-number placement) |
::YBREAKS |
::Y_BREAKS |
explicit y-axis tick positions, like ::XBREAKS |
::FACET_NCOL |
::NCOL |
panels per row of a ::FACET / ::FACET_FREE |
::SMOOTH_METHOD |
::METHOD |
trend line method of a ::SMOOTH: ‘loess’ (default), ‘lm’, ‘gam’ (‘glm’ = Gaussian lm) |
::HIST_BINS |
a ::HISTOGRAM’s bin count (‘20’) or explicit edges (‘0,10,20,30’), shared by every ::CATEGORY / ::FACET group — distinct from ::BINS, which aliases ::CLASSES (a map’s colour-class breaks) | |
::HIST_NORM |
a ::HISTOGRAM’s per-group normalisation: ‘share’ draws each ::CATEGORY / ::FACET group’s bars as a share of that group’s own count (groups of unequal size stay comparable); default: raw counts | |
::ALPHA |
::OPACITY |
opacity 0..1: a map layer, or a scatter’s / bubble’s / jitter’s points (dense scatters) |
::SYNC_ZOOM |
::ZOOM_GROUP |
maps with the same value (e.g. ‘routes’) zoom and pan together in the browser |
::SYNC_FRAME |
::FRAME_GROUP |
time maps (::FRAME) with the same value (e.g. ‘weeks’) step and play together in the browser, by frame label |
::XTITLE |
::X_TITLE, ::XLAB |
x-axis title, e.g. ‘Residual load (GW)’ — names the ::XAXIS variable, drawn under the x ticks (on a ::FLIP chart it moves with the x axis); charts with axes only |
::YTITLE |
::Y_TITLE, ::YLAB |
y-axis title, e.g. ‘Day-ahead price (EUR/MWh)’ — names the measure, drawn rotated beside the y ticks; charts with axes only |
::MAPTILES |
::MAP_TILES |
the installation’s tile basemap under this map: ‘on’ — needs ‘mercator’::PROJECTION and a server with options.basemap (off otherwise) |
::PROJECTION |
::PROJ |
map projection: ‘auto’ (default, by the data’s extent), ‘equal-earth’, ‘mercator’, ‘albers-europe’, ‘conic’, ‘utm’, ‘none’ (planar x/y) |
::CLASSES |
::CLASS_BREAKS, ::BINS |
map colour classes: ‘quantile 5’, ‘jenks 5’, ‘equal 5’ or edges ‘0,10,50,100’ — a stepped legend with a count per class |
::MIDPOINT |
centre of a map’s diverging colour ramp (default 0 when the values span it) | |
::SIGN_SPLIT |
::SPLIT_AT |
colour a single-series ::LINECHART, ::AREACHART or ::DENSITY by the side of a threshold, red below and green above, cut exactly at the crossing: a number (default 0; along y, along x for a density), ‘x 0’ / ‘y 100’, and ‘below:bad; above:good’ (status or #rrggbb) |
::BOUNDARIES |
::REGION_SET |
the built-in layer a ::REGION is looked up in: ‘world’, ‘world-50m’, ‘world-states’, ‘de-states’, ‘de-districts’ (default: the layer most codes match) |
::HEXBIN |
::HEX |
aggregate a map’s points into hexagons (‘auto’ or a width across, ‘25 km’; planar: ‘2.5’; sums the measure, else counts rows) or, on a planar ::SCATTER, bin the points into a 2D count density (‘auto’ or a bin count across each axis) |
::THRESHOLDS |
::STATUS_RULES |
status rules ‘<0:bad; <0.05:warn; good’ — colour a KPI value, gauge zones, chart threshold lines, a ::HEATMAP’s tiles in steps; alone: the next table’s ‘column: rules | …’ |
::RANGE |
gauge domain ‘min,max’ (default 0,100); bullet band edges ‘60,80,100’; a map’s colour domain ‘lo,hi’ (caps outliers) | |
::COLORS |
::COLOURS |
gauge zone colours, comma-separated hex; beside a ::CATEGORY (a chart or a ::MAP) a level map ‘Critical:bad; Watch:warn; OK:good’ (status colours or #rrggbb) |
::LABELS |
gauge zone labels, comma-separated (drawn at each zone) | |
::DIRECTION |
a ::DIAGRAM’s direction: ‘LR’ (left to right, default) or ‘TB’ (top to bottom) | |
::ANIMATE |
::ANIMATION, ::ENTRANCE |
entrance animation: ‘auto’ (lines draw, bars grow, points stagger), ‘draw’, ‘grow’, ‘reveal’ (forward from the ::XLINE, e.g. Today) or ‘none’ |
::STORY_BY |
::STORYBY |
what a ::STORY step lights up: ‘x’ (default) or ‘series’ (the row’s ::CATEGORY) |
::TRANSITION |
::TWEEN |
on an input / cross-filter re-run: ‘tween’ moves the marks to their new values (≤ 300 ms), ‘none’ (default) swaps the chart |
::TOOLTIP |
::TIP |
a column shown in the chart’s hover tooltip only, by its alias (repeatable): units AS “Units” ::TOOLTIP |
::TOOLTIP_FORMAT |
::TOOLTIPFORMAT, ::POINT_FORMAT |
the tooltip’s line per point: ‘{series}: {y:€} ({Units} units)’ — {x}, {y}, {series}, {<::TOOLTIP alias>}, each with an optional :format (a ::YFORMAT keyword, .2f, or a strftime pattern for dates) |
::TOOLTIP_HEADER |
::TOOLTIPHEADER |
the tooltip’s header, same placeholders: ‘{x:%d %b %Y}’ |
::TOOLTIP_MODE |
::TOOLTIPMODE |
which marks the tooltip lists: ‘shared’ (every series at the x, a line chart’s crosshair — the default there), ‘single’ (only the hovered mark), ‘split’ (a label per series beside its point, on a line chart’s crosshair), ‘none’ (no tooltip) |
::HOVER_FOCUS |
::HOVERFOCUS |
hovering a mark: ‘series’ (default) emphasises its whole series and fades the others, as hovering its legend entry does; ‘none’ keeps the plain hover (dense charts) |
::POINTS |
::MARKERS |
line/area point markers: ‘auto’ (default) hides them on a dense series (x positions under 3 px apart) and keeps them as hover/click targets, ‘none’ always hides them, ‘always’ always draws them |
::NORTH_ARROW |
::NORTH, ::NORTHARROW |
a map’s north arrow, pointing to true north: ‘print’ (only in print, PNG, PDF and –svg output; hidden on screen) or ‘always’ |
::LINESTYLE |
::LINE_STYLE |
per row, by ::CATEGORY: ‘flow’ = moving dashes (a forecast, “predicted”; still dashes in static output), ‘dashed’, ‘solid’ |
::LEGEND |
a chart’s legend / colourbar: ‘none’ hides it, or ‘top’/‘right’/‘bottom’/‘left’ moves it; without it, unchanged |
Annotations
Section titled “Annotations”| Cast | Also | Meaning |
|---|---|---|
::REFLINE |
::TARGET, ::GOAL, ::YLINE |
horizontal reference line per distinct value; in a KPI statement the KPI’s goal → a progress bar; on a ::BULLET the per-row goal tick; on a box from statistics (::Q1/::MEDIAN/::Q3) a tick across each row’s box |
::XLINE |
vertical reference line at an x (a number, date or timestamp) | |
::COOKS_CONTOUR |
::COOKS |
Cook’s distance contours (0.5, 1) on residuals vs leverage; value = the model’s parameter count p |
::BAND_LOWER |
::BANDLOWER |
lower edge of a shaded band around a line; several ::BAND_LOWER / ::BAND_UPPER pairs = a nested fan |
::BAND_UPPER |
::BANDUPPER |
upper edge of a shaded band (pairs with the ::BAND_LOWER in the same position) |
::MARKAREA |
::MARK_AREA, ::SHADE |
shade each run of this column’s x-values: CASE WHEN flag THEN day END shades every spell |
::XLINE_LABEL |
::EVENT_LABEL |
label of the ::XLINE on the same row, at the top of the line (events from data) |
::REFLINE_LABEL |
::YLINE_LABEL, ::TARGET_LABEL |
label of the ::REFLINE on the same row, above its right end |
::XBAND_FROM |
::SHADE_FROM |
start of a shaded x-range, one per row (a number, date or timestamp) |
::XBAND_TO |
::SHADE_TO |
end of the shaded x-range started by ::XBAND_FROM on the same row |
::XBAND_LABEL |
::SHADE_LABEL |
label of the shaded x-range on the same row |
::ANNOTATE |
::ANNOTATION |
a text callout at the row’s (x, y); NULL rows draw nothing |
::DATALABELS |
::DATALABEL, ::VALUELABELS, ::SHOWLABELS |
draw the value on each mark or heatmap cell: a size (12), a place — ‘outside’ (past a bar’s end, the default), ‘inside’, ‘center’ (a stack’s default) — or both (‘inside 12’) |
::ABLINE |
::AB_LINE |
straight line y = slope·x + intercept per distinct ‘slope,intercept’ value |
::IDENTITY |
::DIAGONAL, ::IDENTITY_LINE |
dashed grey y = x line (predicted vs actual, calibration, QQ) |
::LABEL_TOP |
::LABELTOP, ::TOPLABELS |
label the top-k points (k = value) with the ::LABEL text, ranked by ::RANK or |y| |
::STORY |
::STORYLINE, ::NARRATIVE |
per row: a caption → a story step that lights up the row’s x (Step / Play controls, the rest dims) |
KPIs and text
Section titled “KPIs and text”| Cast | Also | Meaning |
|---|---|---|
::METRIC |
::KPI, ::BIGNUMBER |
big-number KPI (add ::LABEL for a caption) |
::MONEY |
::DOLLAR, ::CURRENCY |
currency KPI / table column format |
::PERCENT |
::PCT |
percent KPI / table column format; the value is in percent (12.5 → 12.5%; a fraction × 100) |
::COMPACT |
compact-number KPI / table column format (1.2K) | |
::DELTA |
::COMPARE, ::PREVIOUS |
comparison value → trend arrow + % on a KPI (up = good) |
::DELTA_LOWER_GOOD |
::COMPARE_LOWER_GOOD, ::DELTA_INVERSE |
comparison value where lower is better (churn, cost): a rise is drawn red |
::DELTA_FORMAT |
::DELTAFORMAT |
how a KPI’s change reads: ‘pct’ (default), ‘abs’ (in the KPI’s format: +$1,200, +2.3 pp) or ‘both’ |
::DELTA_LABEL |
::DELTALABEL, ::COMPARE_LABEL |
what the change compares against, shown after it: ‘vs last month’, getvariable(‘p_prev_label’) |
::KPI_SIZE |
::KPI_DENSITY |
KPI tile density: ‘compact’ (single line, value + label, no ::SPARKLINE/::GOAL) or ‘normal’ (default); on ::METRIC it sets that tile, on ::GROUP every tile in the box |
::TEXT_SMALL |
small text card | |
::TEXT_MEDIUM |
medium text card | |
::TEXT_LARGE |
large text card | |
::MARKDOWN |
::MD, ::TEXTBOX, ::RICHTEXT |
a Markdown box (browser; lists, links, GFM tables); {{col}} / {{col:fmt}} fill in values from its own row; $…$ / $$…$$ TeX formulas; |
::CALLOUT |
::ADMONITION |
draw the ::MARKDOWN box as a callout: ‘note’, ‘warning’ or ‘success’ |
::MARKDOWN_STYLE |
::MD_STYLE |
a ::MARKDOWN box’s chrome: ‘plain’ (page background, no card/tint/bar), ‘card’ (plain white card) or ‘callout’ (today’s tinted box, the default; ::CALLOUT implies it); ‘caption’ puts the text under the chart right before it, in its card; a dashboard-wide default comes from – @markdown_style |
::MARKDOWN_TONE |
::MD_TONE |
a quiet accent on a ‘card’ ::MARKDOWN box: ‘info’, ‘example’, ‘tip’, ‘caution’, ‘details’ or ‘neutral’ (none) — a thin coloured bar plus a small label; ‘example: Beispiel’ sets the label, ‘example:’ drops it; ‘details’ folds (the label opens it, in the browser); implies ‘card’ |
::IMAGE |
::PICTURE, ::IMG |
a static picture panel: ‘assets/x.svg’, data:image/… or https:; ::ALT is its text alternative, ::IMAGE_DARK a dark-theme variant, ::LABEL a caption |
::IMAGE_DARK |
::IMG_DARK |
the ::IMAGE shown while the dashboard is dark |
Tables
Section titled “Tables”| Cast | Also | Meaning |
|---|---|---|
::TABLE |
::GRID |
the whole result as a table (one marker per panel) |
::RECORD |
::KEY_VALUE |
one record as key/value pairs: a STRUCT / MAP / JSON object’s fields, or the first row’s columns |
::PAGED |
::TABLE_PAGED, ::PAGINATED |
SQL-paginated table for large/remote data |
::TREND |
▲/▼ arrow in a table cell | |
::PVALUE |
::P_VALUE |
a p-value in a table cell: ‘< 0.001’, else three decimals |
::SCIENTIFIC |
::SCI |
a number in scientific notation in a table cell (1.23e−5) |
::COLORSCALE |
::COLOURSCALE, ::HEAT, ::GRADIENT |
heatmap-colour a table column’s cells (low = green, high = red); on a ::HEATMAP / ::CALENDAR its tiles, good → warn → bad |
::COLORSCALE_HIGH_GOOD |
::COLORSCALE_HIGH, ::HEAT_HIGH |
heatmap-colour a table column’s cells (or a ::HEATMAP’s tiles), high = green (scores, accuracy) |
::COLORSCALE_DIVERGING |
::DIVERGING, ::HEAT_DIVERGING |
colour a table column’s cells (or a ::HEATMAP’s tiles) around zero: negative red, positive green (deltas) |
::LINK |
::DRILLTHROUGH, ::DRILL_THROUGH, ::HREF |
drill-through on a chart click / a table link cell: ‘#Tab’, ‘?v.x={value}’, ‘/d/ |
::BADGE |
::STATUS, ::PILL |
render a table column as status pills |
::PLAIN |
::NOBAR |
a plain table column (no in-cell bar) |
::DOWNLOAD_CSV |
CSV export button | |
::DOWNLOAD_XLSX |
::DOWNLOAD_EXCEL |
Excel export button |
::DOWNLOAD_PDF |
print-to-PDF button | |
::DOWNLOAD_JSON |
JSON export button (the rows as an array of objects) |
Inputs
Section titled “Inputs”| Cast | Also | Meaning |
|---|---|---|
::DROPDOWN |
::OPTIONS, ::SELECT_INPUT |
single-select → a DuckDB variable |
::MULTISELECT |
::MULTI |
multi-select → a list variable |
::NUMBER |
::SLIDER, ::NUMERIC |
numeric input (value = default) |
::DATE |
::DATEPICKER |
date picker (value = default) |
::TEXT |
::SEARCH, ::STRING |
free-text input (value = default) |
::DATERANGE |
::DATE_RANGE |
two date columns → from/to variables |
::PERIOD |
::PERIOD_PICKER, ::DATE_PERIOD |
date presets + grain + comparison → |
::BUTTONS |
::BUTTON_GROUP, ::SEGMENTED |
segmented button group: one of a few options → a DuckDB variable (a metric / dimension switcher) |
::TOGGLE |
::SWITCH, ::CHECKBOX |
on/off switch → a BOOLEAN variable (value = default) |
::FORM |
::PARAM_FORM, ::PARAMETERS |
a form generated from rows, one per field: the ::FORM column is the field key (its alias names the variable), columns type (number/slider/dropdown/toggle/date/text/preset), value, options, min, max, step, label, unit, help, show_if (‘model=normal’, ‘a=x & b=y | c=z’), source, section, advanced, width (half/full); ::TITLE / ::SUBTITLE / ::FORM_LAYOUT columns style the card; the values come back as one JSON object: getvariable(‘name’)->>‘field’ |
::HINT |
per-option hint next to a dropdown option | |
::OPTION_LABEL |
the shown text of a dropdown / button / multiselect option (the variable keeps the value) | |
::DEFAULT |
::IS_DEFAULT |
true on the default option of a dropdown / buttons (the first marked row) or the default picks of a multiselect (every marked row); without it: the first option / all |
::DROPDOWN_STYLE |
forces a ::DROPDOWN’s widget: ‘search’ (searchable combobox) or ‘native’ (plain | |
::FORM_LAYOUT |
how a ::FORM’s sections show, a column of the form’s statement: ‘list’ (headings, the default), ‘tabs’ or ‘accordion’ (the first open) | |
::SUBMIT |
a button (value = its label) that records SUBMIT_VARS for this viewer, append-only — requires a locked server with options.state naming this dashboard (#517); disabled, with a visible reason, on a published static site, a server without options.state, or the wasm/live-authoring builder’s own preview session (preview submissions stay in the tab, never reach a server) | |
::SUBMIT_VARS |
comma-separated variable names the preceding ::SUBMIT records, each declared by one of this dashboard’s own input statements | |
::SUBMIT_DONE |
optional confirmation text shown after a successful ::SUBMIT | |
::SAVE |
a button (value = its label) that saves the page’s edits into the ::SAVE_TABLES — an edited graph (::SAVE_GRAPH) or a ::FORM’s values (::SAVE_FORM); in the builder the save stays in the tab (TEMP tables over the base ones), on a locked server it needs options.writeback (#684) | |
::SAVE_GRAPH |
the variable of an editable ::DIAGRAM whose graph the ::SAVE writes: nodes into the first ::SAVE_TABLES table (id, type, label, stage), edges into the second (from, to) | |
::SAVE_FORM |
the variable of a ::FORM whose values the ::SAVE writes: one row per key (column id, default the selected diagram node), a column per field | |
::SAVE_TABLES |
the table(s) a ::SAVE writes: ‘nodes, edges’ for a graph, one table for a form — plain names | |
::SAVE_KEY |
the variable holding a ::SAVE_FORM row’s key (default ‘selected’, the clicked diagram node) |
Layout and directives
Section titled “Layout and directives”| Cast | Also | Meaning |
|---|---|---|
::COLUMNS |
::COLS |
default panels per row |
::SPAN |
::COL, ::WIDTH |
next panel’s width (of 12) |
::HEIGHT |
::TALL |
next panel’s height: px (320), a ratio of its width (‘16:9’, ‘0.5’) or a share of the window (‘40vh’) |
::ROWSELECT |
::ROW_SELECT, ::SELECTABLE |
next table’s row selection: ‘none’ (default), ‘single’ or ‘multi’ — a click sets getvariable(‘ |
::TOTALS |
::TOTAL, ::AGGREGATE |
next table’s totals: ‘sum’|‘mean’|‘median’|‘min’|‘max’|‘count’|‘none’, or per column ‘Revenue: sum; Per 10k: none’ |
::COLGROUP |
::COL_GROUP, ::HEADER_GROUP |
next table’s grouped header: ‘Backtest: mae, rmse | Holdout: mae_h, rmse_h’ |
::FLAG |
::THRESHOLD |
next table: flag cells meeting a condition with ⚠ — ‘mape > 0.2, bias < -5’ |
::HIGHLIGHT |
::TOPN |
next table: emphasise the top / bottom n of a column — ‘Revenue: top 3, Margin: bottom 2’ |
::SUBTOTAL |
::SUBTOTALS, ::GROUP_TOTAL |
next table: a subtotal row after each group of a column — ‘region’ (not for ::PAGED) |
::TOOLBAR |
next table’s toolbar: ‘none’ hides it entirely (row count and chips too; a multi-select’s “N selected” chip stays), or an allow-list of the parts to keep — ‘search,filters,totals,stats,columns,density,export’ (‘totals’ only hides its toggle button, not the row; ‘density’ covers Pages|Scroll too; each kept part still needs its own row/column threshold); an excluded ‘export’ still gets a small hover CSV button | |
::SELECT_AS |
::SELECTAS, ::SELECTION |
next chart’s named selection: ‘region’ → a click sets getvariable(‘region’); ‘region multi’ → a list (shift/ctrl-click adds); a brush on a continuous x sets region_from / region_to |
::EMPTY |
::EMPTY_MESSAGE, ::NODATA |
next panel’s message when its result is empty: ‘No orders in range — widen the dates’ |
::SHOW_IF |
::SHOWIF, ::VISIBLE_IF |
show the next panel (or ::GROUP box) only while this BOOLEAN is TRUE — re-checked on every input change: getvariable(‘q1’) <> ‘’ |
::DRILL |
::DRILLDOWN, ::DRILL_DOWN |
next chart drills down ‘region > country > city’ (‘geo: …’ names the variables): drill_level / drill_depth / drill_path + a variable per level, a breadcrumb back. Bars, ::REGION maps (on the region code) and ::TREEMAP tiles (on the tile’s ::XAXIS, shown as its ::LABEL when there is one) drill |
::GROUP |
::BOX, ::ROW |
open a box; ::ENDGROUP closes it |
::ENDGROUP |
::ENDBOX, ::ENDROW |
close the current box |
::DIAGRAM_PALETTE |
::NODE_TYPES |
before an editable ::DIAGRAM: the node types it may add — the column is the type (its ::CATEGORY), plus label and connects_to (the types it may feed) |
::DIAGRAM_CHECK |
::GRAPH_CHECK |
before an editable ::DIAGRAM: a query over the edited graph returning its problems — the column is a node id, ‘from -> to’ for an edge or NULL for the whole graph, plus status (‘bad’, ‘warn’, …) and message; drawn on the nodes / edges and listed in the toolbar |
::FIGURE |
::PATCHWORK |
open a figure: the charts up to ::ENDFIGURE become the cells of one patchwork-style picture with aligned axes; the value is its title |
::ENDFIGURE |
::END_FIGURE |
close the current ::FIGURE |
::LAYOUT |
::FIGURE_LAYOUT |
on ::FIGURE: ‘(hist / scatter) | checks’ — | side by side, / stacked (binds tighter), ( ) groups, _ an empty cell; a cell is its – @name or its position (1, 2, …) |
::WIDTHS |
::FIGURE_WIDTHS |
on ::FIGURE: relative widths ‘1,2’ — of every side-by-side group with that many cells |
::HEIGHTS |
::FIGURE_HEIGHTS |
on ::FIGURE: relative heights ‘1,4’ — of every stacked group with that many cells |
::AXES_COLLECT |
::COLLECT_AXES |
on ::FIGURE: ‘x’ (stacked charts share one x axis, drawn once at the bottom), ‘align’ (line up the plot areas only) or ‘none’ (default) |
::COLLECT_LEGENDS |
::COLLECT_GUIDES |
on ::FIGURE: true draws identical legends once, beside the figure |
::TAG_LEVELS |
::FIGURE_TAGS |
on ::FIGURE: tag the cells ‘A’ (A, B, …), ‘a’, ‘1’, ‘i’ or ‘I’ |
::FIGURE_NCOL |
on ::FIGURE without ::LAYOUT: the cells fill a grid this many columns wide | |
::TAB |
::PAGE |
start a tab/page |
::SUBTAB |
::SUB_TAB |
a nested tab inside a ::TAB |
::GUIDE_STEP |
::TUTORIAL_STEP, ::WIZARD_STEP |
a step of a guided sequence (onboarding, tutorials): Back / Next, ‘Step 2 of 5’, ?v. |
::GATE |
::STEP_GATE, ::NEXT_IF |
on a ::GUIDE_STEP: Next stays disabled until this BOOLEAN is TRUE |
::GATE_MESSAGE |
::GATE_HINT |
on a ::GUIDE_STEP: why Next is disabled |
::REQUIRES |
::REQUIRES_MODULE |
a module the dashboard needs: ‘name’ (or ‘a, b’); a build without it says so instead of failing on the module’s roles |
::VIEW |
::ALT_VIEW |
one of several alternative views of one panel: consecutive ::VIEW sections share a segmented switcher; 'Lines' AS name ::VIEW names the group (?view.name=) |
::ENDVIEW |
::END_VIEW |
close a ::VIEW group (::TAB, ::SUBTAB, ::SECTION also close it) |
::VIEW_PLACEMENT |
a ::VIEW group’s switcher placement: ‘row’ (default, its own row above the card) or ‘header’ (right-aligned, compact, in the card’s title row — folds into a dropdown below a minimum card width; only when every alternative is exactly one panel, else –check warns and it falls back to ‘row’); set directly before the group’s first ::VIEW marker, like ::COL/::SPAN | |
::FIT |
::FIT_SCREEN |
this ::TAB / ::SUBTAB / ::VIEW (no tabs: the whole dashboard) fits the window while shown — rows scale to fill it, no page scroll (‘fit’::FIT; ?fit=1 / ?fit=0 override it; ignored below 600 px wide) |
::PLACEHOLDER |
an empty grid cell | |
::TRACK |
::STRIP_BELOW, ::STRIP_UNDER |
a thin panel under the previous chart, sharing its x axis (value = its name): ticks, ::HEATMAP tiles per ::YAXIS lane, or a line / bar |
::SECTION |
::SECTION_HEADING |
a section heading that always starts a new row |
Page chrome
Section titled “Page chrome”| Cast | Also | Meaning |
|---|---|---|
::RELOAD |
::REFRESH |
auto-refresh interval (seconds) |
::HEADER_IMAGE |
::HEADERIMAGE |
banner image URL |
::FOOTER_LINK |
::FOOTERLINK |
link at the bottom |
::THEME |
dashboard theme: ‘light’/‘dark’/‘print’/‘colorblind’/‘high-contrast’, a stack ‘acme+dark’, or JSON | |
::LOCALE |
number/date locale for KPIs, tables and axes: ‘en-US’, ‘en-GB’, ‘en-IE’ (English with €), ‘de-DE’, ‘fr-FR’ | |
::DASHBOARD_TITLE |
::DASHBOARDTITLE, ::PAGE_TITLE |
dashboard title: page header, browser tab and export title |
::BRAND |
::BRAND_NAME |
brand / organisation name shown above the dashboard title |
::LOGO |
header logo image URL (relative, https: or data:image/) | |
::FAVICON |
browser-tab icon URL | |
::ASOF |
::AS_OF, ::FRESHNESS, ::DATA_AS_OF |
data freshness: a ‘Data as of 14:02 (2 h ago)’ chip in the header; a ‘stale=24h’ column turns it amber |