net.java.html.leaflet

Class CircleMarker

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.Path

net.java.html.leaflet.Circle

net.java.html.leaflet.CircleMarker

public class CircleMarker
extends Circle

Class representing a marker on a map. This marker is a circle of a fixed size with radius specified in pixels.

Constructor Summary

Constructors

Constructor and Description
CircleMarker(LatLng latlng) Instantiates a circle marker given a geographical point.
CircleMarker(LatLng latlng, PathOptions options) Instantiates a circle marker given a geographical point and an options object.

Method Summary

Modifier and Type	Method and Description
CircleMarker	addTo(Map map) Adds the layer to the map.
CircleMarker	bindPopup(Popup popup) Binds a popup to a click on this marker.
CircleMarker	bindPopup(Popup popup, PopupOptions options) Binds a popup with a particular popup configuration options to a click on this marker.
CircleMarker	bindPopup(String html) Binds a popup with a particular HTML content to a click on this marker.
CircleMarker	bringToBack() Brings the layer to the top of all path layers.
CircleMarker	bringToFront() Returns the LatLngBounds of the Circle Marker.
CircleMarker	closePopup() Closes the bound popup of the marker if it's opened.
CircleMarker	openPopup() Opens the popup previously bound by the bindPopup method.
CircleMarker	redraw() Brings the layer to the bottom of all path layers.
CircleMarker	setLatLng(LatLng latlng) Changes the marker position to the given point.
CircleMarker	setRadius(double radius) Changes the marker radius.
CircleMarker	setStyle(PathOptions options) Changes the appearance of a CircleMarker based on the options in the PathOptions object.
CircleMarker	unbindPopup() Unbinds the popup previously bound to the marker with bindPopup.

Methods inherited from class net.java.html.leaflet.Circle

getLatLng, getRadius

Methods inherited from class net.java.html.leaflet.Path

addEventListener, addMouseListener, addPopupListener, clearAllEventListeners, getBounds, removeEventListener, removeMouseListener, removePopupListener

Methods inherited from class java.lang.Object

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

Constructor Detail

CircleMarker

public CircleMarker(LatLng latlng)

Instantiates a circle marker given a geographical point. The default radius is 10.

Parameters:

latlng - location of the marker

CircleMarker

public CircleMarker(LatLng latlng,
                    PathOptions options)

Instantiates a circle marker given a geographical point and an options object. The default radius is 10 and can be altered by setting the "radius" option in the path options object.

Parameters:

latlng - location of the marker

options - marker configuration options

Method Detail

setLatLng

public CircleMarker setLatLng(LatLng latlng)

Changes the marker position to the given point.

Overrides:

setLatLng in class Circle

Parameters:

latlng - location of the marker

Returns:

this

setRadius

public CircleMarker setRadius(double radius)

Changes the marker radius.

Overrides:

setRadius in class Circle

Parameters:

radius - marker radius

Returns:

this

addTo

public CircleMarker addTo(Map map)

Adds the layer to the map.

Overrides:

addTo in class Circle

Parameters:

map - The map

Returns:

this

setStyle

public CircleMarker setStyle(PathOptions options)

Changes the appearance of a CircleMarker based on the options in the PathOptions object.

Overrides:

setStyle in class Circle

Parameters:

options - path configuration options

Returns:

this

bringToFront

public CircleMarker bringToFront()

Returns the LatLngBounds of the Circle Marker.

Overrides:

bringToFront in class Circle

Returns:

LatLngBounds of the path

bringToBack

public CircleMarker bringToBack()

Brings the layer to the top of all path layers.

Overrides:

bringToBack in class Circle

Returns:

this

redraw

public CircleMarker redraw()

Brings the layer to the bottom of all path layers.

Overrides:

redraw in class Circle

Returns:

this

bindPopup

public CircleMarker bindPopup(String html)

Binds a popup with a particular HTML content to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Overrides:

bindPopup in class Circle

Parameters:

html - HTML content of the popup

Returns:

this

bindPopup

public CircleMarker bindPopup(Popup popup)

Binds a popup to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Overrides:

bindPopup in class Circle

Parameters:

popup - popup object

Returns:

this

bindPopup

public CircleMarker bindPopup(Popup popup,
                              PopupOptions options)

Binds a popup with a particular popup configuration options to a click on this marker. You can also open the bound popup with the Marker openPopup method.

Overrides:

bindPopup in class Circle

Parameters:

popup - popup object

options - popup configuration options

Returns:

this

unbindPopup

public CircleMarker unbindPopup()

Unbinds the popup previously bound to the marker with bindPopup.

Overrides:

unbindPopup in class Circle

Returns:

this

openPopup

public CircleMarker openPopup()

Opens the popup previously bound by the bindPopup method.

Overrides:

openPopup in class Circle

Returns:

this

closePopup

public CircleMarker closePopup()

Closes the bound popup of the marker if it's opened.

Overrides:

closePopup in class Circle

Returns:

this