CircleAnnotationOptions

Builder class from which a circleAnnotation is created.

Constructors

Link copied to clipboard

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

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

Build an annotation

Link copied to clipboard
fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

Link copied to clipboard

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

Link copied to clipboard
fun getGeometry(): Point?

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

Link copied to clipboard
fun getPoint(): Point?

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

Link copied to clipboard

Set circle-blur to initialise the circleAnnotation with.

Link copied to clipboard

Set circle-color to initialise the circleAnnotation with.

Link copied to clipboard

Set circle-opacity to initialise the circleAnnotation with.

Link copied to clipboard

Set circle-radius to initialise the circleAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

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

Set the arbitrary json data of the annotation.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Properties

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. Default value: 0.

Link copied to clipboard
var circleColor: String? = null

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

Link copied to clipboard
var circleOpacity: Double? = null

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

Link copied to clipboard
var circleRadius: Double? = null

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

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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