Example

{% big_value
  data="demo_daily_orders"
  value="sum(total_sales)"
  fmt="usd1m"
/%}

Comparison

{% big_value
	data="demo_daily_orders"
	value="sum(total_sales)"
	fmt="usd1m"
	date_range={
		date="date"
		range="last 12 months"
	}
	comparison={
		compare_vs="prior_year"
	}
/%}

Sparkline

{% big_value
	data="demo_daily_orders"
	value="sum(total_sales)"
	fmt="usd1m"
	sparkline={
		type="line"
		x="date"
	}
/%}

Attributes

data
String
required
Table or view to query
value
String
required
The column name for the main value to display
date_range
Use date_range to filter data for specific time periods like last 12 months, year-to-date, etcExample:
date_range={
  range = value
  date = "string"
}
Attributes:
  • range: enum
  • date: string
comparison
Comparison configuration objectExample:
comparison={
  compare_vs = value
  display_type = value
  target = "string"
  delta = true
  fmt = "string"
  text = "string"
  down_is_good = true
  neutral_range = []
}
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.
  • delta: boolean - Whether to display the comparison as a delta
  • fmt: string - Format for the comparison value
  • text: string - Text displayed after the comparison value
  • down_is_good: boolean - Whether a decrease is considered positive
  • neutral_range: array
sparkline
Sparkline configuration objectExample:
sparkline={
  type = value
  color = "string"
  x = "string"
  y_fmt = "string"
  x_fmt = "string"
  fit_to_data = true
  connect_group = "string"
  date_grain = value
  date_range = { ... }
}
Attributes:
  • type: enum - The type of sparkline to display
  • 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 show the Y scale on the sparkline
  • connect_group: string - Connect group for the sparkline
  • date_grain: enum - Time grain for the sparkline data points
  • date_range: object
fmt
String
Format for the main value
title
String
Title for the main value
max_width
String
default:"fit-content"
Maximum width of the component
min_width
String
default:"auto"
Minimum width of the component
title_class
String
Additional CSS classes for the title
value_class
String
Additional CSS classes for the value
URL to link the value to
info
String
Information tooltip text
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
class_name
String
Additional CSS classes for the component
width
Number
Set the width of this component (in percent) relative to the page width