Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TileLayerDirective

Angular2 directive for Leaflet tile-layers.

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

How to use in a template:

<yaga-map>
    <yaga-tile-layer
        [(url)]="..."
        [(display)]="..."
        [(opacity)]="..."
        [(zIndex)]="..."

        (add)="..."
        (remove)="..."
        (popupopen)="..."
        (popupclose)="..."
        (tooltipopen)="..."
        (tooltipclose)="..."
        (click)="..."
        (dblclick)="..."
        (mousedown)="..."
        (mouseover)="..."
        (mouseout)="..."
        (contextmenu)="..."
        (loading)="..."
        (tileunload)="..."
        (tileloadstart)="..."
        (tileerror)="..."
        (tileload)="..."
        (load)="..."

        [tileSize]="..."
        [updateWhenIdle]="..."
        [updateWhenZooming]="..."
        [updateInterval]="..."
        [bounds]="..."
        [noWrap]="..."
        [className]="..."
        [keepBuffer]="..."
        [maxZoom]="..."
        [minZoom]="..."
        [maxNativeZoom]="..."
        [minNativeZoom]="..."
        [subdomains]="..."
        [errorTileUrl]="..."
        [zoomOffset]="..."
        [tms]="..."
        [zoomReverse]="..."
        [detectRetina]="..."
        [crossOrigin]="..."
        [attribution]="...">
    </yaga-tile-layer>
</yaga-map>
link

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

link

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

link

https://leaflet-ng2.yagajs.org/1.0.0-rc12/coverage/lcov-report/lib/tile-layer.directive.js.html Test coverage

link

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

example

https://leaflet-ng2.yagajs.org/1.0.0-rc12/examples/tile-layer-directive

Hierarchy

  • TileLayer
    • TileLayerDirective

Implements

  • OnDestroy

Index

Constructors

constructor

Properties

Protected _map

_map: Map

Protected Optional _tileZoom

_tileZoom: undefined | number

Protected _tiles

_tiles: InternalTiles

addEvent

addEvent: EventEmitter<LeafletEvent> = new EventEmitter()

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

link

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

clickEvent

clickEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

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

link

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

contextmenuEvent

contextmenuEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

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

link

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

dblclickEvent

dblclickEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

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

link

http://leafletjs.com/reference-1.2.0.html#tilelayer-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-tile-layer [(display)]="someValue"> or <yaga-tile-layer (displayChange)="processEvent($event)">

Protected layerGroupProvider

layerGroupProvider: LayerGroupProvider

loadEvent

loadEvent: EventEmitter<LeafletEvent> = new EventEmitter()

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

link

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

loadingEvent

loadingEvent: EventEmitter<LeafletEvent> = new EventEmitter()

From leaflet fired loading event. Use it with <yaga-tile-layer (loading)="processEvent($event)">

link

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

mousedownEvent

mousedownEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

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

link

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

mouseoutEvent

mouseoutEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

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

link

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

mouseoverEvent

mouseoverEvent: EventEmitter<LeafletMouseEvent> = new EventEmitter()

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

link

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

opacityChange

opacityChange: EventEmitter<number> = new EventEmitter()

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

link

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

options

options: TileLayerOptions

popupcloseEvent

popupcloseEvent: EventEmitter<PopupEvent> = new EventEmitter()

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

link

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

popupopenEvent

popupopenEvent: EventEmitter<PopupEvent> = new EventEmitter()

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

link

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

removeEvent

removeEvent: EventEmitter<LeafletEvent> = new EventEmitter()

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

link

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

tileerrorEvent

tileerrorEvent: EventEmitter<TileErrorEvent> = new EventEmitter()

From leaflet fired tileerror event. Use it with <yaga-tile-layer (tileerror)="processEvent($event)">

link

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

tileloadEvent

tileloadEvent: EventEmitter<TileEvent> = new EventEmitter()

