name

The internal reference name for the bite (not displayed).

title

Chart title to display.

description

Chart description to display.

type

Type of chart to display.

key figure: a single numeric indicator (e.g. total population, number of organisations)
chart: a chart of numeric values (e.g. population by admin1, organisations by sector)
timeseries: data on a timeline (e.g. number of refugees from 2013 to 2023)

For chart, Quick Charts will choose the graph type (pie or bar) automatically, based on the number of distinct values in aggregateColumn (see below).

ingredient

Definition of the data to use in the chart (see below).

unit

The label to place under the number for a key figure.

numberFormat

The format to use for numbers:

us: English format (“,” as thousands separator, “.” as decimal)
de: Continental European format (“ ” as thousands separator, “,” as decimal)

If not provided, the format will be standard computer number format, with no thousands separator and “.” as the decimal separatoruiProperties

Definition of how the chart should be displayed (see below).

aggregateColumn

A HXL tag pattern identifying the reference column for aggregation (chart and timeseries only).

dateColumn

A HXL tag pattern identifying the column to use for dates (timeseries only).

valueColumn

A HXL tag pattern identifying the column containing values.

aggregateFunction

The aggregation function to apply to valueColumn. If the type is “chart” or “timeseries”, the aggregations will apply to each unique value of aggregateColumn.

sum: add all of the values together (numbers only)
average: calculate the mean of the values (numbers only)
count: count all of the values, including duplicates (numbers, dates, or strings)
distinct-count: count all of the unique values

filtersWith

A filter for rows to include in the chart: it should be a list of JSON objects, where the keys are HXL tag patterns and the values are either literal values that must appear in rows to include, or the pseudo values “$MAX” (for the largest value) or “$MIN” (for the smallest value). For example, this filter would include only rows for the latest year (assuming it appears in a column with the HXL hashtag spec “#date+year”).

"filtersWith:" [
  {
     "#date+year": "$MAX$"
  }
]

filtersWithout

Like filtersWith, except that it’s a filter for rows to exclude from the chart.

unit

The label to place under the number for a key figure.

numberFormat

The format to use for numbers:

us: English format (“,” as thousands separator)
de: Continental European format (“.” as thousands separator)

If not provided, the format will be standard computer number format, with no thousands separator and “.” as the decimal separator.

showGrid

Show a grid behind a bar chart or timeseries if true.

swapAxis

Swap the X and Y axes in a bar chart if true.

color

Hex RGB color code for a bar chart, e.g. “#FFFF00” for yellow.

sortingByValue1

Sort a bar chart by values. Use “ASC” for ascending, or “DESC” for descending.

sortingByCategory1

Sort a bar chart by categories (values in the aggregateColumn). Use “ASC” for ascending, or “DESC” for descending.