progress

One figure as a bar toward a limit, such as the yearly cap used or how much of an agent's budget is gone.

label names the figure; source and figure compute it as a kpis tile does (count, sum, avg or value of a column); max is the figure of a full bar, a number above 0. format writes the figure and the limit (usd: $37,900 of $140,000). The bar never passes full; the figure still shows what it is.

When to use

Use it when

A figure against a cap or budget, such as the yearly cap used.
How close a run came to a target, such as tickets a test closed the way a person did.
A count toward a goal for today.

Use another block when

Several figures with no limit.
Use kpis
The figure's history.
Use chart
A warning once the limit is near; say it in words.
Use callout

Yearly cap used

Yearly cap used · $37,900 of $140,00027%

27%

progress: { label: Yearly cap used, source: month, figure: value, column: cap_used_usd, max: 140000, format: usd }

<a id="progress-1"></a>

Yearly cap used: $37,900 of $140,000 (27%)

A test run's match

Last test run closed the same way a person did · 83% of 100%83%

83%

progress: { label: Last test run closed the same way a person did, source: last_test, figure: value, column: matched, max: 100, format: percent }

<a id="progress-1"></a>

Last test run closed the same way a person did: 83% of 100% (83%)

Tickets closed today

Closed today of 250 expected · 3 of 2501%

progress:
  label: Closed today of 250 expected
  source: closed_today
  max: 250

<a id="progress-1"></a>

Closed today of 250 expected: 3 of 250 (1%)

States

ready
the source's rows, drawn
empty
the source has no rows: an Empty part saying so
error
the source failed: the block shows the source's sentence; the page still answers 200

This block offers no actions; it only shows.

JSON Schema