@maplibre/maplibre-react-native 10.0.0-alpha.25 → 10.0.0-alpha.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (159) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/android/build.gradle +51 -16
  3. package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleFactory.java +1 -1
  4. package/docs/Annotation.md +7 -7
  5. package/docs/BackgroundLayer.md +135 -128
  6. package/docs/Callout.md +4 -4
  7. package/docs/Camera.md +15 -15
  8. package/docs/CircleLayer.md +412 -388
  9. package/docs/FillExtrusionLayer.md +302 -292
  10. package/docs/FillLayer.md +265 -251
  11. package/docs/HeadingIndicator.md +4 -4
  12. package/docs/HeatmapLayer.md +178 -172
  13. package/docs/ImageSource.md +4 -4
  14. package/docs/Images.md +4 -4
  15. package/docs/Light.md +130 -123
  16. package/docs/LineLayer.md +524 -498
  17. package/docs/MapView.md +22 -42
  18. package/docs/MarkerView.md +4 -4
  19. package/docs/NativeUserLocation.md +4 -4
  20. package/docs/PointAnnotation.md +6 -10
  21. package/docs/RasterLayer.md +317 -310
  22. package/docs/RasterSource.md +4 -4
  23. package/docs/ShapeSource.md +15 -15
  24. package/docs/Style.md +4 -4
  25. package/docs/SymbolLayer.md +1500 -1406
  26. package/docs/UserLocation.md +9 -13
  27. package/docs/VectorSource.md +9 -9
  28. package/docs/coordinates.md +3 -3
  29. package/docs/location.md +3 -3
  30. package/docs/offlineManager.md +28 -44
  31. package/docs/snapshotManager.md +6 -6
  32. package/ios/RCTMLN/RCTMLNStyle.h +1 -1
  33. package/ios/RCTMLN/RCTMLNStyle.m +1 -1
  34. package/javascript/utils/MaplibreStyles.d.ts +3 -1
  35. package/javascript/utils/index.ts +8 -7
  36. package/javascript/utils/styleMap.ts +1 -1
  37. package/package.json +10 -17
  38. package/scripts/codegen.ts +12 -9
  39. package/scripts/templates/MaplibreStyles.ts.ejs +3 -1
  40. package/scripts/templates/RCTMLNStyle.h.ejs +2 -2
  41. package/scripts/templates/RCTMLNStyle.m.ejs +2 -2
  42. package/scripts/templates/RCTMLNStyleFactory.java.ejs +2 -2
  43. package/scripts/templates/component.md.ejs +83 -82
  44. package/scripts/templates/styleMap.ts.ejs +2 -2
  45. package/scripts/utils/MarkdownBuilder.ts +4 -4
  46. package/scripts/utils/TemplateHelpers.ts +7 -1
  47. package/scripts/utils/getNativeVersion.ts +1 -1
  48. package/.husky/pre-commit +0 -5
  49. package/android/rctmln/.settings/org.eclipse.buildship.core.prefs +0 -2
  50. package/android/rctmln/build.gradle +0 -64
  51. package/android/rctmln/proguard-rules.pro +0 -25
  52. package/ios/RCTMLN/index.d.ts +0 -1183
  53. package/react-native.config.js +0 -10
  54. package/scripts/templates/index.d.ts.ejs +0 -86
  55. /package/android/{rctmln/src → src}/main/AndroidManifest.xml +0 -0
  56. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/RCTMLNPackage.java +0 -0
  57. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractEvent.java +0 -0
  58. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractEventEmitter.java +0 -0
  59. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractMapFeature.java +0 -0
  60. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/MarkerView.java +0 -0
  61. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/MarkerViewManager.java +0 -0
  62. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNCallout.java +0 -0
  63. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNCalloutManager.java +0 -0
  64. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNMarkerView.java +0 -0
  65. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNMarkerViewManager.java +0 -0
  66. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNPointAnnotation.java +0 -0
  67. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNPointAnnotationManager.java +0 -0
  68. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraStop.java +0 -0
  69. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraUpdateItem.java +0 -0
  70. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraUpdateQueue.java +0 -0
  71. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/RCTMLNCamera.java +0 -0
  72. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/RCTMLNCameraManager.java +0 -0
  73. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/constants/CameraMode.java +0 -0
  74. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/images/RCTMLNImages.java +0 -0
  75. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/images/RCTMLNImagesManager.java +0 -0
  76. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/LocationComponentManager.java +0 -0
  77. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/RCTMLNNativeUserLocation.java +0 -0
  78. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/RCTMLNNativeUserLocationManager.java +0 -0
  79. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/LayerSourceInfo.java +0 -0
  80. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNAndroidTextureMapView.java +0 -0
  81. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNAndroidTextureMapViewManager.java +0 -0
  82. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNMapView.java +0 -0
  83. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNMapViewManager.java +0 -0
  84. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/helpers/CameraChangeTracker.java +0 -0
  85. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyle.java +0 -0
  86. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleFunctionParser.java +0 -0
  87. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleValue.java +0 -0
  88. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTLayer.java +0 -0
  89. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNBackgroundLayer.java +0 -0
  90. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNBackgroundLayerManager.java +0 -0
  91. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNCircleLayer.java +0 -0
  92. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNCircleLayerManager.java +0 -0
  93. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillExtrusionLayer.java +0 -0
  94. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillExtrusionLayerManager.java +0 -0
  95. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillLayer.java +0 -0
  96. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillLayerManager.java +0 -0
  97. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNHeatmapLayer.java +0 -0
  98. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNHeatmapLayerManager.java +0 -0
  99. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNLineLayer.java +0 -0
  100. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNLineLayerManager.java +0 -0
  101. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNRasterLayer.java +0 -0
  102. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNRasterLayerManager.java +0 -0
  103. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNSymbolLayer.java +0 -0
  104. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNSymbolLayerManager.java +0 -0
  105. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/light/RCTMLNLight.java +0 -0
  106. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/light/RCTMLNLightManager.java +0 -0
  107. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNImageSource.java +0 -0
  108. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNImageSourceManager.java +0 -0
  109. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNRasterSource.java +0 -0
  110. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNRasterSourceManager.java +0 -0
  111. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNShapeSource.java +0 -0
  112. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNShapeSourceManager.java +0 -0
  113. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNTileSource.java +0 -0
  114. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNTileSourceManager.java +0 -0
  115. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNVectorSource.java +0 -0
  116. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNVectorSourceManager.java +0 -0
  117. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTSource.java +0 -0
  118. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/AbstractEvent.java +0 -0
  119. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/AndroidCallbackEvent.java +0 -0
  120. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/EventEmitter.java +0 -0
  121. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/FeatureClickEvent.java +0 -0
  122. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/IEvent.java +0 -0
  123. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/ImageMissingEvent.java +0 -0
  124. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/LocationEvent.java +0 -0
  125. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapChangeEvent.java +0 -0
  126. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapClickEvent.java +0 -0
  127. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapUserTrackingModeEvent.java +0 -0
  128. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/OfflineEvent.java +0 -0
  129. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/PointAnnotationClickEvent.java +0 -0
  130. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/PointAnnotationDragEvent.java +0 -0
  131. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/constants/EventKeys.java +0 -0
  132. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/constants/EventTypes.java +0 -0
  133. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/http/CustomHeadersInterceptor.java +0 -0
  134. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/LocationManager.java +0 -0
  135. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserLocation.java +0 -0
  136. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserLocationVerticalAlignment.java +0 -0
  137. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserTrackingMode.java +0 -0
  138. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserTrackingState.java +0 -0
  139. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNLocationModule.java +0 -0
  140. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNLogging.java +0 -0
  141. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNModule.java +0 -0
  142. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNOfflineModule.java +0 -0
  143. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNSnapshotModule.java +0 -0
  144. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/BitmapUtils.java +0 -0
  145. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ClusterPropertyEntry.java +0 -0
  146. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ConvertUtils.java +0 -0
  147. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/DownloadMapImageTask.java +0 -0
  148. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ExpressionParser.java +0 -0
  149. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/GeoJSONUtils.java +0 -0
  150. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/GeoViewport.java +0 -0
  151. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ImageEntry.java +0 -0
  152. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ResourceUtils.java +0 -0
  153. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/SimpleEventCallback.java +0 -0
  154. /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/SphericalMercator.java +0 -0
  155. /package/android/{rctmln/src → src}/main/res/drawable/empty.xml +0 -0
  156. /package/android/{rctmln/src → src}/main/res/drawable/empty_drawable.png +0 -0
  157. /package/android/{rctmln/src → src}/main/res/drawable-xxhdpi/red_marker.png +0 -0
  158. /package/android/{rctmln/src → src}/main/res/layout/annotation.xml +0 -0
  159. /package/android/{rctmln/src → src}/main/res/values/strings.xml +0 -0
