net.java.html.leaflet

Class ImageOverlay

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.ImageOverlay

public final class ImageOverlay
extends ILayer

Used to load and display a single image over specific bounds of the map.

Constructor Summary

Constructors

Constructor and Description
ImageOverlay(String imageUrl, LatLngBounds bounds) Instantiates an image overlay object given the URL of the image and the geographical bounds it is tied to.
ImageOverlay(String imageUrl, LatLngBounds bounds, ImageOverlayOptions options) Instantiates an image overlay object given the URL of the image and the geographical bounds it is tied to.

Method Summary

Modifier and Type	Method and Description
ImageOverlay	addTo(Map map) Adds the layer to the map.
ImageOverlay	bindPopup(Popup popup) Binds a given popup object to the overlay.
ImageOverlay	bindPopup(Popup popup, PopupOptions options) Binds a given popup object with the given options to the overlay.
ImageOverlay	bindPopup(String html) Binds a popup with a particular HTML content to a click on this overlay.
ImageOverlay	bringToBack() Brings the layer to the bottom of all path layers.
ImageOverlay	bringToFront() Brings the layer to the top of all path layers.
ImageOverlay	closePopup() Closes the overlay's bound popup if it is opened.
ImageOverlay	openPopup() Opens the popup previously bound by the bindPopup method.
ImageOverlay	setOpacity(double opacity) Sets the opacity of the overlay.
ImageOverlay	setUrl(String imageUrl) Changes the URL of the image.
ImageOverlay	unbindPopup() Unbinds the popup previously bound to the overlay with bindPopup.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageOverlay

public ImageOverlay(String imageUrl,
                    LatLngBounds bounds)

Instantiates an image overlay object given the URL of the image and the geographical bounds it is tied to.

Parameters:

imageUrl - URL of the image

bounds - geographical bounds

ImageOverlay

public ImageOverlay(String imageUrl,
                    LatLngBounds bounds,
                    ImageOverlayOptions options)

Instantiates an image overlay object given the URL of the image and the geographical bounds it is tied to.

Parameters:

imageUrl - URL of the image

bounds - geographical bounds

options - overlayer configuration options

Method Detail

addTo

public ImageOverlay addTo(Map map)

Adds the layer to the map.

Parameters:

map - The map

Returns:

this

setOpacity

public ImageOverlay setOpacity(double opacity)

Sets the opacity of the overlay.

Parameters:

opacity - opacity of the overlay

Returns:

this

setUrl

public ImageOverlay setUrl(String imageUrl)

Changes the URL of the image.

Parameters:

imageUrl - URL of the image

Returns:

this

bringToFront

public ImageOverlay bringToFront()

Brings the layer to the top of all path layers.

Returns:

this

bringToBack

public ImageOverlay bringToBack()

Brings the layer to the bottom of all path layers.

Returns:

this

bindPopup

public ImageOverlay bindPopup(String html)

Binds a popup with a particular HTML content to a click on this overlay.

Parameters:

html - poup HTML content

Returns:

this

bindPopup

public ImageOverlay bindPopup(Popup popup)

Binds a given popup object to the overlay.

Parameters:

popup - popup object

Returns:

this

bindPopup

public ImageOverlay bindPopup(Popup popup,
                              PopupOptions options)

Binds a given popup object with the given options to the overlay.

Parameters:

popup - popup object

options - popup configuration object

Returns:

this

unbindPopup

public ImageOverlay unbindPopup()

Unbinds the popup previously bound to the overlay with bindPopup.

Returns:

this

openPopup

public ImageOverlay openPopup()

Opens the popup previously bound by the bindPopup method.

Returns:

this

closePopup

public ImageOverlay closePopup()

Closes the overlay's bound popup if it is opened.

Returns:

this