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

CompassSettings

class CompassSettings : Parcelable

Shows the compass on the map.

Types

Link copied to clipboard
class Builder

Composes and builds a CompassSettings 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(): CompassSettings.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 clickable: Boolean

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

Link copied to clipboard
val enabled: Boolean

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

Link copied to clipboard
val fadeWhenFacingNorth: Boolean

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

Link copied to clipboard
val image: ImageHolder?

The compass image, the visual representation of the compass.

Link copied to clipboard
val marginBottom: Float

Defines the margin to the bottom that the compass icon 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 compass icon 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 compass icon 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 compass icon honors. Default value: 4. This property is specified in pixels.

Link copied to clipboard
val opacity: Float

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

Link copied to clipboard
val position: Int

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

Link copied to clipboard
val rotation: Float

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

Link copied to clipboard
val visibility: Boolean

Whether the compass is displayed. Default value: true.