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

CompassSettingsBase

abstract class CompassSettingsBase : CompassSettingsInterface

Abstract settings class for CompassPlugin.

This abstract class exposes all the required public APIs to configure the CompassPlugin.

Constructors

CompassSettingsBase

fun CompassSettingsBase()

Functions

getSettings

open override fun getSettings(): CompassSettings

Get current compass configuration.

updateSettings

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

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

Properties

clickable

open override var clickable: Boolean

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

enabled

open override var enabled: Boolean

Whether the compass is visible on the map.

fadeWhenFacingNorth

open override var fadeWhenFacingNorth: Boolean

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

image

open override var image: ImageHolder?

The compass image, the visual representation of the compass.

marginBottom

open override var marginBottom: Float

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

marginLeft

open override var marginLeft: Float

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

marginRight

open override var marginRight: Float

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

marginTop

open override var marginTop: Float

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

opacity

open override var opacity: Float

The alpha channel value of the compass image

position

open override var position: Int

Defines where the compass is positioned on the map

rotation

open override var rotation: Float

The clockwise rotation value in degrees of the compass.

visibility

open override var visibility: Boolean

Whether the compass is displayed.