Line
See also
Parameters
the ID of the layer
the ID of the source
Constructors
Types
Functions
Bind the layer to the Style.
Bind the layer to the map controller.
A filter is a property at the layer level that determines which features should be rendered in a style layer.
Set the LineBlur property transition options
DSL for lineBlurTransition.
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)".
Set the LineBorderColor property transition options
DSL for lineBorderColorTransition.
The width of the line border. A value of zero means no border. Default value: 0. Minimum value: 0.
Set the LineBorderWidth property transition options
DSL for lineBorderWidthTransition.
Set the LineColor property transition options
DSL for lineColorTransition.
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.
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
Set the LineDepthOcclusionFactor property transition options
DSL for lineDepthOcclusionFactorTransition.
Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.
Set the LineEmissiveStrength property transition options
DSL for lineEmissiveStrengthTransition.
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.
Set the LineGapWidth property transition options
DSL for lineGapWidthTransition.
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.
Used to automatically convert miter joins to bevel joins for sharp angles. Default value: 2.
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
Set the LineOcclusionOpacity property transition options
DSL for lineOcclusionOpacityTransition.
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.
Set the LineOffset property transition options
DSL for lineOffsetTransition.
The opacity at which the line will be drawn. Default value: 1. Value range: 0, 1
Set the LineOpacity property transition options
DSL for lineOpacityTransition.
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.
Used to automatically convert round joins to miter joins for shallow angles. Default value: 1.05.
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
The geometry's offset. Values are x, y where negatives indicate left and up, respectively. Default value: 0,0.
Controls the frame of reference for line-translate. Default value: "map".
Set the LineTranslate property transition options
DSL for lineTranslateTransition.
The color to be used for rendering the trimmed line section that is defined by the line-trim-offset property. Default value: "transparent".
Set the LineTrimColor property transition options
DSL for lineTrimColorTransition.
The fade range for the trim-start and trim-end points is defined by the line-trim-offset property. The first element of the array represents the fade range from the trim-start point toward the end of the line, while the second element defines the fade range from the trim-end point toward the beginning of the line. The fade result is achieved by interpolating between line-trim-color and the color specified by the line-color or the line-gradient property. Default value: 0,0. Minimum value: 0,0. Maximum value: 1,1.
The line part between trim-start, trim-end will be painted using line-trim-color, which is transparent by default to produce 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.
Set the LineWidth property transition options
DSL for lineWidthTransition.
Vertical offset from ground, in meters. Defaults to 0. Not supported for globe projection at the moment.
A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.
Whether this layer is displayed.
Properties
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.
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.
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.
The fade range for the trim-start and trim-end points is defined by the line-trim-offset property. The first element of the array represents the fade range from the trim-start point toward the end of the line, while the second element defines the fade range from the trim-end point toward the beginning of the line. The fade result is achieved by interpolating between line-trim-color and the color specified by the line-color or the line-gradient property. Default value: 0,0. Minimum value: 0,0. Maximum value: 1,1.
The fade range for the trim-start and trim-end points is defined by the line-trim-offset property. The first element of the array represents the fade range from the trim-start point toward the end of the line, while the second element defines the fade range from the trim-end point toward the beginning of the line. The fade result is achieved by interpolating between line-trim-color and the color specified by the line-color or the line-gradient property. Default value: 0,0. Minimum value: 0,0. Maximum value: 1,1.