Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeocoderControl

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

Hierarchy

  • EventedControl
    • GeocoderControl

Index

Constructors

constructor

Methods

addEventListener

  • addEventListener(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • addEventListener(type: "baselayerchange" | "overlayadd" | "overlayremove", fn: LayersControlEventHandlerFn, context?: any): this
  • addEventListener(type: "layeradd" | "layerremove", fn: LayerEventHandlerFn, context?: any): this
  • addEventListener(type: "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "error" | "update" | "down" | "predrag", fn: LeafletEventHandlerFn, context?: any): this
  • addEventListener(type: "resize", fn: ResizeEventHandlerFn, context?: any): this
  • addEventListener(type: "popupopen" | "popupclose", fn: PopupEventHandlerFn, context?: any): this
  • addEventListener(type: "tooltipopen" | "tooltipclose", fn: TooltipEventHandlerFn, context?: any): this
  • addEventListener(type: "locationerror", fn: ErrorEventHandlerFn, context?: any): this
  • addEventListener(type: "locationfound", fn: LocationEventHandlerFn, context?: any): this
  • addEventListener(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn: LeafletMouseEventHandlerFn, context?: any): this
  • addEventListener(type: "keypress" | "keydown" | "keyup", fn: LeafletKeyboardEventHandlerFn, context?: any): this
  • addEventListener(type: "zoomanim", fn: ZoomAnimEventHandlerFn, context?: any): this
  • addEventListener(type: "dragend", fn: DragEndEventHandlerFn, context?: any): this
  • addEventListener(type: "tileunload" | "tileloadstart" | "tileload", fn: TileEventHandlerFn, context?: any): this
  • addEventListener(type: "tileerror", fn: TileErrorEventHandlerFn, context?: any): this
  • addEventListener(eventMap: LeafletEventHandlerFnMap): 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
    • Optional context: any

    Returns this

  • Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileunload" | "tileloadstart" | "tileload"
    • fn: TileEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileerror"
    • fn: TileErrorEventHandlerFn
    • Optional context: any

    Returns this

  • Alias for on(...)

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

addEventParent

  • addEventParent(obj: Evented): this
  • Adds an event parent - an Evented that will receive propagated events

    Parameters

    Returns this

addOneTimeEventListener

  • addOneTimeEventListener(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "baselayerchange" | "overlayadd" | "overlayremove", fn: LayersControlEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "layeradd" | "layerremove", fn: LayerEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "error" | "update" | "down" | "predrag", fn: LeafletEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "resize", fn: ResizeEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "popupopen" | "popupclose", fn: PopupEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "tooltipopen" | "tooltipclose", fn: TooltipEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "locationerror", fn: ErrorEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "locationfound", fn: LocationEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn: LeafletMouseEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "keypress" | "keydown" | "keyup", fn: LeafletKeyboardEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "zoomanim", fn: ZoomAnimEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "dragend", fn: DragEndEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "tileunload" | "tileloadstart" | "tileload", fn: TileEventHandlerFn, context?: any): this
  • addOneTimeEventListener(type: "tileerror", fn: TileErrorEventHandlerFn, context?: any): this
  • addOneTimeEventListener(eventMap: LeafletEventHandlerFnMap): this
  • Alias for once(...)

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

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileunload" | "tileloadstart" | "tileload"
    • fn: TileEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileerror"
    • fn: TileErrorEventHandlerFn
    • Optional context: 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

addThrobberClass

  • addThrobberClass(): void

addTo

  • addTo(map: Map): this
  • Parameters

    • map: Map

    Returns this

clearAllEventListeners

  • clearAllEventListeners(): this
  • Alias for off()

    Removes all listeners to all events on the object.

    Returns this

fire

  • fire(type: string, data?: any, propagate?: boolean): 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
    • Optional data: any
    • Optional propagate: boolean

    Returns this

fireEvent

  • fireEvent(type: string, data?: any, propagate?: boolean): 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
    • Optional data: any
    • Optional propagate: boolean

    Returns this

getContainer

  • getContainer(): HTMLElement | undefined
  • Returns HTMLElement | undefined

getPosition

  • getPosition(): ControlPosition
  • Returns ControlPosition

hasEventListeners

  • hasEventListeners(type: string): boolean
  • Alias for listens(...)

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

    Parameters

    • type: string

    Returns boolean

listens

  • listens(type: string): boolean
  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: string

    Returns boolean

markGeocode

off

  • off(type: string, fn?: LeafletEventHandlerFn, context?: any): this
  • off(type: "baselayerchange" | "overlayadd" | "overlayremove", fn?: LayersControlEventHandlerFn, context?: any): this
  • off(type: "layeradd" | "layerremove", fn?: LayerEventHandlerFn, context?: any): this
  • off(type: "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "error" | "update" | "down" | "predrag", fn?: LeafletEventHandlerFn, context?: any): this
  • off(type: "resize", fn?: ResizeEventHandlerFn, context?: any): this
  • off(type: "popupopen" | "popupclose", fn?: PopupEventHandlerFn, context?: any): this
  • off(type: "tooltipopen" | "tooltipclose", fn?: TooltipEventHandlerFn, context?: any): this
  • off(type: "locationerror", fn?: ErrorEventHandlerFn, context?: any): this
  • off(type: "locationfound", fn?: LocationEventHandlerFn, context?: any): this
  • off(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn?: LeafletMouseEventHandlerFn, context?: any): this
  • off(type: "keypress" | "keydown" | "keyup", fn?: LeafletKeyboardEventHandlerFn, context?: any): this
  • off(type: "zoomanim", fn?: ZoomAnimEventHandlerFn, context?: any): this
  • off(type: "dragend", fn?: DragEndEventHandlerFn, context?: any): this
  • off(type: "tileunload" | "tileloadstart" | "tileload", fn?: TileEventHandlerFn, context?: any): this
  • off(type: "tileerror", fn?: TileErrorEventHandlerFn, context?: any): this
  • off(eventMap: LeafletEventHandlerFnMap): this
  • off(): 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
    • Optional fn: LeafletEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • Optional fn: LayersControlEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "layeradd" | "layerremove"
    • Optional fn: LayerEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "resize"
    • Optional fn: ResizeEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "popupopen" | "popupclose"
    • Optional fn: PopupEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tooltipopen" | "tooltipclose"
    • Optional fn: TooltipEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationerror"
    • Optional fn: ErrorEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationfound"
    • Optional fn: LocationEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "keypress" | "keydown" | "keyup"
    • Optional fn: LeafletKeyboardEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "zoomanim"
    • Optional fn: ZoomAnimEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "dragend"
    • Optional fn: DragEndEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileunload" | "tileloadstart" | "tileload"
    • Optional fn: TileEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileerror"
    • Optional fn: TileErrorEventHandlerFn
    • Optional context: 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

on

  • on(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • on(type: "baselayerchange" | "overlayadd" | "overlayremove", fn: LayersControlEventHandlerFn, context?: any): this
  • on(type: "layeradd" | "layerremove", fn: LayerEventHandlerFn, context?: any): this
  • on(type: "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "error" | "update" | "down" | "predrag", fn: LeafletEventHandlerFn, context?: any): this
  • on(type: "resize", fn: ResizeEventHandlerFn, context?: any): this
  • on(type: "popupopen" | "popupclose", fn: PopupEventHandlerFn, context?: any): this
  • on(type: "tooltipopen" | "tooltipclose", fn: TooltipEventHandlerFn, context?: any): this
  • on(type: "locationerror", fn: ErrorEventHandlerFn, context?: any): this
  • on(type: "locationfound", fn: LocationEventHandlerFn, context?: any): this
  • on(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn: LeafletMouseEventHandlerFn, context?: any): this
  • on(type: "keypress" | "keydown" | "keyup", fn: LeafletKeyboardEventHandlerFn, context?: any): this
  • on(type: "zoomanim", fn: ZoomAnimEventHandlerFn, context?: any): this
  • on(type: "dragend", fn: DragEndEventHandlerFn, context?: any): this
  • on(type: "tileunload" | "tileloadstart" | "tileload", fn: TileEventHandlerFn, context?: any): this
  • on(type: "tileerror", fn: TileErrorEventHandlerFn, context?: any): this
  • on(eventMap: LeafletEventHandlerFnMap): 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
    • Optional context: any

    Returns this

  • Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileunload" | "tileloadstart" | "tileload"
    • fn: TileEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileerror"
    • fn: TileErrorEventHandlerFn
    • Optional context: any

    Returns this

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

onAdd

  • onAdd(map: Map): HTMLDivElement

Optional onRemove

  • onRemove(map: Map): void
  • Parameters

    • map: Map

    Returns void

once

  • once(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • once(type: "baselayerchange" | "overlayadd" | "overlayremove", fn: LayersControlEventHandlerFn, context?: any): this
  • once(type: "layeradd" | "layerremove", fn: LayerEventHandlerFn, context?: any): this
  • once(type: "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "error" | "update" | "down" | "predrag", fn: LeafletEventHandlerFn, context?: any): this
  • once(type: "resize", fn: ResizeEventHandlerFn, context?: any): this
  • once(type: "popupopen" | "popupclose", fn: PopupEventHandlerFn, context?: any): this
  • once(type: "tooltipopen" | "tooltipclose", fn: TooltipEventHandlerFn, context?: any): this
  • once(type: "locationerror", fn: ErrorEventHandlerFn, context?: any): this
  • once(type: "locationfound", fn: LocationEventHandlerFn, context?: any): this
  • once(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn: LeafletMouseEventHandlerFn, context?: any): this
  • once(type: "keypress" | "keydown" | "keyup", fn: LeafletKeyboardEventHandlerFn, context?: any): this
  • once(type: "zoomanim", fn: ZoomAnimEventHandlerFn, context?: any): this
  • once(type: "dragend", fn: DragEndEventHandlerFn, context?: any): this
  • once(type: "tileunload" | "tileloadstart" | "tileload", fn: TileEventHandlerFn, context?: any): this
  • once(type: "tileerror", fn: TileEventHandlerFn, context?: any): this
  • once(eventMap: LeafletEventHandlerFnMap): this
  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "resize"
    • fn: ResizeEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "popupopen" | "popupclose"
    • fn: PopupEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tooltipopen" | "tooltipclose"
    • fn: TooltipEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationerror"
    • fn: ErrorEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationfound"
    • fn: LocationEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "keypress" | "keydown" | "keyup"
    • fn: LeafletKeyboardEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "zoomanim"
    • fn: ZoomAnimEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "dragend"
    • fn: DragEndEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileunload" | "tileloadstart" | "tileload"
    • fn: TileEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileerror"
    • fn: TileEventHandlerFn
    • Optional context: any

    Returns this

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

remove

  • remove(): this
  • Returns this

removeEventListener

  • removeEventListener(type: string, fn?: LeafletEventHandlerFn, context?: any): this
  • removeEventListener(type: "baselayerchange" | "overlayadd" | "overlayremove", fn?: LayersControlEventHandlerFn, context?: any): this
  • removeEventListener(type: "layeradd" | "layerremove", fn?: LayerEventHandlerFn, context?: any): this
  • removeEventListener(type: "zoomlevelschange" | "unload" | "viewreset" | "load" | "zoomstart" | "movestart" | "zoom" | "move" | "zoomend" | "moveend" | "autopanstart" | "dragstart" | "drag" | "add" | "remove" | "loading" | "error" | "update" | "down" | "predrag", fn?: LeafletEventHandlerFn, context?: any): this
  • removeEventListener(type: "resize", fn?: ResizeEventHandlerFn, context?: any): this
  • removeEventListener(type: "popupopen" | "popupclose", fn?: PopupEventHandlerFn, context?: any): this
  • removeEventListener(type: "tooltipopen" | "tooltipclose", fn?: TooltipEventHandlerFn, context?: any): this
  • removeEventListener(type: "locationerror", fn?: ErrorEventHandlerFn, context?: any): this
  • removeEventListener(type: "locationfound", fn?: LocationEventHandlerFn, context?: any): this
  • removeEventListener(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn?: LeafletMouseEventHandlerFn, context?: any): this
  • removeEventListener(type: "keypress" | "keydown" | "keyup", fn?: LeafletKeyboardEventHandlerFn, context?: any): this
  • removeEventListener(type: "zoomanim", fn?: ZoomAnimEventHandlerFn, context?: any): this
  • removeEventListener(type: "dragend", fn?: DragEndEventHandlerFn, context?: any): this
  • removeEventListener(type: "tileunload" | "tileloadstart" | "tileload", fn?: TileEventHandlerFn, context?: any): this
  • removeEventListener(type: "tileerror", fn?: TileErrorEventHandlerFn, context?: any): this
  • removeEventListener(eventMap: LeafletEventHandlerFnMap): 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
    • Optional fn: LeafletEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • Optional fn: LayersControlEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "layeradd" | "layerremove"
    • Optional fn: LayerEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "resize"
    • Optional fn: ResizeEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "popupopen" | "popupclose"
    • Optional fn: PopupEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tooltipopen" | "tooltipclose"
    • Optional fn: TooltipEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationerror"
    • Optional fn: ErrorEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "locationfound"
    • Optional fn: LocationEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • type: "keypress" | "keydown" | "keyup"
    • Optional fn: LeafletKeyboardEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "zoomanim"
    • Optional fn: ZoomAnimEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "dragend"
    • Optional fn: DragEndEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileunload" | "tileloadstart" | "tileload"
    • Optional fn: TileEventHandlerFn
    • Optional context: any

    Returns this

  • Parameters

    • type: "tileerror"
    • Optional fn: TileErrorEventHandlerFn
    • Optional context: any

    Returns this

  • Alias for off(...)

    Removes a set of type/listener pairs.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

removeEventParent

  • removeEventParent(obj: Evented): this
  • Removes an event parent, so it will stop receiving propagated events

    Parameters

    Returns this

removeThrobberClass

  • removeThrobberClass(): void

setPosition

  • setPosition(position: ControlPosition): this
  • Parameters

    • position: ControlPosition

    Returns this

setQuery

  • setQuery(string: string): this
  • Sets the query string on the text input

    Parameters

    • string: string

      the query string

    Returns this

Static addInitHook

  • addInitHook(initHookFn: () => void): any & typeof Class
  • addInitHook(methodName: string, ...args: any[]): any & typeof Class
  • Parameters

    • initHookFn: () => void
        • (): void
        • Returns void

    Returns any & typeof Class

  • Parameters

    • methodName: string
    • Rest ...args: any[]

    Returns any & typeof Class

Static extend

  • extend<T>(props: T): { constructor: any } & typeof Control
  • Type parameters

    • T: object

    Parameters

    • props: T

    Returns { constructor: any } & typeof Control

Static include

  • include(props: any): any & typeof Class
  • Parameters

    • props: any

    Returns any & typeof Class

Static mergeOptions

  • mergeOptions(props: any): any & typeof Class
  • Parameters

    • props: any

    Returns any & typeof Class

Object literals

options

options: object

collapsed

collapsed: true = true

defaultMarkGeocode

defaultMarkGeocode: true = true

errorMessage

errorMessage: string = "Nothing found."

expand

expand: "touch" = "touch"

iconLabel

iconLabel: string = "Initiate a new search"

placeholder

placeholder: string = "Search..."

position

position: "topright" = "topright"

query

query: string = ""

queryMinLength

queryMinLength: number = 1

showResultIcons

showResultIcons: false = false

showUniqueResult

showUniqueResult: true = true

suggestMinLength

suggestMinLength: number = 3

suggestTimeout

suggestTimeout: number = 250

Generated using TypeDoc