Dashboard YAML
In your Rill project directory, create a <dashboard_name>.yaml
file in the dashboards
directory. Rill will ingest the dashboard definition next time you run rill start
.
Properties
model
— the model name powering the dashboard with no path (required)
display_name
— the display name for the dashboard (required)
timeseries
— column from your model that will underlie x-axis data in the line charts (required)
dimensions:
— for exploring segments and filtering the dashboard (required)
property
— a categorical column (required)label
— a label for your dashboard dimension (optional)description
— a freeform text description of the dimension for your dashboard (optional)
measures:
— numeric aggregates of columns from your data model (required)
expression
— a combination of operators and functions for aggregations (required)label
— a label for your dashboard measure (optional)description
— a freeform text description of the dimension for your dashboard (optional)format_preset
— one of a set of values that format dashboard measures. (optional; default is humanize). Possible values include:humanize
— round off numbers in an opinionated way to thousands (K), millions (M), billions B), etcnone
— raw outputcurrency_usd
— output rounded to 2 decimal points prepended with a dollar signpercentage
— output transformed from a rate to a percentage appended with a percentage signcomma_separators
— output transformed to decimal formal with commas every 3 digits