Support Menu

Coveo component PipelineContext

Coveo PipelineContext Component (CoveoPipelineContext)

A PipelineContext is used to add contextual information about the environment inside which the query is executed.

It allows to pass arbitrary key values pairs ( think JSON ), which can then be leveraged by the Query Pipeline, or by Coveo Machine Learning.

This can be any arbitrary information that you can use to contextualize the query and help Coveo improve relevance by returning results tailored to a specific context.

This component is meant to be configured using a script tag, with a JSON content.

The values can be either a string or an array of string.

<script class='CoveoPipelineContext' type='text/context'>
     "foo" : "bar",
     "foobar" : ["foo", "bar"]

You can also simply use JavaScript code to pass context values, using the QueryBuilder.addContextValue method.

This means you do not necessarily need to use this component to pass context.

Coveo.$$(root).on('buildingQuery', function(args) {
    args.queryBuilder.addContextValue('foo', 'bar');

Using this component as opposed to JavaScript code means you will be able to leverage the interface editor.

Regardless of if you use this component or JavaScript to add context, both will add the needed data in the Query.Context parameter.


This component also ensures that the framework properly determines the context in all corner cases, including when a standalone search box (initSearchbox) is displaying query suggestions.

In most cases, if you do not use this component, the context will not be resolved and leveraged properly in the query pipeline (see What Is a Query Pipeline?).




  • debugInfo(): any


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




  • getContextKeys(): string[]


  • getContextValue(key: string): string | string[]
  • Get the context value associated to the given key.

    If the global variable Coveo.context contains the requested key, this method will return the value contained in Coveo.context instead of the one contained internally.

    This is especially useful in a Coveo for Salesforce context, where context values can be extracted from a backend service.


    • key: string

    Returns string | string[]


  • setContext(newContext: string | Context): void
  • Set a new context, replacing any value previously set.


    • newContext: string | Context

      The new context to set, which can be directly passed as a JSON, or as a stringified JSON.

    Returns void


  • setContextValue(contextKey: string, contextValue: string | 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.


    • 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



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




componentOptionsModel: ComponentOptionsModel

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


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: boolean

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




logger: Logger

Allows component to log in the dev console.


queryController: QueryController

Contains the singleton that allows to trigger queries.


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: HTMLElement

A reference to the root HTMLElement (the SearchInterface).


searchInterface: SearchInterface

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


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



  • Create a new Component. Resolve all IComponentBindings if not provided.
    Create a new Logger for this component. Attach the component to the SearchInterface.


    • element: HTMLElement

      The HTMLElement on which to create the component. Used to bind data on the element.

    • type: string

      The unique identifier for this component. See : IComponentDefinition.ID. Used to generate the unique Coveo CSS class associated with every component.

    • Default value bindings: IComponentBindings = {}

      The environment for every component. Optional, but omitting to provide one will impact performance.

    Returns PipelineContext


  • IPipelineContextProvider