mapbox-maps-android/com.mapbox.maps.plugin.annotation.generated/PolygonAnnotationOptions

PolygonAnnotationOptions

class PolygonAnnotationOptions : AnnotationOptions<Polygon, PolygonAnnotation>

Builder class from which a polygonAnnotation is created.

Constructors

PolygonAnnotationOptions

fun PolygonAnnotationOptions()

Types

object Companion

Static variables and methods.

Functions

open override fun build(id: String, annotationManager: AnnotationManager<Polygon, PolygonAnnotation, *, *, *, *, *>): PolygonAnnotation

Build an annotation

fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

fun getDraggable(): Boolean

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

fun getGeometry(): Polygon?

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

fun getPoints(): List<List<Point>>

Get a list of lists of Point for the fill, which represents the locations of the fill on the map

fun withData(jsonElement: JsonElement): PolygonAnnotationOptions

Set the arbitrary json data of the annotation.

fun withDraggable(draggable: Boolean): PolygonAnnotationOptions

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

fun withFillColor(@ColorInt fillColor: Int): PolygonAnnotationOptions

fun withFillColor(fillColor: String): PolygonAnnotationOptions

Set fill-color to initialise the polygonAnnotation with.

withFillOpacity

fun withFillOpacity(fillOpacity: Double): PolygonAnnotationOptions

Set fill-opacity to initialise the polygonAnnotation with.

withFillOutlineColor

fun withFillOutlineColor(@ColorInt fillOutlineColor: Int): PolygonAnnotationOptions

fun withFillOutlineColor(fillOutlineColor: String): PolygonAnnotationOptions

Set fill-outline-color to initialise the polygonAnnotation with.

withFillPattern

fun withFillPattern(fillPattern: String): PolygonAnnotationOptions

Set fill-pattern to initialise the polygonAnnotation with.

withFillSortKey

fun withFillSortKey(fillSortKey: Double): PolygonAnnotationOptions

Set fill-sort-key to initialise the polygonAnnotation with.

withFillZOffset

fun withFillZOffset(fillZOffset: Double): PolygonAnnotationOptions

Set fill-z-offset to initialise the polygonAnnotation with.

fun withGeometry(geometry: Polygon): PolygonAnnotationOptions

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

fun withPoints(points: List<List<Point>>): PolygonAnnotationOptions

Set a list of lists of Point for the fill, which represents the locations of the fill on the map

Properties

var fillColor: String? = null

The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used. Default value: "#000000".

var fillOpacity: Double? = null

The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used. Default value: 1. Value range: 0, 1

fillOutlineColor

var fillOutlineColor: String? = null

The outline color of the fill. Matches the value of fill-color if unspecified.

var fillPattern: String? = null

Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

var fillSortKey: 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.

var fillZOffset: Double? = null

Specifies an uniform elevation in meters. Note: If the value is zero, the layer will be rendered on the ground. Non-zero values will elevate the layer from the sea level, which can cause it to be rendered below the terrain. Default value: 0. Minimum value: 0.

Extensions

fun PolygonAnnotationOptions.withFillColor(fillColor: Color): PolygonAnnotationOptions

Set fill-color to initialise the polygonAnnotation with.

withFillOutlineColor

fun PolygonAnnotationOptions.withFillOutlineColor(fillOutlineColor: Color): PolygonAnnotationOptions

Set fill-outline-color to initialise the polygonAnnotation with.