mapbox-maps-android/com.mapbox.maps.plugin.scalebar.generated/ScaleBarSettingsBase

ScaleBarSettingsBase

abstract class ScaleBarSettingsBase : ScaleBarSettingsInterface

Abstract settings class for ScaleBarPlugin.

This abstract class exposes all the required public APIs to configure the ScaleBarPlugin.

Constructors

androidJvm

fun ScaleBarSettingsBase()

Functions

equals

androidJvm

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

getSettings

androidJvm

open override fun getSettings(): ScaleBarSettings

Get current scalebar configuration.

hashCode

androidJvm

open fun hashCode(): Int

toString

androidJvm

open fun toString(): String

updateSettings

androidJvm

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

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

Properties

borderWidth

androidJvm

open override var borderWidth: Float

Defines width of the border for the scale bar.

enabled

androidJvm

open override var enabled: Boolean

Whether the scale is visible on the map.

height

androidJvm

open override var height: Float

Defines height of the scale bar.

isMetricUnits

androidJvm

open override var isMetricUnits: Boolean

Whether the scale bar is using metric unit.

marginBottom

androidJvm

open override var marginBottom: Float

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

marginLeft

androidJvm

open override var marginLeft: Float

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

marginRight

androidJvm

open override var marginRight: Float

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

marginTop

androidJvm

open override var marginTop: Float

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

position

androidJvm

open override var position: Int

Defines where the scale bar is positioned on the map

primaryColor

androidJvm

open override var primaryColor: Int

Defines primary color of the scale bar.

ratio

androidJvm

open override var ratio: Float

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

refreshInterval

androidJvm

open override var refreshInterval: Long

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

secondaryColor

androidJvm

open override var secondaryColor: Int

Defines secondary color of the scale bar.

showTextBorder

androidJvm

open override var showTextBorder: Boolean

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

textBarMargin

androidJvm

open override var textBarMargin: Float

Defines margin of the text bar of the scale bar.

textBorderWidth

androidJvm

open override var textBorderWidth: Float

Defines text border width of the scale bar.

textColor

androidJvm

open override var textColor: Int

Defines text color of the scale bar.

textSize

androidJvm

open override var textSize: Float

Defines text size of the scale bar.

useContinuousRendering

androidJvm

open override 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