Class GeocodingControl
Hierarchy
- MapLibreBasedGeocodingControl
- GeocodingControl
Implements
- IControl
Index
Constructors
Methods
Constructors
constructor
Parameters
- options: MapLibreBaseControlOptions = ...
Returns GeocodingControl
Methods
blur
Returns void
clearList
Clear search result list.
Returns void
clearMap
Clear geocoding search results from the map.
Returns void
focus
listens
- listens(
type:
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle",
): booleanReturns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
Parameters
- type:
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle"The event type
Returns boolean
trueif there is at least one registered listener for specified event type,falseotherwise - type:
off
- off<
T extends
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle",
>(
type: T,
listener: (
ev: {
featureslisted: FeaturesListedEvent;
featuresmarked: FeaturesMarkedEvent;
optionsvisibilitychange: OptionsVisibilityChangeEvent;
pick: PickEvent;
querychange: QueryChangeEvent;
response: ResponseEvent;
reversetoggle: ReverseToggleEvent;
select: SelectEvent;
}[T],
) => void,
): thisRemoves a previously registered event listener.
Type Parameters
- T extends
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle"
Parameters
- type: T
The event type to remove listeners for.
- listener: (
ev: {
featureslisted: FeaturesListedEvent;
featuresmarked: FeaturesMarkedEvent;
optionsvisibilitychange: OptionsVisibilityChangeEvent;
pick: PickEvent;
querychange: QueryChangeEvent;
response: ResponseEvent;
reversetoggle: ReverseToggleEvent;
select: SelectEvent;
}[T],
) => voidThe listener function to remove.
Returns this
- T extends
on
- on<
T extends
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle",
>(
type: T,
listener: (
ev: {
featureslisted: FeaturesListedEvent;
featuresmarked: FeaturesMarkedEvent;
optionsvisibilitychange: OptionsVisibilityChangeEvent;
pick: PickEvent;
querychange: QueryChangeEvent;
response: ResponseEvent;
reversetoggle: ReverseToggleEvent;
select: SelectEvent;
}[T],
) => void,
): SubscriptionAdds a listener to a specified event type.
Type Parameters
- T extends
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle"
Parameters
- type: T
The event type to add a listen for.
- listener: (
ev: {
featureslisted: FeaturesListedEvent;
featuresmarked: FeaturesMarkedEvent;
optionsvisibilitychange: OptionsVisibilityChangeEvent;
pick: PickEvent;
querychange: QueryChangeEvent;
response: ResponseEvent;
reversetoggle: ReverseToggleEvent;
select: SelectEvent;
}[T],
) => voidThe function to be called when the event is fired. The listener function is called with the data object passed to
fire, extended withtargetandtypeproperties.
Returns Subscription
- T extends
onAdd
Register a control on the map and give it a chance to register event listeners and resources. This method is called by Map#addControl internally.
Parameters
- map: Map
the Map this control will be added to
Returns HTMLElement
The control's container element. This should be created by the control and returned by onAdd without being attached to the DOM: the map will insert the control's element into the DOM as necessary.
- map: Map
onAddInt
Parameters
- map: Map$1
Returns HTMLElement
once
- once<
T extends
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle",
>(
type: T,
listener?: (
ev: {
featureslisted: FeaturesListedEvent;
featuresmarked: FeaturesMarkedEvent;
optionsvisibilitychange: OptionsVisibilityChangeEvent;
pick: PickEvent;
querychange: QueryChangeEvent;
response: ResponseEvent;
reversetoggle: ReverseToggleEvent;
select: SelectEvent;
}[T],
) => void,
): Promise<unknown>
| GeocodingControlAdds a listener that will be called only once to a specified event type.
The listener will be called first time the event fires after the listener is registered.
Type Parameters
- T extends
| "select"
| "pick"
| "response"
| "featureslisted"
| "featuresmarked"
| "optionsvisibilitychange"
| "querychange"
| "reversetoggle"
Parameters
- type: T
The event type to listen for.
Optionallistener: (
ev: {
featureslisted: FeaturesListedEvent;
featuresmarked: FeaturesMarkedEvent;
optionsvisibilitychange: OptionsVisibilityChangeEvent;
pick: PickEvent;
querychange: QueryChangeEvent;
response: ResponseEvent;
reversetoggle: ReverseToggleEvent;
select: SelectEvent;
}[T],
) => voidThe function to be called when the event is fired the first time.
Returns Promise<unknown> | GeocodingControl
thisor a promise if a listener is not provided - T extends
onRemove
Returns void
setOptions
Update the control options.
Parameters
- options: MapLibreBaseControlOptions
options to update
Returns void
- options: MapLibreBaseControlOptions
setQuery
Set the content of search input box.
Parameters
- value: string
text to set
- submit: boolean = true
perform the search
Returns void
- value: string
setReverseMode
Set reverse geocoding mode.
Parameters
- reverseActive: boolean
reverse geocoding active
Returns void
- reverseActive: boolean
Blur the search input box.