Quick Filters
Overview
Placement | or |
Required KM objects | Record.Attribute |
Introduction to Quick Filters
Use the "Quick Filter" component on Views to allow users to quickly filter on relevant attributes with as few clicks as possible.
Basic configurations
Basic configurations
Please find below an example of the most basic configuration of a "Quick Filter" component. There are two different ways on how quick filter component can be configured:
Filter by Knowledge Model or
Filter by Attributes
The two different filter options can also be combined.
If you want to make use of quick filters for dates. Please factor in the time difference. This can be done by using unix timestamp such as "{t 1451595600}" which is "Thu Dec 31 2015 21:00:00 GMT+0000"
Option 1: Filter by Knowledge Model
Option 1: Filter by Knowledge Model
You can use KM filter if you want to create complex and reusable filter queries. Before setting up the component you need to define KM filters first. Check out the YAML example in the filter section below.
Attribute | Required | Type | Description |
|---|---|---|---|
filters | true | List of filter | Contains a list of filter. |
filter | true | KM Filters (deprecated) | References a KM filter. Knowledge Model filters:
- id: JAN01
displayName: Jan01 +03GMT
pql: FILTER ROUND_QUARTER("PizzaP2P_xlsx_Sheet_0"."EVENTTIME") = {t 1451595600} #Factors in user timezone (+03GMT) by using unix timestamp
- id: FEB16
displayName: Feb16 00GMT
pql: FILTER ROUND_QUARTER("PizzaP2P_xlsx_Sheet_0"."EVENTTIME") = {d'2016-04-01'} #Doesn't factor in user timezone |
selected | true | Boolean | Defines a default selection state for the quick-filter |
View
id: qf1 type: quick-filters settings: filters: - filter: JAN01 selected: true - filter: FEB16
Option 2: Filter by Attributes
Option 2: Filter by Attributes
You can use the filter by attribute. To create quick filters quickly based on the existing record. attributes from your KM. Please find below the different attributes you need to define the quick filter.
Attribute | Required | Type | Description |
|---|---|---|---|
attributeFilters | true | List of attribute filter | Contains a list of attributes. |
attribute | true | Record.Attribute | References the attribute from the Knowledge Model by which you want to filter. |
type | true | String | Defines the attribute type of the Attribute. |
values - name: Zoe value: Zoe | true | List of values consisting of name and value | Defines the values by which the attribute can should be filtered. |
View
id: qf2 type: quick-filters settings: attributeFilters: - attribute: ACTIVITY.USERNAME type: string values: - name: Zoe value: Zoe - name: Fabian value: Fabian
Advanced configurations
Advanced configurations
Attribute | Required | Type | Possible values | Default Value | Description |
|---|---|---|---|---|---|
single | false | Boolean | true false | false | Defines if only one single filter or multiple filters can be applied. |
label | false | String |
|
| Defines a label should be displayed above the quick filter. Click here to see screenshot  |
styles | false | Enum | overflow styles |
| Contains different styling options such as overflow or styles. |
overflow | false | Enum | full-width line-break scroll | full-width | Defines the orientation of a list of dropdowns when the width of the selected dropdowns exceeds the component size. |
styles | false | Enum | horizontal vertical | - | Contains different style options such as horizontal and vertical alignment. |
horizontal | false | Enum | full right center left | full | Defines the horizontal alignment of the component. |
vertical | false | Enum | top center bottom | bottom | Defines the vertical alignment of the component. |
View
id: qf1 type: quick-filters settings: label: Custom label single: false filters: - filter: FILTER_FABIAN - filter: FILTER_ZOE styles: overflow: full-width position: horizontal: full vertical: bottom