Interface FacetOptions

interface FacetOptions {
    allowedValues?: string[];
    customSort?: string[];
    facetId?: string;
    facetSearch?: FacetSearchOptions;
    field: string;
    filterFacetCount?: boolean;
    hasBreadcrumbs?: boolean;
    injectionDepth?: number;
    numberOfValues?: number;
    resultsMustMatch?: FacetResultsMustMatch;
    sortCriteria?: FacetSortCriterion;
    tabs?: { excluded?: string[]; included?: string[] };
}

Properties

allowedValues? customSort? facetId? facetSearch? field filterFacetCount? hasBreadcrumbs? injectionDepth? numberOfValues? resultsMustMatch? sortCriteria? tabs?

Properties

OptionalallowedValues

allowedValues?: string[]

Specifies an explicit list of allowedValues in the Search API request.

If you specify a list of values for this option, the facet uses only these values (if they are available in the current result set).

The maximum amount of allowed values is 25.

Default value is undefined, and the facet uses all available values for its field in the current result set.

OptionalcustomSort

customSort?: string[]

Identifies the facet values that must appear at the top, in this order. This parameter can be used in conjunction with the sortCriteria parameter.

Facet values not part of the customSort list will be sorted according to the sortCriteria.

The maximum amount of custom sort values is 25.

The default value is undefined, and the facet values will be sorted using only the sortCriteria.

OptionalfacetId

facetId?: string

A unique identifier for the controller. By default, a random unique identifier is generated.

OptionalfacetSearch

facetSearch?: FacetSearchOptions

Facet search options.

field

field: string

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

OptionalfilterFacetCount

filterFacetCount?: boolean

Whether to exclude the parents of folded results when estimating the result count for each facet value.

Default Value

true

OptionalhasBreadcrumbs

hasBreadcrumbs?: boolean

Specifies whether breadcrumbs appear for the facet

Default Value

true

OptionalinjectionDepth

injectionDepth?: number

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 Value

1000

OptionalnumberOfValues

numberOfValues?: number

The number of values to request for this facet. Also determines the number of additional values to request each time this facet is expanded, and the number of values to display when this facet is collapsed.

Minimum: 1

Default Value

8

OptionalresultsMustMatch

resultsMustMatch?: FacetResultsMustMatch

The criterion to use for specifying how results must match the selected facet values.

Default Value

atLeastOneValue

OptionalsortCriteria

sortCriteria?: FacetSortCriterion

The criterion to use for sorting returned facet values.

The sortCriteria option does not apply when making a facet search request. It is only used for sorting returned facet values during a regular Coveo search request.

Learn more about sortCriteria values and the default behavior of specific facets in the Search API documentation.

Default Value

automatic

Optionaltabs

tabs?: { excluded?: string[]; included?: string[] }

The tabs on which the facet should be enabled or disabled.

Settings

Member Visibility

On This Page

Properties