atomic-segmented-facet (Deprecated)

This is for:

Developer
In this article
Warning

Atomic v1 has been deprecated. We recommend using the latest version of the Coveo Atomic library.

The atomic-segmented-facet displays a horizontal facet of the results for the current query.

Properties

Property Attribute Description Type Default

dependsOn

The required facets and values for this facet to be displayed. Examples:

<atomic-segmented-facet facet-id="abc" field="objecttype" ...></atomic-segmented-facet>

<!-- To show the facet when any value is selected in the facet with id "abc": -->
<atomic-segmented-facet
  depends-on-abc
  ...
></atomic-segmented-facet>

<!-- To show the facet when value "doc" is selected in the facet with id "abc": -->
<atomic-facet
  depends-on-abc="doc"
  ...
></atomic-segmented-facet>

{ [x: string]: string; }

{}

facetId

facet-id

Specifies a unique identifier for the facet.

string | undefined

field (required)

field

The field whose values you want to display in the facet.

string

filterFacetCount

filter-facet-count

Whether to exclude the parents of folded results when estimating the result count for each facet value. Note: The target folding field must be a facet field with the Use cache for nested queries options enabled (see Manage fields).

boolean

true

injectionDepth

injection-depth

The maximum number of results to scan in the index to ensure that the facet lists all potential facet values. Note: A high injectionDepth may negatively impact the facet request performance. Minimum: 0 Default: 1000

number

1000

label

label

The non-localized label for the facet. Used in the atomic-breadbox component through the bindings store.

string | undefined

numberOfValues

number-of-values

The number of values to request for this facet. Also determines the number of additional values to request each time more values are shown.

number

6

sortCriteria

sort-criteria

The sort criterion to apply to the returned facet values. Possible values are score, alphanumeric, occurrences, and automatic.

"alphanumeric" | "automatic" | "occurrences" | "score"

'automatic'

Shadow parts

Part Description

label

The facet value label.

placeholder

The placeholder displayed when the facet is loading.

segmented-container

The container that holds the segmented facets.

value-box

The facet value.

value-box-selected

The selected facet value.

values

The facet values container.