Skip to end of metadata
Go to start of metadata

This topic describes properties that are available on the facet component.

 

PropertyDescriptionDefault valueAdditional Details
Basic Settings
TitleSpecifies the title displayed at the top of the facet.  
FieldSpecifies the field whose values will be displayed in the facet. Mandatory field.
Number of ValuesSpecifies the maximum number of values that will be displayed by default in the facet.5 
SortSpecifies the criterion used to sort facet values.Occurrences 

Results Scope

Ignore accents in facet searchSpecifies if the facet search ignores accents.Disabled 
Allowed facet valuesSpecifies an explicit list of allowed facet values. 

 

Separate each value with a comma (,).

Facet value captionSpecifies a mapping of facet values to the desired caption. 

 

The option was available in the Jully 2016 release but was not functioning properly until it was fixed in January 2017.

Options
Enable collapse buttonSpecifies if the facet is collapsible.Enabled 
Enable settings buttonSpecifies if the settings button is enabled.Enabled 
Sort criteria displayed in the settings menuSpecifies the criteria you want to be displayed in the facet settings menu.Occurrences, Score, Alphabetically (ascending), Alphabetically (descending) 
IconSpecifies the facet icon that is displayed next to the title. The icon must be in the media library.
Navigation
Enable search for the facetSpecifies if the search box for searching inside the available values will be displayed at the bottom of the facet.Enabled 
Number of values to display in the facet search resultsSpecifies the number of values displayed in the facet search results popup.15 
Enable more/less buttonSpecifies if the more/less button is enabled.Enabled 
Number of additional facet values to fetch when 'More' is clickedSpecifies the number of additional facet values to fetch when the 'More' button is clicked.10 
Integration
Include facet values in the omniboxSpecifies if the facet should push data to the OmniBox Component.Enabled 
Include facet values in the breadcrumbSpecifies if selected facet values should be displayed in the breadcrumb.Enabled 
Maximum number of facet values displayed in the breadcrumbSpecifies the maximum number of values that the facet should display in the breadcrumb.5 
Computed Field
Computed fieldSpecifies the name of a field 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 operationSpecifies 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 formatSpecifies 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 on GitHub).

Computed field captionSpecifies the computed field's caption in the settings menu. For example, the value Money will be displayed as Money Ascending for computed field ascending.Computed Field 
Advanced Settings

Lookup field

Gets the field used to display the facet values. If the lookup field is not defined, the facet values will be displayed using the FacetField field.  
Is multi-value fieldSpecifies if the facet has multiple values.Disabled 
Facet uses the AND operator

Whether or not the facet uses the AND operator instead of the OR operator to combine selected values.

Disabled

When using the AND operator, an item will return if it matches all selected facet values at the same time. On the other hand, with the OR operator, an item will return when it matches at least one of the selected facet values.

 

Allows user to select the facet operator

Whether or not the user can select the facet operator.

Disabled

When using the AND operator, an item will return if it matches all selected facet values at the same time. On the other hand, with the OR operator, an item will return when it matches at least one of the selected facet values.

 

Show an icon next to the facet valuesSpecifies whether an icon is displayed next to each facet value.Enabled 
Facet accuracy determined by the number of scanned resultsThe 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)

The available options are:

Less Precise (Fast)
Precise (Slower)
More Precise (Slower)
Exact (Slowest)

Enable Save Facet State option in Settings menu

Specifies whether the save state option is available in the facet settings menu.Disabled 

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   
PlaceholderCalls the appropriate container for the component you want to add./coveo-search/coveo-facetsWhen using the Experience Editor, this field is automatically filled with the correct container.
Data SourceSpecifies the source of the data used to populate the component with specific data.  
Id
Unique identifierSpecifies an optional unique identifier for a facet. For example, this identifier will be used to save the facet state in the URL hash. If this field is not specified, the field name will be used as the unique identifier.GenerateNewUniqueId 
Caching
Cacheable
Whether or not to make the component cacheable.
All Disabled
Available options for this parameter are:

Parameters

Additional ParametersAllows 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).