com.tomtom.online.sdk.map

Class MarkerBuilder

java.lang.Object

com.tomtom.online.sdk.map.MarkerBuilder

public class MarkerBuilder
extends java.lang.Object

Builder class used to construct marker object that can be added to the map.

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_ICON_SCALE

Constructor Summary

Constructors

Constructor and Description
MarkerBuilder(LatLng position)

Method Summary

Modifier and Type	Method and Description
Marker	build() Create an instance of a marker.
MarkerBuilder	decal(boolean decal) Whether the marker icon is to be attached to the map
MarkerBuilder	icon(Icon icon) Icon with name.
MarkerBuilder	iconAnchor(MarkerAnchor iconAnchor) Icon anchor points to the point on the icon which will be attached to the map.
MarkerBuilder	markerBalloon(BaseMarkerBalloon markerBalloon) Balloon that is to be shown when user clicks on the marker.
MarkerBuilder	shouldCluster(boolean shouldCluster) When true, marker will be clustered once this option is enabled.
MarkerBuilder	tag(java.io.Serializable tag) TAG is known android pattern to keep additional information.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ICON_SCALE

public static final float DEFAULT_ICON_SCALE

See Also:

Constant Field Values

Constructor Detail

MarkerBuilder

public MarkerBuilder(@NonNull
                     LatLng position)

Method Detail

tag

@NonNull
public MarkerBuilder tag(java.io.Serializable tag)

TAG is known android pattern to keep additional information.

Parameters:

tag - - serializable object

Returns:

builder

decal

@NonNull
public MarkerBuilder decal(boolean decal)

Whether the marker icon is to be attached to the map

Parameters:

decal - marker icon is to be attached to the map

Returns:

builder

icon

@NonNull
public MarkerBuilder icon(Icon icon)

Icon with name.

Parameters:

icon -

Returns:

iconAnchor

@NonNull
public MarkerBuilder iconAnchor(MarkerAnchor iconAnchor)

Icon anchor points to the point on the icon which will be attached to the map.

Parameters:

iconAnchor -

Returns:

markerBalloon

@NonNull
public MarkerBuilder markerBalloon(BaseMarkerBalloon markerBalloon)

Balloon that is to be shown when user clicks on the marker.

shouldCluster

@NonNull
public MarkerBuilder shouldCluster(boolean shouldCluster)

When true, marker will be clustered once this option is enabled. Default value is false.

build

@NonNull
public Marker build()

Create an instance of a marker.