@coveo/headless
    Preparing search index...

    Interface RegisterCategoryFacetActionCreatorPayload

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

    Properties

    activeTab? basePath? delimitingCharacter? facetId field filterByBasePath? filterFacetCount? injectionDepth? numberOfValues? sortCriteria? tabs?

    Properties

    activeTab?: string
    • This field is unused and should not be relied on. If you need the currently active tab, use the TabManager instead.

    This property will be removed in version 4.0.

    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 facet.

    field: string

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

    filterByBasePath?: boolean

    Whether to use basePath as a filter for the results.

    true

    filterFacetCount?: boolean

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

    Note: Resulting count is only an estimation, in some cases this value could be incorrect.

    true

    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

    1000

    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

    5

    sortCriteria?: CategoryFacetSortCriterion

    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.

    Settings

    Member Visibility

    On This Page

    Properties