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

ScaleBarSettings

Shows the scale bar on the map.

data class ScaleBarSettings(enabled: Boolean, position: Int, marginLeft: Float, marginTop: Float, marginRight: Float, marginBottom: Float, textColor: Int, primaryColor: Int, secondaryColor: Int, borderWidth: Float, height: Float, textBarMargin: Float, textBorderWidth: Float, textSize: Float, isMetricUnits: Boolean, refreshInterval: Long, showTextBorder: Boolean, ratio: Float, useContinuousRendering: Boolean)

Constructors

ScaleBarSettings

fun ScaleBarSettings(enabled: Boolean, position: Int, marginLeft: Float, marginTop: Float, marginRight: Float, marginBottom: Float, textColor: Int, primaryColor: Int, secondaryColor: Int, borderWidth: Float, height: Float, textBarMargin: Float, textBorderWidth: Float, textSize: Float, isMetricUnits: Boolean, refreshInterval: Long, showTextBorder: Boolean, ratio: Float, useContinuousRendering: Boolean)

Functions

component1

operator fun component1(): Boolean

component10

operator fun component10(): Float

component11

operator fun component11(): Float

component12

operator fun component12(): Float

component13

operator fun component13(): Float

component14

operator fun component14(): Float

component15

operator fun component15(): Boolean

component16

operator fun component16(): Long

component17

operator fun component17(): Boolean

component18

operator fun component18(): Float

component19

operator fun component19(): Boolean

component2

operator fun component2(): Int

component3

operator fun component3(): Float

component4

operator fun component4(): Float

component5

operator fun component5(): Float

component6

operator fun component6(): Float

component7

operator fun component7(): Int

component8

operator fun component8(): Int

component9

operator fun component9(): Int

copy

fun copy(enabled: Boolean, position: Int, marginLeft: Float, marginTop: Float, marginRight: Float, marginBottom: Float, textColor: Int, primaryColor: Int, secondaryColor: Int, borderWidth: Float, height: Float, textBarMargin: Float, textBorderWidth: Float, textSize: Float, isMetricUnits: Boolean, refreshInterval: Long, showTextBorder: Boolean, ratio: Float, useContinuousRendering: Boolean): ScaleBarSettings

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

borderWidth

Defines width of the border for the scale bar.

var borderWidth: Float

enabled

Whether the scale is visible on the map.

var enabled: Boolean

height

Defines height of the scale bar.

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.

var isMetricUnits: Boolean

marginBottom

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

var marginBottom: Float

marginLeft

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

var marginLeft: Float

marginRight

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

var marginRight: Float

marginTop

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

var marginTop: Float

position

Defines where the scale bar is positioned on the map

var position: Int

primaryColor

Defines primary color of the scale bar.

var primaryColor: Int

ratio

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

var ratio: Float

refreshInterval

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

var refreshInterval: Long

secondaryColor

Defines secondary color of the scale bar.

var secondaryColor: Int

showTextBorder

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

var showTextBorder: Boolean

textBarMargin

Defines margin of the text bar of the scale bar.

var textBarMargin: Float

textBorderWidth

Defines text border width of the scale bar.

var textBorderWidth: Float

textColor

Defines text color of the scale bar.

var textColor: Int

textSize

Defines text size of the scale bar.

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.

var useContinuousRendering: Boolean