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

CompassSettingsInterface

interface CompassSettingsInterface

Interface that defines the public settings interface for CompassPlugin.

Functions

Link copied to clipboard
abstract fun getSettings(): CompassSettings

Get current compass configuration.

Link copied to clipboard
abstract fun updateSettings(block: CompassSettings.Builder.() -> Unit)

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

Properties

Link copied to clipboard
abstract var clickable: Boolean

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

Link copied to clipboard
abstract var enabled: Boolean

Whether the compass is visible on the map.

Link copied to clipboard
abstract var fadeWhenFacingNorth: Boolean

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

Link copied to clipboard
abstract var image: ImageHolder?

The compass image, the visual representation of the compass.

Link copied to clipboard
abstract var marginBottom: Float

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

Link copied to clipboard
abstract var marginLeft: Float

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

Link copied to clipboard
abstract var marginRight: Float

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

Link copied to clipboard
abstract var marginTop: Float

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

Link copied to clipboard
abstract var opacity: Float

The alpha channel value of the compass image

Link copied to clipboard
abstract var position: Int

Defines where the compass is positioned on the map

Link copied to clipboard
abstract var rotation: Float

The clockwise rotation value in degrees of the compass.

Link copied to clipboard
abstract var visibility: Boolean

Whether the compass is displayed.

Inheritors

Link copied to clipboard
Link copied to clipboard