Filter components
A filter component is a component on a page that you use to filter charts.
When a page has multiple filters, the filters are combined with And, which means a chart is affected by all of its associated filters at the same time.
To add a filter component, follow the steps for adding components.
Configure a filter
The configuration panel for filter components is to the right of the page canvas. When you click to select a filter component, its configuration expands automatically.
Filter component configuration consists of data configuration and style configuration. For the configuration steps, see the specific filter type.
Select a sheet
Before you start configuring data, select the sheet that the filter component will use.
You can use sheets whose status is Available.
You can also change the selected sheet later while editing. After you change the sheet, any data configuration you've completed is cleared.
After you select a sheet, the configuration panel shows all fields in the sheet that can be used to configure the chart.
The selected sheet is used to calculate the filter's options and to associate the filter with charts.
Chart association
Filter scope:
- A filter applies only to chart components on the same page
- Edit Chart Association to change which charts the filter applies to
- Add a Cross-Sheet Association to associate the filter with charts that use other sheets
Chart association shows the charts that use the configured sheet. Charts that already exist when the filter is created are selected by default (charts created later aren't selected by default and must be selected manually).
To use this filter to control charts that use other sheets, configure a cross-sheet association.
When you configure a cross-sheet association, you need to select two options: the sheet and the associated field. The field depends on the filter type: drop-down filters require the associated field to be text, and date filters require it to be time or text.
After the configuration is complete, the charts that use that sheet appear in the chart association settings. You can select specific charts, or select all of the corresponding charts at once.
When the filter selection changes, chart data is calculated from the filtered data through the configured associated field.
Filter types
The supported filters are drop-down filters and date filters.
Drop-down filter
A drop-down filter lets you select the options you need from a drop-down list. It supports filtering on text or numeric fields.
When no option is selected, the filter defaults to Default, which means no selection is applied for this filter.
Data configuration
The data configuration of a drop-down filter includes:
-
Field: The field the filter filters on. Only one field can be configured.
- Only text or numeric fields can be configured.
- The options are calculated from the data for this field in the sheet
-
Default Options: After you select a field, you can enter values to configure the filter's default options, up to 10.
- This setting is optional. If it isn't configured, the filter defaults to Default
- Each time a viewer opens the dashboard, the filter filters by the Default Options, and the charts display the filtered results
-
Metrics: The configured metric is used only to calculate the options and their order.
- Metrics are configured in the same way as metrics in chart components.
- A drop-down filter supports only one metric for calculation
-
Filter: The configured filter conditions are used to calculate the options. Data excluded by the filter conditions doesn't appear in the option list.
- Filters are configured in the same way as in chart components.
-
Sort: Add fields and metrics to sorting. The calculated results are sorted accordingly, which determines the display order of the options.
Style configuration
- Show Title: Add a title to the filter so that users can identify what it filters
- Type Settings: Set the filter to single choice or multiple choice, and show or hide the search box
- Appearance: Configure the background color, border color, and border width of the filter component card
Date filter
A date filter lets you select a date range. You can't select specific hours, minutes, or seconds.
When no date is selected, the filter defaults to Default, which means no selection is applied for this filter.
In a date filter, you can select Rolling Date or Exact Date.
Data configuration
The data configuration of a date filter includes:
-
Field: The field the filter filters on. Only one field can be configured.
- Time and date fields are supported
- Text fields are supported, but you need to specify the date format. Enter the format based on the actual values, following the SimpleDateFormat format
For reference, here's how to configure text-type date partitions in some common scenarios
Sample date partition value Date format to enter 2025-09-01 yyyy-MM-dd 2025-09 yyyy-MM 20250901 yyyyMMdd 2025-36 yyyy-ww
⚠️ Note that in edit mode, not all date formats can be handled, so the result may be invalid or not as expected. Go to preview to confirm the result
- Time Range: The default filter range of the date filter. You can select an exact or rolling date range.
- Each time the dashboard is opened, the date filter filters by the configured date range before the data is displayed.
Style configuration
- Show Title: Add a title to the filter so that users can identify what it filters
- Appearance: Configure the background color, border color, and border width of the filter component card