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

CompassSettings

class CompassSettings : Parcelable

Shows the compass on the map.

Types

Builder

class Builder

Composes and builds a CompassSettings object.

Functions

describeContents

abstract fun describeContents(): Int

equals

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

Overloaded equals function.

hashCode

open override fun hashCode(): Int

Overloaded hashCode function based on all class properties.

toBuilder

fun toBuilder(): CompassSettings.Builder

Convert to Builder allowing to change class properties.

toString

open override fun toString(): String

Overloaded toString function.

writeToParcel

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

Properties

clickable

val clickable: Boolean

Whether the compass can be clicked and click events can be registered.

enabled

val enabled: Boolean

Whether the compass is visible on the map.

fadeWhenFacingNorth

val fadeWhenFacingNorth: Boolean

Whether the compass fades out to invisible when facing north direction.

image

val image: ImageHolder?

The compass image, the visual representation of the compass.

marginBottom

val marginBottom: Float

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

marginLeft

val marginLeft: Float

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

marginRight

val marginRight: Float

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

marginTop

val marginTop: Float

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

opacity

val opacity: Float

The alpha channel value of the compass image

position

val position: Int

Defines where the compass is positioned on the map

rotation

val rotation: Float

The clockwise rotation value in degrees of the compass.

visibility

val visibility: Boolean

Whether the compass is displayed.