Mapbox Maps Android/com.mapbox.maps.plugin.scalebar.generated/ScaleBarSettingsInterface

ScaleBarSettingsInterface

Interface that defines the public settings interface for ScaleBarPlugin.

interface ScaleBarSettingsInterface

Functions

equals

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

getSettings

Get current scalebar configuration.

abstract fun getSettings(): ScaleBarSettings

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

updateSettings

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

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

Properties

borderWidth

Defines width of the border for the scale bar.

abstract var borderWidth: Float

enabled

Whether the scale is visible on the map.

abstract var enabled: Boolean

height

Defines height of the scale bar.

abstract var height: Float

isMetricUnits

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 isMetricUnits: Boolean

marginBottom

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

abstract var marginBottom: Float

marginLeft

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

abstract var marginLeft: Float

marginRight

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

abstract var marginRight: Float

marginTop

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

abstract var marginTop: Float

position

Defines where the scale bar is positioned on the map

abstract var position: Int

primaryColor

Defines primary color of the scale bar.

abstract var primaryColor: Int

ratio

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

abstract var ratio: Float

refreshInterval

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

abstract var refreshInterval: Long

secondaryColor

Defines secondary color of the scale bar.

abstract var secondaryColor: Int

showTextBorder

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

abstract var showTextBorder: Boolean

textBarMargin

Defines margin of the text bar of the scale bar.

abstract var textBarMargin: Float

textBorderWidth

Defines text border width of the scale bar.

abstract var textBorderWidth: Float

textColor

Defines text color of the scale bar.

abstract var textColor: Int

textSize

Defines text size of the scale bar.

abstract var textSize: Float

Inheritors

ScaleBarPlugin

ScaleBarSettingsBase