Filter provider

Applies filters to child components.

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

Show FilterInput

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.

Show FilterOperator

The available Filter operators.

​

• EQUALS: Selects values that are equal to the specified value.
• NOT_EQUALS: Selects values that are not equal to the specified value.
• GREATER_THAN: Selects values that are greater than the specified value.
• GREATER_THAN_OR_EQUAL_TO: Selects values that are greater or equal to the specified value.
• LESS_THAN: Selects values that are less than the specified value.
• LESS_THAN_OR_EQUAL_TO: Selects values that are less or equal to the specified value.
• IS_NULL: Selects values that are null. This operator does not accept a value.
• IS_NOT_NULL: Selects values that are not null. This operator does not accept a value.
• LIKE: Selects values that match the specified pattern.
• NOT_LIKE: “Selects values that do not match the specified pattern.

value · String

The value to compare the column to.

and · [FilterInput!]

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

or · [FilterInput!]

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

defaultGranularity · TimeSeriesGranularity

Default time granularity

Show TimeSeriesGranularity

The available time series granularities. Granularities define the unit of time to aggregate the Metric data for a time series query.

For example, if the granularity is set to DAY, then the the time series query will return a label and a value for each day.

If there are no records for a given time series granularity, Propel will return the label and a value of “0” so that the time series can be properly visualized.

​

• MINUTE: Aggregates values by minute intervals.
• FIVE_MINUTES: Aggregates values by 5-minute intervals.
• TEN_MINUTES: Aggregates values by 10-minute intervals.
• FIFTEEN_MINUTES: Aggregates values by 15-minute intervals.
• HOUR: Aggregates values by hourly intervals.
• DAY: Aggregates values by daily intervals.
• WEEK: Aggregates values by weekly intervals.
• MONTH: Aggregates values by monthly intervals.
• YEAR: Aggregates values by yearly intervals.

defaultGroupBy · string[]

Default group by

emptyGroupBy · string[]

GroupBy to be used when the groupBy is empty

maxGroupBy · number

Maximum number of group by columns

defaultDataPool · DataPoolInput | null | undefined

Data Pool input that will be used for all child components that use a Data Pool input

In this example, the Counter component will use the default Data Pool input

Show DataPoolInput

id · ID

The ID of the Data Pool.

name · String

The name of the Data Pool.

defaultTimeRange · TimeRangeInput | null

Default time range

Show TimeRangeInput

The fields required to specify the time range for a time series, counter, or leaderboard Metric query.

If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.

If both relative and absolute time ranges are provided, the relative time range will take precedence.

If a LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.

timestamp · String

The timestamp field to use when querying. Defaults to the timestamp configured on the Data Pool or Metric, if any. Set this to filter on an alternative timestamp field.

relative · RelativeTimeRange

The relative time period.

Show RelativeTimeRange

The Relative time ranges are based on the current date and time.

THIS - The current unit of time. For example, if today is June 8, 2022, and THIS_MONTH is selected, then data for June 2022 would be returned.

PREVIOUS - The previous unit of time. For example, if today is June 8, 2022, and PREVIOUS_MONTH is selected, then data for May 2022 would be returned. It excludes the current unit of time.

NEXT - The next unit of time. For example, if today is June 8, 2022, and NEXT_MONTH is selected, then data for July 2022 would be returned. It excludes the current unit of time.

LAST_N - The last n units of time, including the current one. For example, if today is June 8, 2022 and LAST_N_YEARS with n = 3 is selected, then data for 2020, 2021, and 2022 will be returned. It will include the current time period.

​

• THIS_HOUR: Starts at the zeroth minute of the current hour and continues for 60 minutes.
• TODAY: Starts at 12:00:00 AM of the current day and continues for 24 hours.
• THIS_WEEK: Starts on Monday, 12:00:00 AM of the current week and continues for seven days.
• THIS_MONTH: Starts at 12:00:00 AM on the first day of the current month and continues for the duration of the month.
• THIS_QUARTER: Starts at 12:00:00 AM on the first day of the current calendar quarter and continues for the duration of the quarter.
• THIS_YEAR: Starts on January 1st, 12:00:00 AM of the current year and continues for the duration of the year.
• PREVIOUS_HOUR: Starts at the zeroth minute of the previous hour and continues for 60 minutes.
• YESTERDAY: Starts at 12:00:00 AM on the day before the today and continues for 24 hours.
• PREVIOUS_WEEK: Starts on Monday, 12:00:00 AM, a week before the current week, and continues for seven days.
• PREVIOUS_MONTH: Starts at 12:00:00 AM on the first day of the month before the current month and continues for the duration of the month.
• PREVIOUS_QUARTER: Starts at 12:00:00 AM on the first day of the calendar quarter before the current quarter and continues for the duration of the quarter.
• PREVIOUS_YEAR: Starts on January 1st, 12:00:00 AM, the year before the current year, and continues for the duration of the year.
• NEXT_HOUR: Starts at the zeroth minute of the next hour and continues for 60 minutes.
• TOMORROW: ” Starts at 12:00:00 AM, the day after the current day, and continues for 24 hours.
• NEXT_WEEK: Starts on Monday, 12:00:00 AM, the week after the current week, and continues for the duration of the week.
• NEXT_MONTH: Starts at 12:00:00 AM on the first day of the next month and continues for the duration of the month.
• NEXT_QUARTER: Starts at 12:00:00 AM on the first day of the next calendar quarter and continues for the duration of the quarter.
• NEXT_YEAR: Starts on January 1st, 12:00:00 AM of the next year and continues for the duration of the year.
• LAST_N_MINUTES: Starts at the zeroth second n - 1 minute(s) before the current minute and continues through the current minute. It includes this minute.
• LAST_N_HOURS: Starts at the zeroth minute of the n - 1 hour(s) before the current hour, and continues through the current hour. It includes this hour.
• LAST_N_DAYS: Starts at 12:00:00 AM, n - 1 day(s) before the current day, and continues through the current day. It includes today.
• LAST_N_WEEKS: Starts on Monday, 12:00:00 AM, n - 1 week(s) before the current week, and continues through the current week. It includes this week.
• LAST_N_MONTHS: Starts at 12:00:00 AM on the first day of the month, n - 1 month(s) before the current month, and continues through the current month. It includes this month.
• LAST_N_QUARTERS: Starts at 12:00:00 AM on the first day of the calendar quarter n - 1 quarter(s) before the current quarter and continues through the current quarter. It includes this quarter.
• LAST_N_YEARS: Starts on January 1st, 12:00:00 AM of the year n - 1 year(s) before the current year and continues through the current year. It includes this year.
• LAST_15_MINUTES
• LAST_30_MINUTES
• LAST_HOUR
• LAST_4_HOURS
• LAST_12_HOURS
• LAST_24_HOURS
• LAST_7_DAYS
• LAST_30_DAYS
• LAST_90_DAYS
• LAST_3_MONTHS
• LAST_6_MONTHS
• LAST_YEAR
• LAST_2_YEARS
• LAST_5_YEARS

n · Int

The number of time units for the LAST_N relative periods.

start · DateTime

The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool.

stop · DateTime

The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool.