Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DivIconDirective

Angular2 directive for Leaflet div-icons.

You can use this directive in an Angular2 template after importing YagaModule.

How to use in a template:

<yaga-map>
    <yaga-marker>
        <yaga-div-icon
            [iconAnchor]="..."
            [iconSize]="..."
            [popupAnchor]="...">
            You can paste your HTML content for the icon here!
        </yaga-div-icon>
    </yaga-marker>
</yaga-map>

Notes:

  • All div-icon-directives have the css-class yaga-div-icon.
  • The contentHtml property is not the child-node in the leaflet div-icon, it is the clone of it and gets cloned again on every change.
link

http://leafletjs.com/reference-1.2.0.html#divicon Original Leaflet documentation

link

https://leaflet-ng2.yagajs.org/1.0.0/browser-test?grep=DivIcon%20Directive Unit-Test

link

https://leaflet-ng2.yagajs.org/1.0.0/coverage/lcov-report/lib/div-icon.directive.js.html Test coverage

link

https://leaflet-ng2.yagajs.org/1.0.0/typedoc/classes/divicondirective.html API documentation

example

https://leaflet-ng2.yagajs.org/1.0.0/examples/div-icon-directive/

Hierarchy

  • DivIcon
    • DivIconDirective

Index

Constructors

constructor

Properties

Protected _map

_map: Map

contentHtml

contentHtml: HTMLElement

The native element from angulars element-ref and blueprint for the icon content.

markerProvider

markerProvider: MarkerProvider

options

options: DivIconOptions

updateEvent

updateEvent: EventEmitter<LeafletEvent> = new EventEmitter()

This is an EventEmitter used to notify on any change in this object. It is mainly created to provide reactions of the marker directive on changes.

Accessors

iconAnchor

  • get iconAnchor(): Point
  • set iconAnchor(val: Point): void

iconSize

  • get iconSize(): Point
  • set iconSize(val: Point): void

popupAnchor

  • get popupAnchor(): Point
  • set popupAnchor(val: Point): void

Methods

addEventListener

  • addEventListener(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • addEventListener(eventMap: LeafletEventHandlerFnMap): this
  • Alias for on(...)

    Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

    Parameters

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

    Returns this

  • Alias for on(...)

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

addEventParent

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

    Parameters

    • obj: Evented

    Returns this

addOneTimeEventListener

  • addOneTimeEventListener(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • addOneTimeEventListener(eventMap: LeafletEventHandlerFnMap): this
  • Alias for once(...)

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

    Parameters

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

    Returns this

  • 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: Map | LayerGroup): this
  • Parameters

    • map: Map | LayerGroup

    Returns this

Optional beforeAdd

  • beforeAdd(map: Map): this
  • Parameters

    • map: Map

    Returns this

bindPopup

  • bindPopup(content: function | Content | Popup, options?: PopupOptions): this
  • Parameters

    • content: function | Content | Popup
    • Optional options: PopupOptions

    Returns this

bindTooltip

  • bindTooltip(content: function | Tooltip | Content, options?: TooltipOptions): this
  • Parameters

    • content: function | Tooltip | Content
    • Optional options: TooltipOptions

    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

createIcon

  • createIcon(oldDivIcon: HTMLElement): HTMLElement
  • This inherited function enhances the directive with an own css-class and clones the its html content into the leaflet div icon.

    Parameters

    • oldDivIcon: HTMLElement

    Returns HTMLElement

createShadow

  • createShadow(oldIcon?: HTMLElement): HTMLElement
  • Parameters

    • Optional oldIcon: HTMLElement

    Returns HTMLElement

fire

  • fire(type: string, data?: any, propagate?: undefined | false | true): this
  • Fires an event of the specified type. You can optionally provide a data object — the first argument of the listener function will contain its properties. The event might can optionally be propagated to event parents.

    Parameters

    • type: string
    • Optional data: any
    • Optional propagate: undefined | false | true

    Returns this

fireEvent

  • fireEvent(type: string, data?: any, propagate?: undefined | false | true): this
  • Alias for fire(...)

    Fires an event of the specified type. You can optionally provide a data object — the first argument of the listener function will contain its properties. The event might can optionally be propagated to event parents.

    Parameters

    • type: string
    • Optional data: any
    • Optional propagate: undefined | false | true

    Returns this

Optional getAttribution

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

Optional getEvents

  • getEvents(): object
  • Returns object

    • [name: string]: function
        • (event: LeafletEvent): void
        • Parameters

          • event: LeafletEvent

          Returns void

getPane

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

    • Optional name: undefined | string

    Returns HTMLElement | undefined

getPopup

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

getTooltip

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

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

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): this
  • off(eventMap: LeafletEventHandlerFnMap): this
  • off(): this
  • Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

    Parameters

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

    Returns this

  • Removes a set of type/listener pairs.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • Removes all listeners to all events on the object.

    Returns this

on

  • on(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • on(eventMap: LeafletEventHandlerFnMap): this
  • Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

    Parameters

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

    Returns this

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

onAdd

  • onAdd(map: Map): this
  • Parameters

    • map: Map

    Returns this

onRemove

  • onRemove(map: Map): this
  • Parameters

    • map: Map

    Returns this

once

  • once(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • once(eventMap: LeafletEventHandlerFnMap): this
  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

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

    Returns this

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

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

openPopup

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

    • Optional latlng: LatLngExpression

    Returns this

openTooltip

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

    • Optional latlng: LatLngExpression

    Returns this

remove

  • remove(): this
  • Returns this

removeEventListener

  • removeEventListener(type: string, fn: LeafletEventHandlerFn, context?: any): this
  • removeEventListener(eventMap: LeafletEventHandlerFnMap): this
  • Alias for off(...)

    Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

    Parameters

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

    Returns this

  • Alias for off(...)

    Removes a set of type/listener pairs.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

removeEventParent

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

    Parameters

    • obj: Evented

    Returns this

removeFrom

  • removeFrom(map: Map): this
  • Parameters

    • map: Map

    Returns this

setPopupContent

  • setPopupContent(content: Content | Popup): this
  • Parameters

    • content: Content | Popup

    Returns this

setTooltipContent

  • setTooltipContent(content: Content | Tooltip): this
  • Parameters

    • content: Content | Tooltip

    Returns this

togglePopup

  • togglePopup(): this
  • Returns this

toggleTooltip

  • toggleTooltip(): this
  • Returns this

unbindPopup

  • unbindPopup(): this
  • Returns this

unbindTooltip

  • unbindTooltip(): this
  • Returns this

Static addInitHook

  • addInitHook(initHookFn: function): any & Class
  • addInitHook(methodName: string, ...args: any[]): any & Class
  • Parameters

    • initHookFn: function
        • (): void
        • Returns void

    Returns any & Class

  • Parameters

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

    Returns any & Class

Static extend

  • extend(props: any): object & Class
  • Parameters

    • props: any

    Returns object & Class

Static include

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

    • props: any

    Returns any & Class

Static mergeOptions

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

    • props: any

    Returns any & Class

Generated using TypeDoc