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

ScaleBarSettingsBase

Abstract settings class for ScaleBarPlugin.

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

abstract class ScaleBarSettingsBase : ScaleBarSettingsInterface

Constructors

fun ScaleBarSettingsBase()

Functions

equals

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

getSettings

Get current scalebar configuration.

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

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

Properties

borderWidth

Defines width of the border for the scale bar.

open override var borderWidth: Float

enabled

Whether the scale is visible on the map.

open override var enabled: Boolean

height

Defines height of the scale bar.

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

open override var isMetricUnits: Boolean

marginBottom

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

open override var marginBottom: Float

marginLeft

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

open override var marginLeft: Float

marginRight

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

open override var marginRight: Float

marginTop

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

open override var marginTop: Float

position

Defines where the scale bar is positioned on the map

open override var position: Int

primaryColor

Defines primary color of the scale bar.

open override var primaryColor: Int

ratio

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

open override var ratio: Float

refreshInterval

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

open override var refreshInterval: Long

secondaryColor

Defines secondary color of the scale bar.

open override var secondaryColor: Int

showTextBorder

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

open override var showTextBorder: Boolean

textBarMargin

Defines margin of the text bar of the scale bar.

open override var textBarMargin: Float

textBorderWidth

Defines text border width of the scale bar.

open override var textBorderWidth: Float

textColor

Defines text color of the scale bar.

open override var textColor: Int

textSize

Defines text size of the scale bar.

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

Inheritors

ScaleBarPluginImpl