THIS IS ARCHIVED DOCUMENTATION

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

This is for:

Developer System Administrator

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

This article describes properties that are available on the Distance Facet Range component. Note that while this component is very similar to the Facet Range Component, some properties of the regular Facet Range 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
Facet Value Ranges Specifies the ranges used to display results. This parameter is mandatory.
Integration
Include facet values in the breadcrumb Specifies if selected facet values should be displayed in the breadcrumb. Enabled
Maximum number of facet values displayed in the breadcrumb Specifies the maximum number of values the facet should display in the breadcrumb. 5
Computed Field
Computed field Specifies a field name on which an aggregate operation should be executed for all distinct values of the facet's field. The result of the operation is displayed along with the number of occurrences for each value.
Computed field operation Specifies the type of aggregate operation to use on the computed field. sum

The available values are:

  • sum: Computes the sum of the computed field values.
  • average: Computes the average of the computed field values.
  • minimum: Finds the minimum value of the computed field values.
  • maximum: Finds the maximum value of the computed field values.
Computed field format Specifies how to format the values resulting from a computed field operation.

The formats available are defined by the Globalize.js library. The most common used formats are:

  • c0: Formats the value as a currency.
  • n0: Formats the value as an integer.
  • n2: Formats the value as a floating point with 2 decimal digits.

More information can be obtained in the library's documentation (see Globalize.format).
Computed field caption Specifies the computed field's caption in the settings menu. For example, the value Money is displayed as Money Ascending for computed field ascending.
Advanced settings

Distance field name

 The name of the field used to hold the distance query result. distance You don'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.
Show an icon next to the facet values Specifies if an icon is displayed next to each facet value. Enabled
Facet accuracy determined by the number of scanned results The facet accuracy selection sets the injection depth, the number of search results that are scanned to find possible facet values. Selections from Less Precise (Fast) to Exact (Slowest) progressively increase the number of scanned results, ensuring more possible facet values are found, at the cost of performance. Less Precise (Fast)

Preserve facet position under mouse on new facet query

 Specifies whether the facet should remain stable in its current position in the viewport as long as the mouse is over it. Enabled
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. 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. $GenerateNewUniqueId

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 sub-layout (see Adding Custom Parameters with the Additional Parameters Field).