Filter
- Filter
- Widget Settings
- Data Settings
- Display Settings
- Filtering Settings
- Filter Behavior in Browse Mode
- Dependency Between Applied Filters
- Example of How an Applied Filter Affects a Neighboring One
- Date Selection Limits
- Widget Configuration in YAML
- Data Settings in YAML
- Display Settings in YAML
- Filtering Settings in YAML
- Example of a Configured Widget in the YAML Editor
The widget allows filtering by a selected dimension. Using this widget, you can filter a view that opens in a side or modal window via the click action.
Widget Settings
After adding the widget to a view, you must add a column or indicator to filter by, or configure filtering using a formula. To do this, click the + Dimension button and select the desired option. Hierarchy is also available for setup.
Data Settings
The widget supports standard data settings.
Display Settings
In addition to the common display settings, the widget has unique options.
Text Size
Controls the text size in the widget rows.
Dimension Limit
Specifies the number of rows displayed in the list.
View Type
Depending on the view type (table or list), the widget’s visual appearance changes. The maximum number of rows displayed in a full list is 200.
Display settings are available only if the filter’s data type is String. For the Date data type, only the header and its size can be configured.
Filtering Settings
The widget supports standard filtering settings. A filter configured in the widget cannot be removed in Browse mode.
Filter Behavior in Browse Mode
Multiple values can be selected in Browse mode.
To select values from a list-type filter, click the desired row. The filter will be applied immediately.
To select values for a filter with the Date or Date and time data type, choose a date and time in the calendar that appears and click OK.
When reopening the filter, previously selected values appear at the top of the list, and selected dates are shown in the calendar view.
To modify an applied filter value, click it in the filter panel.
Depending on the filter’s data type (string, date, etc.), various filter types are available in the widget.
Specify a new filter value and click Apply.
If two Filter widgets with the same global dashboard or workspace dimension are added to a dashboard, selecting a value in the first widget automatically selects the same value in the second. In table-type filters, selected values are sorted immediately.
Dependency Between Applied Filters
The values displayed in neighboring filters depend on the selected values of the applied filter. If the applied filter excludes certain items from a neighboring filter, those items will not be shown.
- After applying a filter, only values related to the selected filter values appear in neighboring filters
- The applied filter does not affect the display of its own values
Example of How an Applied Filter Affects a Neighboring One
Two filters are added to the view: one for selecting a component type and another for its subtype.
In the Type filter, Hardware is selected. As a result, the Subtype filter shows only values applicable to hardware.
However, the selected Hardware value in the Type filter does not affect the Type filter itself—all values in the Type filter remain available.
Date Selection Limits
- Date data type:
- When setting a date filter, selection is limited to the minimum and maximum date values present in the table.
- Date and time data type:
- When setting a date and time filter, selection is limited to the minimum and maximum date values in the table.
- There are no restrictions on time values.
- The calendar always opens to the most recent available month.
Widget Configuration in YAML
You can configure the widget not only in the visual editor but also in the YAML editor. The table below lists the keys and values available for configuration. For more information on using the value key, see Dimension and measure values in YAML. Supported data formats are described on the corresponding page.
Data Settings in YAML
| Key | Type | Description |
|---|---|---|
| title | string | Title |
| showMarkdown | boolean | Description |
| markdownText | string | Description text |
| markdownMeasures | — | Measure in description |
| dimensions | — | Dimensions |
| sorting | — | Sorting |
Dimensions in YAML (dimensions key)
To add a dimension, use the dimensions block. The following keys are available within this block:
| Key | Type | Description |
|---|---|---|
| name | string | Dimension name |
| value | — | Dimension formula |
| dbDataType | enum | Dimension data type |
| format | enum | Format |
| formatting | enum | Formatting |
| formattingTemplate | string | Custom formatting Only available for CUSTOM formatting |
| hideEmptyValues | boolean | Hide empty values |
| hierarchyDimensions | — | Hierarchical dimension |
Hierarchical Dimension in YAML (key: hierarchyDimensions)
To add a hierarchical dimension, include the hierarchyDimensions block inside the dimensions block. The following keys are supported:
| Key | Type | Description |
|---|---|---|
| name | string | Dimension name |
| value | — | Dimension formula |
| dbDataType | enum | Dimension data type |
| format | enum | Format |
| formatting | enum | Formatting |
| formattingTemplate | string | Custom formatting Only available for CUSTOM formatting |
| hideEmptyValues | boolean | Hide empty values |
Display Settings in YAML
| Key | Type | Description |
|---|---|---|
| paddings | string | Side paddings |
| titleSize | number | Title size |
| titleColor | — | Title color: - AUTO — auto- BASE — solid |
| titleWeight | enum | Font weight: - NORMAL — normal- BOLD — bold |
| markdownTextSize | number | Markdown description text size Available only if Description is enabled |
| textSize | number | Text size |
| dimensionLimit | number | Dimension limit |
| displaySign | enum | View type: - SELECT — list- TABLE — table |
Filtering Settings in YAML
| Key | Type | Description |
|---|---|---|
| filterMode | enum | Filter mode: - DEFAULT — default- SINGLE — single selection- DISABLED — disabled |
| ignoreFilters | boolean | Ignore filters |
| filters | — | Filters |
| aggregateFilters | — | Aggregate filters |
| stateName | string | State |
Example of a Configured Widget in the YAML Editor
- key: FILTER
apiVersion: "16"
type: FILTER
settings:
displayCondition:
mode: DISABLED
textSize: 12
ignoreFilters: false
filters: []
filterMode: DEFAULT
sorting: []
dimensionLimit: 50
dimensions:
- dbDataType: DATE
name: Date (Date)
format: DATE
value:
mode: TEMPLATE
templateName: date
dbType: CH
tableName: sale
columnName: Date
formatting: AUTO
title: ""
titleSize: 14
stateName: null
displaySign: SELECT
titleColor:
mode: AUTO
titleWeight: NORMAL
showMarkdown: false
markdownMeasures: []
markdownText: ""
Was the article helpful?