LineLayerDsl

interface LineLayerDsl

This Interface contains all the functions that will be exposed to Koltin DSL.

Separated the DSL receiver class to this interface to avoid IDE code suggestion for property getters.

Functions

filter
Link copied to clipboard
abstract fun filter(filter: Expression): LineLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

lineBlur
Link copied to clipboard
abstract fun lineBlur(lineBlur: Expression): LineLayer
abstract fun lineBlur(lineBlur: Double = 0.0): LineLayer

Blur applied to the line, in pixels.

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

Blur applied to the line, in pixels.

lineCap
Link copied to clipboard
abstract fun lineCap(lineCap: Expression): LineLayer
abstract fun lineCap(lineCap: LineCap = LineCap.BUTT): LineLayer

The display of line endings.

lineColor
Link copied to clipboard
abstract fun lineColor(lineColor: Expression): LineLayer
abstract fun lineColor(@ColorInt lineColor: Int): LineLayer
abstract fun lineColor(lineColor: String = "#000000"): LineLayer

The color with which the line will be drawn.

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

The color with which the line will be drawn.

lineDasharray
Link copied to clipboard
abstract fun lineDasharray(lineDasharray: Expression): LineLayer
abstract fun lineDasharray(lineDasharray: List<Double>): LineLayer

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.

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

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.

lineGapWidth
Link copied to clipboard
abstract fun lineGapWidth(lineGapWidth: Expression): LineLayer
abstract fun lineGapWidth(lineGapWidth: Double = 0.0): LineLayer

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

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

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

lineGradient
Link copied to clipboard
abstract fun lineGradient(lineGradient: Expression): LineLayer

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

lineJoin
Link copied to clipboard
abstract fun lineJoin(lineJoin: Expression): LineLayer
abstract fun lineJoin(lineJoin: LineJoin = LineJoin.MITER): LineLayer

The display of lines when joining.

lineMiterLimit
Link copied to clipboard
abstract fun lineMiterLimit(lineMiterLimit: Expression): LineLayer
abstract fun lineMiterLimit(lineMiterLimit: Double = 2.0): LineLayer

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

lineOffset
Link copied to clipboard
abstract fun lineOffset(lineOffset: Expression): LineLayer
abstract fun lineOffset(lineOffset: Double = 0.0): LineLayer

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.

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

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.

lineOpacity
Link copied to clipboard
abstract fun lineOpacity(lineOpacity: Expression): LineLayer
abstract fun lineOpacity(lineOpacity: Double = 1.0): LineLayer

The opacity at which the line will be drawn.

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

The opacity at which the line will be drawn.

linePattern
Link copied to clipboard
abstract fun linePattern(linePattern: Expression): LineLayer
abstract fun linePattern(linePattern: String): LineLayer

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.

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

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.

lineRoundLimit
Link copied to clipboard
abstract fun lineRoundLimit(lineRoundLimit: Expression): LineLayer
abstract fun lineRoundLimit(lineRoundLimit: Double = 1.05): LineLayer

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

lineSortKey
Link copied to clipboard
abstract fun lineSortKey(lineSortKey: Expression): LineLayer
abstract fun lineSortKey(lineSortKey: Double): LineLayer

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

lineTranslate
Link copied to clipboard
abstract fun lineTranslate(lineTranslate: Expression): LineLayer
abstract fun lineTranslate(lineTranslate: List<Double> = listOf(0.0, 0.0)): LineLayer

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

lineTranslateAnchor
Link copied to clipboard
abstract fun lineTranslateAnchor(lineTranslateAnchor: Expression): LineLayer
abstract fun lineTranslateAnchor(lineTranslateAnchor: LineTranslateAnchor = LineTranslateAnchor.MAP): LineLayer

Controls the frame of reference for line-translate.

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

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

lineTrimOffset
Link copied to clipboard
abstract fun lineTrimOffset(lineTrimOffset: Expression): LineLayer
abstract fun lineTrimOffset(lineTrimOffset: List<Double> = listOf(0.0, 0.0)): LineLayer

The line part between trim-start, trim-end will be marked as transparent to make a route vanishing effect. The line trim-off offset is based on the whole line range 0.0, 1.0.

lineWidth
Link copied to clipboard
abstract fun lineWidth(lineWidth: Expression): LineLayer
abstract fun lineWidth(lineWidth: Double = 1.0): LineLayer

Stroke thickness.

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

Stroke thickness.

maxZoom
Link copied to clipboard
abstract fun maxZoom(maxZoom: Double): LineLayer

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

minZoom
Link copied to clipboard
abstract fun minZoom(minZoom: Double): LineLayer

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

sourceLayer
Link copied to clipboard
abstract fun sourceLayer(sourceLayer: String): LineLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

visibility
Link copied to clipboard
abstract fun visibility(visibility: Visibility): LineLayer

Whether this layer is displayed.

Inheritors

LineLayer
Link copied to clipboard