Class SearchCompat

constructor

• new SearchCompat(options?): SearchCompat

• Parameters

  • options: SearchCompatOptions = {}

  Returns SearchCompat

allPlaceholder

ReadonlyautoNavigate

ReadonlyautoRefreshSources

Readonlycontainer

ReadonlydefaultSourceMaxFeatureCandidates

ReadonlydefaultSourceMaxResults

ReadonlydefaultSourceMaxSuggestions

ReadonlyeventBus

includeDefaultSources

loaded

loadStatus

locationEnabled

maxResults

popupEnabled

resultGraphicEnabled

results

searchAllEnabled

searchTerm

selectedResult

selectedResultIndex

sources

suggestions

Readonlyview

addSource

• addSource(source): void

• Parameters

  • source: SearchSourceCompat

  Returns void

clear

• clear(): void

• Returns void

destroy

• destroy(): void

• Returns void

load

• load(): Promise<SearchCompat>

• Returns Promise<SearchCompat>

nextResult

• nextResult(): Promise<undefined | SearchResultCompat>

• Returns Promise<undefined | SearchResultCompat>

previousResult

• previousResult(): Promise<undefined | SearchResultCompat>

• Returns Promise<undefined | SearchResultCompat>

removeSource

• removeSource(source): boolean

• Parameters

  • source: SearchSourceCompat

  Returns boolean

search

• search(termOrRequest): Promise<SearchResponseCompat>

• Parameters

  • termOrRequest: string | Partial<SearchRequestCompat>

  Returns Promise<SearchResponseCompat>

selectResult

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

• Parameters

  • resultOrIndex: number | SearchResultCompat

  Returns Promise<undefined | SearchResultCompat>

setSources

• setSources(sources, options?): void

• Parameters

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

    • OptionalincludeDefaultSources?: boolean

  Returns void

suggest

• suggest(termOrRequest): Promise<SuggestResponseCompat>

• Parameters

  • termOrRequest: string | Partial<SearchRequestCompat>

  Returns Promise<SuggestResponseCompat>

watch

• watch(propertyName, listener): SearchHandleCompat

• Parameters

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

      • Parameters

        • value: unknown

        Returns void

  Returns SearchHandleCompat

when

• when(callback?): Promise<SearchCompat>

• Parameters

  • Optionalcallback: ((widget: SearchCompat) => void)
    • • (widget): void

      • Parameters

        • widget: SearchCompat

        Returns void

  Returns Promise<SearchCompat>