Skip to main content

Example

{% value value="sum(total_sales)" /%}

Attributes

data
String
required
Table or view to query
value
String
required
SQL expression to insert into the SELECT part of the query (e.g., “COUNT(*)”, “SUM(sales)”)
className
String
CSS class to apply to the value
fmt
String
Format code for the value (e.g., “num”, “usd”, “pct”). See formatValue documentation for available formats.
color
String
CSS color to apply to the value (e.g., “red”, “#ff0000”, “rgb(255,0,0)”)
redNegatives
Boolean
When true, negative values will be displayed in red (rgb(220 38 38))
info
String
Information tooltip text (can only be used with title)
comparison
Comparison configuration objectExample:
comparison={
  compare_vs = value
  display_type = value
  target = "string"
  abs_fmt = "string"
  pct_fmt = "string"
  hide_pct = true
}
Attributes:
  • compare_vs: enum - 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)
  • display_type: enum - What to display for comparison. Options: compared_value (comparison period value), abs (absolute change), pct (percentage change)
  • target: string - Target value for target comparison. Can be a column name, aggregation (e.g., “sum(target_sales)”), or literal value.
  • abs_fmt: string - Format code for absolute values in comparison tooltips
  • pct_fmt: string - Format code for percentage values in comparison tooltips
  • hide_pct: boolean - Hide the percentage change line in comparison tooltips
filters
Array
IDs of filters to apply to the query
where
String
Custom SQL WHERE condition to apply to the query. For date filters, use date_range instead.
having
String
Custom SQL HAVING condition to apply to the query after GROUP BY
limit
Number
Maximum number of rows to return from the query
order
String
Column name(s) with optional direction (e.g. “column_name”, “column_name desc”)
qualify
String
Custom SQL QUALIFY condition to filter windowed results
date_range
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:
date_range={
  range = value
  date = "string"
}
Attributes:
  • range: enum
  • date: string
width
Number
Set the width of this component (in percent) relative to the page width
I