com.tomtom.sdk.maps.visualization:poi/com.tomtom.sdk.map.display.visualization.poi/PoiVisualization

PoiVisualization

Entry point for all methods related to the Poi visualization.

Instances of PoiVisualization are created using PoiVisualizationFactory.create. You should call methods on these instances from the main thread only, otherwise an exception can occur.

To use a PoiVisualization instance, first provide a list of Poi with the PoiVisualization.display method.

You can then call PoiVisualization.display or clear to remove the Pois that have been added to the map by PoiVisualization.

To support Android configuration changes, create a PoiVisualization instance on the ViewModel and use replaceMap once the Activity/Fragment is recreated.

Important: This is a Public Preview API. It may be changed or removed at any time.

Functions

addPoiClickListener

abstract fun addPoiClickListener(listener: PoiClickListener)

Sets a listener for when a point of interest (Poi) is clicked by the user. Only one listener can be active at a time. Any previously set listener will be replaced by the new one.

clear

abstract fun clear()

Remove the previous added Pois from the map.

display

abstract fun display(poiList: List<Poi>)

Display a list of Pois on the map. If any Poi was already added before, it will not be added again.

remove

abstract fun remove(poiList: List<Poi>)

Remove Pois from the map if they were added before with PoiVisualization.display.

removePoiClickListener

abstract fun removePoiClickListener(listener: PoiClickListener)

Removes the PoiClickListener.

replaceMap

abstract fun replaceMap(tomtomMap: TomTomMap)

Replaces the current TomTomMap with a new one.