Zum Inhalt

@smartmaps/autocomplete • Docs


@smartmaps/autocomplete / Autocomplete

Class: Autocomplete

Nur auf Englisch verfügbar

Diese Seite gehört zur technischen API-Referenz. Sie wird automatisch aus dem Quellcode erzeugt und liegt daher ausschließlich auf Englisch vor. Die einführenden Seiten und Leitfäden sind auf Deutsch verfügbar.

Extends

Constructors

new Autocomplete()

new Autocomplete(element, apiKey, options?): Autocomplete

Parameters

• element: string | HTMLInputElement

• apiKey: string

• options?: Partial\<AutocompleteOptions>

Returns

Autocomplete

Overrides

`AutoComplete< RequestQuery, ResponseProperties, AutocompleteOptions, SmartmapsAutocompleteEvents

.constructor`

Properties

api

protected api: ApiService\<AutocompleteRequestQueryBase, ResponseProperties, AutocompleteOptions>

Inherited from

AutoComplete.api


autocomplete

autocomplete: Awesomplete

Inherited from

AutoComplete.autocomplete


bounds

bounds: undefined | SmartmapsBoundsLiteral

Inherited from

AutoComplete.bounds


center

center: undefined | LatLngLiteral

Inherited from

AutoComplete.center


inputElement

protected inputElement: HTMLInputElement

Inherited from

AutoComplete.inputElement


isReady

isReady: boolean

Inherited from

AutoComplete.isReady


options

options: AutocompleteOptions

Inherited from

AutoComplete.options


radius

radius: number

Inherited from

AutoComplete.radius


session

session: AutocompleteSession

Inherited from

AutoComplete.session

Methods

addEventListener()

addEventListener(type, callback, options)

addEventListener\<K>(type, callback, options?): void

Type Parameters

• K extends keyof SmartmapsAutocompleteEvents

Parameters

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

AutoComplete.addEventListener

addEventListener(type, callback, options)

addEventListener(type, callback, options?): void

Parameters

• type: string

• callback: null | EventListenerOrEventListenerObject

• options?: boolean | EventListenerOptions

Returns

void

Inherited from

AutoComplete.addEventListener


close()

close(): void

Returns

void

Inherited from

AutoComplete.close


dispatchEvent()

dispatchEvent(event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters

• event: Event

Returns

boolean

Inherited from

AutoComplete.dispatchEvent


extractBounds()

protected extractBounds(bounds): void

Parameters

• bounds: unknown

Returns

void

Inherited from

AutoComplete.extractBounds


extractLatLng()

protected extractLatLng(latlng): void

Parameters

• latlng: unknown

Returns

void

Inherited from

AutoComplete.extractLatLng


fetch()

fetch(query): Promise\<AutocompleteSuggestionCollection\<ResponseProperties>>

Parameters

• query: AutocompleteRequestQueryBase

Returns

Promise\<AutocompleteSuggestionCollection\<ResponseProperties>>

Overrides

AutoComplete.fetch


findAddress()

findAddress(query, address, done?): void | Promise\<AutocompleteSuggestionCollection\<ResponseProperties>>

Parameters

• query: AutocompleteRequestQueryBase

• address: AutocompleteRequestQueryBase

• done?

Returns

void | Promise\<AutocompleteSuggestionCollection\<ResponseProperties>>

Inherited from

AutoComplete.findAddress


getBounds()

getBounds(): undefined | LatLngBoundsExpression

Returns

undefined | LatLngBoundsExpression

Inherited from

AutoComplete.getBounds


getBrand()

protected getBrand(): string

Returns

string

Overrides

AutoComplete.getBrand


getCenter()

getCenter(): undefined | LatLngLiteral

Returns

undefined | LatLngLiteral

Inherited from

AutoComplete.getCenter


getClearIcon()

protected getClearIcon(): string

Returns

string

Overrides

AutoComplete.getClearIcon


getPin()

getPin(address): string

Parameters

• address: string | ResponseProperties

Returns

string

Overrides

AutoComplete.getPin


getSearchIcon()

protected getSearchIcon(): string

Returns

string

Overrides

AutoComplete.getSearchIcon


getSuggestionDirection()

protected getSuggestionDirection(): string

Returns

string

Inherited from

AutoComplete.getSuggestionDirection


open()

open(): void

Returns

void

Inherited from

AutoComplete.open


removeEventListener()

removeEventListener(type, callback, options?): void

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Parameters

• type: string

• callback: null | EventListenerOrEventListenerObject

• options?: boolean | EventListenerOptions

Returns

void

Inherited from

AutoComplete.removeEventListener


removeMap()

removeMap(): void

Returns

void

Inherited from

AutoComplete.removeMap


setBounds()

setBounds(latLngBounds): void

Parameters

• latLngBounds: SmartmapsBoundsExpression

Returns

void

Inherited from

AutoComplete.setBounds


setCenter()

setCenter(latlng, radius?): void

Parameters

• latlng: SmartmapsPointExpression

• radius?: number

Returns

void

Inherited from

AutoComplete.setCenter


setClassName()

protected setClassName(brandClassName): void

Parameters

• brandClassName: string

Returns

void

Inherited from

AutoComplete.setClassName


setMap()

setMap(map): void

Parameters

• map: any

Returns

void

Inherited from

AutoComplete.setMap


update()

update(): void

Returns

void

Inherited from

AutoComplete.update


updateMap()

updateMap(): void

Returns

void

Inherited from

AutoComplete.updateMap


whenReady()

whenReady(onReady?): void | Promise\<void>

Parameters

• onReady?

Returns

void | Promise\<void>

Inherited from

AutoComplete.whenReady