maps:display/com.tomtom.sdk.map.display.ui.currentlocation/CurrentLocationButton

CurrentLocationButton

interface CurrentLocationButton

Defines the properties of a current location button.

Types

Link copied to clipboard
@JvmInline
value class VisibilityPolicy

Defines visibility behavior of the CurrentLocationButton.

Functions

Link copied to clipboard
abstract fun addCurrentLocationButtonClickListener(listener: UiComponentClickListener)

Registers an UiComponentClickListener which is notified when the user clicks on the compass.

Link copied to clipboard

Properties

Link copied to clipboard
@get:DrawableRes
abstract var icon: Int

Defines the icon that is displayed when the map is not centered on the user location.

Link copied to clipboard
abstract val isVisible: Boolean

Reports whether the view is currently visible on the screen.

Link copied to clipboard
abstract var margin: Margin

Defines the margin of the button.

Link copied to clipboard
abstract var visibilityPolicy: CurrentLocationButton.VisibilityPolicy

Defines the visibility policy of the current location button.