From leaflet fired tileload event. Use it with <yaga-tile-layer (tileload)="processEvent($event)">

link

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

tileloadstartEvent

tileloadstartEvent: EventEmitter<TileEvent> = new EventEmitter()

From leaflet fired tileloadstart event. Use it with <yaga-tile-layer (tileloadstart)="processEvent($event)">

link

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

tileunloadEvent

tileunloadEvent: EventEmitter<TileEvent> = new EventEmitter()

From leaflet fired tileunload event. Use it with <yaga-tile-layer (tileunload)="processEvent($event)">

link

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

tooltipcloseEvent

tooltipcloseEvent: EventEmitter<TooltipEvent> = new EventEmitter()

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

link

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

tooltipopenEvent

tooltipopenEvent: EventEmitter<TooltipEvent> = new EventEmitter()

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

link

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

urlChange

urlChange: EventEmitter<string> = new EventEmitter()

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

link

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

zIndexChange

zIndexChange: EventEmitter<number> = new EventEmitter()

Two-Way bound property for the zIndex of the layer. Use it with <yaga-tile-layer [(zIndex)]="someValue"> or <yaga-tile-layer (zIndexChange)="processEvent($event)">

link

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

Accessors

attribution

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

bounds

  • get bounds(): LatLngBoundsExpression | undefined
  • set bounds(val: LatLngBoundsExpression | undefined): void

className

  • get className(): string | undefined
  • set className(val: string | undefined): void

crossOrigin

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

detectRetina

  • get detectRetina(): boolean
  • set detectRetina(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-tile-layer [(display)]="someValue"> or <yaga-tile-layer [display]="someValue">

    Returns boolean

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

    Parameters

    • val: boolean

    Returns void

errorTileUrl

  • get errorTileUrl(): string | undefined
  • set errorTileUrl(val: string | undefined): void

keepBuffer

  • get keepBuffer(): number | undefined
  • set keepBuffer(val: number | undefined): void

maxNativeZoom

  • get maxNativeZoom(): number | undefined
  • set maxNativeZoom(val: number | undefined): void

maxZoom

  • get maxZoom(): number | undefined
  • set maxZoom(val: number | undefined): void

minNativeZoom

  • get minNativeZoom(): number | undefined
  • set minNativeZoom(val: number | undefined): void

minZoom

  • get minZoom(): number | undefined
  • set minZoom(val: number | undefined): void

noWrap

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

opacity

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

subdomains

  • get subdomains(): string[]
  • set subdomains(val: string[]): void

tileSize

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

tms

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

updateInterval

  • get updateInterval(): number | undefined
  • set updateInterval(val: number | undefined): void

updateWhenIdle

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

updateWhenZooming

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

url

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

zIndex

  • get zIndex(): number | undefined
  • set zIndex(val: number | undefined): void

zoomOffset

  • get zoomOffset(): number | undefined
  • set zoomOffset(val: number | undefined): void

zoomReverse

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

Methods

Protected _abortLoading

  • _abortLoading(): void
  • Returns void

Protected _getZoomForUrl

  • _getZoomForUrl(): number
  • Returns number

Protected _tileCoordsToKey

  • _tileCoordsToKey(coords: Coords): string
  • Parameters

    • coords: Coords

    Returns string

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

Protected createTile

  • createTile(coords: Coords, done: DoneCallback): HTMLElement
  • Parameters

    • coords: Coords
    • done: DoneCallback

    Returns HTMLElement

fire

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

    Returns this

fireEvent

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

    Returns this

Optional getAttribution

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

getContainer

  • getContainer(): HTMLElement | null
  • Returns HTMLElement | 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

getTileSize

  • getTileSize(): Point
  • Returns Point

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

isLoading

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

redraw

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

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, noRedraw?: undefined | true | false): this

setZIndex

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

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

    Returns any

Static extend

  • extend(props: any): any
  • Parameters

    • props: any

    Returns any

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