LineLayer

A stroked line.

class LineLayer(layerId: String, sourceId: String) : Layer, LineLayerDsl

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

LineLayer
Link copied to clipboard

the ID of the layer

fun LineLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

bindTo
Link copied to clipboard

Bind the layer to the Style.

override fun bindTo(delegate: StyleInterface)

Bind the layer to the map controller.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
filter
Link copied to clipboard

Set the filter property

open override fun filter(filter: Expression): LineLayer
hashCode
Link copied to clipboard
open override fun hashCode(): Int
lineBlur
Link copied to clipboard

Set the LineBlur property

open override fun lineBlur(lineBlur: Expression): LineLayer
open override fun lineBlur(lineBlur: Double): LineLayer
lineBlurTransition
Link copied to clipboard

Set the LineBlur property transition options

open override fun lineBlurTransition(options: StyleTransition): LineLayer
open override fun lineBlurTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
lineCap
Link copied to clipboard

Set the LineCap property

open override fun lineCap(lineCap: Expression): LineLayer
open override fun lineCap(lineCap: LineCap): LineLayer
lineColor
Link copied to clipboard

Set the LineColor property

open override fun lineColor(lineColor: Expression): LineLayer
open override fun lineColor(lineColor: String): LineLayer

Set the LineColor property.

open override fun lineColor(@ColorInt() lineColor: Int): LineLayer
lineColorTransition
Link copied to clipboard

Set the LineColor property transition options

open override fun lineColorTransition(options: StyleTransition): LineLayer
open override fun lineColorTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
lineDasharray
Link copied to clipboard

Set the LineDasharray property

open override fun lineDasharray(lineDasharray: Expression): LineLayer
open override fun lineDasharray(lineDasharray: List<Double>): LineLayer
lineDasharrayTransition
Link copied to clipboard

Set the LineDasharray property transition options

open override fun lineDasharrayTransition(options: StyleTransition): LineLayer
open override fun lineDasharrayTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
lineGapWidth
Link copied to clipboard

Set the LineGapWidth property

open override fun lineGapWidth(lineGapWidth: Expression): LineLayer
open override fun lineGapWidth(lineGapWidth: Double): LineLayer
lineGapWidthTransition
Link copied to clipboard

Set the LineGapWidth property transition options

open override fun lineGapWidthTransition(options: StyleTransition): LineLayer
open override fun lineGapWidthTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
lineGradient
Link copied to clipboard

Set the LineGradient property

open override fun lineGradient(lineGradient: Expression): LineLayer
lineJoin
Link copied to clipboard

Set the LineJoin property

open override fun lineJoin(lineJoin: Expression): LineLayer
open override fun lineJoin(lineJoin: LineJoin): LineLayer
lineMiterLimit
Link copied to clipboard

Set the LineMiterLimit property

open override fun lineMiterLimit(lineMiterLimit: Expression): LineLayer
open override fun lineMiterLimit(lineMiterLimit: Double): LineLayer
lineOffset
Link copied to clipboard

Set the LineOffset property

open override fun lineOffset(lineOffset: Expression): LineLayer
open override fun lineOffset(lineOffset: Double): LineLayer
lineOffsetTransition
Link copied to clipboard

Set the LineOffset property transition options

open override fun lineOffsetTransition(options: StyleTransition): LineLayer
open override fun lineOffsetTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
lineOpacity
Link copied to clipboard

Set the LineOpacity property

open override fun lineOpacity(lineOpacity: Expression): LineLayer
open override fun lineOpacity(lineOpacity: Double): LineLayer
lineOpacityTransition
Link copied to clipboard

Set the LineOpacity property transition options

open override fun lineOpacityTransition(options: StyleTransition): LineLayer
open override fun lineOpacityTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
linePattern
Link copied to clipboard

Set the LinePattern property

open override fun linePattern(linePattern: Expression): LineLayer
open override fun linePattern(linePattern: String): LineLayer
linePatternTransition
Link copied to clipboard

Set the LinePattern property transition options

open override fun linePatternTransition(options: StyleTransition): LineLayer
open override fun linePatternTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
lineRoundLimit
Link copied to clipboard

Set the LineRoundLimit property

