PolylineAnnotationOptions

Builder class from which a polylineAnnotation is created.

Constructors

Link copied to clipboard

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
open override fun build(id: String, annotationManager: AnnotationManager<LineString, PolylineAnnotation, *, *, *, *, *>): PolylineAnnotation

Build an annotation

Link copied to clipboard
fun getData(): JsonElement?

Get the arbitrary json data of the annotation.

Link copied to clipboard

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

Link copied to clipboard
fun getGeometry(): LineString?

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

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

Link copied to clipboard
fun withData(jsonElement: JsonElement): PolylineAnnotationOptions

Set the arbitrary json data of the annotation.

Link copied to clipboard

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

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

Link copied to clipboard

Set line-blur to initialise the polylineAnnotation with.

Link copied to clipboard

Set line-border-color to initialise the polylineAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

Set line-color to initialise the polylineAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

Set line-join to initialise the polylineAnnotation with.

Link copied to clipboard

Set line-offset to initialise the polylineAnnotation with.

Link copied to clipboard

Set line-opacity to initialise the polylineAnnotation with.

Link copied to clipboard

Set line-pattern to initialise the polylineAnnotation with.

Link copied to clipboard

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

Link copied to clipboard

Set line-width to initialise the polylineAnnotation with.

Link copied to clipboard

Set line-z-offset to initialise the polylineAnnotation with.

Link copied to clipboard

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

Properties

Link copied to clipboard
var lineBlur: Double? = null

Blur applied to the line, in pixels. Default value: 0. Minimum value: 0.

Link copied to clipboard
var lineBorderColor: String? = null

The color of the line border. If line-border-width is greater than zero and the alpha value of this color is 0 (default), the color for the border will be selected automatically based on the line color. Default value: "rgba(0, 0, 0, 0)".

Link copied to clipboard
var lineBorderWidth: Double? = null

The width of the line border. A value of zero means no border. Default value: 0. Minimum value: 0.

Link copied to clipboard
var lineColor: String? = null

The color with which the line will be drawn. Default value: "#000000".

Link copied to clipboard
var lineGapWidth: Double? = null

Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap. Default value: 0. Minimum value: 0.

Link copied to clipboard
var lineJoin: LineJoin? = null

The display of lines when joining. Default value: "miter".

Link copied to clipboard
var lineOffset: Double? = null

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. Default value: 0.

Link copied to clipboard
var lineOpacity: Double? = null

The opacity at which the line will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard
var linePattern: String? = null

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.

Link copied to clipboard
var lineSortKey: Double? = null

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

Link copied to clipboard
var lineWidth: Double? = null

Stroke thickness. Default value: 1. Minimum value: 0.

Link copied to clipboard
var lineZOffset: Double? = null

Vertical offset from ground, in meters. Defaults to 0. Not supported for globe projection at the moment.