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

Link copied to clipboard

Functions

Link copied to clipboard
open override fun getSettings(): CompassSettings

Get current compass configuration.

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

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

Properties

Link copied to clipboard
open override var clickable: Boolean

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

Link copied to clipboard
open override var enabled: Boolean

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

Link copied to clipboard
open override var fadeWhenFacingNorth: Boolean

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

Link copied to clipboard
open override var image: ImageHolder?

The compass image, the visual representation of the compass.

Link copied to clipboard
open override var marginBottom: Float

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

Link copied to clipboard
open override var marginLeft: Float

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

Link copied to clipboard
open override var marginRight: Float

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

Link copied to clipboard
open override var marginTop: Float

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

Link copied to clipboard
open override var opacity: Float

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

Link copied to clipboard
open override var position: Int

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

Link copied to clipboard
open override var rotation: Float

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

Link copied to clipboard
open override var visibility: Boolean

Whether the compass is displayed. Default value: true.