mapbox-maps-android/com.mapbox.maps.plugin.scalebar/ScaleBarPluginImpl

ScaleBarPluginImpl

Concrete implementation of ScaleBarViewPlugin.

open class ScaleBarPluginImpl(viewImplProvider: (Context) -> ScaleBarImpl) : ScaleBarSettingsBase, ScaleBarPlugin

Constructors

ScaleBarPluginImpl

fun ScaleBarPluginImpl(viewImplProvider: (Context) -> ScaleBarImpl)

Functions

bind

Bind the ViewPlugin with current map context. This will create a View that will be added to the MapView.

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

cleanup

Called when the map is destroyed. Should be used to cleanup plugin resources for that map.

open override fun cleanup()

equals

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

getSettings

open override fun getSettings(): ScaleBarSettings

hashCode

open override fun hashCode(): Int

initialize

Called when the plugin is first added to the map.

open override fun initialize()

onDelegateProvider

Provides all map delegate instances.

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

onPluginView

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

open override fun onPluginView(view: View)

onSizeChanged

Invoked when MapView's width and height have changed.

open override fun onSizeChanged(width: Int, height: Int)

toString

open override fun toString(): String

updateSettings

open override fun updateSettings(block: ScaleBarSettings.() -> Unit)

Properties

borderWidth

open override var borderWidth: Float

distancePerPixel

How many meters in each pixel.

open override var distancePerPixel: Float

enabled

Defines whether the plugins is enabled or disabled.

open override var enabled: Boolean

height

open override var height: Float

isMetricUnits

open override var isMetricUnits: Boolean

marginBottom

open override var marginBottom: Float

marginLeft

open override var marginLeft: Float

marginRight

open override var marginRight: Float

marginTop

open override var marginTop: Float

position

open override var position: Int

primaryColor

open override var primaryColor: Int

ratio

open override var ratio: Float

refreshInterval

open override var refreshInterval: Long

secondaryColor

open override var secondaryColor: Int

showTextBorder

open override var showTextBorder: Boolean

textBarMargin

open override var textBarMargin: Float

textBorderWidth

open override var textBorderWidth: Float

textColor

open override var textColor: Int

textSize

open override var textSize: Float

useContinuousRendering

If set to True scale bar will be triggering onDraw depending on ScaleBarSettings.refreshInterval even if actual data did not change. If set to False scale bar will redraw only on demand.

Defaults to False and should not be changed explicitly in most cases. Could be set to True to produce correct GPU frame metrics when running gfxinfo command.

open override var useContinuousRendering: Boolean