com.tomtom.online.sdk.map

Interface MarkerSettings

All Superinterfaces:

com.tomtom.core.maps.OnMapTapListener, TomtomMapCallback.OnMapChangedListener

public interface MarkerSettings
extends com.tomtom.core.maps.OnMapTapListener, TomtomMapCallback.OnMapChangedListener

Advanced settings for markers manipulation. To obtain this interface, call TomtomMap.getMarkerSettings()

Method Summary

Modifier and Type	Method and Description
Marker	addMarker(MarkerBuilder markerBuilder) Add marker to map.
void	addOnMarkerClickListener(TomtomMapCallback.OnMarkerClickListener listener) Called to add a listener for marker clicks.
boolean	areMarkersActive() Indicates whether any markers are added on the map or not.
Optional<Marker>	findMarkerByID(long id) Find marker using its id.
Optional<Marker>	findMarkerByPosition(LatLng location) Find marker using its location (latitude, longitude).
java.util.List<Marker>	getMarkers() Get list of all markers added to map.
java.util.Collection<Marker>	getSelectedMarker() Get list of selected markers.
void	onViewStateRestored(com.tomtom.online.sdk.map.MapState savedState) Called internally to restore state, e.g.
void	removeMarker(Marker marker) Remove selected marker, if added to the map.
void	removeMarkerByID(long id) Remove marker by marker id.
void	removeMarkerByTag(java.io.Serializable tag) Remove all markers with tag.
void	removeMarkers() Remove all markers from the map.
void	removeOnMarkerClickListener(TomtomMapCallback.OnMarkerClickListener listener) Called to remove a listener for marker clicks.
void	removeOnMarkerClickListeners() Remove all registered marker click listeners.
void	setDefaultBehaviorWhenSelected(OnMarkerSelectedListener defaultBehaviorWhenSelected) Marker can be selected and deselected by user by touch events or programmatically.
void	setMarkersClustering(boolean enabled) Turn on / off markers clustering.
void	setMarkersClustering(boolean enabled, int radius, int maxZoom) Turn on / off markers clustering and provide custom parameters to customize the algorithm.
void	zoomToAllMarkers() Zoom map to level where all markers are visible.
void	zoomToMarkers(java.util.List<Marker> markers) Zoom to map markers.

Methods inherited from interface com.tomtom.core.maps.OnMapTapListener

onMapLongTap, onMapTap

Methods inherited from interface com.tomtom.online.sdk.map.TomtomMapCallback.OnMapChangedListener

onCameraDidChange, onCameraIsChanging, onCameraWillChange, onDidFailLoadingMap, onDidFinishLoadingMap, onDidFinishLoadingStyle, onDidFinishRenderingFrame, onDidFinishRenderingMap, onSourceChanged, onWillStartLoadingMap, onWillStartRenderingFrame, onWillStartRenderingMap

Method Detail

areMarkersActive

boolean areMarkersActive()

Indicates whether any markers are added on the map or not.

Returns:

True if markers are added on the map, false otherwise.

zoomToMarkers

void zoomToMarkers(java.util.List<Marker> markers)

Zoom to map markers. Map bounding box is calculated in a way that all markers are visible.

Parameters:

markers - List of markers to be shown.

getSelectedMarker

java.util.Collection<Marker> getSelectedMarker()

Get list of selected markers. In default implementation list should be empty or with one element

Returns:

selected markers.

onViewStateRestored

void onViewStateRestored(com.tomtom.online.sdk.map.MapState savedState)

Called internally to restore state, e.g. when app is resumed from the background.

setDefaultBehaviorWhenSelected

void setDefaultBehaviorWhenSelected(OnMarkerSelectedListener defaultBehaviorWhenSelected)

Marker can be selected and deselected by user by touch events or programmatically. Marker is selected when user tap on marker icon, other markers then are deselected. Markers are deselected when user tap on map. Default implementation shows popup when marker is selected.

Parameters:

defaultBehaviorWhenSelected -

setMarkersClustering

void setMarkersClustering(boolean enabled)

Turn on / off markers clustering. By default, clustering is not enabled.

setMarkersClustering

void setMarkersClustering(boolean enabled,
                          int radius,
                          int maxZoom)

Turn on / off markers clustering and provide custom parameters to customize the algorithm. By default, clustering is not enabled, maximum zoom level is set to 16 and radius is set to 50.

Parameters:

radius - Minimum distance in pixels between markers that defines whether they should be clustered or not.

maxZoom - Maximum zoom level to cluster the points on.

addMarker

Marker addMarker(MarkerBuilder markerBuilder)

Add marker to map. Define marker view na behavior by options.

Returns:

handle to marker.

getMarkers

java.util.List<Marker> getMarkers()

Get list of all markers added to map. Even marker which already not visible on map.

Returns:

list of all marker on the map.

findMarkerByPosition

Optional<Marker> findMarkerByPosition(LatLng location)

Find marker using its location (latitude, longitude).

findMarkerByID

Optional<Marker> findMarkerByID(long id)

Find marker using its id.

removeMarker

void removeMarker(Marker marker)

Remove selected marker, if added to the map.

Parameters:

marker -

removeMarkers

void removeMarkers()

Remove all markers from the map.

removeMarkerByID

void removeMarkerByID(long id)

Remove marker by marker id. Because id is unique, method should remove one marker.

removeMarkerByTag

void removeMarkerByTag(java.io.Serializable tag)

Remove all markers with tag.

zoomToAllMarkers

void zoomToAllMarkers()

Zoom map to level where all markers are visible.

addOnMarkerClickListener

void addOnMarkerClickListener(TomtomMapCallback.OnMarkerClickListener listener)

Called to add a listener for marker clicks.

Parameters:

listener - Listener to be added for marker clicks.

removeOnMarkerClickListener

void removeOnMarkerClickListener(TomtomMapCallback.OnMarkerClickListener listener)

Called to remove a listener for marker clicks.

Parameters:

listener - Listener to be removed for marker clicks.

removeOnMarkerClickListeners

void removeOnMarkerClickListeners()

Remove all registered marker click listeners.