Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • LayerGroup
    • RoomLabel

Implements

Index

Constructors

constructor

Properties

Protected _map

_map: Map

Private Readonly closedLabels

closedLabels: Label[]

Private Readonly emergencyLabels

emergencyLabels: Label[]

Optional feature

feature: GeometryCollection | FeatureCollection<Geometry, any> | Feature<MultiPoint, any>

Private Readonly infrastructureLabels

infrastructureLabels: Label[]

Private labelLayer

labelLayer: undefined | LabelLayer

Private Readonly normalLabels

normalLabels: Label[]

Private Readonly options

Private removeWatcher

removeWatcher: Option<(newValue: unknown) => void>

Methods

addEventListener

  • addEventListener(type: string, fn: LeafletEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "baselayerchange" | "overlayadd" | "overlayremove", fn: LayersControlEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "layeradd" | "layerremove", fn: LayerEventHandlerFn, context?: any): RoomLabel
  • 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): RoomLabel
  • addEventListener(type: "resize", fn: ResizeEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "popupopen" | "popupclose", fn: PopupEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "tooltipopen" | "tooltipclose", fn: TooltipEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "locationerror", fn: ErrorEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "locationfound", fn: LocationEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn: LeafletMouseEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "keypress" | "keydown" | "keyup", fn: LeafletKeyboardEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "zoomanim", fn: ZoomAnimEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "dragend", fn: DragEndEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "tileunload" | "tileloadstart" | "tileload", fn: TileEventHandlerFn, context?: any): RoomLabel
  • addEventListener(type: "tileerror", fn: TileErrorEventHandlerFn, context?: any): RoomLabel
  • addEventListener(eventMap: LeafletEventHandlerFnMap): RoomLabel
  • 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 RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

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

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Alias for on(...)

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns RoomLabel

addEventParent

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

    Parameters

    • obj: Evented

    Returns RoomLabel

addLayer

  • Adds the given layer to the group.

    Parameters

    • layer: Layer

    Returns RoomLabel

