
Examples
Basic Usage

Comparison

Sparkline

Text Size
Attributes
Table or view to query
The column name for the main value to display
Use date_range to filter data for specific time periods. Accepts predefined ranges (e.g., “last 12 months”), dynamic ranges (e.g., “Last 90 days”), custom date ranges (e.g., “2020-01-01 to 2023-03-01”), or partial ranges (e.g., “from 2020-01-01”, “until 2023-03-01”)Example:Attributes:
- range:
string- Time period to filter. Use presets like ‘last 7 days’, dynamic patterns like ‘Last 90 days’, custom ranges like ‘2020-01-01 to 2023-03-01’, or partial ranges like ‘from 2020-01-01’.- Allowed values:
last 7 dayslast 30 dayslast 3 monthslast 6 monthslast 12 monthsweek to datemonth to datequarter to dateyear to dateprevious weekprevious monthprevious quarterprevious yearall time
- Allowed values:
- date:
string- Date column to filter on. Required when the data has multiple date columns.
Comparison configuration objectExample:Attributes:
- compare_vs:
string- Type of comparison to perform. Options: prior year (same period last year), prior period (previous period of same duration), target (compare against a target value), benchmark (compare against group average/aggregate)- Allowed values:
prior yearprior periodtargetbenchmark
- Allowed values:
- display_type:
string- What to display for comparison. Options: compared_value (comparison period value), abs (absolute change), pct (percentage change). Default: pct- Allowed values:
compared_valueabspct
- Allowed values:
- target:
string- Target value for target comparison. Can be a column name, aggregation (e.g., “sum(target_sales)”), or literal value. - benchmark:
options group- Options:
- agg:
string- Aggregation function to apply across benchmark group. Options: avg (average), median, min, max, sum, count, count_distinct- Allowed values:
avgmedianminmaxsumcountcount_distinct
- Allowed values:
- subject:
string- Column or expression that defines individual entities in the benchmark (e.g., “store_name”, “customer_id”). Required for single-value components. - value:
string- Optional column or expression to use for benchmark calculation. If not specified, uses the main value column. Useful if you have a pre-aggregated benchmark table for RLS reasons. - within:
array of strings- Dimension columns to group the benchmark by (e.g., [“region”]). Leave empty for dataset-wide benchmark. - where:
string- SQL WHERE clause to filter which entities are included in the benchmark - exclude_self:
boolean- Exclude the current row from its own benchmark calculation (table context only). Default: false
- agg:
- Options:
- hide_pct:
boolean- Hide the percentage change line in comparison tooltips - pct_fmt:
string- Format code for percentage values in comparison tooltips - abs_fmt:
string- Format code for absolute values in comparison tooltips - text:
string- Text displayed after the comparison value - delta:
boolean- Whether to display the comparison as a delta - down_is_good:
boolean- Whether a decrease is considered positive - neutral_range:
array- Range [min, max] for neutral values. Use null for infinity (e.g., [null, 0] means anything ≤ 0 is neutral)
Sparkline configuration objectExample:Attributes:
- type:
string- The type of sparkline to display- Allowed values:
lineareabar
- Allowed values:
- color:
string- Color for the sparkline - x:
string- X column for the sparkline - y_fmt:
string- Value format for the sparkline tooltips - x_fmt:
string- Date format for the sparkline tooltips - fit_to_data:
boolean- Whether to fit the Y axis scale to the data range - connect_group:
string- Connect group for the sparkline - date_grain:
string- Time grain for the sparkline data points- Allowed values:
yearquartermonthweekdayhourminute
- Allowed values:
- date_range:
options group- Options:
- range:
string- Time period to filter. Use presets like ‘last 7 days’, dynamic patterns like ‘Last 90 days’, custom ranges like ‘2020-01-01 to 2023-03-01’, or partial ranges like ‘from 2020-01-01’.- Allowed values:
last 7 dayslast 30 dayslast 3 monthslast 6 monthslast 12 monthsweek to datemonth to datequarter to dateyear to dateprevious weekprevious monthprevious quarterprevious yearall time
- Allowed values:
- date:
string- Date column to filter on. Required when the data has multiple date columns.
- range:
- Options:
Format for the main value. See Value Formatting for available formats.
Title for the main value
Maximum width of the component
Minimum width of the component
Text size for the value. Options: sm, base, lg, xl (default), 2xl, 3xl, 4xl, 5xlAllowed values:
smbaselgxl2xl3xl4xl5xl
Additional CSS classes for the title
Additional CSS classes for the value
URL to link the value to
Information tooltip text
URL to link the info text to (can only be used with info)
Create a custom link title for the info link, placed after the info text (can only be used with info_link)
IDs of filters to apply to the query
Custom SQL WHERE condition to apply to the query. For date filters, use date_range instead.
Custom SQL HAVING condition to apply to the query after GROUP BY
Maximum number of rows to return from the query. Note: When used with tables, limit will disable subtotals to prevent incomplete subtotal rows.
Column name(s) with optional direction (e.g. “column_name”, “column_name desc”)
Custom SQL QUALIFY condition to filter windowed results
Additional CSS classes for the component
Time in seconds between automatic data refreshes (minimum 60). Overrides the page-level auto-refresh setting for this component.
Set the width of this component (in percent) relative to the page width

