RangeVisualization

Entry point for all methods related to the range visualization.

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

To use a RangeVisualization instance, first provide a Range with the RangeVisualization.display method.

You can then call clear to remove all the primitives that have been added to the map RangeVisualization.

To support Android configuration changes, create a RangeVisualization 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

Link copied to clipboard
abstract fun clear()

Remove the previous added Range from the map.

Link copied to clipboard
abstract fun close()
Link copied to clipboard
abstract fun display(range: Range)

Display a reachable Range on the map. Previous Range is removed from the map

Link copied to clipboard
abstract fun replaceMap(tomtomMap: TomTomMap)

Replaces the current TomTomMap with a new one.

Properties

Link copied to clipboard
abstract val activeRange: Range?

The active range displayed on the map or null if no range is being displayed.