open override fun lineRoundLimit(lineRoundLimit: Expression): LineLayer
open override fun lineRoundLimit(lineRoundLimit: Double): LineLayer
lineSortKey
Link copied to clipboard

Set the LineSortKey property

open override fun lineSortKey(lineSortKey: Expression): LineLayer
open override fun lineSortKey(lineSortKey: Double): LineLayer
lineTranslate
Link copied to clipboard

Set the LineTranslate property

open override fun lineTranslate(lineTranslate: Expression): LineLayer
open override fun lineTranslate(lineTranslate: List<Double>): LineLayer
lineTranslateAnchor
Link copied to clipboard

Set the LineTranslateAnchor property

open override fun lineTranslateAnchor(lineTranslateAnchor: Expression): LineLayer
open override fun lineTranslateAnchor(lineTranslateAnchor: LineTranslateAnchor): LineLayer
lineTranslateTransition
Link copied to clipboard

Set the LineTranslate property transition options

open override fun lineTranslateTransition(options: StyleTransition): LineLayer
open override fun lineTranslateTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
lineWidth
Link copied to clipboard

Set the LineWidth property

open override fun lineWidth(lineWidth: Expression): LineLayer
open override fun lineWidth(lineWidth: Double): LineLayer
lineWidthTransition
Link copied to clipboard

Set the LineWidth property transition options

open override fun lineWidthTransition(options: StyleTransition): LineLayer
open override fun lineWidthTransition(block: StyleTransition.Builder.() -> Unit): LineLayer
maxZoom
Link copied to clipboard

Set the maxzoom property

open override fun maxZoom(maxZoom: Double): LineLayer
minZoom
Link copied to clipboard

Set the minzoom property

open override fun minZoom(minZoom: Double): LineLayer
sourceLayer
Link copied to clipboard

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): LineLayer
toString
Link copied to clipboard
open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>)
visibility
Link copied to clipboard

Set the Visibility property

open override fun visibility(visibility: Visibility): LineLayer

Properties

filter
Link copied to clipboard

A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The feature-state expression is not supported in filter expressions.

val filter: Expression?
layerId
Link copied to clipboard

the ID of the layer

open override val layerId: String
layerProperties
Link copied to clipboard

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>
lineBlur
Link copied to clipboard

Blur applied to the line, in pixels.

val lineBlur: Double?
lineBlurAsExpression
Link copied to clipboard

This is an Expression representation of "line-blur".

Blur applied to the line, in pixels.

val lineBlurAsExpression: Expression?
lineBlurTransition
Link copied to clipboard

Transition options for LineBlur.

val lineBlurTransition: StyleTransition?
lineCap
Link copied to clipboard

The display of line endings.

val lineCap: LineCap?
lineCapAsExpression
Link copied to clipboard

This is an Expression representation of "line-cap".

The display of line endings.

val lineCapAsExpression: Expression?
lineColor
Link copied to clipboard

The color with which the line will be drawn.

val lineColor: String?
lineColorAsColorInt
Link copied to clipboard

The color with which the line will be drawn.

val lineColorAsColorInt: Int?
lineColorAsExpression
Link copied to clipboard

This is an Expression representation of "line-color".

The color with which the line will be drawn.

val lineColorAsExpression: Expression?
lineColorTransition
Link copied to clipboard

Transition options for LineColor.

val lineColorTransition: StyleTransition?
lineDasharray
Link copied to clipboard

Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. Note that GeoJSON sources with lineMetrics: true specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.

val lineDasharray: List<Double>?
lineDasharrayAsExpression
Link copied to clipboard

This is an Expression representation of "line-dasharray".

Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. Note that GeoJSON sources with lineMetrics: true specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.

val lineDasharrayAsExpression: Expression?
lineDasharrayTransition
Link copied to clipboard

Transition options for LineDasharray.

val lineDasharrayTransition: StyleTransition?
lineGapWidth
Link copied to clipboard

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

val lineGapWidth: Double?
lineGapWidthAsExpression
Link copied to clipboard

This is an Expression representation of "line-gap-width".

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

val lineGapWidthAsExpression: Expression?
lineGapWidthTransition
Link copied to clipboard

