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

ScaleBarSettings

class ScaleBarSettings : Parcelable

Shows the scale bar on the map.

Types

Composes and builds a ScaleBarSettings object.

Functions

describeContents

abstract fun describeContents(): Int

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

Overloaded equals function.

open override fun hashCode(): Int

Overloaded hashCode function based on all class properties.

fun toBuilder(): ScaleBarSettings.Builder

Convert to Builder allowing to change class properties.

open override fun toString(): String

Overloaded toString function.

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

val borderWidth: Float

Defines width of the border for the scale bar. This property is specified in pixels.

val enabled: Boolean

Whether the scale is visible on the map.

val height: Float

Defines height of the scale bar. This property is specified in pixels.

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

val marginBottom: Float

Defines the margin to the bottom that the scale bar honors. This property is specified in pixels.

val marginLeft: Float

Defines the margin to the left that the scale bar honors. This property is specified in pixels.

val marginRight: Float

Defines the margin to the right that the scale bar honors. This property is specified in pixels.

val marginTop: Float

Defines the margin to the top that the scale bar honors. This property is specified in pixels.

val position: Int

Defines where the scale bar is positioned on the map

val primaryColor: Int

Defines primary color of the scale bar.

val ratio: Float

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

refreshInterval

val refreshInterval: Long

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

val secondaryColor: Int

Defines secondary color of the scale bar.

val showTextBorder: Boolean

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

val textBarMargin: Float

Defines margin of the text bar of the scale bar. This property is specified in pixels.

textBorderWidth

val textBorderWidth: Float

Defines text border width of the scale bar. This property is specified in pixels.

val textColor: Int

Defines text color of the scale bar.

val textSize: Float

Defines text size of the scale bar. This property is specified in pixels.

useContinuousRendering

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