package/docs/LineLayer.md CHANGED
@@ -1,577 +1,603 @@
1
- <!-- DO NOT MODIFY! -->
1
+ <!-- DO NOT MODIFY -->
2
2
  <!-- This file is auto-generated from javascript/components/LineLayer.tsx -->
3
- ## <MapLibreGL.LineLayer />
4
- ### LineLayer is a style layer that renders one or more stroked polylines on the map.
3
+ # `<MapLibreGL.LineLayer />`
4
+ LineLayer is a style layer that renders one or more stroked polylines on the map.
5
5
 
6
- ### props
6
+ ## Props
7
7
  | Prop | Type | Default | Required | Description |
8
8
  | ---- | :--: | :-----: | :------: | :----------: |
9
9
  | style | `LineLayerStyleProps` | `none` | `false` | Customizable style attributes |
10
10
  | sourceID | `FIX ME UNKNOWN TYPE` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | FIX ME NO DESCRIPTION |
11
11
 
12
12
 
13
- ### styles
14
-
15
- * <a href="#name">lineCap</a><br/>
16
- * <a href="#name-1">lineJoin</a><br/>
17
- * <a href="#name-2">lineMiterLimit</a><br/>
18
- * <a href="#name-3">lineRoundLimit</a><br/>
19
- * <a href="#name-4">lineSortKey</a><br/>
20
- * <a href="#name-5">visibility</a><br/>
21
- * <a href="#name-6">lineOpacity</a><br/>
22
- * <a href="#name-7">lineColor</a><br/>
23
- * <a href="#name-8">lineTranslate</a><br/>
24
- * <a href="#name-9">lineTranslateAnchor</a><br/>
25
- * <a href="#name-10">lineWidth</a><br/>
26
- * <a href="#name-11">lineGapWidth</a><br/>
27
- * <a href="#name-12">lineOffset</a><br/>
28
- * <a href="#name-13">lineBlur</a><br/>
29
- * <a href="#name-14">lineDasharray</a><br/>
30
- * <a href="#name-15">linePattern</a><br/>
31
- * <a href="#name-16">lineGradient</a><br/>
32
-
33
- ___
34
-
35
- #### Name
36
- `lineCap`
37
-
38
- #### Description
39
- The display of line endings.
40
-
41
- #### Type
42
- `enum`
43
- #### Default Value
44
- `butt`
45
-
46
- #### Supported Values
47
- **butt** - A cap with a squared-off end which is drawn to the exact endpoint of the line.<br />
48
- **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 />
49
- **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 />
13
+ ## Styles
50
14
 
