leaflet.geodesic
    Preparing search index...

    Class GeodesicLine

    Draw geodesic lines based on L.Polyline

    Hierarchy

    • Polyline
      • GeodesicLine
    Index

    Constructors

    Properties

    _map: Map
    defaultOptions: GeodesicOptions = ...

    these should be good for most use-cases

    feature?: Feature<LineString | MultiLineString, any>

    does the actual geometry calculations

    options: PolylineOptions
    points: LatLng[][] = []

    stores all positions that are used to create the geodesic line

    statistics: Statistics = ...

    use this if you need some detailled info about the current geometry

    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:
            | "add"
            | "error"
            | "remove"
            | "zoom"
            | "move"
            | "loading"
            | "drag"
            | "dragstart"
            | "load"
            | "unload"
            | "update"
            | "zoomlevelschange"
            | "viewreset"
            | "zoomstart"
            | "movestart"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "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"
            | "contextmenu"
            | "dblclick"
            | "mousedown"
            | "mousemove"
            | "mouseout"
            | "mouseover"
            | "mouseup"
            | "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: "keydown" | "keypress" | "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

    • Parameters

      • targetEl: HTMLElement

      Returns this

    • add a given point to the geodesic line object

      Parameters

      • latlng: LatLngExpression

        point to add. The point will always be added to the last linestring of a multiline

      • Optionallatlngs: LatLng[]

        define a linestring to add the new point to. Read from points-property before (e.g. line.addLatLng(Beijing, line.points[0]);)

      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:
            | "add"
            | "error"
            | "remove"
            | "zoom"
            | "move"
            | "loading"
            | "drag"
            | "dragstart"
            | "load"
            | "unload"
            | "update"
            | "zoomlevelschange"
            | "viewreset"
            | "zoomstart"
            | "movestart"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "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"
            | "contextmenu"
            | "dblclick"
            | "mousedown"
            | "mousemove"
            | "mouseout"
            | "mouseover"
            | "mouseup"
            | "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: "keydown" | "keypress" | "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 | LayerGroup<any>

      Returns this

    • Parameters

      • map: Map

      Returns this

    • Parameters

      • content: Content | Popup | ((layer: Layer) => Content)
      • Optionaloptions: PopupOptions

      Returns this

    • Parameters

      • content: Content | Tooltip | ((layer: Layer) => Content)
      • Optionaloptions: TooltipOptions

      Returns this

    • Returns this

    • Returns this

    • Alias for off()

      Removes all listeners to all events on the object.

      Returns this

    • Returns this

    • Parameters

      • p: Point

      Returns Point

    • Returns this

    • Calculates the distance between two geo-positions

      Parameters

      • start: LatLngExpression

        1st position

      • dest: LatLngExpression

        2nd position

      Returns number

      the distance in meters

    • 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

    • Creates geodesic lines from a given GeoJSON-Object.

      Parameters

      • input: GeoJSON

        GeoJSON-Object

      Returns this

    • Returns null | string

    • Returns LatLngBounds

    • Returns LatLng

    • Returns undefined | Element

    • Returns { [name: string]: LeafletEventHandlerFn }

    • Returns LatLng[] | LatLng[][] | LatLng[][][]

    • Parameters

      • Optionalname: string

      Returns undefined | HTMLElement

    • Returns undefined | Popup

    • Returns undefined | Tooltip

    • Alias for listens(...)

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

      Parameters

      • type: string

      Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

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

      Parameters

      • type:
            | "add"
            | "error"
            | "remove"
            | "resize"
            | "zoom"
            | "move"
            | "loading"
            | "click"
            | "contextmenu"
            | "dblclick"
            | "drag"
            | "dragend"
            | "dragstart"
            | "keydown"
            | "keypress"
            | "keyup"
            | "load"
            | "mousedown"
            | "mousemove"
            | "mouseout"
            | "mouseover"
            | "mouseup"
            | "unload"
            | "update"
            | "baselayerchange"
            | "overlayadd"
            | "overlayremove"
            | "layeradd"
            | "layerremove"
            | "zoomlevelschange"
            | "viewreset"
            | "zoomstart"
            | "movestart"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "down"
            | "predrag"
            | "popupopen"
            | "tooltipopen"
            | "tooltipclose"
            | "locationerror"
            | "locationfound"
            | "preclick"
            | "zoomanim"
            | "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:
            | "add"
            | "error"
            | "remove"
            | "zoom"
            | "move"
            | "loading"
            | "drag"
            | "dragstart"
            | "load"
            | "unload"
            | "update"
            | "zoomlevelschange"
            | "viewreset"
            | "zoomstart"
            | "movestart"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "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"
            | "contextmenu"
            | "dblclick"
            | "mousedown"
            | "mousemove"
            | "mouseout"
            | "mouseover"
            | "mouseup"
            | "preclick"
      • fn: LeafletMouseEventHandlerFn
      • Optionalcontext: any
      • Optionalpropagate: boolean

      Returns boolean

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

      Parameters

      • type: "keydown" | "keypress" | "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:
            | "add"
            | "error"
            | "remove"
            | "zoom"
            | "move"
            | "loading"
            | "drag"
            | "dragstart"
            | "load"
            | "unload"
            | "update"
            | "zoomlevelschange"
            | "viewreset"
            | "zoomstart"
            | "movestart"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "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"
            | "contextmenu"
            | "dblclick"
            | "mousedown"
            | "mousemove"
            | "mouseout"
            | "mouseover"
            | "mouseup"
            | "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: "keydown" | "keypress" | "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:
            | "add"
            | "error"
            | "remove"
            | "zoom"
            | "move"
            | "loading"
            | "drag"
            | "dragstart"
            | "load"
            | "unload"
            | "update"
            | "zoomlevelschange"
            | "viewreset"
            | "zoomstart"
            | "movestart"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "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"
            | "contextmenu"
            | "dblclick"
            | "mousedown"
            | "mousemove"
            | "mouseout"
            | "mouseover"
            | "mouseup"
            | "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: "keydown" | "keypress" | "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

      • map: Map

      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:
            | "add"
            | "error"
            | "remove"
            | "zoom"
            | "move"
            | "loading"
            | "drag"
            | "dragstart"
            | "load"
            | "unload"
            | "update"
            | "zoomlevelschange"
            | "viewreset"
            | "zoomstart"
            | "movestart"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "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"
            | "contextmenu"
            | "dblclick"
            | "mousedown"
            | "mousemove"
            | "mouseout"
            | "mouseover"
            | "mouseup"
            | "preclick"
      • fn: LeafletMouseEventHandlerFn
      • Optionalcontext: any

      Returns this

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

      Parameters

      • type: "keydown" | "keypress" | "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 this

    • Parameters

      • Optionallatlng: LatLngExpression

      Returns this

    • Parameters

      • Optionallatlng: LatLngExpression

      Returns this

    • Returns this

    • 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:
            | "add"
            | "error"
            | "remove"
            | "zoom"
            | "move"
            | "loading"
            | "drag"
            | "dragstart"
            | "load"
            | "unload"
            | "update"
            | "zoomlevelschange"
            | "viewreset"
            | "zoomstart"
            | "movestart"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "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"
            | "contextmenu"
            | "dblclick"
            | "mousedown"
            | "mousemove"
            | "mouseout"
            | "mouseover"
            | "mouseup"
            | "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: "keydown" | "keypress" | "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

      • map: Map

      Returns this

    • Parameters

      • targetEl: HTMLElement

      Returns this

    • overwrites the original function with additional functionality to create a geodesic line

      Parameters

      • latlngs: LatLngExpression[] | LatLngExpression[][]

        an array (or 2d-array) of positions

      Returns this

    • Parameters

      • content: Content | Popup

      Returns this

    • Parameters

      • style: PathOptions

      Returns this

    • Parameters

      • content: Content | Tooltip

      Returns this

    • Parameters

      • Optionalprecision: number | false

      Returns Feature<LineString | MultiLineString, any>

    • Returns this

    • Returns this

    • Returns this

    • Returns this

    • Parameters

      • initHookFn: () => void

      Returns any

    • Parameters

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

      Returns any

    • Returns void

    • Parameters

      • props: any

      Returns new (...args: any[]) => any & typeof Class

    • Parameters

      • props: any

      Returns any

    • Parameters

      • props: any

      Returns any