Interface NumericFacetOptions

The options defining a NumericFacet.

interface NumericFacetOptions {
    currentValues?: NumericRangeRequest[];
    facetId?: string;
    field: string;
    filterFacetCount?: boolean;
    generateAutomaticRanges: boolean;
    injectionDepth?: number;
    numberOfValues?: number;
    rangeAlgorithm?: RangeFacetRangeAlgorithm;
    resultsMustMatch?: FacetResultsMustMatch;
    sortCriteria?: RangeFacetSortCriterion;
    tabs?: { excluded?: string[]; included?: string[] };
}

Properties

currentValues? facetId? field filterFacetCount? generateAutomaticRanges injectionDepth? numberOfValues? rangeAlgorithm? resultsMustMatch? sortCriteria? tabs?

Properties

OptionalcurrentValues

currentValues?: NumericRangeRequest[]

The values displayed by the facet in the search interface at the moment of the request.

If generateAutomaticRanges is false, values must be specified. If generateAutomaticRanges is true, automatic ranges are going to be appended after the specified values.

Default Value

[]

OptionalfacetId

facetId?: string

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

field

field: string

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

OptionalfilterFacetCount

filterFacetCount?: boolean

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

Default Value

true

generateAutomaticRanges

generateAutomaticRanges: boolean

Whether the index should automatically create range values.

Tip: If you set this parameter to true, you should ensure that the 'Use cache for numeric queries' option is enabled for this facet's field in your index in order to speed up automatic range evaluation.

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

OptionalrangeAlgorithm

rangeAlgorithm?: RangeFacetRangeAlgorithm

The algorithm that's used for generating the ranges of this facet when they aren't manually defined. The default value of "even" generates equally sized facet ranges across all of the results. The value "equiprobable" generates facet ranges which vary in size but have a more balanced number of results within each range.

Default Value

even

OptionalresultsMustMatch

resultsMustMatch?: FacetResultsMustMatch

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

Default Value

atLeastOneValue

OptionalsortCriteria

sortCriteria?: RangeFacetSortCriterion

The sort criterion to apply to the returned facet values.

Default Value

ascending

Optionaltabs

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

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

Settings

Member Visibility

On This Page

Properties