15
+ * <a href="#name">`lineCap`</a><br/>
16
+ * <a href="#name-1">`lineJoin`</a><br/>
17
+ * <a href="#name-2">`lineMiterLimit`</a><br/>
18
+ * <a href="#name-3">`lineRoundLimit`</a><br/>
19
+ * <a href="#name-4">`lineSortKey`</a><br/>
20
+ * <a href="#name-5">`visibility`</a><br/>
21
+ * <a href="#name-6">`lineOpacity`</a><br/>
22
+ * <a href="#name-7">`lineColor`</a><br/>
23
+ * <a href="#name-8">`lineTranslate`</a><br/>
24
+ * <a href="#name-9">`lineTranslateAnchor`</a><br/>
25
+ * <a href="#name-10">`lineWidth`</a><br/>
26
+ * <a href="#name-11">`lineGapWidth`</a><br/>
27
+ * <a href="#name-12">`lineOffset`</a><br/>
28
+ * <a href="#name-13">`lineBlur`</a><br/>
29
+ * <a href="#name-14">`lineDasharray`</a><br/>
30
+ * <a href="#name-15">`linePattern`</a><br/>
31
+ * <a href="#name-16">`lineGradient`</a><br/>
51
32
 
52
- #### Expression
53
33
 
54
- Parameters: `zoom`
34
+ ### `lineCap`
55
35
 
56
- ___
36
+ The display of line endings.
57
37
 
58
- #### Name
59
- `lineJoin`
38
+ <dl>
39
+ <dt>Type</dt>
40
+ <dd>
41
+ <code>enum</code>
42
+ </dd>
43
+ <dt>Default Value</dt>
44
+ <dd><code>butt</code></dd>
45
+ <dt>Supported Values</dt>
46
+ <dd>
47
+ <ul>
48
+ <li>
49
+ <code>butt</code>: A cap with a squared-off end which is drawn to the exact endpoint of the line.
50
+ </li>
51
+ <li>
52
+ <code>round</code>: 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.
53
+ </li>
54
+ <li>
55
+ <code>square</code>: 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.
56
+ </li>
57
+ </ul>
58
+ </dd>
59
+ <dt>Expression Parameters</dt>
60
+ <dd><code>zoom</code></dd>
61
+ </dl>
62
+
63
+
64
+
65
+ ### `lineJoin`
60
66
 
61
- #### Description
62
67
  The display of lines when joining.
63
68
 
64
- #### Type
65
- `enum`
66
- #### Default Value
67
- `miter`
68
-
69
- #### Supported Values
70
- **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 />
71
- **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 />
72
- **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 />
73
-
69
+ <dl>
70
+ <dt>Type</dt>
71
+ <dd>
72
+ <code>enum</code>
73
+ </dd>
74
+ <dt>Default Value</dt>
75
+ <dd><code>miter</code></dd>
76
+ <dt>Supported Values</dt>
77
+ <dd>
78
+ <ul>
79
+ <li>
80
+ <code>bevel</code>: 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.
81
+ </li>
82
+ <li>
83
+ <code>round</code>: 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.
84
+ </li>
85
+ <li>
86
+ <code>miter</code>: A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.
87
+ </li>
88
+ </ul>
89
+ </dd>
90
+ <dt>Supported Style Functions</dt>
91
+ <dd><code>camera</code></dd>
92
+ <dt>Expression Parameters</dt>
93
+ <dd><code>zoom, feature</code></dd>
94
+ </dl>
95
+
96
+
97
+
98
+ ### `lineMiterLimit`
74
99
 
