NumericFilter (Product Listing Engine)
NumericFilter (Product Listing Engine)
This is for:
DeveloperThe NumericFilter
controller makes it possible to create a numeric filter.
Methods
clear
Clears the current filter.
disable
Disables the filter. I.e., prevents it from filtering results.
enable
Enables the filter. I.e., undoes the effects of disable
.
setRange
Updates the selected range.
Parameters
-
range:
NumericFilterRange
The numeric range.
Returns boolean
: Whether the range is valid.
subscribe
Adds a callback that’s invoked on state change.
Parameters
-
listener:
() => void
A callback that’s invoked on state change.
Returns Unsubscribe
: A function to remove the listener.
Attributes
state
The state of the NumericFilter
controller.
Properties
-
enabled:
boolean
Whether the filter is enabled and its value is used to filter search results.
-
facetId:
string
The facet ID.
-
isLoading:
boolean
Returns
true
if a search is in progress, andfalse
if not. -
range?:
NumericFacetValue
The current selected range.
Initialize
buildNumericFilter
Parameters
-
engine:
ProductListingEngine
The headless engine.
-
props:
NumericFilterProps
The configurable
NumericFilter
properties.
Returns NumericFilter
NumericFilterProps
The configurable NumericFilter
properties.
Properties
-
options:
NumericFilterOptions
The options for the
NumericFilter
controller. -
initialState?:
NumericFilterInitialState
The initial state.
NumericFilterOptions
The options for the NumericFilter
controller.
Properties
-
field:
string
The field whose values you want to display in the filter.
-
facetId?:
string
A unique identifier for the controller. By default, a unique random ID is generated.
-
filterFacetCount?:
boolean
Whether to exclude folded result parents when estimating the result count for each facet value.
Default:
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
Default:
1000
NumericFilterInitialState
The initial state.
Properties
-
range:
NumericFilterRange
The initial selected range.
Related Types
NumericFacetValue
Properties
-
end:
number
The ending value for the numeric range.
-
endInclusive:
boolean
Whether or not the end value is included in the range.
-
numberOfResults:
number
The number of results that have the facet value.
-
start:
number
The starting value for the numeric range.
-
state:
'idle' | 'selected' | 'excluded'
The state of the facet value, indicating whether it is filtering results (
selected
) or not (idle
).
NumericFilterRange
Properties
-
end:
number
The ending value for the numeric range.
-
start:
number
The starting value for the numeric range.
Unsubscribe
Call signatures
-
(): void