Class TileLayer

Hierarchy

TileLayer

Implements

Index

Classes

Canvas
WMS

Constructors

constructor

Constructors

constructor

new TileLayer(urlTemplate: string, options?: TileLayerOptions): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3706
Instantiates a tile layer object given a URL template and optionally an options object.

Parameters
- urlTemplate: string
- Optional options: TileLayerOptions
Returns TileLayer

Methods

addEventListener

addEventListener(type: string, fn: function, context?: any): TileLayer
addEventListener(eventMap: any, context?: any): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3771
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns TileLayer
Implementation of IEventPowered.addEventListener
- Defined in src/typings/leaflet/leaflet.d.ts:3780
Parameters
- eventMap: any
- Optional context: any
Returns TileLayer

addOneTimeEventListener

addOneTimeEventListener(type: string, fn: function, context?: any): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3772
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns TileLayer

addTo

addTo(map: Map): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3717
Adds the layer to the map.

Parameters
- map: Map
Returns TileLayer

bringToBack

bringToBack(): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3727
Brings the tile layer to the bottom of all tile layers.

Returns TileLayer

bringToFront

bringToFront(): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3722
Brings the tile layer to the top of all tile layers.

Returns TileLayer

clearAllEventListeners

clearAllEventListeners(): TileLayer

Implementation of IEventPowered.clearAllEventListeners
- Defined in src/typings/leaflet/leaflet.d.ts:3782
Returns TileLayer

fire

fire(type: string, data?: any): TileLayer

Implementation of IEventPowered.fire
- Defined in src/typings/leaflet/leaflet.d.ts:3779
Parameters
- type: string
- Optional data: any
Returns TileLayer

fireEvent

fireEvent(type: string, data?: any): TileLayer

Implementation of IEventPowered.fireEvent
- Defined in src/typings/leaflet/leaflet.d.ts:3775
Parameters
- type: string
- Optional data: any
Returns TileLayer

getContainer

getContainer(): HTMLElement

- Defined in src/typings/leaflet/leaflet.d.ts:3752
Returns the HTML element that contains the tiles for this layer.

Returns HTMLElement

hasEventListeners

hasEventListeners(type: string): boolean

Implementation of IEventPowered.hasEventListeners
- Defined in src/typings/leaflet/leaflet.d.ts:3774
Parameters
- type: string
Returns boolean

off

off(type: string, fn?: function, context?: any): TileLayer
off(eventMap?: any, context?: any): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3778
Parameters
- type: string
- Optional fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns TileLayer
Implementation of IEventPowered.off
- Defined in src/typings/leaflet/leaflet.d.ts:3784
Parameters
- Optional eventMap: any
- Optional context: any
Returns TileLayer

on

on(type: string, fn: function, context?: any): TileLayer
on(eventMap: any, context?: any): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3776
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns TileLayer
Implementation of IEventPowered.on
- Defined in src/typings/leaflet/leaflet.d.ts:3783
Parameters
- eventMap: any
- Optional context: any
Returns TileLayer

onAdd

onAdd(map: Map): void

Implementation of ILayer.onAdd
- Defined in src/typings/leaflet/leaflet.d.ts:3761
Should contain code that creates DOM elements for the overlay, adds them to map panes where they should belong and puts listeners on relevant map events. Called on map.addLayer(layer).

Parameters
- map: Map
Returns void

onRemove

onRemove(map: Map): void

Implementation of ILayer.onRemove
- Defined in src/typings/leaflet/leaflet.d.ts:3767
Should contain all clean up code that removes the overlay's elements from the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer).

Parameters
- map: Map
Returns void

once

once(type: string, fn: function, context?: any): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3777
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns TileLayer

redraw

redraw(): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3742
Causes the layer to clear all the tiles and request them again.

Returns TileLayer

removeEventListener

removeEventListener(type: string, fn?: function, context?: any): TileLayer
removeEventListener(eventMap?: any, context?: any): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3773
Parameters
- type: string
- Optional fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns TileLayer
Implementation of IEventPowered.removeEventListener
- Defined in src/typings/leaflet/leaflet.d.ts:3781
Parameters
- Optional eventMap: any
- Optional context: any
Returns TileLayer

setOpacity

setOpacity(opacity: number): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3732
Changes the opacity of the tile layer.

Parameters
- opacity: number
Returns TileLayer

setUrl

setUrl(urlTemplate: string): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3747
Updates the layer's URL template and redraws it.

Parameters
- urlTemplate: string
Returns TileLayer

setZIndex

setZIndex(zIndex: number): TileLayer

- Defined in src/typings/leaflet/leaflet.d.ts:3737
Sets the zIndex of the tile layer.

Parameters
- zIndex: number
Returns TileLayer