mapbox-maps-android/com.mapbox.maps.plugin.compass.generated/CompassSettingsInterface

CompassSettingsInterface

interface CompassSettingsInterface

Interface that defines the public settings interface for CompassPlugin.

Functions

equals

androidJvm

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

getSettings

androidJvm

abstract fun getSettings(): CompassSettings

Get current compass configuration.

hashCode

androidJvm

open fun hashCode(): Int

toString

androidJvm

open fun toString(): String

updateSettings

androidJvm

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

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

Properties

clickable

androidJvm

abstract var clickable: Boolean

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

enabled

androidJvm

abstract var enabled: Boolean

Whether the compass is visible on the map.

fadeWhenFacingNorth

androidJvm

abstract var fadeWhenFacingNorth: Boolean

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

image

androidJvm

abstract var image: Drawable?

The compass image, the visual representation of the compass.

marginBottom

androidJvm

abstract var marginBottom: Float

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

marginLeft

androidJvm

abstract var marginLeft: Float

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

marginRight

androidJvm

abstract var marginRight: Float

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

marginTop

androidJvm

abstract var marginTop: Float

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

opacity

androidJvm

abstract var opacity: Float

The alpha channel value of the compass image

position

androidJvm

abstract var position: Int

Defines where the compass is positioned on the map

rotation

androidJvm

abstract var rotation: Float

The clockwise rotation value in degrees of the compass.

visibility

androidJvm

abstract var visibility: Boolean

Whether the compass is displayed.

Inheritors

CompassPlugin

CompassSettingsBase