75
- #### Supported Style Functions
76
- `camera`
77
- #### Expression
78
-
79
- Parameters: `zoom, feature`
80
-
81
- ___
82
-
83
- #### Name
84
- `lineMiterLimit`
85
-
86
- #### Description
87
100
  Used to automatically convert miter joins to bevel joins for sharp angles.
88
101
 
89
- #### Type
90
- `number`
91
- #### Default Value
92
- `2`
93
-
102
+ <dl>
103
+ <dt>Type</dt>
104
+ <dd>
105
+ <code>number</code>
106
+ </dd>
107
+ <dt>Default Value</dt>
108
+ <dd><code>2</code></dd>
109
+ </ul>
110
+ </dd>
111
+ <dt>Expression Parameters</dt>
112
+ <dd><code>zoom</code></dd>
113
+ </dl>
94
114
 
95
- #### Expression
96
115
 
97
- Parameters: `zoom`
98
116
 
99
- ___
117
+ ### `lineRoundLimit`
100
118
 
101
- #### Name
102
- `lineRoundLimit`
103
-
104
- #### Description
105
119
  Used to automatically convert round joins to miter joins for shallow angles.
106
120
 
107
- #### Type
108
- `number`
109
- #### Default Value
110
- `1.05`
111
-
112
-
113
- #### Expression
121
+ <dl>
122
+ <dt>Type</dt>
123
+ <dd>
124
+ <code>number</code>
125
+ </dd>
126
+ <dt>Default Value</dt>
127
+ <dd><code>1.05</code></dd>
128
+ </ul>
129
+ </dd>
130
+ <dt>Expression Parameters</dt>
131
+ <dd><code>zoom</code></dd>
132
+ </dl>
114
133
 
115
- Parameters: `zoom`
116
134
 
117
- ___
118
135
 
119
- #### Name
120
- `lineSortKey`
136
+ ### `lineSortKey`
121
137
 
122
- #### Description
123
138
  Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
124
139
 
125
- #### Type
126
- `number`
127
-
128
-
129
- #### Expression
140
+ <dl>
141
+ <dt>Type</dt>
142
+ <dd>
143
+ <code>number</code>
144
+ </dd>
145
+ </ul>
146
+ </dd>
147
+ <dt>Expression Parameters</dt>
148
+ <dd><code>zoom, feature</code></dd>
149
+ </dl>
130
150
 
131
- Parameters: `zoom, feature`
132
151
 
133
- ___
134
152
 
135
- #### Name
136
- `visibility`
153
+ ### `visibility`
137
154
 
138
- #### Description
139
155
  Whether this layer is displayed.
140
156
 
141
- #### Type
142
- `enum`
143
- #### Default Value
144
- `visible`
145
-
146
- #### Supported Values
147
- **visible** - The layer is shown.<br />
148
- **none** - The layer is not shown.<br />
149
-
150
-
151
-
152
- ___
153
-
154
- #### Name
155
- `lineOpacity`
157
+ <dl>
158
+ <dt>Type</dt>
159
+ <dd>
160
+ <code>enum</code>
161
+ </dd>
162
+ <dt>Default Value</dt>
163
+ <dd><code>visible</code></dd>
164
+ <dt>Supported Values</dt>
165
+ <dd>
166
+ <ul>
167
+ <li>
168
+ <code>visible</code>: The layer is shown.
169
+ </li>
170
+ <li>
171
+ <code>none</code>: The layer is not shown.
172
+ </li>
173
+ </ul>
174
+ </dd>
175
+ </dl>
176
+
177
+
178
+
179
+ ### `lineOpacity`
156
180
 
157
- #### Description
158
181
  The opacity at which the line will be drawn.
159
182
 
160
- #### Type
161
- `number`
162
- #### Default Value
163
- `1`
183
+ <dl>
184
+ <dt>Type</dt>
185
+ <dd>
186
+ <code>number</code>
187
+ </dd>
188
+ <dt>Default Value</dt>
189
+ <dd><code>1</code></dd>
190
+ </ul>
191
+ </dd>
192
+ <dt>Minimum</dt>
193
+ <dd><code>0</code></dd>
194
+ <dt>Maximum</dt>
195
+ <dd><code>1</code></dd>
196
+ <dt>Expression Parameters</dt>
197
+ <dd><code>zoom, feature, feature-state</code></dd>
198
+ </dl>
199
+
200
+ ### `lineOpacityTransition`
201
+
202
+ The transition affecting any changes to this layer’s lineOpacity property.
203
+
204
+ <dl>
205
+ <dt>Type</dt>
206
+ <dd>
207
+ <code>{ duration, delay }</code>
208
+ </dd>
209
+
210
+ <dt>Units</dt>
211
+ <dd>
212
+ <code>milliseconds</code>
213
+ </dd>
214
+
215
+ <dt>Default Value</dt>
216
+ <dd>
217
+ <code>{duration: 300, delay: 0}</code>
218
+ </dd>
219
+ </dl>
220
+
221
+
222
+ ### `lineColor`
164
223
 
