Mapbox Maps Android/com.mapbox.maps.plugin.compass.generated/CompassSettings

CompassSettings

Shows the compass on the map.

data class CompassSettings(enabled: Boolean, position: Int, marginLeft: Float, marginTop: Float, marginRight: Float, marginBottom: Float, opacity: Float, rotation: Float, visibility: Boolean, fadeWhenFacingNorth: Boolean, clickable: Boolean, image: Drawable?)

Constructors

CompassSettings

fun CompassSettings(enabled: Boolean, position: Int, marginLeft: Float, marginTop: Float, marginRight: Float, marginBottom: Float, opacity: Float, rotation: Float, visibility: Boolean, fadeWhenFacingNorth: Boolean, clickable: Boolean, image: Drawable?)

Functions

component1

operator fun component1(): Boolean

component10

operator fun component10(): Boolean

component11

operator fun component11(): Boolean

component12

operator fun component12(): Drawable?

component2

operator fun component2(): Int

component3

operator fun component3(): Float

component4

operator fun component4(): Float

component5

operator fun component5(): Float

component6

operator fun component6(): Float

component7

operator fun component7(): Float

component8

operator fun component8(): Float

component9

operator fun component9(): Boolean

copy

fun copy(enabled: Boolean, position: Int, marginLeft: Float, marginTop: Float, marginRight: Float, marginBottom: Float, opacity: Float, rotation: Float, visibility: Boolean, fadeWhenFacingNorth: Boolean, clickable: Boolean, image: Drawable?): CompassSettings

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

clickable

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

var clickable: Boolean

enabled

Whether the compass is visible on the map.

var enabled: Boolean

fadeWhenFacingNorth

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

var fadeWhenFacingNorth: Boolean

image

The compass image, the visual representation of the compass.

var image: Drawable?

marginBottom

Defines the margin to the bottom that the compass icon honors.

var marginBottom: Float

marginLeft

Defines the margin to the left that the compass icon honors.

var marginLeft: Float

marginRight

Defines the margin to the right that the compass icon honors.

var marginRight: Float

marginTop

Defines the margin to the top that the compass icon honors.

var marginTop: Float

opacity

The alpha channel value of the compass image

var opacity: Float

position

Defines where the compass is positioned on the map

var position: Int

rotation

The clockwise rotation value in degrees of the compass.

var rotation: Float

visibility

Whether the compass is displayed.

var visibility: Boolean