Skip to main content
Version: Next

ChartDataFilter

colrequired

The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)

Example: country
grainstring

Optional time grain for temporal filters

Example: PT1M
isExtraboolean

Indicates if the filter has been added by a filter component as opposed to being a part of the original query.

opstringrequired

The comparison operator.

Possible values: [==, !=, >, <, >=, <=, LIKE, NOT LIKE, ILIKE, IS NULL, IS NOT NULL, IN, NOT IN, IS TRUE, IS FALSE, TEMPORAL_RANGE]

Example: IN
valnullable

The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.

Example: ["China","France","Japan"]
ChartDataFilter
{
"col": "country",
"grain": "PT1M",
"isExtra": true,
"op": "IN",
"val": [
"China",
"France",
"Japan"
]
}