IFacetOption

Interface

Facet Option shown in the UI as either a radio button or checkbox

Properties

Property Type Notes
key string

Unique key, used for query params and telemetry

label string

Translated label for the option

selected boolean

Is this option selected when the UI loads

count Optional number

For aggregate based Facets, the count of entries in the index with this value

filter Optional Filter<FilterType>

DEPRECATED: Filter to be applied when this option is selected

filters Optional Array<Filter<FilterType>>

Filters to be applied when this option is selected


Interface defined in common/src/search/types/IFacetOption.ts:6