Mapbox Maps Android/com.mapbox.maps.plugin.annotation.generated/CircleOptions

CircleOptions

Builder class from which a circle is created.

class CircleOptions : AnnotationOptions<Point, Circle>

Constructors

CircleOptions

fun CircleOptions()

Types

Companion

Static variables and methods.

object Companion

Functions

build

Build an annotation

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

equals

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

getData

Get the arbitrary json data of the annotation.

fun getData(): JsonElement?

getDraggable

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

fun getDraggable(): Boolean

getGeometry

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

fun getGeometry(): Point?

getPoint

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

fun getPoint(): Point?

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withCircleBlur

Set circle-blur to initialise the circle with.

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

fun withCircleBlur(circleBlur: Double): CircleOptions

withCircleColor

Set circle-color to initialise the circle with.

The fill color of the circle.

fun withCircleColor(circleColor: String): CircleOptions

withCircleOpacity

Set circle-opacity to initialise the circle with.

The opacity at which the circle will be drawn.

fun withCircleOpacity(circleOpacity: Double): CircleOptions

withCircleRadius

Set circle-radius to initialise the circle with.

Circle radius.

fun withCircleRadius(circleRadius: Double): CircleOptions

withCircleSortKey

Set circle-sort-key to initialise the circle 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): CircleOptions

withCircleStrokeColor

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

The stroke color of the circle.

fun withCircleStrokeColor(circleStrokeColor: String): CircleOptions

withCircleStrokeOpacity

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

The opacity of the circle's stroke.

fun withCircleStrokeOpacity(circleStrokeOpacity: Double): CircleOptions

withCircleStrokeWidth

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

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

fun withCircleStrokeWidth(circleStrokeWidth: Double): CircleOptions

withData

Set the arbitrary json data of the annotation.

fun withData(jsonElement: JsonElement): CircleOptions

withDraggable

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

fun withDraggable(draggable: Boolean): CircleOptions

withGeometry

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

fun withGeometry(geometry: Point): CircleOptions

withPoint

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

fun withPoint(point: Point): CircleOptions

Properties

circleBlur

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

var circleBlur: Double

circleColor

The fill color of the circle.

var circleColor: String

circleOpacity

The opacity at which the circle will be drawn.

var circleOpacity: Double

circleRadius

Circle radius.

var circleRadius: Double

circleSortKey

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

The stroke color of the circle.

var circleStrokeColor: String

circleStrokeOpacity

The opacity of the circle's stroke.

var circleStrokeOpacity: Double

circleStrokeWidth

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

var circleStrokeWidth: Double