Integration Card Filters
Filters allow end users to refine displayed data based on selected criteria.
Filters are defined in the "configuration" section of the manifest.
The card developer choses the type of each filter, its initial value and the available options for the end user.
In order to make the filter functional its value has to be bound to the data requests made by the card.
All filters provide access to their current value through the filters model.
When the end user selects different value the model is updated, refreshing all fields that are bound to it.
Filter Properties
All filters have the following common properties:
| Property | Type | Default Value | Required | Description | Schema Version | Since |
|---|---|---|---|---|---|---|
| type | string | "Select" | No |
The type of the filter. Based on this value additional properties of the filter are available.
Possible values are:
|
1.24.0 | 1.80 |
| label | string | No | A label for the filter. This property is used by screen readers. | 1.24.0 | 1.80 | |
| visible | boolean | true | No | Whether the filter should be visible on the screen. | 1.50.0 | 1.110 |
Filters Model
The value of each filter is stored in the filters model.
It can be referenced throughout the manifest with the following syntax: {filters>/keyOfTheFilter/value}.
Depending on the filter type different values are available.