@rnmapbox/maps 10.0.0-beta.33 → 10.0.0-beta.35

package/docs/LineLayer.md

@@ -1,8 +1,8 @@
 <!-- This file was autogenerated from LineLayer.js do not modify -->
-## <MapboxGL.LineLayer />
-### LineLayer is a style layer that renders one or more stroked polylines on the map.
+# <MapboxGL.LineLayer />
+LineLayer is a style layer that renders one or more stroked polylines on the map.
 
-### props
+## props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
@@ -17,7 +17,7 @@
 | style | `union` | `none` | `false` | Customizable style attributes |
 
 
-### styles
+## styles
 
 * <a href="#linecap">lineCap</a><br/>
 * <a href="#linejoin">lineJoin</a><br/>
@@ -40,118 +40,118 @@
 
 ___
 
-#### lineCap
+### lineCap
 Name: `lineCap`
 
-#### Description
+### Description
 The display of line endings.
 
-#### Type
+### Type
 `enum`
-#### Default Value
+### Default Value
 `butt`
 
-#### Supported Values
+### Supported Values
 **butt** - A cap with a squared-off end which is drawn to the exact endpoint of the line.<br />
 **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.<br />
 **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.<br />
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature`
 
 ___
 
-#### lineJoin
+### lineJoin
 Name: `lineJoin`
 
-#### Description
+### Description
 The display of lines when joining.
 
-#### Type
+### Type
 `enum`
-#### Default Value
+### Default Value
 `miter`
 
-#### Supported Values
+### 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.<br />
 **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.<br />
 **miter** - A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.<br />
 
 
-#### Supported Style Functions
+### Supported Style Functions
 `camera`
-#### Expression
+### Expression
 
 Parameters: `zoom, feature`
 
 ___
 
-#### lineMiterLimit
+### lineMiterLimit
 Name: `lineMiterLimit`
 
-#### Description
+### Description
 Used to automatically convert miter joins to bevel joins for sharp angles.
 
-#### Type
+### Type
 `number`
-#### Default Value
+### Default Value
 `2`
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom`
 
 ___
 
-#### lineRoundLimit
+### lineRoundLimit
 Name: `lineRoundLimit`
 
-#### Description
+### Description
 Used to automatically convert round joins to miter joins for shallow angles.
 
-#### Type
+### Type
 `number`
-#### Default Value
+### Default Value
 `1.05`
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom`
 
 ___
 
-#### lineSortKey
+### lineSortKey
 Name: `lineSortKey`
 
-#### Description
+### Description
 Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
 
-#### Type
+### Type
 `number`
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature`
 
 ___
 
-#### visibility
+### visibility
 Name: `visibility`
 
-#### Description
+### Description
 Whether this layer is displayed.
 
-#### Type
+### Type
 `enum`
-#### Default Value
+### Default Value
 `visible`
 
-#### Supported Values
+### Supported Values
 **visible** - The layer is shown.<br />
 **none** - The layer is not shown.<br />
 
@@ -159,448 +159,448 @@ Whether this layer is displayed.
 
 ___
 
-#### lineOpacity
+### lineOpacity
 Name: `lineOpacity`
 
-#### Description
+### Description
 The opacity at which the line will be drawn.
 
-#### Type
+### Type
 `number`
-#### Default Value
+### Default Value
 `1`
 
-#### Minimum
+### Minimum
 `0`
 
 
-#### Maximum
+### Maximum
 `1`
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature, feature-state`
 ___
 
-#### Name
+### Name
 
 `lineOpacityTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s lineOpacity propery.
+The transition affecting any changes to this layer’s lineOpacity property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### lineColor
+### lineColor
 Name: `lineColor`
 
-#### Description
+### Description
 The color with which the line will be drawn.
 
-#### Type
+### Type
 `color`
-#### Default Value
+### Default Value
 `#000000`
 
 
-#### Disabled By
+### Disabled By
 `linePattern`
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature, feature-state`
 ___
 
-#### Name
+### Name
 
 `lineColorTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s lineColor propery.
+The transition affecting any changes to this layer’s lineColor property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### lineTranslate
+### lineTranslate
 Name: `lineTranslate`
 
-#### Description
+### Description
 The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
 
-#### Type
+### Type
 `array<number>`
-#### Default Value
+### Default Value
 `[0,0]`
 
-#### Units
+### Units
 `pixels`
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom`
 ___
 
-#### Name
+### Name
 
 `lineTranslateTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s lineTranslate propery.
+The transition affecting any changes to this layer’s lineTranslate property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### lineTranslateAnchor
+### lineTranslateAnchor
 Name: `lineTranslateAnchor`
 
-#### Description
+### Description
 Controls the frame of reference for `lineTranslate`.
 
-#### Type
+### Type
 `enum`
