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

ScaleBarSettings

class ScaleBarSettings : Parcelable

Shows the scale bar on the map.

Types

Link copied to clipboard
class Builder

Composes and builds a ScaleBarSettings object.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Overloaded equals function.

Link copied to clipboard
open override fun hashCode(): Int

Overloaded hashCode function based on all class properties.

Link copied to clipboard
fun toBuilder(): ScaleBarSettings.Builder

Convert to Builder allowing to change class properties.

Link copied to clipboard
open override fun toString(): String

Overloaded toString function.

Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
val borderWidth: Float

Defines width of the border for the scale bar. Default value: 2. This property is specified in pixels.

Link copied to clipboard
val enabled: Boolean

Whether the scale is visible on the map. Default value: true.

Link copied to clipboard
val height: Float

Defines height of the scale bar. Default value: 2. This property is specified in pixels.

Link copied to clipboard
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. Default value: true.

Link copied to clipboard
val marginBottom: Float

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

Link copied to clipboard
val marginLeft: Float

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

Link copied to clipboard
val marginRight: Float

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

Link copied to clipboard
val marginTop: Float

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

Link copied to clipboard
val position: Int

Defines where the scale bar is positioned on the map Default value: "top-left".

Link copied to clipboard
val primaryColor: Int

Defines primary color of the scale bar. Default value: "black".

Link copied to clipboard
val ratio: Float

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

Link copied to clipboard
val refreshInterval: Long

Configures minimum refresh interval, in millisecond, default is 15. Default value: 15.

Link copied to clipboard
val secondaryColor: Int

Defines secondary color of the scale bar. Default value: "white".

Link copied to clipboard
val showTextBorder: Boolean

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

Link copied to clipboard
val textBarMargin: Float

Defines margin of the text bar of the scale bar. Default value: 8. This property is specified in pixels.

Link copied to clipboard
val textBorderWidth: Float

Defines text border width of the scale bar. Default value: 2. This property is specified in pixels.

Link copied to clipboard
val textColor: Int

Defines text color of the scale bar. Default value: "black".

Link copied to clipboard
val textSize: Float

Defines text size of the scale bar. Default value: 8. This property is specified in pixels.

Link copied to clipboard
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. Default value: false.