Transition options for LineGapWidth.

val lineGapWidthTransition: StyleTransition?
lineGradient
Link copied to clipboard

Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify "lineMetrics": true.

val lineGradient: Expression?
lineJoin
Link copied to clipboard

The display of lines when joining.

val lineJoin: LineJoin?
lineJoinAsExpression
Link copied to clipboard

This is an Expression representation of "line-join".

The display of lines when joining.

val lineJoinAsExpression: Expression?
lineMiterLimit
Link copied to clipboard

Used to automatically convert miter joins to bevel joins for sharp angles.

val lineMiterLimit: Double?
lineMiterLimitAsExpression
Link copied to clipboard

This is an Expression representation of "line-miter-limit".

Used to automatically convert miter joins to bevel joins for sharp angles.

val lineMiterLimitAsExpression: Expression?
lineOffset
Link copied to clipboard

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.

val lineOffset: Double?
lineOffsetAsExpression
Link copied to clipboard

This is an Expression representation of "line-offset".

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.

val lineOffsetAsExpression: Expression?
lineOffsetTransition
Link copied to clipboard

Transition options for LineOffset.

val lineOffsetTransition: StyleTransition?
lineOpacity
Link copied to clipboard

The opacity at which the line will be drawn.

val lineOpacity: Double?
lineOpacityAsExpression
Link copied to clipboard

This is an Expression representation of "line-opacity".

The opacity at which the line will be drawn.

val lineOpacityAsExpression: Expression?
lineOpacityTransition
Link copied to clipboard

Transition options for LineOpacity.

val lineOpacityTransition: StyleTransition?
linePattern
Link copied to clipboard

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.

val linePattern: String?
linePatternAsExpression
Link copied to clipboard

This is an Expression representation of "line-pattern".

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.

val linePatternAsExpression: Expression?
linePatternTransition
Link copied to clipboard

Transition options for LinePattern.

val linePatternTransition: StyleTransition?
lineRoundLimit
Link copied to clipboard

Used to automatically convert round joins to miter joins for shallow angles.

val lineRoundLimit: Double?
lineRoundLimitAsExpression
Link copied to clipboard

This is an Expression representation of "line-round-limit".

Used to automatically convert round joins to miter joins for shallow angles.

val lineRoundLimitAsExpression: Expression?
lineSortKey
Link copied to clipboard

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

val lineSortKey: Double?
lineSortKeyAsExpression
Link copied to clipboard

This is an Expression representation of "line-sort-key".

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

val lineSortKeyAsExpression: Expression?
lineTranslate
Link copied to clipboard

The geometry's offset. Values are x, y where negatives indicate left and up, respectively.

val lineTranslate: List<Double>?
lineTranslateAnchor
Link copied to clipboard

Controls the frame of reference for line-translate.

val lineTranslateAnchor: LineTranslateAnchor?
lineTranslateAnchorAsExpression
Link copied to clipboard

This is an Expression representation of "line-translate-anchor".

Controls the frame of reference for line-translate.

val lineTranslateAnchorAsExpression: Expression?
lineTranslateAsExpression
Link copied to clipboard

This is an Expression representation of "line-translate".

The geometry's offset. Values are x, y where negatives indicate left and up, respectively.

val lineTranslateAsExpression: Expression?
lineTranslateTransition
Link copied to clipboard

Transition options for LineTranslate.

val lineTranslateTransition: StyleTransition?
lineWidth
Link copied to clipboard

Stroke thickness.

val lineWidth: Double?
lineWidthAsExpression
Link copied to clipboard

This is an Expression representation of "line-width".

Stroke thickness.

val lineWidthAsExpression: Expression?
lineWidthTransition
Link copied to clipboard

Transition options for LineWidth.

val lineWidthTransition: StyleTransition?
maxZoom
Link copied to clipboard

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

Range: minimum: 0 maximum: 24

open override val maxZoom: Double?
minZoom
Link copied to clipboard

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Range: minimum: 0 maximum: 24

open override val minZoom: Double?
sourceId
Link copied to clipboard

the ID of the source

val sourceId: String
sourceLayer
Link copied to clipboard

Source layer.

val sourceLayer: String?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?