maps:display/com.tomtom.sdk.map.display.ui.compass/CompassButton

CompassButton

interface CompassButton

Defines the properties of a compass.

Types

Link copied to clipboard
@JvmInline
value class VisibilityPolicy

Defines the visibility policy of the CompassButton.

Functions

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

Registers 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 rotated. The icon will not be changed immediately if the compass is not rotated.

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
@get:DrawableRes
abstract var northUpIcon: Int

Defines the icon that is displayed when the compass moves to a north up position and before it becomes transparent. The icon will not be changed immediately if the compass is rotated.

Link copied to clipboard
abstract var visibilityPolicy: CompassButton.VisibilityPolicy

Defines the visibility policy of the compass button.