Coveo ResultsFiltersPreferences Component (CoveoResultsFiltersPreferences)

The ResultFiltersPreferences component allows end users to create custom filters to apply to queries. These filters are saved to local storage.

Only advanced end users who understand the Coveo query syntax should use this feature (see Coveo Query Syntax Reference).

This component is normally accessible through the Settings menu. Its usual location in the DOM is inside the PreferencesPanel element.

See also the ResultsPreferences component.

Index

Methods

Properties

Accessors

Component Options

Constructors

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void

  • Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components 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

getBindings

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

bind: ComponentEvents

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 different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers 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}

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.

Static ID

ID: string

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

Accessors

usageAnalytics

Component Options

filters

filters: any

Specifies the default filters which all end users can apply.

End users cannot modify or delete these filters. These filters do not count as "user-made" filters, but rather as "built-in" filters created by the developer of the search page.

Note:

You cannot set this option directly in the component markup as an HTML attribute. You must either set it in the init call of your search interface (see Passing Component Options in the init Call), or before the init call, using the options top-level function (see Passing Component Options Before the init Call).

Filters should follow this definition:

filters : { [caption : string] : { expression : string, tab? : string[] } };

Example:

var myFilters = { "Only Google Drive Items" : { expression : "@connectortype == 'GoogleDriveCrawler'", tab : ["Tab1", "Tab2"] },

"Another Filter" : { expression : [ ... another expression ... ] },

[ ... ] };

// You can set the option in the 'init' call:
Coveo.init(document.querySelector("#search"), {
  ResultsFiltersPreferences : {
    filters : myFilters
  }
});

// Or before the 'init' call, using the 'options' top-level function:
// Coveo.options(document.querySelector("#search"), {
//   ResultsFiltersPreferences : {
       filters : myFilters
     }
// });

Default value is undefined.

includeInBreadcrumb

includeInBreadcrumb: boolean

Specifies whether to display the active filter(s) in the Breadcrumb.

Default value is true.

Default

true

Markup configuration example(s) :
data-include-in-breadcrumb='true'
data-include-in-breadcrumb='false'

showAdvancedFilters

showAdvancedFilters: boolean

Specifies whether to show the Create button that allows the end user to create filters.

If you set this option to false, only the pre-populated filters are available to the end user.

Default value is true.

Default

true

Markup configuration example(s) :
data-show-advanced-filters='true'
data-show-advanced-filters='false'

Constructors

constructor