Quick filters configuration options
Overview
During the configuration of the Quick filters pane, you have the ability to customize how you want to display options within the different filters. This topic covers all configuration options available.
To see examples of how these options are used in the JSON, check out Static quick filter configuration, Dynamic quick filter configuration, or Mixed mode quick filter configuration.
Configuration options
The following options are used when configuring quick filters. They are optional to the configuration.
| Filter Option | Sub Option | Description |
|---|---|---|
| default_mode |
The default mode to use when positioning a filter category. Values: static or dynamic. If nothing is specified, static is used. |
|
| default_profile |
The profile to initially select in the drop-down on the IP catalog. If there is no default_profile, and you have not visited the IP catalog, the first profile in the drop-down will be selected. Once the IP catalog is visited, the last selected profile will always be selected. |
|
| default_option_sort_order |
Default order to sort filter options. Values: alphanumeric (default) or incremental Incremental: sorts the filter options in a filter category in descending order by their incremental result counts |
|
| filter_categories |
The top-down order you want the filter categories rendered in. You can name choice properties, “Library” or “Label.” |
|
| displayed_options | Sets the height of the filter category to show a specific number of filter options. | |
| option_order | These filter options appear at the top of this filter category, in a top-down order. | |
| option_preselect | These filter options are selected each time the user switches to this profile. | |
| option_sort_order |
The order to sort filter options in this filter category. Values: alphanumeric (default) or incremental Setting this will override the global property for a specific filter category. |
Metrics options
The following options are optional to configure.
| Filter Option | Sub Option | Description |
|---|---|---|
| metrics > option_count | Configuration for the option count metric. | |
| L1 | Default is 5. | |
| H1 | Default is 10. | |
| H2 | Default is 20. | |
| L2 | Default is 25 | |
| weight | Weight is assigned to this metric for use in calculating a filter category’s Section Figure of Merit score. Default is 0.2 | |
| metrics > option_coverage | Configuration for the option coverage metric. | |
| weight | Default is 0.4. | |
| metrics > option_distribution | Configuration for the option distribution metric. | |
| weight | Default is 0.4. |