Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageOverlayDirective

Angular2 directive for Leaflet image overlays.

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

How to use in a template:

<yaga-map>
    <yaga-image-overlay
        [(url)]="..."
        [(display)]="..."
        [(opacity)]="..."
        [(zIndex)]="..."
        [(bounds)]="..."
        [(north)]="..."
        [(east)]="..."
        [(south)]="..."
        [(west)]="..."

        (add)="..."
        (remove)="..."
        (popupopen)="..."
        (popupclose)="..."
        (tooltipopen)="..."
        (tooltipclose)="..."
        (click)="..."
        (dblclick)="..."
        (mousedown)="..."
        (mouseover)="..."
        (mouseout)="..."
        (contextmenu)="..."
        (load)="..."
        (error)="..."

        [crossOrigin]="..."
        [alt]="..."
        [interactive]="..."
        [attribution]="..."
        >
    </yaga-image-overlay>
</yaga-map>
link

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

link

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

link

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

link

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

example

https://leaflet-ng2.yagajs.org/1.0.0/examples/image-overlay-directive

Hierarchy

  • ImageOverlay
    • ImageOverlayDirective

Implements

  • OnDestroy

Index

Constructors

constructor

Properties

Protected _map

_map: Map

addEvent

addEvent: EventEmitter<LeafletEvent> = new EventEmitter()

From leaflet fired add event. Use it with <yaga-image-overlay (add)="processEvent($event)">

link

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

boundsChange

boundsChange: EventEmitter<LatLngBounds> = new EventEmitter()

Two-Way bound property for the bounds of the image. Use it with <yaga-image-overlay [(bounds)]="someValue"> or <yaga-image-overlay (opacityChange)="processEvent($event)">

link

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

clickEvent

clickEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

From leaflet fired click event. Use it with <yaga-image-overlay (click)="processEvent($event)">

link

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

contextmenuEvent

contextmenuEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

From leaflet fired contextmenu event. Use it with <yaga-image-overlay (contextmenu)="processEvent($event)">

link

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

dblclickEvent

dblclickEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

From leaflet fired dblclick event. Use it with <yaga-image-overlay (dblclick)="processEvent($event)">

link

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

displayChange

displayChange: EventEmitter<boolean> = new EventEmitter()

Two-Way bound property for the display status of the layer. Use it with <yaga-image-overlay [(display)]="someValue"> or <yaga-image-overlay (displayChange)="processEvent($event)">

eastChange

eastChange: EventEmitter<number> = new EventEmitter()

Two-Way bound property for the east bounds of the image. Use it with <yaga-image-overlay [(east)]="someValue"> or <yaga-image-overlay (eastChange)="processEvent($event)">

link

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

errorEvent

errorEvent: EventEmitter<LeafletEvent> = new EventEmitter()

From leaflet fired error event. Use it with <yaga-image-overlay (error)="processEvent($event)">

link

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

Protected layerGroupProvider

layerGroupProvider: LayerGroupProvider

loadEvent

loadEvent: EventEmitter<LeafletEvent> = new EventEmitter()

From leaflet fired load event. Use it with <yaga-image-overlay (load)="processEvent($event)">

link

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

mousedownEvent

mousedownEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

From leaflet fired mousedown event. Use it with <yaga-image-overlay (mousedown)="processEvent($event)">

link

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

mouseoutEvent

mouseoutEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

From leaflet fired mouseout event. Use it with <yaga-image-overlay (mouseout)="processEvent($event)">

link

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

mouseoverEvent

mouseoverEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

From leaflet fired mouseover event. Use it with <yaga-image-overlay (mouseover)="processEvent($event)">

link

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

northChange

northChange: EventEmitter<number> = new EventEmitter()

Two-Way bound property for the north bounds of the image. Use it with <yaga-image-overlay [(north)]="someValue"> or <yaga-image-overlay (northChange)="processEvent($event)">

link

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

opacityChange

opacityChange: EventEmitter<number> = new EventEmitter()

Two-Way bound property for the opacity of the layer. Use it with <yaga-image-overlay [(opacity)]="someValue"> or <yaga-image-overlay (opacityChange)="processEvent($event)">

link

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

options

options: ImageOverlayOptions

popupcloseEvent

popupcloseEvent: EventEmitter<PopupEvent> = new EventEmitter()

From leaflet fired popupclose event. Use it with <yaga-image-overlay (popupclose)="processEvent($event)">

link

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

popupopenEvent

popupopenEvent: EventEmitter<PopupEvent> = new EventEmitter()

From leaflet fired popupopen event. Use it with <yaga-image-overlay (popupopen)="processEvent($event)">

link

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

removeEvent

removeEvent: EventEmitter<LeafletEvent> = new EventEmitter()

From leaflet fired remove event. Use it with <yaga-image-overlay (remove)="processEvent($event)">

link

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

southChange

southChange: EventEmitter<number> = new EventEmitter()

