Coveo JavaScript Search Framework - Reference Documentation

Index

Coveo components

Modules

Enumerations

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

BaseFormTypes

Context

Context: IStringMap<string | string[]>

IAnalyticsDocumentViewMeta

IAnalyticsDocumentViewMeta: object

Type declaration

  • author: string
  • Optional documentTitle?: string
  • Optional documentURL?: string

IQueryExpression

IQueryExpression: string

ResponseFormat

ResponseFormat: "json" | "opensearch-atom" | "opensearch-rss" | "xlsx"

ValidLayout

ValidLayout: "list" | "card" | "table"

ValidTooltipPlacement

ValidTooltipPlacement: "auto-start" | "auto" | "auto-end" | "top-start" | "top" | "top-end" | "right-start" | "right" | "right-end" | "bottom-end" | "bottom" | "bottom-start" | "left-end" | "left" | "left-start"

Functions

$$

addActionCauseToList

clearLocalData

  • clearLocalData(searchRoot?: HTMLElement): void
  • Parameters

    • Default value searchRoot: HTMLElement = document.querySelector(Component.computeSelectorForType(SearchInterface.ID)) as HTMLElement

    Returns void

configureResourceRoot

  • configureResourceRoot(path: string): void

disableAnalytics

  • disableAnalytics(searchRoot?: HTMLElement): void
  • Parameters

    • Default value searchRoot: HTMLElement = document.querySelector(Component.computeSelectorForType(SearchInterface.ID)) as HTMLElement

    Returns void

enableAnalytics

  • enableAnalytics(searchRoot?: HTMLElement): void
  • Parameters

    • Default value searchRoot: HTMLElement = document.querySelector(Component.computeSelectorForType(SearchInterface.ID)) as HTMLElement

    Returns void

executeQuery

get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent

init

  • init(element: HTMLElement, options?: any): Promise<object>

initRecommendation

  • initRecommendation(element: HTMLElement, mainSearchInterface?: HTMLElement, userContext?: object, options?: any): Promise<object>
  • Parameters

    • element: HTMLElement
    • Optional mainSearchInterface: HTMLElement
    • Optional userContext: object
      • [name: string]: any
    • Default value options: any = {}

    Returns Promise<object>

    }

initSearchbox

  • initSearchbox(element: HTMLElement, searchPageUri: string, options?: any): Promise<object>

load

  • load<T>(id: string): Promise<T>

logClickEvent

logCustomEvent

logSearchAsYouTypeEvent

  • logSearchAsYouTypeEvent<TMeta>(element: HTMLElement, searchAsYouTypeEventCause: IAnalyticsActionCause, metadata: TMeta): void

logSearchEvent

options

  • options(element: HTMLElement, optionsToSet?: any): void

patch

  • patch(element: HTMLElement, methodName: string, handler: function): void
  • Parameters

    • element: HTMLElement
    • methodName: string
    • handler: function
        • (...args: any[]): any
        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns void

racePromises

  • racePromises<T>(promises: Thenable<T>[]): Promise<T>

removeActionCauseFromList

  • removeActionCauseFromList(actionCauseToRemoveName: string): void

state

  • state(element: HTMLElement, ...args: any[]): any

Object literals

Const ResponsiveFacetOptions

ResponsiveFacetOptions: object

dropdownHeaderLabel

dropdownHeaderLabel: string

enableResponsiveMode

enableResponsiveMode: boolean