165
- #### Minimum
166
- `0`
167
-
168
-
169
- #### Maximum
170
- `1`
171
-
172
- #### Expression
173
-
174
- Parameters: `zoom, feature, feature-state`
175
- ___
176
-
177
- #### Name
178
-
179
- `lineOpacityTransition`
180
-
181
- #### Description
182
-
183
- The transition affecting any changes to this layer’s lineOpacity propery.
184
-
185
- #### Type
186
-
187
- `{ duration, delay }`
188
-
189
- #### Units
190
- `milliseconds`
191
-
192
- #### Default Value
193
- `{duration: 300, delay: 0}`
194
-
195
-
196
- ___
197
-
198
- #### Name
199
- `lineColor`
200
-
201
- #### Description
202
224
  The color with which the line will be drawn.
203
225
 
204
- #### Type
205
- `color`
206
- #### Default Value
207
- `#000000`
208
-
209
-
210
- #### Disabled By
211
- `linePattern`
212
-
213
- #### Expression
214
-
215
- Parameters: `zoom, feature, feature-state`
216
- ___
226
+ <dl>
227
+ <dt>Type</dt>
228
+ <dd>
229
+ <code>color</code>
230
+ </dd>
231
+ <dt>Default Value</dt>
232
+ <dd><code>#000000</code></dd>
233
+ </ul>
234
+ </dd>
235
+ <dt>Disabled By</dt>
236
+ <dd><code>linePattern</code></dd>
237
+ <dt>Expression Parameters</dt>
238
+ <dd><code>zoom, feature, feature-state</code></dd>
239
+ </dl>
240
+
241
+ ### `lineColorTransition`
242
+
243
+ The transition affecting any changes to this layer’s lineColor property.
244
+
245
+ <dl>
246
+ <dt>Type</dt>
247
+ <dd>
248
+ <code>{ duration, delay }</code>
249
+ </dd>
250
+
251
+ <dt>Units</dt>
252
+ <dd>
253
+ <code>milliseconds</code>
254
+ </dd>
255
+
256
+ <dt>Default Value</dt>
257
+ <dd>
258
+ <code>{duration: 300, delay: 0}</code>
259
+ </dd>
260
+ </dl>
261
+
262
+
263
+ ### `lineTranslate`
217
264
 
218
- #### Name
219
-
220
- `lineColorTransition`
221
-
222
- #### Description
223
-
224
- The transition affecting any changes to this layer’s lineColor propery.
225
-
226
- #### Type
227
-
228
- `{ duration, delay }`
229
-
230
- #### Units
231
- `milliseconds`
232
-
233
- #### Default Value
234
- `{duration: 300, delay: 0}`
235
-
236
-
237
- ___
238
-
239
- #### Name
240
- `lineTranslate`
241
-
242
- #### Description
243
265
  The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
244
266
 
245
- #### Type
246
- `array<number>`
247
- #### Default Value
248
- `[0,0]`
249
-
250
- #### Units
251
- `pixels`
252
-
253
-
254
- #### Expression
255
-
256
- Parameters: `zoom`
257
- ___
258
-
259
- #### Name
260
-
261
- `lineTranslateTransition`
262
-
263
- #### Description
264
-
265
- The transition affecting any changes to this layer’s lineTranslate propery.
266
-
267
- #### Type
268
-
269
- `{ duration, delay }`
267
+ <dl>
268
+ <dt>Type</dt>
269
+ <dd>
270
+ <code>array<number></code>
271
+ </dd>
272
+ <dt>Default Value</dt>
273
+ <dd><code>[0,0]</code></dd>
274
+ </ul>
275
+ </dd>
276
+ <dt>Units</dt>
277
+ <dd><code>pixels</code></dd>
278
+ <dt>Expression Parameters</dt>
279
+ <dd><code>zoom</code></dd>
280
+ </dl>
281
+
282
+ ### `lineTranslateTransition`
283
+
284
+ The transition affecting any changes to this layer’s lineTranslate property.
285
+
286
+ <dl>
287
+ <dt>Type</dt>
288
+ <dd>
289
+ <code>{ duration, delay }</code>
290
+ </dd>
291
+
292
+ <dt>Units</dt>
293
+ <dd>
294
+ <code>milliseconds</code>
295
+ </dd>
296
+
297
+ <dt>Default Value</dt>
298
+ <dd>
299
+ <code>{duration: 300, delay: 0}</code>
300
+ </dd>
301
+ </dl>
302
+
303
+
304
+ ### `lineTranslateAnchor`
270
305
 
