CompassPlugin

Presenter interface for the Compass.

Functions

addCompassClickListener
Link copied to clipboard

Add an OnClick listener to the presenter.

abstract fun addCompassClickListener(onClickListener: OnCompassClickListener)
bind
Link copied to clipboard

Bind a view instance

abstract override fun bind(mapView: FrameLayout, attrs: AttributeSet?, pixelRatio: Float): View
cleanup
Link copied to clipboard
open override fun cleanup()
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getSettings
Link copied to clipboard

Get current compass configuration.

abstract override fun getSettings(): CompassSettings
hashCode
Link copied to clipboard
open override fun hashCode(): Int
initialize
Link copied to clipboard
open override fun initialize()
onCameraMove
Link copied to clipboard

Called whenever camera position changes. Could be invoked from any thread when map starts rendering.

abstract override fun onCameraMove(lat: Double, lon: Double, zoom: Double, pitch: Double, bearing: Double, padding: Array<Double>)
onCompassClicked
Link copied to clipboard

Invoked when the compass view is clicked.

abstract fun onCompassClicked()
onDelegateProvider
Link copied to clipboard
open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)
onPluginView
Link copied to clipboard

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

open override fun onPluginView(view: View)
onStart
Link copied to clipboard

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

open override fun onStart()
onStop
Link copied to clipboard

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

open override fun onStop()
removeCompassClickListener
Link copied to clipboard

Remove an OnClick listener from the presenter.

abstract fun removeCompassClickListener(onClickListener: OnCompassClickListener)
toString
Link copied to clipboard
open override fun toString(): String
updateSettings
Link copied to clipboard

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

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

Properties

clickable
Link copied to clipboard

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

abstract override var clickable: Boolean
enabled
Link copied to clipboard

Whether the compass is visible on the map.

abstract override var enabled: Boolean
fadeWhenFacingNorth
Link copied to clipboard

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

abstract override var fadeWhenFacingNorth: Boolean
image
Link copied to clipboard

The compass image, the visual representation of the compass.

abstract override var image: Drawable?
marginBottom
Link copied to clipboard

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

abstract override var marginBottom: Float
marginLeft
Link copied to clipboard

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

abstract override var marginLeft: Float
marginRight
Link copied to clipboard

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

abstract override var marginRight: Float
marginTop
Link copied to clipboard

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

abstract override var marginTop: Float
opacity
Link copied to clipboard

The alpha channel value of the compass image

abstract override var opacity: Float
position
Link copied to clipboard

Defines where the compass is positioned on the map

abstract override var position: Int
rotation
Link copied to clipboard

The clockwise rotation value in degrees of the compass.

abstract override var rotation: Float
visibility
Link copied to clipboard

Whether the compass is displayed.

abstract override var visibility: Boolean

Inheritors

CompassViewPlugin
Link copied to clipboard