mapbox-maps-android/com.mapbox.maps.plugin.compass.generated/CompassSettings/Builder

Builder

class Builder

Composes and builds a CompassSettings object.

This is a concrete implementation of the builder design pattern.

Constructors

Builder

fun Builder()

Functions

build

fun build(): CompassSettings

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

setClickable

fun setClickable(clickable: Boolean): CompassSettings.Builder

Setter for clickable: whether the compass can be clicked and click events can be registered. Default value: true.

setEnabled

fun setEnabled(enabled: Boolean): CompassSettings.Builder

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

setFadeWhenFacingNorth

fun setFadeWhenFacingNorth(fadeWhenFacingNorth: Boolean): CompassSettings.Builder

Setter for fadeWhenFacingNorth: whether the compass fades out to invisible when facing north direction. Default value: true.

setImage

fun setImage(image: ImageHolder?): CompassSettings.Builder

Setter for image: the compass image, the visual representation of the compass.

setMarginBottom

fun setMarginBottom(marginBottom: Float): CompassSettings.Builder

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

setMarginLeft

fun setMarginLeft(marginLeft: Float): CompassSettings.Builder

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

setMarginRight

fun setMarginRight(marginRight: Float): CompassSettings.Builder

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

setMarginTop

fun setMarginTop(marginTop: Float): CompassSettings.Builder

Setter for marginTop: defines the margin to the top that the compass icon honors. Default value: 4. This property is specified in pixels.

setOpacity

fun setOpacity(opacity: Float): CompassSettings.Builder

Setter for opacity: the alpha channel value of the compass image Default value: 1.

setPosition

fun setPosition(position: Int): CompassSettings.Builder

Setter for position: defines where the compass is positioned on the map Default value: "top-right".

setRotation

fun setRotation(rotation: Float): CompassSettings.Builder

Setter for rotation: the clockwise rotation value in degrees of the compass. Default value:

setVisibility

fun setVisibility(visibility: Boolean): CompassSettings.Builder

Setter for visibility: whether the compass is displayed. Default value: true.

Properties

clickable

var clickable: Boolean = true

Whether the compass can be clicked and click events can be registered. Default value: true.

enabled

var enabled: Boolean = true

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

fadeWhenFacingNorth

var fadeWhenFacingNorth: Boolean = true

Whether the compass fades out to invisible when facing north direction. Default value: true.

image

var image: ImageHolder? = null

The compass image, the visual representation of the compass.

marginBottom

var marginBottom: Float = 4.0f

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

marginLeft

var marginLeft: Float = 4.0f

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

marginRight

var marginRight: Float = 4.0f

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

marginTop

var marginTop: Float = 4.0f

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

opacity

var opacity: Float = 1.0f

The alpha channel value of the compass image Default value: 1.

position

var position: Int

Defines where the compass is positioned on the map Default value: "top-right".

rotation

var rotation: Float = 0.0f

The clockwise rotation value in degrees of the compass. Default value: 0.

visibility

var visibility: Boolean = true

Whether the compass is displayed. Default value: true.