Coveo MissingTerms Component (CoveoMissingTerms)

This result template component renders a list of query terms that were not matched by the associated result item.

Available since

July 2019 Release (v2.6459)

Index

Methods

Properties

Accessors

Component Options

Constructors

Methods

addTermForcedToAppear

  • addTermForcedToAppear(term: string): void

  • Injects a term in the advanced part of the query expression (aq) to filter out items that do not match the term.

    Parameters

    • term: string

      The term to add to the advanced query expression.

    Returns void

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

missingTerms

  • get (): string[]

  • Returns all original basic query expression terms and phrases that were not matched by the result item the component instance is associated with.

    Returns string[]

usageAnalytics

Component Options

caption

caption: string

The text to display before missing terms.

Default: The localized string for Missing.

Markup configuration example(s) :
data-caption='foo'

clickable

clickable: boolean

Whether to allow the end-user to click a missing term to filter out items that do not match this term.

Default: true

Default

true

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

numberOfTerms

numberOfTerms: number

The maximum number of missing term to be displayed

Default: 5 Minimum value: 1

Minimum

1

Default

5

Markup configuration example(s) :
data-number-of-terms='10'

Constructors

constructor

  • Creates a new MissingTerms component instance.

    Parameters

    • element: HTMLElement

      The element on which to instantiate the component.

    • Optional options: IMissingTermsOptions

      The configuration options for the component.

    • Optional bindings: IComponentBindings

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

    • Optional result: IQueryResult

      The query result item to associate the component with.

    Returns MissingTerms