Coveo ResultsPreferences Component (CoveoResultsPreferences)

The ResultsPreferences component allows the end user to select preferences related to the search results. These preferences are then saved in the local storage of the end user.

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

See also the ResultsFiltersPreferences 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

save

  • save(): 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

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

enableOpenInNewWindow

enableOpenInNewWindow: boolean

Specifies whether to make the option to open results in a new window available.

Default value is true

Default

true

Markup configuration example(s) :
data-enable-open-in-new-window='true'
data-enable-open-in-new-window='false'

enableOpenInOutlook

enableOpenInOutlook: boolean

Specifies whether to make the option to open results in Microsoft Outlook available.

Default value is false

Default

false

Markup configuration example(s) :
data-enable-open-in-outlook='true'
data-enable-open-in-outlook='false'

enableQuerySyntax

enableQuerySyntax: boolean

Specifies whether to make the option to allow end users to turn query syntax on or off available.

If query syntax is enabled, the Coveo Platform tries to interpret special query syntax (e.g., @objecttype=message) when the end user types a query in the Querybox (see Coveo Query Syntax Reference). Enabling query syntax also causes the Querybox to highlight any query syntax.

Selecting On for the Enable query syntax setting enables query syntax, whereas selecting Off disables it. Selecting Automatic uses the Querybox enableQuerySyntax option value (which is false by default).

Default value is false

Default

false

Markup configuration example(s) :
data-enable-query-syntax='true'
data-enable-query-syntax='false'

Constructors

constructor