-
Facets Reference
- Coveo Category Facet
- Coveo Date Facet Range
- Coveo Date Facet Slider
- Coveo Distance Facet Range
- Coveo Dynamic Date Facet Range
- Coveo Dynamic Distance Facet Range
- Coveo Dynamic Facet
- Coveo Dynamic Facet Manager
- Coveo Dynamic Hierarchical Facet
- Coveo Dynamic Numeric Facet Range
- Coveo Facet
- Coveo Numeric Facet Range
- Coveo Numeric Facet Slider
Coveo Numeric Facet Range
The Coveo Dynamic Numeric Facet Range is now recommended over the Coveo Numeric Facet Range rendering. |
Implements the Coveo JavaScript Search Framework FacetRange component to display a facet whose values are expressed as numeric ranges.
Usage Notes
-
The Sitecore field used as the data source
Field
value must be included for indexing in the Templates table of the Indexing Manager (see About the Indexing Manager - Fields). -
To use the Coveo Numeric Facet Range rendering with custom numeric ranges, you first need to create a content tree structure, such as the one below, containing a
Custom Numeric Ranges
item with childrenNumeric Range
items. This structure can be placed anywhere in the content tree. You will reference the location of theCustom Numeric Ranges
item in theFacet value ranges
data source option (see Configure Custom Ranges for a Date Range or Numeric Range Facet). -
Any change to the facet range value selection(s) triggers a new Search API call.
Insertion Location
The Coveo Numeric Facet Range rendering is an Allowed Control in the following placeholder(s): Facets
Example insertion sequence for the Coveo Numeric Facet Range rendering.
Coveo for Sitecore SXA rendering insertion locations aren’t limited by placeholder Allowed Controls. The Coveo Numeric Facet Range rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.
Example insertion sequence for the Coveo Numeric Facet Range rendering.
Data Source Options
Option name | Description |
---|---|
Title | See title component option |
Field | See field component option |
Facet name | See id component option |
Number of values | See numberOfValues component option |
Sort | See sortCriteria component option |
Ignore accents in facet search | See facetSearchIgnoreAccents component option |
Allowed facet values | See allowedValues component option |
Facet value caption | This option is exposed for legacy reasons. |
Enable collapse button | See enableCollapse component option |
Enable settings button | See enableSettings component option |
Sort criteria displayed in the settings menu | See availableSorts component option |
Enable search for the facet | See enableFacetSearch component option |
Number of values to display in the facet search results | See numberOfValuesInFacetSearch component option |
Enable more/less button | See enableMoreLess component option |
Number of additional facet values to fetch when 'More' is clicked | See pageSize component option |
Include facet values in the omnibox | This option is exposed for legacy reasons. It is not recommended to use it. Specifies if the facet should push data to the Omnibox component. |
Include facet values in the breadcrumb | See includeInBreadcrumb component option |
Maximum number of facet values displayed in the breadcrumb | See numberOfValuesInBreadcrumb component option |
Computed field | See computedField component option |
Computed field operation | See computedFieldOperation component option |
Computed field format | See computedFieldFormat component option |
Computed field caption | See computedFieldCaption component option |
Is multi-value field | See isMultiValueField component option |
Facet uses the AND operator | See useAnd component option |
Allow user to select the facet operator | See enableTogglingOperator component option |
Facet accuracy determined by the number of scanned results | Sets the injectionDepth component option to a preset value |
Enable 'Save Facet State' option in Settings menu | See enableSettingsFacetState component option |
Preserve facet position under mouse on new facet query | See preservePosition component option |
Facet value ranges | Specifies whether to use automatically generated numeric ranges or custom numeric ranges created in Sitecore. |
DOM unique Id | Randomly generated HTML element id. |
Additional data attributes |
Allows use of the Coveo JavaScript Search Framework FacetRange component options that aren’t directly available in the data source. |
Sample Generated HTML and Corresponding Visual Output
<div id="coveod863082c" class="CoveoFacetRange"
data-available-sorts="alphaascending,alphadescending,occurrences,score"
data-value-caption="{"range1" : "Under $100" , "range2" : "$100 - $250" , "range3" : "$250 - $500" ,
"range4" : "$500 - $1000" , "range5" : "Over $1000"}"
data-prebind-field="fieldTranslator" data-field="@saleprice" data-injection-depth="1000"
data-sort-criteria="alphaascending" data-title="Sale Price"
data-ranges="[{"start":"0","end":"100","endInclusive":false,"label":"range1"},
{"start":"100","end":"250","endInclusive":false,"label":"range2"},
{"start":"250","end":"500","endInclusive":false,"label":"range3"},
{"start":"500","end":"1000","endInclusive":false,"label":"range4"},
{"start":"1000","end":"1000000","endInclusive":false,"label":"range5"}]"
data-date-field="false" data-applied-prebind="true">