Two-Way bound property for the south bounds of the image. Use it with <yaga-image-overlay [(south)]="someValue"> or <yaga-image-overlay (southChange)="processEvent($event)">

link

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

tooltipcloseEvent

tooltipcloseEvent: EventEmitter<TooltipEvent> = new EventEmitter()

From leaflet fired tooltipclose event. Use it with <yaga-image-overlay (tooltipclose)="processEvent($event)">

link

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

tooltipopenEvent

tooltipopenEvent: EventEmitter<TooltipEvent> = new EventEmitter()

From leaflet fired tooltipopen event. Use it with <yaga-image-overlay (tooltipopen)="processEvent($event)">

link

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

urlChange

urlChange: EventEmitter<string> = new EventEmitter()

Two-Way bound property for the URL. Use it with <yaga-image-overlay [(url)]="someValue"> or <yaga-image-overlay (urlChange)="processEvent($event)">

link

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

westChange

westChange: EventEmitter<number> = new EventEmitter()

Two-Way bound property for the west bounds of the image. Use it with <yaga-image-overlay [(west)]="someValue"> or <yaga-image-overlay (westChange)="processEvent($event)">

link

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

Accessors

alt

  • get alt(): string
  • set alt(val: string): void

attribution

  • get attribution(): string
  • set attribution(val: string): void

bounds

  • get bounds(): LatLngBounds
  • set bounds(val: LatLngBounds): void
  • Two-Way bound property for the bounds of the image. Use it with <yaga-image-overlay [(bounds)]="someValue"> or <yaga-image-overlay [bounds]="someValue">

    Returns LatLngBounds

  • Two-Way bound property for the bounds of the image. Use it with <yaga-image-overlay [(bounds)]="someValue"> or <yaga-image-overlay [bounds]="someValue">

    Parameters

    • val: LatLngBounds

    Returns void

crossOrigin

  • get crossOrigin(): boolean
  • set crossOrigin(val: boolean): void

display

  • get display(): boolean
  • set display(val: boolean): void
  • Two-Way bound property for the display status of the layer. Use it with <yaga-image-overlay [(display)]="someValue"> or <yaga-image-overlay [display]="someValue">

    Returns boolean

  • Two-Way bound property for the display status of the layer. Use it with <yaga-image-overlay [(display)]="someValue"> or <yaga-image-overlay [display]="someValue">

    Parameters

    • val: boolean

    Returns void

east

  • get east(): number
  • set east(val: number): void
  • Two-Way bound property for the east bounds of the image. Use it with <yaga-image-overlay [(east)]="someValue"> or <yaga-image-overlay [east]="someValue">

    Returns number

  • Two-Way bound property for the east bounds of the image. Use it with <yaga-image-overlay [(east)]="someValue"> or <yaga-image-overlay [east]="someValue">

    Parameters

    • val: number

    Returns void

interactive

  • get interactive(): boolean
  • set interactive(val: boolean): void

north

  • get north(): number
  • set north(val: number): void
  • Two-Way bound property for the north bounds of the image. Use it with <yaga-image-overlay [(north)]="someValue"> or <yaga-image-overlay [north]="someValue">

    Returns number

  • Two-Way bound property for the north bounds of the image. Use it with <yaga-image-overlay [(north)]="someValue"> or <yaga-image-overlay [north]="someValue">

    Parameters

    • val: number

    Returns void

opacity

  • get opacity(): number
  • set opacity(val: number): void

south

  • get south(): number
  • set south(val: number): void
  • Two-Way bound property for the south bounds of the image. Use it with <yaga-image-overlay [(south)]="someValue"> or <yaga-image-overlay [south]="someValue">

    Returns number

  • Two-Way bound property for the south bounds of the image. Use it with <yaga-image-overlay [(south)]="someValue"> or <yaga-image-overlay [south]="someValue">

    Parameters

    • val: number

    Returns void

url

  • get url(): string
  • set url(val: string): void

west

  • get west(): number
  • set west(val: number): void
  • Two-Way bound property for the west bounds of the image. Use it with <yaga-image-overlay [(west)]="someValue"> or <yaga-image-overlay [west]="someValue">

    Returns number

  • Two-Way bound property for the west bounds of the image. Use it with <yaga-image-overlay [(west)]="someValue"> or <yaga-image-overlay [west]="someValue">

    Parameters

    • val: number

    Returns 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

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: 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

getBounds

  • getBounds(): LatLngBounds
  • Get the bounds that this ImageOverlay covers

    Returns LatLngBounds

getElement

  • getElement(): HTMLImageElement | undefined
  • Get the img element that represents the ImageOverlay on the map

    Returns HTMLImageElement | undefined

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

ngOnDestroy

  • ngOnDestroy(): void

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

setBounds

  • setBounds(val: LatLngBoundsExpression): this

setOpacity

  • setOpacity(val: number): 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

setUrl

  • setUrl(url: string): 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