LineLayer.md

March 19, 2018 · View on GitHub

<MapboxGL.LineLayer />

LineLayer is a style layer that renders one or more stroked polylines on the map.

props

Prop	Type	Default	Required	Description
id	`string`	`none`	`false`	A string that uniquely identifies the source in the style to which it is added.
sourceID	`string`	`MapboxGL.StyleSource.DefaultSourceID`	`false`	The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined.
sourceLayerID	`string`	`none`	`false`	Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.
aboveLayerID	`string`	`none`	`false`	Inserts a layer above aboveLayerID.
belowLayerID	`string`	`none`	`false`	Inserts a layer below belowLayerID
layerIndex	`number`	`none`	`false`	Inserts a layer at a specified index
filter	`array`	`none`	`false`	Filter only the features in the source layer that satisfy a condition that you define
minZoomLevel	`number`	`none`	`false`	The minimum zoom level at which the layer gets parsed and appears.
maxZoomLevel	`number`	`none`	`false`	The maximum zoom level at which the layer gets parsed and appears.
style	`union`	`none`	`false`	Customizable style attributes

butt - A cap with a squared-off end which is drawn to the exact endpoint of the line.
round - A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
square - A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.

Supported Style Functions

camera

Name

lineJoin

Description

The display of lines when joining.

Type

enum

Default Value

miter

Supported Values

bevel - A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
round - A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
miter - A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.

Supported Style Functions

camera

Name

lineMiterLimit

Description

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

Type

number

Default Value

2

Supported Style Functions

camera

Name

lineRoundLimit

Description

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

Type

number

Default Value

1.05

Supported Style Functions

camera

Name

visibility

Description

Whether this layer is displayed.

Type

enum

Default Value

visible

Supported Values

visible - The layer is shown.
none - The layer is not shown.

Name

lineOpacity

Description

The opacity at which the line will be drawn.

Type

number

Default Value

1

Minimum

0

Maximum

1

Supported Style Functions

camera, source, composite

Name

lineColor

Description

The color with which the line will be drawn.

Type

color

Default Value

#000000

Disabled By

linePattern

Supported Style Functions

camera, source, composite

Name

lineTranslate

Description

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

Type

array<number>

Default Value

[0,0]

Units

pixels

Supported Style Functions

camera

Name

lineTranslateAnchor

Description

Controls the frame of reference for lineTranslate.

Type

enum

Default Value

map

Supported Values

map - The line is translated relative to the map.
viewport - The line is translated relative to the viewport.

Requires

lineTranslate

Supported Style Functions

camera

Name

lineWidth

Description

Stroke thickness.

Type

number

Default Value

1

Units

pixels

Minimum

0

Supported Style Functions

camera

Name

lineGapWidth

Description

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

Type

number

Default Value

0

Units

pixels

Minimum

0

Supported Style Functions

camera, source, composite

Name

lineOffset

Description

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.