Examples
Basic Usage
Using filters
Placing the workflow.period selector
Attributes
string
required
The id of the period, used in SQL query templates (e.g.
{{my_period.between}}). On a page with workflow.period, id="period" places that selector here instead of at the top of the page.string
The calendar grain each period covers. Defaults to
month.Allowed values:dayweekmonthquarteryear
number
How many complete periods to offer. Defaults to 12.
string
The date column to filter. When set, the selector can be referenced with
{{id.filter}} or listed in a chart’s filters prop, e.g. filters=["sales_period"].Using the Filter Variable
Reference this filter using{{filter_id}}. The value returned depends on where you use it.
Available Properties
You can also access specific properties using{{filter_id.property}}:
.between
A WHERE-clause fragment covering the period in the active SQL dialect:BETWEEN <start> AND <end>.
Example value: BETWEEN toDate('2026-07-01') AND toDate('2026-07-31')
.label
The period’s display label, e.g.Jul 2026.
Example value: Jul 2026
.start
The first date of the period, as an expression for the active SQL dialect. Usestart_label in prose.
Example value: toDate('2026-07-01')
.end
The last date of the period (inclusive), for the active SQL dialect. Useend_label in prose.
Example value: toDate('2026-07-31')
.start_label
The first date of the period, formatted for display. Example value:Jul 1, 2026
.end_label
The last date of the period (inclusive), formatted for display. Example value:Jul 31, 2026
.filter
A complete SQL filter expression for the period. Requiresvalue_column; resolves to true without it.
Example value: order_date >= toDate('2026-07-01') AND order_date <= toDate('2026-07-31')
.key
The period’s stable identifier, e.g.2026-07. Use it to key per-period records.
Example value: 2026-07
.grain
The period grain, e.g.month.
Example value: month