Class TileLayerOffline

options

addEventListener

• addEventListener(type, fn, context?): 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: "baselayerchange" | "overlayadd" | "overlayremove"
  • fn: LayersControlEventHandlerFn
  • Optionalcontext: any

  Returns this
• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• 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

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addEventListener(eventMap): 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): this

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

  Parameters

  • obj: Evented

  Returns this

addInteractiveTarget

• addInteractiveTarget(targetEl): this

• Parameters

  • targetEl: HTMLElement

  Returns this

addOneTimeEventListener

• addOneTimeEventListener(type, fn, context?): 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
• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• 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

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(type, fn, context?): this

• Parameters

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

  Returns this

• addOneTimeEventListener(eventMap): this

• Alias for once(...)

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

  Parameters

  • eventMap: LeafletEventHandlerFnMap

  Returns this

addTo

• addTo(map): this

• Parameters

  • map: Map | LayerGroup<any>

  Returns this

OptionalbeforeAdd

• beforeAdd(map): this

• Parameters

  • map: Map

  Returns this

bindPopup

• bindPopup(content, options?): this

• Parameters

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

  Returns this

bindTooltip

• bindTooltip(content, options?): this

• Parameters

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

  Returns this

bringToBack

• bringToBack(): this

• Returns this

bringToFront

• bringToFront(): this

• Returns this

clearAllEventListeners

• clearAllEventListeners(): this

• Alias for off()

  Removes all listeners to all events on the object.

  Returns this

closePopup

• closePopup(): this

• Returns this

closeTooltip

• closeTooltip(): this

• Returns this

fire

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

fireEvent

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

OptionalgetAttribution

• getAttribution(): null | string

• Returns null | string

getContainer

• getContainer(): null | HTMLElement

• Returns null | HTMLElement

OptionalgetEvents

• getEvents(): {
      [name: string]: LeafletEventHandlerFn;
  }

• Returns {
      [name: string]: LeafletEventHandlerFn;
  }

  • [name: string]: LeafletEventHandlerFn

getPane

• getPane(name?): undefined | HTMLElement

• Parameters

  • Optionalname: string

  Returns undefined | HTMLElement

getPopup

• getPopup(): undefined | Popup

• Returns undefined | Popup

getTileSize

• getTileSize(): Point

• Returns Point

getTileUrl

• getTileUrl(coords): string

• Parameters

  • coords: Coords

  Returns string

getTooltip

• getTooltip(): undefined | Tooltip

• Returns undefined | Tooltip

hasEventListeners

• hasEventListeners(type): boolean

• Alias for listens(...)

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

  Parameters

  • type: string

  Returns boolean

isLoading

• isLoading(): boolean

• Returns boolean

isPopupOpen

• isPopupOpen(): boolean

• Returns boolean

isTooltipOpen

• isTooltipOpen(): boolean

• Returns boolean

listens

• listens(type, propagate?): 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
• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• 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

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

• listens(type, fn, context?, propagate?): boolean

• Parameters

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

  Returns boolean

off

• off(type, fn?, context?): 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: "baselayerchange" | "overlayadd" | "overlayremove"
  • Optionalfn: LayersControlEventHandlerFn
  • Optionalcontext: any

  Returns this
• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• 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

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(type, fn?, context?): this

• Parameters

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

  Returns this

• off(eventMap): this

• Removes a set of type/listener pairs.

  Parameters

  • eventMap: LeafletEventHandlerFnMap

  Returns this
• off(): this

• Removes all listeners to all events on the object.

  Returns this

on

• on(type, fn, context?): 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
• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• 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

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(type, fn, context?): this

• Parameters

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

  Returns this

• on(eventMap): this

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

  Parameters

  • eventMap: LeafletEventHandlerFnMap

  Returns this

onAdd

• onAdd(map): this

• Parameters

  • map: Map

  Returns this

onRemove

• onRemove(map): this

• Parameters

  • map: Map

  Returns this

once

• once(type, fn, context?): 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
• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• 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

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(type, fn, context?): this

• Parameters

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

  Returns this

• once(eventMap): this

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

  Parameters

  • eventMap: LeafletEventHandlerFnMap

  Returns this

openPopup

• openPopup(latlng?): this

• Parameters

  • Optionallatlng: LatLngExpression

  Returns this

openTooltip

• openTooltip(latlng?): this

• Parameters

  • Optionallatlng: LatLngExpression

  Returns this

redraw

• redraw(): this

• Returns this

remove

• remove(): this

• Returns this

removeEventListener

• removeEventListener(type, fn?, context?): 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
• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• 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

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(type, fn?, context?): this

• Parameters

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

  Returns this

• removeEventListener(eventMap): this

• Alias for off(...)

  Removes a set of type/listener pairs.

  Parameters

  • eventMap: LeafletEventHandlerFnMap

  Returns this

removeEventParent

• removeEventParent(obj): this

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

  Parameters

  • obj: Evented

  Returns this

removeFrom

• removeFrom(map): this

• Parameters

  • map: Map

  Returns this

removeInteractiveTarget

• removeInteractiveTarget(targetEl): this

• Parameters

  • targetEl: HTMLElement

  Returns this

setOpacity

• setOpacity(opacity): this

• Parameters

  • opacity: number

  Returns this

setPopupContent

• setPopupContent(content): this

• Parameters

  • content: Content | Popup

  Returns this

setTooltipContent

• setTooltipContent(content): this

• Parameters

  • content: Content | Tooltip

  Returns this

setUrl

• setUrl(url, noRedraw?): this

• Parameters

  • url: string
  • OptionalnoRedraw: boolean

  Returns this

setZIndex

• setZIndex(zIndex): this

• Parameters

  • zIndex: number

  Returns this

togglePopup

• togglePopup(): this

• Returns this

toggleTooltip

• toggleTooltip(): this

• Returns this

unbindPopup

• unbindPopup(): this

• Returns this

unbindTooltip

• unbindTooltip(): this

• Returns this

StaticaddInitHook

• addInitHook(initHookFn): any

• Parameters

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

      • Returns void

  Returns any

• addInitHook(methodName, ...args): any

• Parameters

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

  Returns any

StaticcallInitHooks

• callInitHooks(): void

• Returns void

Staticextend

• extend(props): (new (...args: any[]) => any) & typeof Class

• Parameters

  • props: any

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

Staticinclude

• include(props): any

• Parameters

  • props: any

  Returns any

StaticmergeOptions

• mergeOptions(props): any

• Parameters

  • props: any

  Returns any