Class SearchCompat

constructor

• new SearchCompat(options?: SearchCompatOptions): SearchCompat

  Parameters

  • options: SearchCompatOptions = {}

  Returns SearchCompat

activeSource

allPlaceholder

ReadonlyautoNavigate

ReadonlyautoRefreshSources

container

ReadonlydefaultSourceMaxFeatureCandidates

ReadonlydefaultSourceMaxResults

ReadonlydefaultSourceMaxSuggestions

ReadonlyeventBus

includeDefaultSources

loaded

loadStatus

locationEnabled

maxResults

popupEnabled

resultGraphicEnabled

results

searchAllEnabled

searchTerm

selectedResult

selectedResultIndex

sources

suggestions

Readonlyview

addSource

• addSource(source: SearchSourceCompat): void

  Parameters

  • source: SearchSourceCompat

  Returns void

attachContainer

• attachContainer(element: HTMLElement): void

  Parameters

  • element: HTMLElement

  Returns void

clear

• clear(): void

  Returns void

destroy

• destroy(): void

  Returns void

load

• load(): Promise<SearchCompat>

  Returns Promise<SearchCompat>

nextResult

• nextResult(): Promise<SearchResultCompat | undefined>

  Returns Promise<SearchResultCompat | undefined>

previousResult

• previousResult(): Promise<SearchResultCompat | undefined>

  Returns Promise<SearchResultCompat | undefined>

removeSource

• removeSource(source: SearchSourceCompat): boolean

  Parameters

  • source: SearchSourceCompat

  Returns boolean

search

• search(
      termOrRequest: string | Partial<SearchRequestCompat>,
  ): Promise<SearchResponseCompat>

  Parameters

  • termOrRequest: string | Partial<SearchRequestCompat>

  Returns Promise<SearchResponseCompat>

selectResult

• selectResult(
      resultOrIndex: number | SearchResultCompat,
  ): Promise<SearchResultCompat | undefined>

  Parameters

  • resultOrIndex: number | SearchResultCompat

  Returns Promise<SearchResultCompat | undefined>

setActiveSource

• setActiveSource(source: SearchSourceCompat | undefined): void

  Parameters

  • source: SearchSourceCompat | undefined

  Returns void

setSources

• setSources(
      sources: readonly SearchSourceCompat[],
      options?: { includeDefaultSources?: boolean },
  ): void

  Parameters

  • sources: readonly SearchSourceCompat[]
  • options: { includeDefaultSources?: boolean } = {}

  Returns void

suggest

• suggest(
      termOrRequest: string | Partial<SearchRequestCompat>,
  ): Promise<SuggestResponseCompat>

  Parameters

  • termOrRequest: string | Partial<SearchRequestCompat>

  Returns Promise<SuggestResponseCompat>

watch

• watch(
      propertyName: string,
      listener: (value: unknown) => void,
  ): SearchHandleCompat

  Parameters

  • propertyName: string
  • listener: (value: unknown) => void

  Returns SearchHandleCompat

when

• when(callback?: (widget: SearchCompat) => void): Promise<SearchCompat>

  Parameters

  • Optionalcallback: (widget: SearchCompat) => void

  Returns Promise<SearchCompat>