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

androidJvm

fun PolygonAnnotationOptions()

Types

Companion

androidJvm

object Companion

Static variables and methods.

Functions

build

androidJvm

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

Build an annotation

equals

androidJvm

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

getData

androidJvm

fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

getDraggable

androidJvm

fun getDraggable(): Boolean

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

getGeometry

androidJvm

fun getGeometry(): Polygon?

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

getPoints

androidJvm

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

hashCode

androidJvm

open fun hashCode(): Int

toString

androidJvm

open fun toString(): String

withData

androidJvm

fun withData(jsonElement: JsonElement): PolygonAnnotationOptions

Set the arbitrary json data of the annotation.

withDraggable

androidJvm

fun withDraggable(draggable: Boolean): PolygonAnnotationOptions

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

withFillColor

androidJvm

fun withFillColor(@ColorInt() fillColor: Int): PolygonAnnotationOptions

Set fill-color to initialise the polygonAnnotation with.

fun withFillColor(fillColor: String): PolygonAnnotationOptions

Set fill-color to initialise the polygonAnnotation with.

withFillOpacity

androidJvm

fun withFillOpacity(fillOpacity: Double): PolygonAnnotationOptions

Set fill-opacity to initialise the polygonAnnotation with.

withFillOutlineColor

androidJvm

fun withFillOutlineColor(@ColorInt() fillOutlineColor: Int): PolygonAnnotationOptions

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

fun withFillOutlineColor(fillOutlineColor: String): PolygonAnnotationOptions

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

withFillPattern

androidJvm

fun withFillPattern(fillPattern: String): PolygonAnnotationOptions

Set fill-pattern to initialise the polygonAnnotation with.

withFillSortKey

androidJvm

fun withFillSortKey(fillSortKey: Double): PolygonAnnotationOptions

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

withGeometry

androidJvm

fun withGeometry(geometry: Polygon): PolygonAnnotationOptions

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

withPoints

androidJvm

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

fillColor

androidJvm

var fillColor: String? = null

The color of the filled part of this layer.

fillOpacity

androidJvm

var fillOpacity: Double? = null

The opacity of the entire fill layer.

fillOutlineColor

androidJvm

var fillOutlineColor: String? = null

The outline color of the fill.

fillPattern

androidJvm

var fillPattern: String? = null

Name of image in sprite to use for drawing image fills.

fillSortKey

androidJvm

var fillSortKey: Double? = null

Sorts features in ascending order based on this value.