271
- #### Units
272
- `milliseconds`
273
-
274
- #### Default Value
275
- `{duration: 300, delay: 0}`
276
-
277
-
278
- ___
279
-
280
- #### Name
281
- `lineTranslateAnchor`
282
-
283
- #### Description
284
306
  Controls the frame of reference for `lineTranslate`.
285
307
 
286
- #### Type
287
- `enum`
288
- #### Default Value
289
- `map`
290
-
291
- #### Supported Values
292
- **map** - The line is translated relative to the map.<br />
293
- **viewport** - The line is translated relative to the viewport.<br />
294
-
295
-
296
- #### Requires
297
- `lineTranslate`
298
-
299
- #### Expression
300
-
301
- Parameters: `zoom`
308
+ <dl>
309
+ <dt>Type</dt>
310
+ <dd>
311
+ <code>enum</code>
312
+ </dd>
313
+ <dt>Default Value</dt>
314
+ <dd><code>map</code></dd>
315
+ <dt>Supported Values</dt>
316
+ <dd>
317
+ <ul>
318
+ <li>
319
+ <code>map</code>: The line is translated relative to the map.
320
+ </li>
321
+ <li>
322
+ <code>viewport</code>: The line is translated relative to the viewport.
323
+ </li>
324
+ </ul>
325
+ </dd>
326
+ <dt>Requires</dt>
327
+ <dd><code>lineTranslate</code></dd>
328
+ <dt>Expression Parameters</dt>
329
+ <dd><code>zoom</code></dd>
330
+ </dl>
331
+
332
+
333
+
334
+ ### `lineWidth`
302
335
 
303
- ___
304
-
305
- #### Name
306
- `lineWidth`
307
-
308
- #### Description
309
336
  Stroke thickness.
310
337
 
311
- #### Type
312
- `number`
313
- #### Default Value
314
- `1`
315
-
316
- #### Units
317
- `pixels`
318
-
319
- #### Minimum
320
- `0`
321
-
322
-
323
- #### Supported Style Functions
324
- `camera`
325
- #### Expression
326
-
327
- Parameters: `zoom, feature, feature-state`
328
- ___
329
-
330
- #### Name
331
-
332
- `lineWidthTransition`
333
-
334
- #### Description
338
+ <dl>
339
+ <dt>Type</dt>
340
+ <dd>
341
+ <code>number</code>
342
+ </dd>
343
+ <dt>Default Value</dt>
344
+ <dd><code>1</code></dd>
345
+ </ul>
346
+ </dd>
347
+ <dt>Units</dt>
348
+ <dd><code>pixels</code></dd>
349
+ <dt>Minimum</dt>
350
+ <dd><code>0</code></dd>
351
+ <dt>Supported Style Functions</dt>
352
+ <dd><code>camera</code></dd>
353
+ <dt>Expression Parameters</dt>
354
+ <dd><code>zoom, feature, feature-state</code></dd>
355
+ </dl>
356
+
357
+ ### `lineWidthTransition`
358
+
359
+ The transition affecting any changes to this layer’s lineWidth property.
360
+
361
+ <dl>
362
+ <dt>Type</dt>
363
+ <dd>
364
+ <code>{ duration, delay }</code>
365
+ </dd>
366
+
367
+ <dt>Units</dt>
368
+ <dd>
369
+ <code>milliseconds</code>
370
+ </dd>
371
+
372
+ <dt>Default Value</dt>
373
+ <dd>
374
+ <code>{duration: 300, delay: 0}</code>
375
+ </dd>
376
+ </dl>
377
+
378
+
379
+ ### `lineGapWidth`
335
380
 
336
- The transition affecting any changes to this layer’s lineWidth propery.
337
-
338
- #### Type
339
-
340
- `{ duration, delay }`
341
-
342
- #### Units
343
- `milliseconds`
344
-
345
- #### Default Value
346
- `{duration: 300, delay: 0}`
347
-
348
-
349
- ___
350
-
351
- #### Name
352
- `lineGapWidth`
353
-
354
- #### Description
355
381
  Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
356
382
 
