This is the geocoder control. It works like any other Leaflet control, and is added to the map.

Hierarchy

  • EventedControl
    • Geocoder

Constructors

  • Instantiates a geocoder control (to be invoked using new)

    Parameters

    • Optionaloptions: Partial<GeocoderControlOptions>

      the options

    Returns Geocoder

Properties

options: GeocoderControlOptions = ...

Methods

  • 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').

    Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type:
          | "zoom"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type:
          | "click"
          | "dblclick"
          | "mousedown"
          | "mouseup"
          | "mouseover"
          | "mouseout"
          | "mousemove"
          | "contextmenu"
          | "preclick"
    • fn: LeafletMouseEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "tileunload" | "tileloadstart" | "tileload" | "tileabort"
    • fn: TileEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "tileerror"
    • fn: TileErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for on(...)

    Adds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • Adds an event parent - an Evented that will receive propagated events

    Parameters

    • obj: Evented

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type:
          | "zoom"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type:
          | "click"
          | "dblclick"
          | "mousedown"
          | "mouseup"
          | "mouseover"
          | "mouseout"
          | "mousemove"
          | "contextmenu"
          | "preclick"
    • fn: LeafletMouseEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "tileunload" | "tileloadstart" | "tileload" | "tileabort"
    • fn: TileEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "tileerror"
    • fn: TileErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • Parameters

    • map: Map

    Returns this

  • Alias for off()

    Removes all listeners to all events on the object.

    Returns this

  • 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.

    Parameters

    • type: string
    • Optionaldata: any
    • Optionalpropagate: boolean

    Returns this

  • Alias 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.

    Parameters

    • type: string
    • Optionaldata: any
    • Optionalpropagate: boolean

    Returns this

  • Returns undefined | HTMLElement

  • Returns ControlPosition

  • Alias for listens(...)

    Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: string

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type:
          | "zoom"
          | "baselayerchange"
          | "overlayadd"
          | "overlayremove"
          | "layeradd"
          | "layerremove"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
          | "resize"
          | "popupopen"
          | "tooltipopen"
          | "tooltipclose"
          | "locationerror"
          | "locationfound"
          | "click"
          | "dblclick"
          | "mousedown"
          | "mouseup"
          | "mouseover"
          | "mouseout"
          | "mousemove"
          | "contextmenu"
          | "preclick"
          | "keypress"
          | "keydown"
          | "keyup"
          | "zoomanim"
          | "dragend"
          | "tileunload"
          | "tileloadstart"
          | "tileload"
          | "tileabort"
          | "tileerror"
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type:
          | "zoom"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type:
          | "click"
          | "dblclick"
          | "mousedown"
          | "mouseup"
          | "mouseover"
          | "mouseout"
          | "mousemove"
          | "contextmenu"
          | "preclick"
    • fn: LeafletMouseEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "tileunload" | "tileloadstart" | "tileload" | "tileabort"
    • fn: TileEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "tileerror"
    • fn: TileEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • 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.

    Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • Optionalfn: LayersControlEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "layeradd" | "layerremove"
    • Optionalfn: LayerEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type:
          | "zoom"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
    • Optionalfn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "resize"
    • Optionalfn: ResizeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "popupopen" | "popupclose"
    • Optionalfn: PopupEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "tooltipopen" | "tooltipclose"
    • Optionalfn: TooltipEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "locationerror"
    • Optionalfn: ErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "locationfound"
    • Optionalfn: LocationEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type:
          | "click"
          | "dblclick"
          | "mousedown"
          | "mouseup"
          | "mouseover"
          | "mouseout"
          | "mousemove"
          | "contextmenu"
          | "preclick"
    • Optionalfn: LeafletMouseEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "keypress" | "keydown" | "keyup"
    • Optionalfn: LeafletKeyboardEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "zoomanim"
    • Optionalfn: ZoomAnimEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "dragend"
    • Optionalfn: DragEndEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "tileunload" | "tileloadstart" | "tileload" | "tileabort"
    • Optionalfn: TileEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: "tileerror"
    • Optionalfn: TileErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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.

    Parameters

    • type: string
    • Optionalfn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Removes a set of type/listener pairs.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • Removes all listeners to all events on the object.

    Returns this

  • 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').

    Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type:
          | "zoom"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type:
          | "click"
          | "dblclick"
          | "mousedown"
          | "mouseup"
          | "mouseover"
          | "mouseout"
          | "mousemove"
          | "contextmenu"
          | "preclick"
    • fn: LeafletMouseEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "tileunload" | "tileloadstart" | "tileload" | "tileabort"
    • fn: TileEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: "tileerror"
    • fn: TileErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • 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').

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Adds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • Parameters

    • type: "markgeocode"
    • fn: MarkGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Parameters

    • type: "startgeocode"
    • fn: StartGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Parameters

    • type: "startsuggest"
    • fn: StartGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Parameters

    • type: "finishsuggest"
    • fn: FinishGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Parameters

    • type: "finishgeocode"
    • fn: FinishGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type:
          | "zoom"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type:
          | "click"
          | "dblclick"
          | "mousedown"
          | "mouseup"
          | "mouseover"
          | "mouseout"
          | "mousemove"
          | "contextmenu"
          | "preclick"
    • fn: LeafletMouseEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "tileunload" | "tileloadstart" | "tileload" | "tileabort"
    • fn: TileEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "tileerror"
    • fn: TileEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • Parameters

    • map: Map

    Returns void

  • Returns this

  • Alias 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.

    Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • Optionalfn: LayersControlEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "layeradd" | "layerremove"
    • Optionalfn: LayerEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type:
          | "zoom"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
    • Optionalfn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "resize"
    • Optionalfn: ResizeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "popupopen" | "popupclose"
    • Optionalfn: PopupEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "tooltipopen" | "tooltipclose"
    • Optionalfn: TooltipEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "locationerror"
    • Optionalfn: ErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "locationfound"
    • Optionalfn: LocationEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type:
          | "click"
          | "dblclick"
          | "mousedown"
          | "mouseup"
          | "mouseover"
          | "mouseout"
          | "mousemove"
          | "contextmenu"
          | "preclick"
    • Optionalfn: LeafletMouseEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "keypress" | "keydown" | "keyup"
    • Optionalfn: LeafletKeyboardEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "zoomanim"
    • Optionalfn: ZoomAnimEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "dragend"
    • Optionalfn: DragEndEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "tileunload" | "tileloadstart" | "tileload" | "tileabort"
    • Optionalfn: TileEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: "tileerror"
    • Optionalfn: TileErrorEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias 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.

    Parameters

    • type: string
    • Optionalfn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • Alias for off(...)

    Removes a set of type/listener pairs.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • Removes an event parent, so it will stop receiving propagated events

    Parameters

    • obj: Evented

    Returns this

  • Parameters

    • position: ControlPosition

    Returns this

  • Sets the query string on the text input

    Parameters

    • string: string

      the query string

    Returns this