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

FillOptions

Builder class from which a fill is created.

class FillOptions : AnnotationOptions<Polygon, Fill>

Constructors

FillOptions

fun FillOptions()

Types

Companion

Static variables and methods.

object Companion

Functions

build

Build an annotation

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

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 fill is draggable, meaning it can be dragged across the screen when touched and moved.

fun getDraggable(): Boolean

getGeometry

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

fun getGeometry(): Polygon?

getPoints

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

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withData

Set the arbitrary json data of the annotation.

fun withData(jsonElement: JsonElement): FillOptions

withDraggable

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

fun withDraggable(draggable: Boolean): FillOptions

withFillColor

Set fill-color to initialise the fill with.

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.

fun withFillColor(fillColor: String): FillOptions

withFillOpacity

Set fill-opacity to initialise the fill with.

The opacity of the entire fill layer. In contrast to the {@link PropertyFactory#fillColor}, this value will also affect the 1px stroke around the fill, if the stroke is used.

fun withFillOpacity(fillOpacity: Double): FillOptions

withFillOutlineColor

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

The outline color of the fill. Matches the value of {@link PropertyFactory#fillColor} if unspecified.

fun withFillOutlineColor(fillOutlineColor: String): FillOptions

withFillPattern

Set fill-pattern to initialise the fill with.

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.

fun withFillPattern(fillPattern: String): FillOptions

withFillSortKey

Set fill-sort-key to initialise the fill 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 withFillSortKey(fillSortKey: Double): FillOptions

withGeometry

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

fun withGeometry(geometry: Polygon): FillOptions

withPoints

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

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

Properties

fillColor

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.

var fillColor: String

fillOpacity

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.

var fillOpacity: Double

fillOutlineColor

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

var fillOutlineColor: String?

fillPattern

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 fillPattern: String?

fillSortKey

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 fillSortKey: Double?