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

PolylineAnnotationOptions

Builder class from which a polylineAnnotation is created.

class PolylineAnnotationOptions : AnnotationOptions<LineString, PolylineAnnotation>

Constructors

fun PolylineAnnotationOptions()

Types

Companion

Static variables and methods.

object Companion

Functions

build

Build an annotation

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

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

fun getDraggable(): Boolean

getGeometry

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

fun getGeometry(): LineString?

getPoints

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

fun getPoints(): 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): PolylineAnnotationOptions

withDraggable

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

fun withDraggable(draggable: Boolean): PolylineAnnotationOptions

withGeometry

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

fun withGeometry(geometry: LineString): PolylineAnnotationOptions

withLineBlur

Set line-blur to initialise the polylineAnnotation with.

Blur applied to the line, in density-independent pixels.

fun withLineBlur(lineBlur: Double): PolylineAnnotationOptions

withLineColor

Set line-color to initialise the polylineAnnotation with.

The color with which the line will be drawn.

fun withLineColor(lineColor: Int): PolylineAnnotationOptions

fun withLineColor(lineColor: String): PolylineAnnotationOptions

withLineGapWidth

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

Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.

fun withLineGapWidth(lineGapWidth: Double): PolylineAnnotationOptions

withLineJoin

Set line-join to initialise the polylineAnnotation with.

The display of lines when joining.

fun withLineJoin(lineJoin: LineJoin): PolylineAnnotationOptions

withLineOffset

Set line-offset to initialise the polylineAnnotation with.

The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

fun withLineOffset(lineOffset: Double): PolylineAnnotationOptions

withLineOpacity

Set line-opacity to initialise the polylineAnnotation with.

The opacity at which the line will be drawn.

fun withLineOpacity(lineOpacity: Double): PolylineAnnotationOptions

withLinePattern

Set line-pattern to initialise the polylineAnnotation with.

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

fun withLinePattern(linePattern: String): PolylineAnnotationOptions

withLineSortKey

Set line-sort-key to initialise the polylineAnnotation 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 withLineSortKey(lineSortKey: Double): PolylineAnnotationOptions

withLineWidth

Set line-width to initialise the polylineAnnotation with.

Stroke thickness.

fun withLineWidth(lineWidth: Double): PolylineAnnotationOptions

withPoints

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

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

Properties

lineBlur

Blur applied to the line, in pixels.

var lineBlur: Double?

lineColor

The color with which the line will be drawn.

var lineColor: String?

lineGapWidth

Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.

var lineGapWidth: Double?

lineJoin

The display of lines when joining.

var lineJoin: LineJoin?

lineOffset

The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

var lineOffset: Double?

lineOpacity

The opacity at which the line will be drawn.

var lineOpacity: Double?

linePattern

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

var linePattern: String?

lineSortKey

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

lineWidth

Stroke thickness.

var lineWidth: Double?