Mapbox Maps Android/com.mapbox.maps.plugin.compass.generated/CompassSettingsInterface

CompassSettingsInterface

Interface that defines the public settings interface for CompassPlugin.

interface CompassSettingsInterface

Functions

equals

open operator override fun equals(other: Any?): Boolean

getSettings

Get current compass configuration.

abstract fun getSettings(): CompassSettings

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

updateSettings

Update compass configuration, the update will be applied to the plugin automatically.

abstract fun updateSettings(block: CompassSettings.() -> Unit)

Properties

clickable

Whether the compass can be clicked and click events can be registered.

abstract var clickable: Boolean

enabled

Whether the compass is visible on the map.

abstract var enabled: Boolean

fadeWhenFacingNorth

Whether the compass fades out to invisible when facing north direction.

abstract var fadeWhenFacingNorth: Boolean

image

The compass image, the visual representation of the compass.

abstract var image: Drawable?

marginBottom

Defines the margin to the bottom that the compass icon honors.

abstract var marginBottom: Float

marginLeft

Defines the margin to the left that the compass icon honors.

abstract var marginLeft: Float

marginRight

Defines the margin to the right that the compass icon honors.

abstract var marginRight: Float

marginTop

Defines the margin to the top that the compass icon honors.

abstract var marginTop: Float

opacity

The alpha channel value of the compass image

abstract var opacity: Float

position

Defines where the compass is positioned on the map

abstract var position: Int

rotation

The clockwise rotation value in degrees of the compass.

abstract var rotation: Float

visibility

Whether the compass is displayed.

abstract var visibility: Boolean

Inheritors

CompassPlugin

CompassSettingsBase