mapbox-maps-android/com.mapbox.maps.plugin.annotation.generated/CircleAnnotationOptions

CircleAnnotationOptions

class CircleAnnotationOptions : AnnotationOptions<Point, CircleAnnotation>

Builder class from which a circleAnnotation is created.

Constructors

androidJvm

fun CircleAnnotationOptions()

Types

Companion

androidJvm

object Companion

Static variables and methods.

Functions

build

androidJvm

open override fun build(id: Long, annotationManager: AnnotationManager<Point, CircleAnnotation, *, *, *, *, *>): CircleAnnotation

Build an annotation

equals

androidJvm

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

getData

androidJvm

fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

getDraggable

androidJvm

fun getDraggable(): Boolean

Returns whether this circleAnnotation is draggable, meaning it can be dragged across the screen when touched and moved.

getGeometry

androidJvm

fun getGeometry(): Point?

Get the geometry of the circleAnnotation, which represents the location of the circleAnnotation on the map

getPoint

androidJvm

fun getPoint(): Point?

Get the Point of the circleAnnotation, which represents the location of the circleAnnotation on the map

hashCode

androidJvm

open fun hashCode(): Int

toString

androidJvm

open fun toString(): String

withCircleBlur

androidJvm

fun withCircleBlur(circleBlur: Double): CircleAnnotationOptions

Set circle-blur to initialise the circleAnnotation with.

withCircleColor

androidJvm

fun withCircleColor(@ColorInt() circleColor: Int): CircleAnnotationOptions

Set circle-color to initialise the circleAnnotation with.

fun withCircleColor(circleColor: String): CircleAnnotationOptions

Set circle-color to initialise the circleAnnotation with.

withCircleOpacity

androidJvm

fun withCircleOpacity(circleOpacity: Double): CircleAnnotationOptions

Set circle-opacity to initialise the circleAnnotation with.

withCircleRadius

androidJvm

fun withCircleRadius(circleRadius: Double): CircleAnnotationOptions

Set circle-radius to initialise the circleAnnotation with.

withCircleSortKey

androidJvm

fun withCircleSortKey(circleSortKey: Double): CircleAnnotationOptions

Set circle-sort-key to initialise the circleAnnotation with.

withCircleStrokeColor

androidJvm

fun withCircleStrokeColor(@ColorInt() circleStrokeColor: Int): CircleAnnotationOptions

Set circle-stroke-color to initialise the circleAnnotation with.

fun withCircleStrokeColor(circleStrokeColor: String): CircleAnnotationOptions

Set circle-stroke-color to initialise the circleAnnotation with.

withCircleStrokeOpacity

androidJvm

fun withCircleStrokeOpacity(circleStrokeOpacity: Double): CircleAnnotationOptions

Set circle-stroke-opacity to initialise the circleAnnotation with.

withCircleStrokeWidth

androidJvm

fun withCircleStrokeWidth(circleStrokeWidth: Double): CircleAnnotationOptions

Set circle-stroke-width to initialise the circleAnnotation with.

withData

androidJvm

fun withData(jsonElement: JsonElement): CircleAnnotationOptions

Set the arbitrary json data of the annotation.

withDraggable

androidJvm

fun withDraggable(draggable: Boolean): CircleAnnotationOptions

Set whether this circleAnnotation should be draggable, meaning it can be dragged across the screen when touched and moved.

withGeometry

androidJvm

fun withGeometry(geometry: Point): CircleAnnotationOptions

Set the geometry of the circleAnnotation, which represents the location of the circleAnnotation on the map

withPoint

androidJvm

fun withPoint(point: Point): CircleAnnotationOptions

Set the Point of the circleAnnotation, which represents the location of the circleAnnotation on the map

Properties

circleBlur

androidJvm

var circleBlur: Double? = null

Amount to blur the circle.

circleColor

androidJvm

var circleColor: String? = null

The fill color of the circle.

circleOpacity

androidJvm

var circleOpacity: Double? = null

The opacity at which the circle will be drawn.

circleRadius

androidJvm

var circleRadius: Double? = null

Circle radius.

circleSortKey

androidJvm

var circleSortKey: Double? = null

Sorts features in ascending order based on this value.

circleStrokeColor

androidJvm

var circleStrokeColor: String? = null

The stroke color of the circle.

circleStrokeOpacity

androidJvm

var circleStrokeOpacity: Double? = null

The opacity of the circle's stroke.

circleStrokeWidth

androidJvm

var circleStrokeWidth: Double? = null

The width of the circle's stroke.