-#### Default Value
+### Default Value
 `map`
 
-#### Supported Values
+### Supported Values
 **map** - The line is translated relative to the map.<br />
 **viewport** - The line is translated relative to the viewport.<br />
 
 
-#### Requires
+### Requires
 `lineTranslate`
 
-#### Expression
+### Expression
 
 Parameters: `zoom`
 
 ___
 
-#### lineWidth
+### lineWidth
 Name: `lineWidth`
 
-#### Description
+### Description
 Stroke thickness.
 
-#### Type
+### Type
 `number`
-#### Default Value
+### Default Value
 `1`
 
-#### Units
+### Units
 `pixels`
 
-#### Minimum
+### Minimum
 `0`
 
 
-#### Supported Style Functions
+### Supported Style Functions
 `camera`
-#### Expression
+### Expression
 
 Parameters: `zoom, feature, feature-state`
 ___
 
-#### Name
+### Name
 
 `lineWidthTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s lineWidth propery.
+The transition affecting any changes to this layer’s lineWidth property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### lineGapWidth
+### lineGapWidth
 Name: `lineGapWidth`
 
-#### Description
+### Description
 Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
 
-#### Type
+### Type
 `number`
-#### Default Value
+### Default Value
 `0`
 
-#### Units
+### Units
 `pixels`
 
-#### Minimum
+### Minimum
 `0`
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature, feature-state`
 ___
 
-#### Name
+### Name
 
 `lineGapWidthTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s lineGapWidth propery.
+The transition affecting any changes to this layer’s lineGapWidth property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### lineOffset
+### lineOffset
 Name: `lineOffset`
 
-#### Description
+### 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.
 
-#### Type
+### Type
 `number`
-#### Default Value
+### Default Value
 `0`
 
-#### Units
+### Units
 `pixels`
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature, feature-state`
 ___
 
-#### Name
+### Name
 
 `lineOffsetTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s lineOffset propery.
+The transition affecting any changes to this layer’s lineOffset property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### lineBlur
+### lineBlur
 Name: `lineBlur`
 
-#### Description
+### Description
 Blur applied to the line, in pixels.
 
-#### Type
+### Type
 `number`
-#### Default Value
+### Default Value
 `0`
 
-#### Units
+### Units
 `pixels`
 
-#### Minimum
+### Minimum
 `0`
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature, feature-state`
 ___
 
-#### Name
+### Name
 
 `lineBlurTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s lineBlur propery.
+The transition affecting any changes to this layer’s lineBlur property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### lineDasharray
+### lineDasharray
 Name: `lineDasharray`
 
-#### Description
+### Description
 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 zoomDependent expressions will be evaluated only at integer zoom levels.
 
-#### Type
+### Type
 `array<number>`
 
-#### Units
+### Units
 `line widths`
 
-#### Minimum
+### Minimum
 `0`
 
 
-#### Disabled By
+### Disabled By
 `linePattern`
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature`
 ___
 
-#### Name
+### Name
 
 `lineDasharrayTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s lineDasharray propery.
+The transition affecting any changes to this layer’s lineDasharray property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### linePattern
+### linePattern
 Name: `linePattern`
 
-#### Description
+### Description
 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 zoomDependent expressions will be evaluated only at integer zoom levels.
 
-#### Type
+### Type
 `resolvedImage`
 
 
-#### Expression
+### Expression
 
 Parameters: `zoom, feature`
 ___
 
-#### Name
+### Name
 
 `linePatternTransition`
 
-#### Description
+### Description
 
-The transition affecting any changes to this layer’s linePattern propery.
+The transition affecting any changes to this layer’s linePattern property.
 
-#### Type
+### Type
 
 `{ duration, delay }`
 
-#### Units
+### Units
 `milliseconds`
 
-#### Default Value
+### Default Value
 `{duration: 300, delay: 0}`
 
 
 ___
 
-#### lineGradient
+### lineGradient
 Name: `lineGradient`
 
-#### Description
+### Description
 Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `"lineMetrics": true`.
 
-#### Type
+### Type
 `color`
 
 
-#### Disabled By
+### Disabled By
 `linePattern`
 
-#### Expression
+### Expression
 
 Parameters: `line-progress`
 
 ___
 
-#### lineTrimOffset
+### lineTrimOffset
 Name: `lineTrimOffset`
 
-#### Description
+### Description
 The line part between [trimStart, trimEnd] will be marked as transparent to make a route vanishing effect. The line trimOff offset is based on the whole line range [0.0, 1.0].
 
-#### Type
+### Type
 `array<number>`
-#### Default Value
+### Default Value
 `[0,0]`
 
-#### Minimum
+### Minimum
 `0,0`
 
 
-#### Maximum
+### Maximum
 `1,1`