Dockable Filter Control
The Dockable Filter Control panel lets you place an interactive filter panel directly on your dashboard, allowing real-time selection of filter values. You can position and customize the panel anywhere to fit your layout and workflow. Dockable filters work best filtering fields with a small number of values. For larger datasets, the Filtering Panel is a better option.
You can add more than one dockable filtering panel to a single dashboard.
For the filtering panel to function, at least one global parameter must be created and linked in the relevant data model.
When to use the dockable filter control
- Providing on-demand filtering: Interact with filter controls directly for quick data exploration.
- Customizing filter placement: Position filter controls where they best fit your dashboard layout and user flow.
Add a dockable filter control
- In the Toolbar panel, choose Edit Dashboard.
- Select Miscellaneous Controls.
- Drag the Dockable Filter Control control onto the dashboard. A gray highlight appears to show possible placement sections.
- (Optional) To resize the panel, use the sides or corners to make the view bigger or smaller.
- Select the settings icon on the panel to open the Properties panel.
- In the Data tab, expand the Parameters section and select a parameter from the dropdown list.
- Customize the panel further by sorting parameters, adding a title, or adjusting the panel color.
- In the Toolbar panel, select Save or Save As to save your changes.
Apply a filter
- On a dockable filter control, select a filter.
- Click Add to Filter. The selected filters appear at the bottom of the dashboard, and the data refreshes automatically.
If the Filters bar is hidden, go to the Toolbar panel, select Layout, then click Filters to display it.
Remove a filter
You can remove a filter in several ways.
Using the Exclude from Filter button
- On a dockable filter control, select the filter you want to remove.
- Click Exclude from Filter. The data refreshes automatically.
Using the Filters section
- If the Filters bar is hidden, go to the Toolbar panel, select Layout, then click Filters to display it.
- Find the filter you want to remove. Hover over it and click the X icon. The data refreshes automatically.
Using the Clear Filter option
- On a dockable filter control, click the Clear Filter icon in the top-right corner. This removes all filters from the dashboard.
Dockable filter control properties
Data
Data Configuration
| Parameter | Description |
|---|---|
| Advanced Filter | Opens the Advanced Filter dialog for detailed filter configuration. |
| Parameter | Selects the required global parameter for the filtering panel. This determines which underlying field or values the filter uses. |
| Prompt Name | Chooses the prompt used for user input. By default, this matches the global parameter. |
| Sort Order | Sets whether parameter values appear in ascending or descending order. |
| Sorted Field | Chooses the data field used for sorting filter values. |
| Display Value | Selects which field appears as the label for each value in the panel. |
Default Selection
| Parameter | Description |
|---|---|
| Default Selected Values | Sets the value to be automatically selected when the dashboard loads. You can use a global parameter or select a value using the prompt icon. |
Design
Title
Visible only when the Properties option is enabled in the panel settings.
| Parameter | Description |
|---|---|
| Description | Adds a title or a description to the panel. Select the translation icon next to the text box to add labels in multiple languages. |
| Description Font Size | Sets the font size for the panel description. |
| Color | Sets the font color. Use the color picker and select Apply, or enter a HEX code manually. |
| Position | Positions the description at the top or bottom of the panel. |
Global Panel
| Parameter | Description |
|---|---|
| Background | Sets the background color of the filtering panel. Use the color picker and select Apply, or enter a HEX code manually. |
| Orientation | Sets the layout to vertical or horizontal. |
| Custom Width | Allows you to manually adjust the panel width when selected. |
Items Style
| Parameter | Description |
|---|---|
| Items | Customizes the font color, background color, and font size of the filter items. Use the color picker and select Apply, or enter a HEX code manually. |
| Selected Items | Customizes the font color and background color for selected items. Use the color picker and select Apply, or enter a HEX code manually. |
Advanced Options
Interactions
Visible only when the Dashboard Filtering option is enabled in the panel settings.
| Parameter | Description |
|---|---|
| Enable the single selection | Allows only one value to be selected at a time. |
| Views to apply filter | Specifies which dashboard views are affected by the filters. |