mapbox-maps-android/com.mapbox.maps.plugin.compass/CompassPlugin

CompassPlugin

interface CompassPlugin : ViewPlugin, MapCameraPlugin, LifecyclePlugin, CompassSettingsInterface

Presenter interface for the Compass.

Functions

addCompassClickListener

androidJvm

abstract fun addCompassClickListener(onClickListener: OnCompassClickListener)

Add an OnClick listener to the presenter.

bind

androidJvm

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

Bind a view instance

cleanup

androidJvm

open fun cleanup()

Called when the map is destroyed.

equals

androidJvm

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

getSettings

androidJvm

abstract fun getSettings(): CompassSettings

Get current compass configuration.

hashCode

androidJvm

open fun hashCode(): Int

initialize

androidJvm

open fun initialize()

Called when the plugin is first added to the map.

onCameraMove

androidJvm

@AnyThread()

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

Called whenever camera position changes.

onCompassClicked

androidJvm

abstract fun onCompassClicked()

Invoked when the compass view is clicked.

onDelegateProvider

androidJvm

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onPluginView

androidJvm

open fun onPluginView(view: View)

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

onStart

androidJvm

open fun onStart()

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

onStop

androidJvm

open fun onStop()

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

removeCompassClickListener

androidJvm

abstract fun removeCompassClickListener(onClickListener: OnCompassClickListener)

Remove an OnClick listener from the presenter.

toString

androidJvm

open fun toString(): String

updateSettings

androidJvm

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

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

Properties

clickable

androidJvm

abstract var clickable: Boolean

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

enabled

androidJvm

abstract var enabled: Boolean

Whether the compass is visible on the map.

fadeWhenFacingNorth

androidJvm

abstract var fadeWhenFacingNorth: Boolean

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

image

androidJvm

abstract var image: Drawable?

The compass image, the visual representation of the compass.

marginBottom

androidJvm

abstract var marginBottom: Float

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

marginLeft

androidJvm

abstract var marginLeft: Float

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

marginRight

androidJvm

abstract var marginRight: Float

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

marginTop

androidJvm

abstract var marginTop: Float

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

opacity

androidJvm

abstract var opacity: Float

The alpha channel value of the compass image

position

androidJvm

abstract var position: Int

Defines where the compass is positioned on the map

rotation

androidJvm

abstract var rotation: Float

The clockwise rotation value in degrees of the compass.

visibility

androidJvm

abstract var visibility: Boolean

Whether the compass is displayed.

Inheritors

CompassViewPlugin