interface CategoryFacetOptions {
    basePath?: string[];
    delimitingCharacter?: string;
    facetId?: string;
    facetSearch?: CategoryFacetSearchOptions;
    field: string;
    filterByBasePath?: boolean;
    filterFacetCount?: boolean;
    injectionDepth?: number;
    numberOfValues?: number;
    sortCriteria?: CategoryFacetSortCriterion;
    tabs?: { excluded?: string[]; included?: string[] };
}

Properties

basePath?: string[]

The base path shared by all values for the facet.

[]

delimitingCharacter?: string

The character that specifies the hierarchical dependency.

;

facetId?: string

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

Facet search options.

field: string

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

filterByBasePath?: boolean

Whether to filter the results using basePath.

true

filterFacetCount?: boolean

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

true

injectionDepth?: number

The maximum number of results to scan in the index to ensure that the facet lists all of the potential facet values.

Note: A high injectionDepth may reduce facet request performance.

Minimum: 0

1000

numberOfValues?: number

The number of values to request for this facet. This option also determines the number of additional values to request each time this facet is expanded, as well as the number of values to display when this facet is collapsed.

Minimum: 1

5

The criterion to use for sorting returned facet values.

occurrences

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

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