com.gwidgets.api.leaflet

Class ImageOverlay

java.lang.Object

com.gwidgets.api.leaflet.ImageOverlay

All Implemented Interfaces:

ILayer

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

Used to load and display a single image over specific bounds of the map, implements ILayer interface.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
static L	addTo(Map map) Adds the overlay to the map.
static L	bringToBack() Brings the layer to the bottom of all overlays.
static L	bringToFront() Brings the layer to the top of all overlays.
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.
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.
static L	setOpacity(java.lang.Number opacity) Sets the opacity of the overlay.

Methods inherited from class java.lang.Object

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

Method Detail

addTo

@JsMethod
public static L addTo(Map map)

Adds the overlay to the map.

Parameters:

map - the map

Returns:

the L class

setOpacity

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

Sets the opacity of the overlay.

Parameters:

opacity - the opacity

Returns:

the L class

bringToFront

@JsMethod
public static L bringToFront()

Brings the layer to the top of all overlays.

Returns:

the L class

bringToBack

@JsMethod
public static L bringToBack()

Brings the layer to the bottom of all overlays.

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