Support Menu

Coveo component FacetRange

Coveo FacetRange Component (CoveoFacetRange)

The FacetRange component displays a Facet whose values are expressed as ranges. These ranges are computed from the results of the current query.

This component inherits from the Facet component. This implies that you must specify a valid field value for this component to work.

Most of the options available for a Facet component are also available for a FacetRange component. There are some exceptions, however.

Here is the list of Facet options which the FacetRange component does not support.

Moreover, while the numberOfValues option still allows you to specify the maximum number of values to display in a FacetRange component, it is not possible for the end to display additional values, since the component does not support the More button.

not supported in

Coveo for Salesforce Free

Index

Component Options

dateField

dateField: boolean

Specifies whether the field for which you require ranges is a date field.

This allows the component to correctly build the outgoing IGroupByRequest.

Default value is false.

Markup configuration example(s) :
data-date-field='true'
data-date-field='false'

ranges

ranges: Array<IRangeValue>

Specifies an array of IRangeValue to use as Facet values.

Examples:

You can set the option in the 'init' call:

var myRanges = [
  {
     start: 0,
     end: 100,
     label: "0 - 100",
     endInclusive: false
   },
   {
     start: 100,
     end: 200,
     label: "100 - 200",
     endInclusive: false
   },
   {
     start: 200,
     end: 300,
     label: "200 - 300",
     endInclusive: false
   }
]

Coveo.init(document.querySelector('#search'), {
   FacetRange : {
       ranges : myRanges
   }
})

Or directly in the markup:

<!-- Ensure that the double quotes are properly handled in data-ranges. -->
<div class='CoveoFacetRange' data-field='@myotherfield' data-ranges='[{"start": 0, "end": 100, "label": "0 - 100", "endInclusive": false}, {"start": 100, "end": 200, "label": "100 - 200", "endInclusive": false}]'></div>

Note:

Ranges can overlap.

By default, the index automatically generates the ranges. However, the index cannot automatically generate the ranges if the field you specify for the FacetRange component is generated by a query function (see Query Function). When this is the case, you must specify the ranges at query time.

Methods

collapse

  • collapse(): void

debugInfo

  • debugInfo(): any

deselectMultipleValues

  • deselectMultipleValues(values: FacetValue[]): void

deselectValue

disable

  • disable(): void
  • Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Component are enabled by default on creation.

    Returns void

enable

  • enable(): void
  • Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void

excludeMultipleValues

  • excludeMultipleValues(values: FacetValue[]): void

excludeValue

expand

  • expand(): void

getBindings

getDisplayedFacetValues

getDisplayedValues

  • getDisplayedValues(): string[]

getEndpoint

  • getEndpoint(): ISearchEndpoint

getExcludedValues

  • getExcludedValues(): string[]

getSelectedValues

  • getSelectedValues(): string[]

getValueCaption

hideWaitingAnimation

  • hideWaitingAnimation(): void

reset

  • reset(): void

selectMultipleValues

  • selectMultipleValues(values: FacetValue[]): void

selectValue

showLess

  • showLess(): void

showMore

  • showMore(): void

showWaitingAnimation

  • showWaitingAnimation(): void

switchToAnd

  • switchToAnd(): void

switchToOr

  • switchToOr(): void

toggleExcludeValue

toggleSelectValue

unexcludeMultipleValues

  • unexcludeMultipleValues(values: FacetValue[]): void

unexcludeValue

updateSort

  • updateSort(criteria: string): void

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent
  • Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
    If there is multiple component bound to the current HTMLElement, you must specify the component class.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for differents component. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger component state event when modified. Each component can listen to those events.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

facetSearch

facetSearch: FacetSearch

Renders and handles the facet Search part of the component.

facetSettings

facetSettings: FacetSettings

Renders and handles the facet Settings part of the component

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton

Constructors

constructor

  • Creates a new FacetRange component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IFacetRangeOptions

      The options for the FacetRange component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    Returns FacetRange

Implements