com.mapbox.mapboxsdk.annotations

Class MarkerView

java.lang.Object

com.mapbox.mapboxsdk.annotations.Annotation

com.mapbox.mapboxsdk.annotations.Marker

com.mapbox.mapboxsdk.annotations.MarkerView

All Implemented Interfaces:

java.lang.Comparable<Annotation>

public class MarkerView
extends Marker

MarkerView is an annotation that shows an View at a geographical location.

This class uses MapboxMap.MarkerViewAdapter to adapt a MarkerView model to an Android SDK View object.

An InfoWindow can be shown when a MarkerView is pressed

Field Summary

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

mapboxMap, mapView

Constructor Summary

Constructors

Constructor and Description
MarkerView(BaseMarkerViewOptions baseMarkerViewOptions) Creates a instance of MarkerView using the builder of MarkerView

Method Summary

Modifier and Type	Method and Description
float	getAlpha() Get the alpha value of the MarkerView.
float	getAnchorU() Get the horizontal distance, normalized to [0, 1], of the anchor from the left edge.
float	getAnchorV() Get the vertical distance, normalized to [0, 1], of the anchor from the top edge.
Icon	getIcon() Get the icon of the MarkerView.
float	getInfoWindowAnchorU() Get the horizontal distance, normalized to [0, 1], of the info window anchor from the left edge.
float	getInfoWindowAnchorV() Get the vertical distance, normalized to [0, 1], of the info window anchor from the top edge.
float	getRotation() Get the rotation value of the MarkerView.
boolean	isFlat() Get the flat state of a MarkerView.
boolean	isSelected()
boolean	isVisible() Returns the visible state of the MarkerView.
void	setAlpha(float alpha) Set the alpha value of the MarkerView.
void	setAnchor(float u, float v) Specifies the anchor being set on a particular point point of the MarkerView.
void	setFlat(boolean flat) Sets whether this marker should be flat against the map true or a billboard facing the camera false.
void	setIcon(Icon icon) Set the icon of the MarkerView.
void	setInfoWindowAnchor(float u, float v) Specifies the anchor point of the info window on the View of the MarkerView.
void	setMapboxMap(MapboxMap mapboxMap) Set the MapboxMap associated tot the MapView containing the MarkerView.
void	setPosition(LatLng position) Sets the position.
void	setRotation(float rotation) Set the rotation value of the MarkerView.
void	setVisible(boolean visible) Set the visible state of a MarkerView.
java.lang.String	toString() Get the String representation of a MarkerView.

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

getInfoWindow, getPosition, getSnippet, getTitle, hideInfoWindow, isInfoWindowShown, setRightOffsetPixels, setSnippet, setTitle, setTopOffsetPixels, showInfoWindow

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerView

public MarkerView(BaseMarkerViewOptions baseMarkerViewOptions)

Creates a instance of MarkerView using the builder of MarkerView

Parameters:

baseMarkerViewOptions - the builder used to construct the MarkerView

Method Detail

setAnchor

public void setAnchor(float u,
                      float v)

Specifies the anchor being set on a particular point point of the MarkerView.

The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0], where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.

Parameters:

u - u-coordinate of the anchor, as a ratio of the image width (in the range [0, 1])

v - v-coordinate of the anchor, as a ratio of the image height (in the range [0, 1])

getAnchorU

public float getAnchorU()

Get the horizontal distance, normalized to [0, 1], of the anchor from the left edge.

Returns:

the u-value of the anchor

getAnchorV

public float getAnchorV()

Get the vertical distance, normalized to [0, 1], of the anchor from the top edge.

Returns:

the v-value of the anchor

setInfoWindowAnchor

public void setInfoWindowAnchor(float u,
                                float v)

Specifies the anchor point of the info window on the View of the MarkerView.

This is specified in the same coordinate system as the anchor.

The default is the top middle of the View.

Parameters:

u - u-coordinate of the info window anchor, as a ratio of the image width (in the range [0, 1])

v - v-coordinate of the info window anchor, as a ratio of the image height (in the range [0, 1])

See Also:

for more details.

getInfoWindowAnchorU

public float getInfoWindowAnchorU()

Get the horizontal distance, normalized to [0, 1], of the info window anchor from the left edge.

Returns:

the u value of the InfoWindow anchor.

getInfoWindowAnchorV

public float getInfoWindowAnchorV()

Get the vertical distance, normalized to [0, 1], of the info window anchor from the top edge.

Returns:

the v value of the InfoWindow anchor.

isFlat

public boolean isFlat()

Get the flat state of a MarkerView.

Returns:

true is the MarkerView is flat; false is the MarkerView is billboard

setFlat

public void setFlat(boolean flat)

Sets whether this marker should be flat against the map true or a billboard facing the camera false.

Parameters:

flat - the flat state of the MarkerView

setVisible

public void setVisible(boolean visible)

Set the visible state of a MarkerView.

Parameters:

visible - true will make the MarkerView visible, false will hide the MarkerViews

isVisible

public boolean isVisible()

Returns the visible state of the MarkerView.

Returns:

the visible state

setRotation

public void setRotation(float rotation)

Set the rotation value of the MarkerView.

This will result in animating the rotation of the MarkerView using an rotation animator from current value to the provided parameter value.

Parameters:

rotation - the rotation value to animate to

getRotation

public float getRotation()

Get the rotation value of the MarkerView.

Returns:

the rotation value

getAlpha

public float getAlpha()

Get the alpha value of the MarkerView.

Returns:

the alpha value

setAlpha

public void setAlpha(float alpha)

Set the alpha value of the MarkerView.

This will result in animating the alpha of the MarkerView using an alpha animator from current value to the provided parameter value.

Parameters:

alpha - the alpha value to animate to

setIcon

public void setIcon(Icon icon)

Set the icon of the MarkerView.

Overrides:

setIcon in class Marker

Parameters:

icon - the icon to be used as Marker image

setPosition

public void setPosition(LatLng position)

Description copied from class: Marker

Sets the position.

Overrides:

setPosition in class Marker

Parameters:

position - new position

isSelected

public boolean isSelected()

getIcon

public Icon getIcon()

Get the icon of the MarkerView.

Overrides:

getIcon in class Marker

Returns:

the icon use as Marker image

setMapboxMap

public void setMapboxMap(MapboxMap mapboxMap)

Set the MapboxMap associated tot the MapView containing the MarkerView.

This method is used to instantiate the MarkerView and provide an instance of MapboxMap.MarkerViewAdapter

Overrides:

setMapboxMap in class Annotation

Parameters:

mapboxMap - the MapboxMap instances

toString

public java.lang.String toString()

Get the String representation of a MarkerView.

Overrides:

toString in class Marker

Returns:

the String representation