com.mapbox.mapboxsdk.annotations

Class Marker

java.lang.Object

com.mapbox.mapboxsdk.annotations.Annotation

com.mapbox.mapboxsdk.annotations.Marker

All Implemented Interfaces:

java.lang.Comparable<Annotation>

Direct Known Subclasses:

MarkerView

public class Marker
extends Annotation

Marker is an annotation that shows an icon image at a geographical location. The default marker uses a provided icon. This icon can be customized using IconFactory to generate an Icon using a provided image. Markers are added to the map by first giving a LatLng and using MapboxMap.addMarker(MarkerOptions). The marker icon will be centered at this position so it is common to add padding to the icon image before usage.

If more customization is needed, we offer MarkerView which places a View on top of the map at a geographical location.

Markers are designed to be interactive. They receive click events by default, and are often used with event listeners to bring up info windows. An InfoWindow is displayed by default when either a title or snippet is provided.

Field Summary

Fields inherited from class com.mapbox.mapboxsdk.annotations.Annotation

mapboxMap, mapView

Constructor Summary

Constructors

Constructor and Description
Marker(BaseMarkerOptions baseMarkerOptions) Creates a instance of Marker using the builder of Marker.

Method Summary

Modifier and Type	Method and Description
Icon	getIcon() Gets the Icon currently used for the marker.
InfoWindow	getInfoWindow() Gets the InfoWindow the marker is using.
LatLng	getPosition() Returns the position of the marker.
java.lang.String	getSnippet() Gets the snippet of the marker.
java.lang.String	getTitle() Gets the snippet of the marker.
void	hideInfoWindow() Do not use this method, used internally by the SDK.
boolean	isInfoWindowShown() Do not use this method, used internally by the SDK.
void	setIcon(Icon icon) Sets the icon of the marker.
void	setPosition(LatLng position) Sets the location of the marker.
void	setRightOffsetPixels(int rightOffsetPixels) Do not use this method, used internally by the SDK.
void	setSnippet(java.lang.String snippet) Sets the snippet of the marker.
void	setTitle(java.lang.String title) Sets the title of the marker.
void	setTopOffsetPixels(int topOffsetPixels) Do not use this method, used internally by the SDK.
InfoWindow	showInfoWindow(MapboxMap mapboxMap, MapView mapView) Do not use this method, used internally by the SDK.
java.lang.String	toString() Returns a String with the marker position.

Methods inherited from class com.mapbox.mapboxsdk.annotations.Annotation

compareTo, equals, getId, getMapboxMap, getMapView, hashCode, remove, setId, setMapboxMap, setMapView

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Marker

public Marker(BaseMarkerOptions baseMarkerOptions)

Creates a instance of Marker using the builder of Marker.

Parameters:

baseMarkerOptions - The builder used to construct the Marker.

Method Detail

getPosition

public LatLng getPosition()

Returns the position of the marker.

Returns:

A LatLng object specifying the marker's current position.

getSnippet

public java.lang.String getSnippet()

Gets the snippet of the marker.

Returns:

A string containing the marker's snippet.

getTitle

public java.lang.String getTitle()

Gets the snippet of the marker.

Returns:

A string containing the marker's snippet.

hideInfoWindow

public void hideInfoWindow()

Do not use this method, used internally by the SDK.

isInfoWindowShown

public boolean isInfoWindowShown()

Do not use this method, used internally by the SDK.

Returns:

true if the infoWindow is shown

setPosition

public void setPosition(LatLng position)

Sets the location of the marker.

Parameters:

position - A LatLng defining the marker position.

setSnippet

public void setSnippet(java.lang.String snippet)

Sets the snippet of the marker.

Parameters:

snippet - A String used in the marker info window. If null, the snippet is cleared.

setIcon

public void setIcon(@Nullable
                    Icon icon)

Sets the icon of the marker.

Parameters:

icon - The Icon to be used as Marker image

getIcon

public Icon getIcon()

Gets the Icon currently used for the marker. If no Icon was set for the marker, the default icon will be returned.

Returns:

The Icon the marker is using.

setTitle

public void setTitle(java.lang.String title)

Sets the title of the marker.

Parameters:

title - A String used in the marker info window. If null, the title is cleared.

getInfoWindow

@Nullable
public InfoWindow getInfoWindow()

Gets the InfoWindow the marker is using. If the marker hasn't had an info window defined, this will return null.

Returns:

The info window the marker is using.

showInfoWindow

public InfoWindow showInfoWindow(@NonNull
                                 MapboxMap mapboxMap,
                                 @NonNull
                                 MapView mapView)

Do not use this method, used internally by the SDK. Use MapboxMap.selectMarker(Marker) if you want to programmatically display the markers info window.

Parameters:

mapboxMap - The hosting mapbox map.

mapView - The hosting map view.

Returns:

The info window that was shown.

setTopOffsetPixels

public void setTopOffsetPixels(int topOffsetPixels)

Do not use this method, used internally by the SDK.

Parameters:

topOffsetPixels - the top offset pixels.

setRightOffsetPixels

public void setRightOffsetPixels(int rightOffsetPixels)

Do not use this method, used internally by the SDK.

Parameters:

rightOffsetPixels - the right offset pixels.

toString

public java.lang.String toString()

Returns a String with the marker position.

Overrides:

toString in class java.lang.Object

Returns:

A String with the marker position.