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

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.

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

Link copied to clipboard

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

Link copied to clipboard
abstract fun lineBorderColor(lineBorderColor: Expression): LineLayer
abstract fun lineBorderColor(@ColorInt lineBorderColor: Int): LineLayer
abstract fun lineBorderColor(lineBorderColor: String = "rgba(0, 0, 0, 0)"): LineLayer

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

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
abstract fun lineBorderWidth(lineBorderWidth: Expression): LineLayer
abstract fun lineBorderWidth(lineBorderWidth: Double = 0.0): LineLayer

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

Link copied to clipboard

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

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

The display of line endings. Default value: "butt".

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. Default value: "#000000".

Link copied to clipboard

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

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

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

Decrease line layer opacity based on occlusion from 3D objects. Value 0 disables occlusion, value 1 means fully occluded. Default value: 1. Value range: 0, 1

Link copied to clipboard

Decrease line layer opacity based on occlusion from 3D objects. Value 0 disables occlusion, value 1 means fully occluded. Default value: 1. Value range: 0, 1

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

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

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

Link copied to clipboard

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
abstract fun lineGradient(lineGradient: Expression): LineLayer

A gradient used to color a line feature at various distances along its length. Defined using a step or interpolate expression which outputs a color for each corresponding line-progress input value. line-progress is a percentage of the line feature's total length as measured on the webmercator projected coordinate plane (a number between 0 and 1). Can only be used with GeoJSON sources that specify "lineMetrics": true.

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

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

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

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

Opacity multiplier (multiplies line-opacity value) of the line part that is occluded by 3D objects. Value 0 hides occluded part, value 1 means the same opacity as non-occluded part. The property is not supported when line-opacity has data-driven styling. Default value: 0. Value range: 0, 1

Link copied to clipboard

Opacity multiplier (multiplies line-opacity value) of the line part that is occluded by 3D objects. Value 0 hides occluded part, value 1 means the same opacity as non-occluded part. The property is not supported when line-opacity has data-driven styling. Default value: 0. Value range: 0, 1

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

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

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. Default value: 1. Value range: 0, 1

Link copied to clipboard

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

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.

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

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.

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

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

Link copied to clipboard

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

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. Default value: 0,0. Minimum value: 0,0. Maximum value: 1,1.

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

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

Link copied to clipboard

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

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

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

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.

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.

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

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

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.

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

Whether this layer is displayed.

Inheritors

Link copied to clipboard