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

Builder

class Builder

Composes and builds a ScaleBarSettings object.

This is a concrete implementation of the builder design pattern.

Constructors

Builder

fun Builder()

Functions

build

fun build(): ScaleBarSettings

Returns a ScaleBarSettings reference to the object being constructed by the builder.

setBorderWidth

fun setBorderWidth(borderWidth: Float): ScaleBarSettings.Builder

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

setEnabled

fun setEnabled(enabled: Boolean): ScaleBarSettings.Builder

Setter for enabled: whether the scale is visible on the map. Default value: true.

setHeight

fun setHeight(height: Float): ScaleBarSettings.Builder

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

setIsMetricUnits

fun setIsMetricUnits(isMetricUnits: Boolean): ScaleBarSettings.Builder

Setter for 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. Default value: true.

setMarginBottom

fun setMarginBottom(marginBottom: Float): ScaleBarSettings.Builder

Setter for marginBottom: defines the margin to the bottom that the scale bar honors. Default value: 4. This property is specified in pixels.

setMarginLeft

fun setMarginLeft(marginLeft: Float): ScaleBarSettings.Builder

Setter for marginLeft: defines the margin to the left that the scale bar honors. Default value: 4. This property is specified in pixels.

setMarginRight

fun setMarginRight(marginRight: Float): ScaleBarSettings.Builder

Setter for marginRight: defines the margin to the right that the scale bar honors. Default value: 4. This property is specified in pixels.

setMarginTop

fun setMarginTop(marginTop: Float): ScaleBarSettings.Builder

Setter for marginTop: defines the margin to the top that the scale bar honors. Default value:

setPosition

fun setPosition(position: Int): ScaleBarSettings.Builder

Setter for position: defines where the scale bar is positioned on the map Default value: "top-left".

setPrimaryColor

fun setPrimaryColor(primaryColor: Int): ScaleBarSettings.Builder

Setter for primaryColor: defines primary color of the scale bar. Default value: "black".

setRatio

fun setRatio(ratio: Float): ScaleBarSettings.Builder

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

setRefreshInterval

fun setRefreshInterval(refreshInterval: Long): ScaleBarSettings.Builder

Setter for refreshInterval: configures minimum refresh interval, in millisecond, default is

setSecondaryColor

fun setSecondaryColor(secondaryColor: Int): ScaleBarSettings.Builder

Setter for secondaryColor: defines secondary color of the scale bar. Default value: "white".

setShowTextBorder

fun setShowTextBorder(showTextBorder: Boolean): ScaleBarSettings.Builder

Setter for showTextBorder: configures whether to show the text border or not, default is true. Default value: true.

setTextBarMargin

fun setTextBarMargin(textBarMargin: Float): ScaleBarSettings.Builder

Setter for textBarMargin: defines margin of the text bar of the scale bar. Default value: 8. This property is specified in pixels.

setTextBorderWidth

fun setTextBorderWidth(textBorderWidth: Float): ScaleBarSettings.Builder

Setter for textBorderWidth: defines text border width of the scale bar. Default value: 2. This property is specified in pixels.

setTextColor

fun setTextColor(textColor: Int): ScaleBarSettings.Builder

Setter for textColor: defines text color of the scale bar. Default value: "black".

setTextSize

fun setTextSize(textSize: Float): ScaleBarSettings.Builder

Setter for textSize: defines text size of the scale bar. Default value: 8. This property is specified in pixels.

setUseContinuousRendering

fun setUseContinuousRendering(useContinuousRendering: Boolean): ScaleBarSettings.Builder

Setter for 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. Default value: false.

Properties

borderWidth

var borderWidth: Float = 2.0f

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

enabled

var enabled: Boolean = true

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

height

var height: Float = 2.0f

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

isMetricUnits

var isMetricUnits: Boolean = true

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.

marginBottom

var marginBottom: Float = 4.0f

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

marginLeft

var marginLeft: Float = 4.0f

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

marginRight

var marginRight: Float = 4.0f

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

marginTop

var marginTop: Float = 4.0f

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

position

var position: Int

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

primaryColor

var primaryColor: Int

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

ratio

var ratio: Float = 0.5f

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

refreshInterval

var refreshInterval: Long = 15

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

secondaryColor

var secondaryColor: Int

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

showTextBorder

var showTextBorder: Boolean = true

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

textBarMargin

var textBarMargin: Float = 8.0f

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

textBorderWidth

var textBorderWidth: Float = 2.0f

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

textColor

var textColor: Int

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

textSize

var textSize: Float = 8.0f

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

useContinuousRendering

var useContinuousRendering: Boolean = false

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.