AdvancedMarkerOptions

public class AdvancedMarkerOptions extends MarkerOptions

Defines marker options for AdvancedMarker.

This class does not apply to the Navigation SDK. It exists for compile time compatibility with com.google.android.gms:play-services-maps only.

Nested Class Summary

@interface AdvancedMarkerOptions.CollisionBehavior Indicates how the marker is dealt with when involved in a collision with other markers or base map labels.

Inherited Constant Summary

From interface com.google.android.gms.common.internal.safeparcel.SafeParcelable

String NULL

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Public Constructor Summary

AdvancedMarkerOptions()

Public Method Summary

AdvancedMarkerOptions	alpha(float alpha) Sets the alpha (opacity) of the marker.
AdvancedMarkerOptions	anchor(float u, float v) Specifies the anchor to be at a particular point in the marker image.
AdvancedMarkerOptions	collisionBehavior(int collisionBehavior) This method is deprecated. No replacement.
AdvancedMarkerOptions	contentDescription(String contentDescription) Sets the content description of the marker.
AdvancedMarkerOptions	draggable(boolean draggable) Sets the draggability for the marker.
AdvancedMarkerOptions	flat(boolean flat) Sets whether this marker should be flat against the map `true` or a billboard facing the camera `false`.
int	getCollisionBehavior() This method is deprecated. No replacement.
View	getIconView() Gets the icon view instance for this `AdvancedMarkerOptions` object.
AdvancedMarkerOptions	icon(BitmapDescriptor iconDescriptor) Sets the icon for the marker.
AdvancedMarkerOptions	iconView(View view) Sets the view instance to be used as icon for the marker.
AdvancedMarkerOptions	infoWindowAnchor(float u, float v) Specifies the anchor point of the info window on the marker image.
AdvancedMarkerOptions	position(LatLng latlng) Sets the location for the marker.
AdvancedMarkerOptions	rotation(float rotation) Sets the rotation of the marker in degrees clockwise about the marker's anchor point.
AdvancedMarkerOptions	snippet(String snippet) Sets the snippet for the marker.
AdvancedMarkerOptions	title(String title) Sets the title for the marker.
AdvancedMarkerOptions	visible(boolean visible) Sets the visibility for the marker.
AdvancedMarkerOptions	zIndex(float zIndex) Sets the zIndex for the marker.

Inherited Method Summary

From class com.google.android.gms.maps.model.MarkerOptions

MarkerOptions	alpha(float alpha) Sets the alpha (opacity) of the marker.
MarkerOptions	anchor(float u, float v) Specifies the anchor to be at a particular point in the marker image.
MarkerOptions	collisionBehavior(int collisionBehavior) This method is deprecated. No replacement.
MarkerOptions	contentDescription(String contentDescription) Sets the content description of the marker.
MarkerOptions	draggable(boolean draggable) Sets the draggability for the marker.
MarkerOptions	flat(boolean flat) Sets whether this marker should be flat against the map `true` or a billboard facing the camera `false`.
float	getAlpha() Gets the alpha set for this `MarkerOptions` object.
float	getAnchorU() Horizontal distance, normalized to [0, 1], of the anchor from the left edge.
float	getAnchorV() Vertical distance, normalized to [0, 1], of the anchor from the top edge.
int	getCollisionBehavior() This method is deprecated. No replacement.
String	getContentDescription() Gets the content description of this `MarkerOptions` object.
BitmapDescriptor	getIcon() Gets the custom icon descriptor set for this `MarkerOptions` object.
float	getInfoWindowAnchorU() Horizontal distance, normalized to [0, 1], of the info window anchor from the left edge.
float	getInfoWindowAnchorV() Vertical distance, normalized to [0, 1], of the info window anchor from the top edge.
LatLng	getPosition() Returns the position set for this `MarkerOptions` object.
float	getRotation() Gets the rotation set for this `MarkerOptions` object.
String	getSnippet() Gets the snippet, text displayed below the marker's title, for this `MarkerOptions` object.
String	getTitle() Gets the title set for this `MarkerOptions` object.
float	getZIndex() Gets the zIndex set for this `MarkerOptions` object.
MarkerOptions	icon(BitmapDescriptor iconDescriptor) Sets the icon for the marker.
MarkerOptions	infoWindowAnchor(float u, float v) Specifies the anchor point of the info window on the marker image.
boolean	isDraggable() Gets the draggability setting for this `MarkerOptions` object.
boolean	isFlat() Gets the flat setting for this `MarkerOptions` object.
boolean	isVisible() Gets the visibility setting for this `MarkerOptions` object.
MarkerOptions	position(LatLng latlng) Sets the location for the marker.
MarkerOptions	rotation(float rotation) Sets the rotation of the marker in degrees clockwise about the marker's anchor point.
MarkerOptions	snippet(String snippet) Sets the snippet for the marker.
MarkerOptions	title(String title) Sets the title for the marker.
MarkerOptions	visible(boolean visible) Sets the visibility for the marker.
void	writeToParcel(Parcel out, int flags)
MarkerOptions	zIndex(float zIndex) Sets the zIndex for the marker.

From class com.google.android.gms.common.internal.safeparcel.AbstractSafeParcelable