357
- #### Type
358
- `number`
359
- #### Default Value
360
- `0`
361
-
362
- #### Units
363
- `pixels`
364
-
365
- #### Minimum
366
- `0`
367
-
368
-
369
- #### Expression
370
-
371
- Parameters: `zoom, feature, feature-state`
372
- ___
373
-
374
- #### Name
375
-
376
- `lineGapWidthTransition`
377
-
378
- #### Description
379
-
380
- The transition affecting any changes to this layer’s lineGapWidth propery.
381
-
382
- #### Type
383
-
384
- `{ duration, delay }`
385
-
386
- #### Units
387
- `milliseconds`
388
-
389
- #### Default Value
390
- `{duration: 300, delay: 0}`
383
+ <dl>
384
+ <dt>Type</dt>
385
+ <dd>
386
+ <code>number</code>
387
+ </dd>
388
+ <dt>Default Value</dt>
389
+ <dd><code>0</code></dd>
390
+ </ul>
391
+ </dd>
392
+ <dt>Units</dt>
393
+ <dd><code>pixels</code></dd>
394
+ <dt>Minimum</dt>
395
+ <dd><code>0</code></dd>
396
+ <dt>Expression Parameters</dt>
397
+ <dd><code>zoom, feature, feature-state</code></dd>
398
+ </dl>
399
+
400
+ ### `lineGapWidthTransition`
401
+
402
+ The transition affecting any changes to this layer’s lineGapWidth property.
403
+
404
+ <dl>
405
+ <dt>Type</dt>
406
+ <dd>
407
+ <code>{ duration, delay }</code>
408
+ </dd>
409
+
410
+ <dt>Units</dt>
411
+ <dd>
412
+ <code>milliseconds</code>
413
+ </dd>
414
+
415
+ <dt>Default Value</dt>
416
+ <dd>
417
+ <code>{duration: 300, delay: 0}</code>
418
+ </dd>
419
+ </dl>
420
+
421
+
422
+ ### `lineOffset`
391
423
 
392
-
393
- ___
394
-
395
- #### Name
396
- `lineOffset`
397
-
398
- #### Description
399
424
  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.
400
425
 
401
- #### Type
402
- `number`
403
- #### Default Value
404
- `0`
405
-
406
- #### Units
407
- `pixels`
408
-
409
-
410
- #### Expression
411
-
412
- Parameters: `zoom, feature, feature-state`
413
- ___
414
-
415
- #### Name
416
-
417
- `lineOffsetTransition`
418
-
419
- #### Description
426
+ <dl>
427
+ <dt>Type</dt>
428
+ <dd>
429
+ <code>number</code>
430
+ </dd>
431
+ <dt>Default Value</dt>
432
+ <dd><code>0</code></dd>
433
+ </ul>
434
+ </dd>
435
+ <dt>Units</dt>
436
+ <dd><code>pixels</code></dd>
437
+ <dt>Expression Parameters</dt>
438
+ <dd><code>zoom, feature, feature-state</code></dd>
439
+ </dl>
440
+
441
+ ### `lineOffsetTransition`
442
+
443
+ The transition affecting any changes to this layer’s lineOffset property.
444
+
445
+ <dl>
446
+ <dt>Type</dt>
447
+ <dd>
448
+ <code>{ duration, delay }</code>
449
+ </dd>
450
+
451
+ <dt>Units</dt>
452
+ <dd>
453
+ <code>milliseconds</code>
454
+ </dd>
455
+
456
+ <dt>Default Value</dt>
457
+ <dd>
458
+ <code>{duration: 300, delay: 0}</code>
459
+ </dd>
460
+ </dl>
461
+
462
+
463
+ ### `lineBlur`
420
464
 
421
- The transition affecting any changes to this layer’s lineOffset propery.
422
-
423
- #### Type
424
-
425
- `{ duration, delay }`
426
-
427
- #### Units
428
- `milliseconds`
429
-
430
- #### Default Value
431
- `{duration: 300, delay: 0}`
432
-
433
-
434
- ___
435
-
436
- #### Name
437
- `lineBlur`
438
-
439
- #### Description
440
465
  Blur applied to the line, in pixels.
441
466
 
442
- #### Type
443
- `number`
444
- #### Default Value
445
- `0`
446
-
447
- #### Units
448
- `pixels`
449
-
450
- #### Minimum
451
- `0`
467
+ <dl>
468
+ <dt>Type</dt>
469
+ <dd>
470
+ <code>number</code>
471
+ </dd>
472
+ <dt>Default Value</dt>
473
+ <dd><code>0</code></dd>
474
+ </ul>
475
+ </dd>
476
+ <dt>Units</dt>
477
+ <dd><code>pixels</code></dd>
478
+ <dt>Minimum</dt>
479
+ <dd><code>0</code></dd>
480
+ <dt>Expression Parameters</dt>
481
+ <dd><code>zoom, feature, feature-state</code></dd>
482
+ </dl>
483
+
484
+ ### `lineBlurTransition`
485
+
486
+ The transition affecting any changes to this layer’s lineBlur property.
487
+
488
+ <dl>
489
+ <dt>Type</dt>
490
+ <dd>
491
+ <code>{ duration, delay }</code>
492
+ </dd>
493
+
494
+ <dt>Units</dt>
495
+ <dd>
496
+ <code>milliseconds</code>
497
+ </dd>
498
+
499
+ <dt>Default Value</dt>
500
+ <dd>
501
+ <code>{duration: 300, delay: 0}</code>
502
+ </dd>
503
+ </dl>
504
+
505
+
506
+ ### `lineDasharray`
452
507
 
