Filter provider

Filters from the Time Range Picker, Simple Filter, Time Grain Picker, or Group By components are applied to the child components.

<FilterProvider>
  // Input components
  // Visualization components
</FilterProvider>

GitHub

Props API

baseFilters

FilterInput[]

Set of pre defined filters that will be used by all the child components

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column

String

required

The name of the column to filter on.

operator

FilterOperator

required

The operation to perform when comparing the column and filter values.

value

String

The value to compare the column to.

and

[FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

[FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

defaultGranularity

TimeSeriesGranularity

Default time granularity

defaultGroupBy

string[]

Default group by

emptyGroupBy

string[]

GroupBy to be used when the groupBy is empty

maxGroupBy

number

Maximum number of group by columns

Get Started

Themes

Visualizations

Inputs

Providers

Query Hooks

Props API

Get Started

Themes

Visualizations

Inputs

Providers

Query Hooks

​Props API

Props API