CompassSettingsBase

abstract class CompassSettingsBase : CompassSettingsInterface
Content copied to clipboard

Abstract settings class for CompassPlugin.

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

Constructors

CompassSettingsBase
Link copied to clipboard
fun CompassSettingsBase()
Content copied to clipboard

Functions

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

Get current compass configuration.

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

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

Properties

clickable
Link copied to clipboard
open override var clickable: Boolean
Content copied to clipboard

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

enabled
Link copied to clipboard
open override var enabled: Boolean
Content copied to clipboard

Whether the compass is visible on the map.

fadeWhenFacingNorth
Link copied to clipboard
open override var fadeWhenFacingNorth: Boolean
Content copied to clipboard

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

image
Link copied to clipboard
open override var image: Drawable?
Content copied to clipboard

The compass image, the visual representation of the compass.

marginBottom
Link copied to clipboard
open override var marginBottom: Float
Content copied to clipboard

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

marginLeft
Link copied to clipboard
open override var marginLeft: Float
Content copied to clipboard

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

marginRight
Link copied to clipboard
open override var marginRight: Float
Content copied to clipboard

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

marginTop
Link copied to clipboard
open override var marginTop: Float
Content copied to clipboard

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

opacity
Link copied to clipboard
open override var opacity: Float
Content copied to clipboard

The alpha channel value of the compass image

position
Link copied to clipboard
open override var position: Int
Content copied to clipboard

Defines where the compass is positioned on the map

rotation
Link copied to clipboard
open override var rotation: Float
Content copied to clipboard

The clockwise rotation value in degrees of the compass.

visibility
Link copied to clipboard
open override var visibility: Boolean
Content copied to clipboard

Whether the compass is displayed.

Inheritors

CompassViewPlugin
Link copied to clipboard