com.gwidgets.api.leaflet

Class TileLayer

java.lang.Object

com.gwidgets.api.leaflet.TileLayer

All Implemented Interfaces:

ILayer

Direct Known Subclasses:

Canvas, WMS

@JsType(isNative=true)
public class TileLayer
extends java.lang.Object
implements ILayer

Used to load and display tile layers on the map,

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addTo(Map map) Adds the layer to the map.
L	bringToBack() Brings the tile layer to the bottom of all tile layers.
L	bringToFront() Brings the tile layer to the top of all tile layers.
static L	clearAllEventListeners() Clear all event listeners.
static L	fire(java.lang.String type) Fires an event of the specified type.
HTMLElement	getContainer() Returns the HTML element that contains the tiles for this layer.
static L	off(java.lang.String type, Function fn) the listener will only get fired once and then removed.
static L	on(java.lang.String type, Function fn) Adds a set of type/listener pairs
void	onAdd(Map map) 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.
static L	once(java.lang.String type, Function fn) Once.
void	onRemove(Map map) Should contain all clean up code that removes the overlay's elements from the DOM and removes listeners previously added in onAdd.
L	redraw() Causes the layer to clear all the tiles and request them again
L	setOpacity(java.lang.Number opacity) Changes the opacity of the tile layer.
L	setUrl(java.lang.String urlTemplate) Updates the layer's URL template and redraws it.
L	setZIndex(java.lang.Number zIndex) Sets the zIndex of the tile layer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addTo

@JsMethod
public L addTo(Map map)

Adds the layer to the map.

Parameters:

map - the map

Returns:

the L class

bringToFront

@JsMethod
public L bringToFront()

Brings the tile layer to the top of all tile layers.

Returns:

the L class

bringToBack

@JsMethod
public L bringToBack()

Brings the tile layer to the bottom of all tile layers.

Returns:

the L class

setOpacity

@JsMethod
public L setOpacity(java.lang.Number opacity)

Changes the opacity of the tile layer.

Parameters:

opacity - the opacity

Returns:

the L class

setZIndex

@JsMethod
public L setZIndex(java.lang.Number zIndex)

Sets the zIndex of the tile layer.

Parameters:

zIndex - the z index

Returns:

the L class

redraw

@JsMethod
public L redraw()

Causes the layer to clear all the tiles and request them again

Returns:

the L class

setUrl

@JsMethod
public L setUrl(java.lang.String urlTemplate)

Updates the layer's URL template and redraws it.

Parameters:

urlTemplate - the url template

Returns:

the L class

getContainer

@JsMethod
public HTMLElement getContainer()

Returns the HTML element that contains the tiles for this layer.

Returns:

the container

clearAllEventListeners

@JsMethod
public static L clearAllEventListeners()

Clear all event listeners.

Returns:

the L class

on

@JsMethod
public static L on(java.lang.String type,
                              Function fn)

Adds a set of type/listener pairs

Parameters:

type - the type

fn - the callback function

Returns:

the L class

once

@JsMethod
public static L once(java.lang.String type,
                                Function fn)

Once.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

off

@JsMethod
public static L off(java.lang.String type,
                               Function fn)

the listener will only get fired once and then removed.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

fire

@JsMethod
public static L fire(java.lang.String type)

Fires an event of the specified type. You can optionally provide an data object — the first argument of the listener function will contain its properties.

Parameters:

type - the type

Returns:

the L class

onAdd

@JsMethod
public void onAdd(Map map)

Description copied from interface: ILayer

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).

Specified by:

onAdd in interface ILayer

Parameters:

map - the map

onRemove

@JsMethod
public void onRemove(Map map)

Description copied from interface: ILayer

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).

Specified by:

onRemove in interface ILayer

Parameters:

map - the map