THIS IS ARCHIVED DOCUMENTATION

Coveo for Sitecore Legacy Search UI Framework - Facet Distance Slider Component Properties

This is for:

Developer System Administrator

Coveo for Sitecore (June 2017) Coveo for Sitecore (November 2018)

This article describes properties that are available on the Distance Facet Slider component. Note that while this component is very similar to the Facet Slider Component, some properties of the regular Facet Slider aren’t available for this component.

Property Description Default value Additional details
Basic settings
Title Specifies the title displayed at the top of the facet. New Facet
Range Settings
Minimum

Specifies the lowest boundary of the slider.
Maximum Specifies the highest boundary of the slider. This parameter is mandatory.
Allow user to change the slider minimum value Specifies if the slider minimum value is customizable. Disabled
Number of steps Specifies the number of steps to include in the slider. 10 For example, on a slider going from 0 to 100 and a number of steps of 10, slider buttons can only be placed on 0, 10, 20, 30, ..., 10.
Appearance Settings
Separator Specifies the separator used to display results. "-"
Value caption Specifies the format of the range displayed under the slider.

Replace the boundary with {0} or {1}. The caption will replace the distance unit that was set in the Coveo Distance Resources Component Properties.
Options
Icon Specifies the facet icon that's displayed next to the title. The icon must be in the media library.
Integration
Include facet values in the breadcrumb Specifies if the selected facet values should be displayed in the breadcrumb. Enabled
Advanced settings
Distance field name The name of the field used to hold the distance query result. distance It doesn't need to be modified for the component to work. However, its value can be changed by creating a new List Value Parameter in the Distance Field Names folder (located at /sitecore/system/Settings/Indexing and Search/Coveo) with the desired name for the distance field and selecting this new item in this field.
Display graph Specifies if you want to display a graph on top of your slider. Disabled
Graph number of steps Specifies the number of bar division of your graph. 10
Graph animation duration Specifies the duration of the slider animation in milliseconds. 500 ms
Id Specifies an optional unique identifier for a facet. For example, this identifier is used to save the facet state in the URL hash. If this field isn't specified, the field name is used as the unique identifier. Must be specified if you're adding two facets for the same field.
General
Placeholder Calls the appropriate container for the component you want to add. /coveo-search/coveo-facets When using the Experience Editor, this field is automatically filled with the correct container.
Data Source Specifies the source of the data used to populate the component with specific data.
Id
Unique identifier Specifies an optional unique identifier for a facet. $GenerateNewUniqueId

If not set by the user, the field is filed with a generated unique ID.
Caching
Caching Specifies if the component rendering is cached.

Parameters

Additional Parameters Allows passing custom parameters to a Coveo component. These custom parameters must be specified in the Coveo Search Component sublayout (see Adding Custom Parameters with the Additional Parameters Field).