uk.co.ordnancesurvey.android.maps

Class Marker

java.lang.Object

uk.co.ordnancesurvey.android.maps.Marker

public final class Marker
extends Object

An icon placed at a particular point on the map's surface. A marker icon is drawn oriented against the device's screen rather than the map's surface; i.e., it will not necessarily change orientation due to map rotations, tilting, or zooming.

A marker has the following properties:

Anchor
The point on the image that will be placed at the LatLng position of the marker. This defaults to 50% from the left of the image and at the bottom of the image.

Position
The GridPoint value for the marker's position on the map. You can change this value at any time if you want to move the marker.

Title
A text string that's displayed in an info window when the user taps the marker. You can change this value at any time.

Snippet
Additional text that's displayed below the title. You can change this value at any time.

Icon
A bitmap that's displayed for the marker. If the icon is left unset, a default icon is displayed. You can specify an alternative coloring of the default icon using defaultMarker(float). You can't change the icon once you've created the marker.

Drag Status
If you want to allow the user to drag the marker, set this property to true. You can change this value at any time. The default is false.

Visibility
By default, the marker is visible. To make the marker invisible, set this property to false. You can change this value at any time.

Example

 
 OSMap map = ... // get a map.
 // Add a marker at Scafell Pike
 Marker marker = map.addMarker(new MarkerOptions()
     .position(GridPoint.parse("NY2154807223"))
     .title("Scafell Pike")
     .snippet("Highest Mountain in England"));
 

Developer Guide

For more information, read the Markers developer guide.

Method Summary

Methods

Modifier and Type	Method and Description
GridPoint	getGridPoint() Returns the position of the marker.
String	getSnippet() Gets the snippet of the marker.
String	getTitle() Gets the title of the marker.
void	hideInfoWindow() Hides the info window if it is shown from this marker.
boolean	isDraggable() Gets the draggability of the marker.
boolean	isVisible()
void	remove() Removes this marker from the map.
void	setDraggable(boolean draggable) Sets the draggability of the marker.
void	setGridPoint(GridPoint gp)
void	setSnippet(String snippet) Sets the snippet of the marker.
void	setTitle(String title) Sets the title of the marker.
void	setVisible(boolean visible) Sets the visibility of this marker.
void	showInfoWindow() Shows the info window of this marker on the map, if this marker isVisible().

Methods inherited from class java.lang.Object

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

Method Detail

getGridPoint

public GridPoint getGridPoint()

Returns the position of the marker.

Returns:

A GridPoint object specifying the marker's current position

setGridPoint

public void setGridPoint(GridPoint gp)

setVisible

public void setVisible(boolean visible)

Sets the visibility of this marker. If set to false and an info window is currently showing for this marker, this will hide the info window.

isVisible

public boolean isVisible()

showInfoWindow

public void showInfoWindow()

Shows the info window of this marker on the map, if this marker isVisible().

hideInfoWindow

public void hideInfoWindow()

Hides the info window if it is shown from this marker.

This method has no effect if this marker is not visible.

setDraggable

public void setDraggable(boolean draggable)

Sets the draggability of the marker. When a marker is draggable, it can be moved by the user by long pressing on the marker.

isDraggable

public boolean isDraggable()

Gets the draggability of the marker. When a marker is draggable, it can be moved by the user by long pressing on the marker.

Returns:

true if the marker is draggable; otherwise, returns false.

remove

public void remove()

Removes this marker from the map. After a marker has been removed, the behavior of all its methods is undefined.

setTitle

public void setTitle(String title)

Sets the title of the marker.

setSnippet

public void setSnippet(String snippet)

Sets the snippet of the marker.

getTitle

public String getTitle()

Gets the title of the marker.

Returns:

A string containing the marker's title.

getSnippet

public String getSnippet()

Gets the snippet of the marker.

Returns:

A string containing the marker's snippet.