CircleAnnotationOptions

Builder class from which a circleAnnotation is created.

class CircleAnnotationOptions : AnnotationOptions<Point, CircleAnnotation>

Constructors

CircleAnnotationOptions
Link copied to clipboard
fun CircleAnnotationOptions()

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

build
Link copied to clipboard

Build an annotation

open override fun build(id: Long, annotationManager: AnnotationManager<Point, CircleAnnotation, *, *, *, *, *>): CircleAnnotation
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getData
Link copied to clipboard

Get the arbitrary json data of the annotation.

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

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

fun getDraggable(): Boolean
getGeometry
Link copied to clipboard

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

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

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

fun getPoint(): Point?
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String
withCircleBlur
Link copied to clipboard

Set circle-blur to initialise the circleAnnotation with.

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

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

Set circle-color to initialise the circleAnnotation with.

The fill color of the circle.

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

Set circle-opacity to initialise the circleAnnotation with.

The opacity at which the circle will be drawn.

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

Set circle-radius to initialise the circleAnnotation with.

Circle radius.

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

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

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

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

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

The stroke color of the circle.

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

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

The opacity of the circle's stroke.

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

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

The width of the circle's stroke. Strokes are placed outside of the {@link PropertyFactory#circleRadius}.

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

Set the arbitrary json data of the annotation.

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

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

fun withDraggable(draggable: Boolean): CircleAnnotationOptions
withGeometry
Link copied to clipboard

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

fun withGeometry(geometry: Point): CircleAnnotationOptions
withPoint
Link copied to clipboard

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

fun withPoint(point: Point): CircleAnnotationOptions

Properties

circleBlur
Link copied to clipboard

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

var circleBlur: Double?
circleColor
Link copied to clipboard

The fill color of the circle.

var circleColor: String?
circleOpacity
Link copied to clipboard

The opacity at which the circle will be drawn.

var circleOpacity: Double?
circleRadius
Link copied to clipboard

Circle radius.

var circleRadius: Double?
circleSortKey
Link copied to clipboard

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

var circleSortKey: Double?
circleStrokeColor
Link copied to clipboard

The stroke color of the circle.

var circleStrokeColor: String?
circleStrokeOpacity
Link copied to clipboard

The opacity of the circle's stroke.

var circleStrokeOpacity: Double?
circleStrokeWidth
Link copied to clipboard

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

var circleStrokeWidth: Double?