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

CompassViewPlugin

open class CompassViewPlugin(viewImplProvider: (Context) -> CompassViewImpl, fadeAnimator: ValueAnimator, mainHandler: Handler) : CompassSettingsBase, CompassPlugin

Concrete implementation of CompassPlugin.

Constructors

CompassViewPlugin

androidJvm

fun CompassViewPlugin(viewImplProvider: (Context) -> CompassViewImpl = { CompassViewImpl(it) }, fadeAnimator: ValueAnimator = ValueAnimator.ofFloat(1f, 0f), mainHandler: Handler = Handler(Looper.getMainLooper()))

Types

Companion

androidJvm

object Companion

Static variables and methods.

Functions

addCompassClickListener

androidJvm

open override fun addCompassClickListener(onClickListener: OnCompassClickListener)

Add an OnClick listener to the presenter.

bind

androidJvm

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

Bind the ViewPlugin with current map context.

cleanup

androidJvm

open override fun cleanup()

Called when the map is destroyed.

equals

androidJvm

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

getSettings

androidJvm

abstract fun getSettings(): CompassSettings

hashCode

androidJvm

open fun hashCode(): Int

initialize

androidJvm

open override fun initialize()

Called when the plugin is first added to the map.

onCameraMove

androidJvm

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

Called whenever camera position changes.

onCompassClicked

androidJvm

open override fun onCompassClicked()

Invoked when the compass view is clicked.

onDelegateProvider

androidJvm

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onPluginView

androidJvm

open override fun onPluginView(view: View)

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

onStart

androidJvm

open override fun onStart()

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

onStop

androidJvm

open override fun onStop()

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

removeCompassClickListener

androidJvm

open override 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)

Properties

clickable

androidJvm

abstract var clickable: Boolean

enabled

androidJvm

open override var enabled: Boolean

Defines whether the plugins is enabled or disabled.

fadeWhenFacingNorth

androidJvm

abstract var fadeWhenFacingNorth: Boolean

image

androidJvm

abstract var image: Drawable?

marginBottom

androidJvm

abstract var marginBottom: Float

marginLeft

androidJvm

abstract var marginLeft: Float

marginRight

androidJvm

abstract var marginRight: Float

marginTop

androidJvm

abstract var marginTop: Float

opacity

androidJvm

abstract var opacity: Float

position

androidJvm

abstract var position: Int

rotation

androidJvm

abstract var rotation: Float

visibility

androidJvm

abstract var visibility: Boolean