Instantiates a geocoder control (to be invoked using new
)
Optional
options: Partial<GeocoderControlOptions>the options
Alias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAlias for on(...)
Adds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}
Adds an event parent - an Evented that will receive propagated events
Alias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyAlias for once(...)
Behaves as on(...), except the listener will only get fired once and then removed.
Alias for off()
Removes all listeners to all events on the object.
Fires an event of the specified type. You can optionally provide a data object — the first argument of the listener function will contain its properties. The event might can optionally be propagated to event parents.
Optional
data: anyOptional
propagate: booleanAlias for fire(...)
Fires an event of the specified type. You can optionally provide a data object — the first argument of the listener function will contain its properties. The event might can optionally be propagated to event parents.
Optional
data: anyOptional
propagate: booleanAlias for listens(...)
Returns true if a particular event type has any listeners attached to it.
Returns true if a particular event type has any listeners attached to it.
Optional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanReturns true if a particular event type has any listeners attached to it.
Optional
context: anyOptional
propagate: booleanRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LayersControlEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LayerEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LeafletEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: ResizeEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: PopupEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: TooltipEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: ErrorEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LocationEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LeafletMouseEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LeafletKeyboardEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: ZoomAnimEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: DragEndEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: TileEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: TileErrorEventHandlerFnOptional
context: anyRemoves a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LeafletEventHandlerFnOptional
context: anyRemoves a set of type/listener pairs.
Removes all listeners to all events on the object.
Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').
Optional
context: anyAdds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}
Optional
context: anyOptional
context: anyOptional
context: anyOptional
context: anyOptional
context: anyReturns the container DOM element for the control and add listeners on relevant map events.
the map instance
Behaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
context: anyBehaves as on(...), except the listener will only get fired once and then removed.
Optional
onAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LayersControlEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LayerEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LeafletEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: ResizeEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: PopupEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: TooltipEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: ErrorEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LocationEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LeafletMouseEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LeafletKeyboardEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: ZoomAnimEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: DragEndEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: TileEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: TileErrorEventHandlerFnOptional
context: anyAlias for off(...)
Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.
Optional
fn: LeafletEventHandlerFnOptional
context: anyAlias for off(...)
Removes a set of type/listener pairs.
Removes an event parent, so it will stop receiving propagated events
Sets the query string on the text input
the query string
This is the geocoder control. It works like any other Leaflet control, and is added to the map.