addOneTimeEventListener

  • addOneTimeEventListener(type: string, fn: LeafletEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "baselayerchange" | "overlayadd" | "overlayremove", fn: LayersControlEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "layeradd" | "layerremove", fn: LayerEventHandlerFn, context?: any): RoomLabel
  • 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): RoomLabel
  • addOneTimeEventListener(type: "resize", fn: ResizeEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "popupopen" | "popupclose", fn: PopupEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "tooltipopen" | "tooltipclose", fn: TooltipEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "locationerror", fn: ErrorEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "locationfound", fn: LocationEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn: LeafletMouseEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "keypress" | "keydown" | "keyup", fn: LeafletKeyboardEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "zoomanim", fn: ZoomAnimEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "dragend", fn: DragEndEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "tileunload" | "tileloadstart" | "tileload", fn: TileEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(type: "tileerror", fn: TileErrorEventHandlerFn, context?: any): RoomLabel
  • addOneTimeEventListener(eventMap: LeafletEventHandlerFnMap): RoomLabel
  • 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 RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

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

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Alias for once(...)

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns RoomLabel

addTo

  • addTo(map: Map | LayerGroup<any>): RoomLabel
  • Parameters

    • map: Map | LayerGroup<any>

    Returns RoomLabel

Optional beforeAdd

bindPopup

  • bindPopup(content: Popup | ((layer: Layer) => Content) | Content, options?: PopupOptions): RoomLabel
  • Parameters

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

    Returns RoomLabel

bindTooltip

  • bindTooltip(content: Content | ((layer: Layer) => Content) | Tooltip, options?: TooltipOptions): RoomLabel
  • Parameters

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

    Returns RoomLabel

clearAllEventListeners

  • Alias for off()

    Removes all listeners to all events on the object.

    Returns RoomLabel

clearLayers

  • Removes all the layers from the group.

    Returns RoomLabel

closePopup

closeTooltip

Private createLabelLayer

  • createLabelLayer(): void
  • Returns void

eachLayer

  • eachLayer(fn: (layer: Layer) => void, context?: any): RoomLabel
  • Iterates over the layers of the group, optionally specifying context of the iterator function.

    Parameters

    • fn: (layer: Layer) => void
        • (layer: Layer): void
        • Parameters

          • layer: Layer

          Returns void

    • Optional context: any

    Returns RoomLabel

fire

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

fireEvent

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

Optional getAttribution

  • getAttribution(): null | string
  • Returns null | string

Optional getEvents

  • getEvents(): {}
  • Returns {}

    • [name: string]: LeafletEventHandlerFn

getFloorNumber

  • getFloorNumber(): string

getLayer

  • getLayer(id: number): undefined | Layer
  • Returns the layer with the given internal ID.

    Parameters

    • id: number

    Returns undefined | Layer

getLayerId

  • getLayerId(layer: Layer): number
  • Returns the internal ID for a layer

    Parameters

    • layer: Layer

    Returns number

getLayers

  • getLayers(): Layer[]
  • Returns an array of all the layers added to the group.

    Returns Layer[]

getPane

  • getPane(name?: string): undefined | HTMLElement
  • Parameters

    • Optional name: string

    Returns undefined | HTMLElement

getPopup

  • getPopup(): undefined | Popup
  • Returns undefined | Popup

Private getRoomLabel

  • Parameters

    Returns Label

getTooltip

  • getTooltip(): undefined | Tooltip
  • Returns undefined | Tooltip

Private getVertexLabel

  • Parameters

    Returns Option<Label>

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

hasLayer

  • hasLayer(layer: Layer): boolean
  • Returns true if the given layer is currently added to the group.

    Parameters

    • layer: Layer

    Returns boolean

invoke

  • invoke(methodName: string, ...params: any[]): RoomLabel
  • Calls methodName on every layer contained in this group, passing any additional parameters. Has no effect if the layers contained do not implement methodName.

    Parameters

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

    Returns RoomLabel

isPopupOpen

  • isPopupOpen(): boolean
  • Returns boolean

isTooltipOpen

  • isTooltipOpen(): boolean
  • 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

off

  • off(type: string, fn?: LeafletEventHandlerFn, context?: any): RoomLabel
  • off(type: "baselayerchange" | "overlayadd" | "overlayremove", fn?: LayersControlEventHandlerFn, context?: any): RoomLabel
  • off(type: "layeradd" | "layerremove", fn?: LayerEventHandlerFn, context?: any): RoomLabel
  • 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): RoomLabel
  • off(type: "resize", fn?: ResizeEventHandlerFn, context?: any): RoomLabel
  • off(type: "popupopen" | "popupclose", fn?: PopupEventHandlerFn, context?: any): RoomLabel
  • off(type: "tooltipopen" | "tooltipclose", fn?: TooltipEventHandlerFn, context?: any): RoomLabel
  • off(type: "locationerror", fn?: ErrorEventHandlerFn, context?: any): RoomLabel
  • off(type: "locationfound", fn?: LocationEventHandlerFn, context?: any): RoomLabel
  • off(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn?: LeafletMouseEventHandlerFn, context?: any): RoomLabel
  • off(type: "keypress" | "keydown" | "keyup", fn?: LeafletKeyboardEventHandlerFn, context?: any): RoomLabel
  • off(type: "zoomanim", fn?: ZoomAnimEventHandlerFn, context?: any): RoomLabel
  • off(type: "dragend", fn?: DragEndEventHandlerFn, context?: any): RoomLabel
  • off(type: "tileunload" | "tileloadstart" | "tileload", fn?: TileEventHandlerFn, context?: any): RoomLabel
  • off(type: "tileerror", fn?: TileErrorEventHandlerFn, context?: any): RoomLabel
  • off(eventMap: LeafletEventHandlerFnMap): RoomLabel
  • off(): RoomLabel
  • 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 RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

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

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Removes a set of type/listener pairs.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns RoomLabel

  • Removes all listeners to all events on the object.

    Returns RoomLabel

on

  • on(type: string, fn: LeafletEventHandlerFn, context?: any): RoomLabel
  • on(type: "baselayerchange" | "overlayadd" | "overlayremove", fn: LayersControlEventHandlerFn, context?: any): RoomLabel
  • on(type: "layeradd" | "layerremove", fn: LayerEventHandlerFn, context?: any): RoomLabel
  • 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): RoomLabel
  • on(type: "resize", fn: ResizeEventHandlerFn, context?: any): RoomLabel
  • on(type: "popupopen" | "popupclose", fn: PopupEventHandlerFn, context?: any): RoomLabel
  • on(type: "tooltipopen" | "tooltipclose", fn: TooltipEventHandlerFn, context?: any): RoomLabel
  • on(type: "locationerror", fn: ErrorEventHandlerFn, context?: any): RoomLabel
  • on(type: "locationfound", fn: LocationEventHandlerFn, context?: any): RoomLabel
  • on(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn: LeafletMouseEventHandlerFn, context?: any): RoomLabel
  • on(type: "keypress" | "keydown" | "keyup", fn: LeafletKeyboardEventHandlerFn, context?: any): RoomLabel
  • on(type: "zoomanim", fn: ZoomAnimEventHandlerFn, context?: any): RoomLabel
  • on(type: "dragend", fn: DragEndEventHandlerFn, context?: any): RoomLabel
  • on(type: "tileunload" | "tileloadstart" | "tileload", fn: TileEventHandlerFn, context?: any): RoomLabel
  • on(type: "tileerror", fn: TileErrorEventHandlerFn, context?: any): RoomLabel
  • on(eventMap: LeafletEventHandlerFnMap): RoomLabel
  • 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 RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

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

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns RoomLabel

onAdd

onRemove

