Mapbox Maps Android/com.mapbox.maps.plugin.compass/CompassPlugin

CompassPlugin

Presenter interface for the Compass.

interface CompassPlugin : ViewPlugin, MapCameraPlugin, LifecyclePlugin, CompassSettingsInterface

Functions

addCompassClickListener

Add an OnClick listener to the presenter.

abstract fun addCompassClickListener(onClickListener: OnCompassClickListener)

bind

Bind a view instance

abstract override fun bind(mapView: FrameLayout, attrs: AttributeSet?, pixelRatio: Float): View

cleanup

open override fun cleanup()

equals

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

getSettings

Get current compass configuration.

abstract override fun getSettings(): CompassSettings

hashCode

open override fun hashCode(): Int

initialize

open override fun initialize()

onCameraMove

Called whenever camera position changes.

abstract override fun onCameraMove(lat: Double, lon: Double, zoom: Double, pitch: Double, bearing: Double, padding: Array<Double>?, anchor: Pair<Double, Double>?)

onCompassClicked

Invoked when the compass view is clicked.

abstract fun onCompassClicked()

onDelegateProvider

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

onPluginView

Provides a view instances returned in inflate after it's been added to the MapView.

open override fun onPluginView(view: View)

onStart

Called whenever activity's/fragment's lifecycle is entering a "started" state.

open override fun onStart()

onStop

Called whenever activity's/fragment's lifecycle is entering a "stopped" state.

open override fun onStop()

removeCompassClickListener

Remove an OnClick listener from the presenter.

abstract fun removeCompassClickListener(onClickListener: OnCompassClickListener)

toString

open override fun toString(): String

updateSettings

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

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

Properties

clickable

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

abstract override var clickable: Boolean

enabled

Whether the compass is visible on the map.

abstract override var enabled: Boolean

fadeWhenFacingNorth

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

abstract override var fadeWhenFacingNorth: Boolean

image

The compass image, the visual representation of the compass.

abstract override var image: Drawable?

marginBottom

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

abstract override var marginBottom: Float

marginLeft

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

abstract override var marginLeft: Float

marginRight

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

abstract override var marginRight: Float

marginTop

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

abstract override var marginTop: Float

opacity

The alpha channel value of the compass image

abstract override var opacity: Float

position

Defines where the compass is positioned on the map

abstract override var position: Int

rotation

The clockwise rotation value in degrees of the compass.

abstract override var rotation: Float

visibility

Whether the compass is displayed.

abstract override var visibility: Boolean

Inheritors

CompassViewPlugin