453
-
454
- #### Expression
455
-
456
- Parameters: `zoom, feature, feature-state`
457
- ___
458
-
459
- #### Name
460
-
461
- `lineBlurTransition`
462
-
463
- #### Description
464
-
465
- The transition affecting any changes to this layer’s lineBlur propery.
466
-
467
- #### Type
468
-
469
- `{ duration, delay }`
470
-
471
- #### Units
472
- `milliseconds`
473
-
474
- #### Default Value
475
- `{duration: 300, delay: 0}`
476
-
477
-
478
- ___
479
-
480
- #### Name
481
- `lineDasharray`
482
-
483
- #### Description
484
508
  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.
485
509
 
486
- #### Type
487
- `array<number>`
488
-
489
- #### Units
490
- `line widths`
491
-
492
- #### Minimum
493
- `0`
494
-
495
-
496
- #### Disabled By
497
- `linePattern`
498
-
499
- #### Expression
500
-
501
- Parameters: `zoom`
502
- ___
503
-
504
- #### Name
510
+ <dl>
511
+ <dt>Type</dt>
512
+ <dd>
513
+ <code>array<number></code>
514
+ </dd>
515
+ </ul>
516
+ </dd>
517
+ <dt>Units</dt>
518
+ <dd><code>line widths</code></dd>
519
+ <dt>Minimum</dt>
520
+ <dd><code>0</code></dd>
521
+ <dt>Disabled By</dt>
522
+ <dd><code>linePattern</code></dd>
523
+ <dt>Expression Parameters</dt>
524
+ <dd><code>zoom</code></dd>
525
+ </dl>
526
+
527
+ ### `lineDasharrayTransition`
528
+
529
+ The transition affecting any changes to this layer’s lineDasharray property.
530
+
531
+ <dl>
532
+ <dt>Type</dt>
533
+ <dd>
534
+ <code>{ duration, delay }</code>
535
+ </dd>
536
+
537
+ <dt>Units</dt>
538
+ <dd>
539
+ <code>milliseconds</code>
540
+ </dd>
541
+
542
+ <dt>Default Value</dt>
543
+ <dd>
544
+ <code>{duration: 300, delay: 0}</code>
545
+ </dd>
546
+ </dl>
547
+
548
+
549
+ ### `linePattern`
505
550
 
506
- `lineDasharrayTransition`
507
-
508
- #### Description
509
-
510
- The transition affecting any changes to this layer’s lineDasharray propery.
511
-
512
- #### Type
513
-
514
- `{ duration, delay }`
515
-
516
- #### Units
517
- `milliseconds`
518
-
519
- #### Default Value
520
- `{duration: 300, delay: 0}`
521
-
522
-
523
- ___
524
-
525
- #### Name
526
- `linePattern`
527
-
528
- #### Description
529
551
  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.
530
552
 
531
- #### Type
532
- `resolvedImage`
553
+ <dl>
554
+ <dt>Type</dt>
555
+ <dd>
556
+ <code>resolvedImage</code>
557
+ </dd>
558
+ </ul>
559
+ </dd>
560
+ <dt>Expression Parameters</dt>
561
+ <dd><code>zoom, feature</code></dd>
562
+ </dl>
533
563
 
564
+ ### `linePatternTransition`
534
565
 
535
- #### Expression
566
+ The transition affecting any changes to this layer’s linePattern property.
536
567
 
537
- Parameters: `zoom, feature`
538
- ___
568
+ <dl>
569
+ <dt>Type</dt>
570
+ <dd>
571
+ <code>{ duration, delay }</code>
572
+ </dd>
539
573
 
540
- #### Name
574
+ <dt>Units</dt>
575
+ <dd>
576
+ <code>milliseconds</code>
577
+ </dd>
541
578
 
542
- `linePatternTransition`
579
+ <dt>Default Value</dt>
580
+ <dd>
581
+ <code>{duration: 300, delay: 0}</code>
582
+ </dd>
583
+ </dl>
543
584
 
544
- #### Description
545
585
 
546
- The transition affecting any changes to this layer’s linePattern propery.
586
+ ### `lineGradient`
547
587
 
548
- #### Type
549
-
550
- `{ duration, delay }`
551
-
552
- #### Units
553
- `milliseconds`
554
-
555
- #### Default Value
556
- `{duration: 300, delay: 0}`
557
-
558
-
559
- ___
560
-
561
- #### Name
562
- `lineGradient`
563
-
564
- #### Description
565
588
  Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `"lineMetrics": true`.
566
589
 
567
- #### Type
568
- `color`
569
-
570
-
571
- #### Disabled By
572
- `lineDasharray, linePattern`
573
-
574
- #### Expression
590
+ <dl>
591
+ <dt>Type</dt>
592
+ <dd>
593
+ <code>color</code>
594
+ </dd>
595
+ </ul>
596
+ </dd>
597
+ <dt>Disabled By</dt>
598
+ <dd><code>lineDasharray, linePattern</code></dd>
599
+ <dt>Expression Parameters</dt>
600
+ <dd><code>line-progress</code></dd>
601
+ </dl>
575
602
 
576
- Parameters: `line-progress`
577
603