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

CompassSettingsInterface

interface CompassSettingsInterface

Interface that defines the public settings interface for CompassPlugin.

Functions

getSettings

abstract fun getSettings(): CompassSettings

Get current compass configuration.

updateSettings

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

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

Properties

clickable

abstract var clickable: Boolean

Whether the compass can be clicked and click events can be registered. Default value: true.

enabled

abstract var enabled: Boolean

Whether the compass is visible on the map. Default value: true.

fadeWhenFacingNorth

abstract var fadeWhenFacingNorth: Boolean

Whether the compass fades out to invisible when facing north direction. Default value: true.

image

abstract var image: ImageHolder?

The compass image, the visual representation of the compass.

marginBottom

abstract var marginBottom: Float

Defines the margin to the bottom that the compass icon honors. Default value: 4.

marginLeft

abstract var marginLeft: Float

Defines the margin to the left that the compass icon honors. Default value: 4.

marginRight

abstract var marginRight: Float

Defines the margin to the right that the compass icon honors. Default value: 4.

marginTop

abstract var marginTop: Float

Defines the margin to the top that the compass icon honors. Default value: 4.

opacity

abstract var opacity: Float

The alpha channel value of the compass image Default value: 1.

position

abstract var position: Int

Defines where the compass is positioned on the map Default value: "top-right".

rotation

abstract var rotation: Float

The clockwise rotation value in degrees of the compass. Default value: 0.

visibility

abstract var visibility: Boolean

Whether the compass is displayed. Default value: true.

Inheritors

CompassPlugin

CompassSettingsBase