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

CircleAnnotationOptions

fun CircleAnnotationOptions()

Types

object Companion

Static variables and methods.

Functions

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

Build an annotation

fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

fun getDraggable(): Boolean

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

fun getGeometry(): Point?

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

fun getPoint(): Point?

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

fun withCircleBlur(circleBlur: Double): CircleAnnotationOptions

Set circle-blur to initialise the circleAnnotation with.

withCircleColor

fun withCircleColor(@ColorInt circleColor: Int): CircleAnnotationOptions

fun withCircleColor(circleColor: String): CircleAnnotationOptions

Set circle-color to initialise the circleAnnotation with.

withCircleOpacity

fun withCircleOpacity(circleOpacity: Double): CircleAnnotationOptions

Set circle-opacity to initialise the circleAnnotation with.

withCircleRadius

fun withCircleRadius(circleRadius: Double): CircleAnnotationOptions

Set circle-radius to initialise the circleAnnotation with.

withCircleSortKey

fun withCircleSortKey(circleSortKey: Double): CircleAnnotationOptions

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

withCircleStrokeColor

fun withCircleStrokeColor(@ColorInt circleStrokeColor: Int): CircleAnnotationOptions

fun withCircleStrokeColor(circleStrokeColor: String): CircleAnnotationOptions

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

withCircleStrokeOpacity

fun withCircleStrokeOpacity(circleStrokeOpacity: Double): CircleAnnotationOptions

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

withCircleStrokeWidth

fun withCircleStrokeWidth(circleStrokeWidth: Double): CircleAnnotationOptions

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

fun withData(jsonElement: JsonElement): CircleAnnotationOptions

Set the arbitrary json data of the annotation.

fun withDraggable(draggable: Boolean): CircleAnnotationOptions

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

fun withGeometry(geometry: Point): CircleAnnotationOptions

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

fun withPoint(point: Point): CircleAnnotationOptions

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

Properties

var circleBlur: Double? = null

Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. Setting a negative value renders the blur as an inner glow effect. Default value: 0.

var circleColor: String? = null

The fill color of the circle. Default value: "#000000".

var circleOpacity: Double? = null

The opacity at which the circle will be drawn. Default value: 1. Value range: 0, 1

var circleRadius: Double? = null

Circle radius. Default value: 5. Minimum value: 0.

var circleSortKey: Double? = null

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

circleStrokeColor

var circleStrokeColor: String? = null

The stroke color of the circle. Default value: "#000000".

circleStrokeOpacity

var circleStrokeOpacity: Double? = null

The opacity of the circle's stroke. Default value: 1. Value range: 0, 1

circleStrokeWidth

var circleStrokeWidth: Double? = null

The width of the circle's stroke. Strokes are placed outside of the circle-radius. Default value: 0. Minimum value: 0.

Extensions

withCircleColor

fun CircleAnnotationOptions.withCircleColor(circleColor: Color): CircleAnnotationOptions

Set circle-color to initialise the circleAnnotation with.

withCircleStrokeColor

fun CircleAnnotationOptions.withCircleStrokeColor(circleStrokeColor: Color): CircleAnnotationOptions

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