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[] };
}

Properties

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

Properties

OptionalactiveTab

activeTab?: string

The currently active tab.

OptionalbasePath

basePath?: string[]

The base path shared by all values for the facet.

Default Value

[]

OptionaldelimitingCharacter

delimitingCharacter?: string

The character that specifies the hierarchical dependency.

Default Value

;

facetId

facetId: string

A unique identifier for the facet.

field

field: string

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

OptionalfilterByBasePath

filterByBasePath?: boolean

Whether to use basePath as a filter for the results.

Default Value

true

OptionalfilterFacetCount

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.

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

5

OptionalsortCriteria

sortCriteria?: CategoryFacetSortCriterion

The criterion to use for sorting returned facet values.

Default Value

occurrences

Optionaltabs

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

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

Settings

Member Visibility

On This Page

Properties