PolylineAnnotationOptions

class PolylineAnnotationOptions : AnnotationOptions<LineString, PolylineAnnotation>

Builder class from which a polylineAnnotation is created.

Constructors

PolylineAnnotationOptions
Link copied to clipboard
fun PolylineAnnotationOptions()

Types

Companion
Link copied to clipboard
object Companion
Static variables and methods.

Functions

build
Link copied to clipboard
open override fun build(id: Long, annotationManager: AnnotationManager<LineString, PolylineAnnotation, *, *, *, *, *>): PolylineAnnotation
Build an annotation
getData
Link copied to clipboard
fun getData(): JsonElement?
Get the arbitrary json data of the annotation.
getDraggable
Link copied to clipboard
fun getDraggable(): Boolean
Returns whether this polylineAnnotation is draggable, meaning it can be dragged across the screen when touched and moved.
getGeometry
Link copied to clipboard
fun getGeometry(): LineString?
Get the geometry of the polylineAnnotation, which represents the location of the polylineAnnotation on the map
getPoints
Link copied to clipboard
fun getPoints(): List<Point>
Get a list of Point for the line, which represents the locations of the line on the map
withData
Link copied to clipboard
fun withData(jsonElement: JsonElement): PolylineAnnotationOptions
Set the arbitrary json data of the annotation.
withDraggable
Link copied to clipboard
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
Link copied to clipboard
fun withGeometry(geometry: LineString): PolylineAnnotationOptions
Set the geometry of the polylineAnnotation, which represents the location of the polylineAnnotation on the map
withLineBlur
Link copied to clipboard
fun withLineBlur(lineBlur: Double): PolylineAnnotationOptions
Set line-blur to initialise the polylineAnnotation with.
withLineColor
Link copied to clipboard
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
Link copied to clipboard
fun withLineGapWidth(lineGapWidth: Double): PolylineAnnotationOptions
Set line-gap-width to initialise the polylineAnnotation with.
withLineJoin
Link copied to clipboard
fun withLineJoin(lineJoin: LineJoin): PolylineAnnotationOptions
Set line-join to initialise the polylineAnnotation with.
withLineOffset
Link copied to clipboard
fun withLineOffset(lineOffset: Double): PolylineAnnotationOptions
Set line-offset to initialise the polylineAnnotation with.
withLineOpacity
Link copied to clipboard
fun withLineOpacity(lineOpacity: Double): PolylineAnnotationOptions
Set line-opacity to initialise the polylineAnnotation with.
withLinePattern
Link copied to clipboard
fun withLinePattern(linePattern: String): PolylineAnnotationOptions
Set line-pattern to initialise the polylineAnnotation with.
withLineSortKey
Link copied to clipboard
fun withLineSortKey(lineSortKey: Double): PolylineAnnotationOptions
Set line-sort-key to initialise the polylineAnnotation with.
withLineWidth
Link copied to clipboard
fun withLineWidth(lineWidth: Double): PolylineAnnotationOptions
Set line-width to initialise the polylineAnnotation with.
withPoints
Link copied to clipboard
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
Link copied to clipboard
var lineBlur: Double? = null
Blur applied to the line, in pixels.
lineColor
Link copied to clipboard
var lineColor: String? = null
The color with which the line will be drawn.
lineGapWidth
Link copied to clipboard
var lineGapWidth: Double? = null
Draws a line casing outside of a line's actual path.
lineJoin
Link copied to clipboard
var lineJoin: LineJoin? = null
The display of lines when joining.
lineOffset
Link copied to clipboard
var lineOffset: Double? = null
The line's offset.
lineOpacity
Link copied to clipboard
var lineOpacity: Double? = null
The opacity at which the line will be drawn.
linePattern
Link copied to clipboard
var linePattern: String? = null
Name of image in sprite to use for drawing image lines.
lineSortKey
Link copied to clipboard
var lineSortKey: Double? = null
Sorts features in ascending order based on this value.
lineWidth
Link copied to clipboard
var lineWidth: Double? = null
Stroke thickness.