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

PolylineAnnotationOptions

class PolylineAnnotationOptions : AnnotationOptions<LineString, PolylineAnnotation>

Builder class from which a polylineAnnotation is created.

Constructors

fun PolylineAnnotationOptions()

Types

Companion

object Companion

Static variables and methods.

Functions

build

open override fun build(id: Long, annotationManager: AnnotationManager<LineString, PolylineAnnotation, *, *, *, *, *>): PolylineAnnotation

Build an annotation

equals

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

getData

fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

getDraggable

fun getDraggable(): Boolean

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

getGeometry

fun getGeometry(): LineString?

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

getPoints

fun getPoints(): List<Point>

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

withData

fun withData(jsonElement: JsonElement): PolylineAnnotationOptions

Set the arbitrary json data of the annotation.

withDraggable

fun withDraggable(draggable: Boolean): PolylineAnnotationOptions

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

withGeometry

fun withGeometry(geometry: LineString): PolylineAnnotationOptions

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

withLineBlur

fun withLineBlur(lineBlur: Double): PolylineAnnotationOptions

Set line-blur to initialise the polylineAnnotation with.

withLineColor

fun withLineColor(@ColorInt() lineColor: Int): PolylineAnnotationOptions

Set line-color to initialise the polylineAnnotation with.

fun withLineColor(lineColor: String): PolylineAnnotationOptions

Set line-color to initialise the polylineAnnotation with.

withLineGapWidth

fun withLineGapWidth(lineGapWidth: Double): PolylineAnnotationOptions

Set line-gap-width to initialise the polylineAnnotation with.

withLineJoin

fun withLineJoin(lineJoin: LineJoin): PolylineAnnotationOptions

Set line-join to initialise the polylineAnnotation with.

withLineOffset

fun withLineOffset(lineOffset: Double): PolylineAnnotationOptions

Set line-offset to initialise the polylineAnnotation with.

withLineOpacity

fun withLineOpacity(lineOpacity: Double): PolylineAnnotationOptions

Set line-opacity to initialise the polylineAnnotation with.

withLinePattern

fun withLinePattern(linePattern: String): PolylineAnnotationOptions

Set line-pattern to initialise the polylineAnnotation with.

withLineSortKey

fun withLineSortKey(lineSortKey: Double): PolylineAnnotationOptions

Set line-sort-key to initialise the polylineAnnotation with.

withLineWidth

fun withLineWidth(lineWidth: Double): PolylineAnnotationOptions

Set line-width to initialise the polylineAnnotation with.

withPoints

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

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

Properties

lineBlur

var lineBlur: Double? = null

Blur applied to the line, in pixels.

lineColor

var lineColor: String? = null

The color with which the line will be drawn.

lineGapWidth

var lineGapWidth: Double? = null

Draws a line casing outside of a line's actual path.

lineJoin

var lineJoin: LineJoin? = null

The display of lines when joining.

lineOffset

var lineOffset: Double? = null

The line's offset.

lineOpacity

var lineOpacity: Double? = null

The opacity at which the line will be drawn.

linePattern

var linePattern: String? = null

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

lineSortKey

var lineSortKey: Double? = null

Sorts features in ascending order based on this value.

lineWidth

var lineWidth: Double? = null

Stroke thickness.