com.tomtom.sdk.maps:map-display-api/com.tomtom.sdk.map.display.ui/MapView

MapView

class MapView : FrameLayout, UiComponents, LifecycleAware, MapProvider

MapView to wrap the underlying map renderer. It handles application lifecycle events in order to properly manage the lifecycle of the map. The view can be created programmatically or via the XML view inflation. See MapResources to check what attributes can be configured via XML.

Direct usage of this class must ensure binding between the following lifecycle methods:

onCreate(bundle: Bundle?)- called when the parent, lifecycle aware component is being created. The bundle argument contains extra data which shall be handled by calling the corresponding onSaveInstanceState(bundle: Bundle) callback.
onStart() - called when the parent component is visible to the user.
onResume() - called when the parent component is visible to the user and actively running.
onPause() - called when the parent component is no longer resumed.
onStop() - called when the parent component is no longer started.
onSaveInstanceState(bundle: Bundle) - called when the parent component saves its instance state. See the onSaveInstanceState(bundle: Bundle) for a sample usage of this callback.
onDestroy() - called when the parent component is being destroyed.

Constructors

MapView

constructor(context: Context, mapOptions: MapOptions)

Creates a MapView with a default Android environment.

constructor(context: Context, attrs: AttributeSet)

Creates a MapView with a default Android environment, used when inflating from XML.

Properties

balloonsViewContainer

open override val balloonsViewContainer: ViewGroup

This provides access to the container view that holds all balloon views associated with markers on the map.

compassButton

open override val compassButton: CompassButton

This provides access to the compass button UI component on the MapView. This button adjusts the map to a northern orientation.

currentLocationButton

open override val currentLocationButton: CurrentLocationButton

This provides access to the current location button UI component on the MapView. This button can be used to move the map's focus to the user's current location.

logoView

open override val logoView: LogoView

This provides access to the logo view UI component on the MapView. This view displays the TomTom logo, representing the map provider.

markerBalloonViewAdapter

open override var markerBalloonViewAdapter: BalloonViewAdapter

This gets or sets the adapter responsible for providing and managing balloon views associated with markers on the map.

scaleView

open override val scaleView: ScaleView

This provides access to the scale view UI component on the MapView. This view displays the current scale of the map.

zoomControlsView

open override val zoomControlsView: ZoomControlsView

This provides access to the zoom controls UI component on the MapView. These controls can be used to zoom in and out on the map.

Functions

getMapAsync

@MainThread

open override fun getMapAsync(callback: MapReadyCallback): Cancellable

Fetches a map instance asynchronously. The provided callback is invoked when the map instance is ready for use.

onCreate

open override fun onCreate(bundle: Bundle?)

This handles the 'onCreate' lifecycle event. It initializes the MapView internals and UI components.

onDestroy

open override fun onDestroy()

This handles the 'onDestroy' lifecycle event. It is called when the parent component is being destroyed. This ensures the internal map view components are properly shut down and resources are freed.

onPause

open override fun onPause()

This handles the 'onPause' lifecycle event. It is called when the parent component is no longer resumed but still visible. This ensures the internal map view components pause their active processes to conserve resources.

onResume

open override fun onResume()

This handles the 'onResume' lifecycle event. It is called when the parent component is visible to the user and actively running. This ensures the internal map view components are active and updated.

onSaveInstanceState

open override fun onSaveInstanceState(bundle: Bundle)

This handles the 'onSaveInstanceState' lifecycle event. It is called when the parent component saves its instance state. Stores the current state of the MapView component, ensuring that the state can be restored after a configuration change or other events that restart the component.

onStart

open override fun onStart()

This handles the 'onStart' lifecycle event. It is called when the parent component becomes visible to the user. This ensures the internal map view components are ready to display.

onStop

open override fun onStop()

This handles the 'onStop' lifecycle event. It is called when the parent component is no longer visible to the user. This ensures the internal map view components stop all active processes to conserve resources.

onTouchEvent

open override fun onTouchEvent(event: MotionEvent): Boolean

Overridden in order to support internal map gestures. Usually the parent component does not have to call this method manually as it is called by the Android Framework.

MapView

Constructors

Properties

Functions

Inherited functions