CircleAnnotationOptions

class CircleAnnotationOptions : AnnotationOptions<Point, CircleAnnotation>

Builder class from which a circleAnnotation is created.

Constructors

CircleAnnotationOptions
Link copied to clipboard
fun CircleAnnotationOptions()

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

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

Build an annotation

getData
Link copied to clipboard
fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

getDraggable
Link copied to clipboard
fun getDraggable(): Boolean

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

getGeometry
Link copied to clipboard
fun getGeometry(): Point?

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

getPoint
Link copied to clipboard
fun getPoint(): Point?

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

withCircleBlur
Link copied to clipboard
fun withCircleBlur(circleBlur: Double): CircleAnnotationOptions

Set circle-blur to initialise the circleAnnotation with.

withCircleColor
Link copied to clipboard
fun withCircleColor(@ColorInt circleColor: Int): CircleAnnotationOptions
fun withCircleColor(circleColor: String): CircleAnnotationOptions

Set circle-color to initialise the circleAnnotation with.

withCircleOpacity
Link copied to clipboard
fun withCircleOpacity(circleOpacity: Double): CircleAnnotationOptions

Set circle-opacity to initialise the circleAnnotation with.

withCircleRadius
Link copied to clipboard
fun withCircleRadius(circleRadius: Double): CircleAnnotationOptions

Set circle-radius to initialise the circleAnnotation with.

withCircleSortKey
Link copied to clipboard
fun withCircleSortKey(circleSortKey: Double): CircleAnnotationOptions

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

withCircleStrokeColor
Link copied to clipboard
fun withCircleStrokeColor(@ColorInt circleStrokeColor: Int): CircleAnnotationOptions
fun withCircleStrokeColor(circleStrokeColor: String): CircleAnnotationOptions

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

withCircleStrokeOpacity
Link copied to clipboard
fun withCircleStrokeOpacity(circleStrokeOpacity: Double): CircleAnnotationOptions

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

withCircleStrokeWidth
Link copied to clipboard
fun withCircleStrokeWidth(circleStrokeWidth: Double): CircleAnnotationOptions

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

withData
Link copied to clipboard
fun withData(jsonElement: JsonElement): CircleAnnotationOptions

Set the arbitrary json data of the annotation.

withDraggable
Link copied to clipboard
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
Link copied to clipboard
fun withGeometry(geometry: Point): CircleAnnotationOptions

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

withPoint
Link copied to clipboard
fun withPoint(point: Point): CircleAnnotationOptions

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

Properties

circleBlur
Link copied to clipboard
var circleBlur: Double? = null

Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.

circleColor
Link copied to clipboard
var circleColor: String? = null

The fill color of the circle.

circleOpacity
Link copied to clipboard
var circleOpacity: Double? = null

The opacity at which the circle will be drawn.

circleRadius
Link copied to clipboard
var circleRadius: Double? = null

Circle radius.

circleSortKey
Link copied to clipboard
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
Link copied to clipboard
var circleStrokeColor: String? = null

The stroke color of the circle.

circleStrokeOpacity
Link copied to clipboard
var circleStrokeOpacity: Double? = null

The opacity of the circle's stroke.

circleStrokeWidth
Link copied to clipboard
var circleStrokeWidth: Double? = null

The width of the circle's stroke. Strokes are placed outside of the circle-radius.