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

androidJvm

fun CompassSettingsBase()

Functions

equals

androidJvm

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

getSettings

androidJvm

open override fun getSettings(): CompassSettings

Get current compass configuration.

hashCode

androidJvm

open fun hashCode(): Int

toString

androidJvm

open fun toString(): String

updateSettings

androidJvm

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

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

Properties

clickable

androidJvm

open override var clickable: Boolean

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

enabled

androidJvm

open override var enabled: Boolean

Whether the compass is visible on the map.

fadeWhenFacingNorth

androidJvm

open override var fadeWhenFacingNorth: Boolean

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

image

androidJvm

open override var image: Drawable?

The compass image, the visual representation of the compass.

marginBottom

androidJvm

open override var marginBottom: Float

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

marginLeft

androidJvm

open override var marginLeft: Float

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

marginRight

androidJvm

open override var marginRight: Float

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

marginTop

androidJvm

open override var marginTop: Float

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

opacity

androidJvm

open override var opacity: Float

The alpha channel value of the compass image

position

androidJvm

open override var position: Int

Defines where the compass is positioned on the map

rotation

androidJvm

open override var rotation: Float

The clockwise rotation value in degrees of the compass.

visibility

androidJvm

open override var visibility: Boolean

Whether the compass is displayed.

Inheritors

CompassViewPlugin