final int

describeContents()

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Public Constructors

public AdvancedMarkerOptions ()

Public Methods

public AdvancedMarkerOptions alpha (float alpha)

Sets the alpha (opacity) of the marker. This is a value from 0 to 1, where 0 means the marker is completely transparent and 1 means the marker is completely opaque.

Parameters

alpha

Returns

the object for which the method was called, with the new alpha set.

public AdvancedMarkerOptions anchor (float u, float v)

Specifies the anchor to be at a particular point in the marker image.

The anchor specifies the point in the icon image that is anchored to the marker's position on the Earth's surface.

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. The anchoring point in a W x H image is the nearest discrete grid point in a (W + 1) x (H + 1) grid, obtained by scaling the then rounding. For example, in a 4 x 2 image, the anchor point (0.7, 0.6) resolves to the grid point at (3, 1).

 *-----+-----+-----+-----*
 |     |     |     |     |
 |     |     |     |     |
 +-----+-----+-----+-----+
 |     |     |   X |     |   (U, V) = (0.7, 0.6)
 |     |     |     |     |
 *-----+-----+-----+-----*
 *-----+-----+-----+-----*
 |     |     |     |     |
 |     |     |     |     |
 +-----+-----+-----X-----+   (X, Y) = (3, 1)
 |     |     |     |     |
 |     |     |     |     |
 *-----+-----+-----+-----*

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])

Returns

the object for which the method was called, with the new anchor set.

public AdvancedMarkerOptions collisionBehavior (int collisionBehavior)

This method is deprecated.
No replacement.

Sets the AdvancedMarkerOptions.CollisionBehavior of the marker.

Parameters

collisionBehavior

Returns

the object for which the method was called, with the collision state set.

public AdvancedMarkerOptions contentDescription (String contentDescription)

Sets the content description of the marker. This text may be read aloud if android's talkback accessibility feature is enabled.

This API does not apply to the Navigation SDK. It exists for compile time compatibility with com.google.android.gms:play-services-maps only.

Parameters

contentDescription

Returns

the object for which the method was called, with the new content description set

public AdvancedMarkerOptions draggable (boolean draggable)

Sets the draggability for the marker.

Parameters

draggable

Returns

the object for which the method was called, with the new draggable state set.

public AdvancedMarkerOptions flat (boolean flat)

Sets whether this marker should be flat against the map true or a billboard facing the camera false. If the marker is flat against the map, it will always be drawn facing the camera and will rotate and tilt with the camera, unlike a GroundOverlay. If the marker is a billboard, it will remain stuck to the map as the camera rotates and tilts. Both flat and billboard markers remain the same size as the camera zooms. The default value is false.

Parameters

flat

Returns

the object for which the method was called, with the new flat state set.

public int getCollisionBehavior ()

This method is deprecated.
No replacement.

Gets the AdvancedMarkerOptions.CollisionBehavior for this AdvancedMarkerOptions object.

Returns

the collision behavior.

public View getIconView ()

Gets the icon view instance for this AdvancedMarkerOptions object.

Returns

the icon view instance.

public AdvancedMarkerOptions icon (BitmapDescriptor iconDescriptor)

Sets the icon for the marker.

Parameters

iconDescriptor	if `null`, the default marker is used.

Returns

the object for which the method was called, with the new icon descriptor set.

public AdvancedMarkerOptions iconView (View view)

Sets the view instance to be used as icon for the marker.

If iconView is set, the BitmapDescriptor set via icon(BitmapDescriptor) will be ignored.

Parameters

view	the View to be used as marker icon.

public AdvancedMarkerOptions infoWindowAnchor (float u, float v)

Specifies the anchor point of the info window on the marker image. This is specified in the same coordinate system as the anchor. See anchor(float, float) for more details. The default is the top middle of the image.

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])

Returns

the object for which the method was called, with the new info window anchor set.

public AdvancedMarkerOptions position (LatLng latlng)

Sets the location for the marker.

Parameters

latlng

Returns

the object for which the method was called, with the new position set.

public AdvancedMarkerOptions rotation (float rotation)

Sets the rotation of the marker in degrees clockwise about the marker's anchor point. The axis of rotation is perpendicular to the marker. A rotation of 0 corresponds to the default position of the marker. When the marker is flat on the map, the default position is North aligned and the rotation is such that the marker always remains flat on the map. When the marker is a billboard, the default position is pointing up and the rotation is such that the marker is always facing the camera. The default value is 0.

Parameters

rotation

Returns

the object for which the method was called, with the new rotation set.

public AdvancedMarkerOptions snippet (String snippet)

Sets the snippet for the marker.

Parameters

snippet

Returns

the object for which the method was called, with the new snippet set.

public AdvancedMarkerOptions title (String title)

Sets the title for the marker.

Parameters

title

Returns

the object for which the method was called, with the new title set.

public AdvancedMarkerOptions visible (boolean visible)

Sets the visibility for the marker.

Parameters

visible

Returns

the object for which the method was called, with the new visibility state set.

public AdvancedMarkerOptions zIndex (float zIndex)

Sets the zIndex for the marker.

Parameters

zIndex

Returns

the object for which the method was called, with the new zIndex set.