once

  • once(type: string, fn: LeafletEventHandlerFn, context?: any): RoomLabel
  • once(type: "baselayerchange" | "overlayadd" | "overlayremove", fn: LayersControlEventHandlerFn, context?: any): RoomLabel
  • once(type: "layeradd" | "layerremove", fn: LayerEventHandlerFn, context?: any): RoomLabel
  • 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): RoomLabel
  • once(type: "resize", fn: ResizeEventHandlerFn, context?: any): RoomLabel
  • once(type: "popupopen" | "popupclose", fn: PopupEventHandlerFn, context?: any): RoomLabel
  • once(type: "tooltipopen" | "tooltipclose", fn: TooltipEventHandlerFn, context?: any): RoomLabel
  • once(type: "locationerror", fn: ErrorEventHandlerFn, context?: any): RoomLabel
  • once(type: "locationfound", fn: LocationEventHandlerFn, context?: any): RoomLabel
  • once(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn: LeafletMouseEventHandlerFn, context?: any): RoomLabel
  • once(type: "keypress" | "keydown" | "keyup", fn: LeafletKeyboardEventHandlerFn, context?: any): RoomLabel
  • once(type: "zoomanim", fn: ZoomAnimEventHandlerFn, context?: any): RoomLabel
  • once(type: "dragend", fn: DragEndEventHandlerFn, context?: any): RoomLabel
  • once(type: "tileunload" | "tileloadstart" | "tileload", fn: TileEventHandlerFn, context?: any): RoomLabel
  • once(type: "tileerror", fn: TileEventHandlerFn, context?: any): RoomLabel
  • once(eventMap: LeafletEventHandlerFnMap): RoomLabel
  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

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

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns RoomLabel

openPopup

  • openPopup(latlng?: LatLngExpression): RoomLabel
  • Parameters

    • Optional latlng: LatLngExpression

    Returns RoomLabel

openTooltip

  • openTooltip(latlng?: LatLngExpression): RoomLabel
  • Parameters

    • Optional latlng: LatLngExpression

    Returns RoomLabel

remove

removeEventListener

  • removeEventListener(type: string, fn?: LeafletEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "baselayerchange" | "overlayadd" | "overlayremove", fn?: LayersControlEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "layeradd" | "layerremove", fn?: LayerEventHandlerFn, context?: any): RoomLabel
  • 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): RoomLabel
  • removeEventListener(type: "resize", fn?: ResizeEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "popupopen" | "popupclose", fn?: PopupEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "tooltipopen" | "tooltipclose", fn?: TooltipEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "locationerror", fn?: ErrorEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "locationfound", fn?: LocationEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "click" | "dblclick" | "mousedown" | "mouseup" | "mouseover" | "mouseout" | "mousemove" | "contextmenu" | "preclick", fn?: LeafletMouseEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "keypress" | "keydown" | "keyup", fn?: LeafletKeyboardEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "zoomanim", fn?: ZoomAnimEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "dragend", fn?: DragEndEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "tileunload" | "tileloadstart" | "tileload", fn?: TileEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(type: "tileerror", fn?: TileErrorEventHandlerFn, context?: any): RoomLabel
  • removeEventListener(eventMap: LeafletEventHandlerFnMap): RoomLabel
  • 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 RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

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

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Parameters

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

    Returns RoomLabel

  • Alias for off(...)

    Removes a set of type/listener pairs.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns RoomLabel

removeEventParent

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

    Parameters

    • obj: Evented

    Returns RoomLabel

removeFrom

removeLayer

  • removeLayer(layer: number | Layer): RoomLabel
  • Removes the layer with the given internal ID or the given layer from the group.

    Parameters

    • layer: number | Layer

    Returns RoomLabel

setPopupContent

  • setPopupContent(content: Popup | Content): RoomLabel

setTooltipContent

  • setTooltipContent(content: Content | Tooltip): RoomLabel

setZIndex

  • Calls setZIndex on every layer contained in this group, passing the z-index.

    Parameters

    • zIndex: number

    Returns RoomLabel

toGeoJSON

  • toGeoJSON(precision?: number): GeometryCollection | FeatureCollection<Geometry, any> | Feature<MultiPoint, any>
  • Returns a GeoJSON representation of the layer group (as a GeoJSON GeometryCollection, GeoJSONFeatureCollection or Multipoint).

    Parameters

    • Optional precision: number

    Returns GeometryCollection | FeatureCollection<Geometry, any> | Feature<MultiPoint, any>

togglePopup

toggleTooltip

unbindPopup

unbindTooltip

Static addInitHook

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

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

    Returns any

  • Parameters

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

    Returns any

Static extend

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

    • props: any

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

Static Private getIcon

  • getIcon(pairs: [string, string][], tags: string[]): Option<string>
  • Parameters

    • pairs: [string, string][]
    • tags: string[]

    Returns Option<string>

Static include

  • include(props: any): any
  • Parameters

    • props: any

    Returns any

Static mergeOptions

  • mergeOptions(props: any): any
  • Parameters

    • props: any

    Returns any

Generated using TypeDoc