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

ScaleBarPlugin

interface ScaleBarPlugin : ViewPlugin, MapSizePlugin, ScaleBarSettingsInterface

Presenter interface for the ScaleBar.

Functions

bind

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

Bind a view instance

cleanup

open fun cleanup()

Called when the map is destroyed.

equals

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

getSettings

abstract fun getSettings(): ScaleBarSettings

Get current scalebar configuration.

hashCode

open fun hashCode(): Int

initialize

open fun initialize()

Called when the plugin is first added to the map.

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onPluginView

open fun onPluginView(view: View)

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

onSizeChanged

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

Invoked when MapView's width and height have changed.

toString

open fun toString(): String

updateSettings

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

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

Properties

borderWidth

abstract var borderWidth: Float

Defines width of the border for the scale bar.

distancePerPixel

abstract var distancePerPixel: Float

How many meters in each pixel.

enabled

abstract var enabled: Boolean

Whether the scale is visible on the map.

height

abstract var height: Float

Defines height of the scale bar.

isMetricUnits

abstract var isMetricUnits: Boolean

Whether the scale bar is using metric unit.

marginBottom

abstract var marginBottom: Float

Defines the margin to the bottom that the scale bar honors.

marginLeft

abstract var marginLeft: Float

Defines the margin to the left that the scale bar honors.

marginRight

abstract var marginRight: Float

Defines the margin to the right that the scale bar honors.

marginTop

abstract var marginTop: Float

Defines the margin to the top that the scale bar honors.

position

abstract var position: Int

Defines where the scale bar is positioned on the map

primaryColor

abstract var primaryColor: Int

Defines primary color of the scale bar.

ratio

abstract var ratio: Float

configures ratio of scale bar max width compared with MapView width, default is 0.5.

refreshInterval

abstract var refreshInterval: Long

Configures minimum refresh interval, in millisecond, default is 15.

secondaryColor

abstract var secondaryColor: Int

Defines secondary color of the scale bar.

showTextBorder

abstract var showTextBorder: Boolean

Configures whether to show the text border or not, default is true.

textBarMargin

abstract var textBarMargin: Float

Defines margin of the text bar of the scale bar.

textBorderWidth

abstract var textBorderWidth: Float

Defines text border width of the scale bar.

textColor

abstract var textColor: Int

Defines text color of the scale bar.

textSize

abstract var textSize: Float

Defines text size of the scale bar.

useContinuousRendering

abstract var useContinuousRendering: Boolean

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

Inheritors

ScaleBarPluginImpl