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

ScaleBarPlugin

interface ScaleBarPlugin : ViewPlugin, MapSizePlugin, ScaleBarSettingsInterface

Presenter interface for the ScaleBar.

Functions

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

Bind a view instance

open fun cleanup()

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

abstract fun getSettings(): ScaleBarSettings

Get current scalebar configuration.

open fun initialize()

Called when the plugin is first added to the map.

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

open fun onPluginView(view: View)

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

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

Invoked when MapView's width and height have changed.

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

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

Properties

abstract var borderWidth: Float

Defines width of the border for the scale bar.

distancePerPixel

abstract var distancePerPixel: Float

How many meters in each pixel.

abstract var enabled: Boolean

Whether the scale is visible on the map.

abstract var height: Float

Defines height of the scale bar.

abstract var isMetricUnits: Boolean

Whether the scale bar is using metric unit. True if the scale bar is using metric system, false if the scale bar is using imperial units.

abstract var marginBottom: Float

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

abstract var marginLeft: Float

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

abstract var marginRight: Float

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

abstract var marginTop: Float

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

abstract var position: Int

Defines where the scale bar is positioned on the map

abstract var primaryColor: Int

Defines primary color of the scale bar.

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.

abstract var secondaryColor: Int

Defines secondary color of the scale bar.

abstract var showTextBorder: Boolean

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

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.

abstract var textColor: Int

Defines text color of the scale bar.

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. 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.