| 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 |
- visibility
- circleRadius
- circleColor
- circleBlur
- circleOpacity
- circleTranslate
- circleTranslateAnchor
- circlePitchScale
- circlePitchAlignment
- circleStrokeWidth
- circleStrokeColor
- circleStrokeOpacity
visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
circleRadius
Circle radius.
number
5
pixels
0
Parameters: zoom, feature, feature-state
circleRadiusTransition
The transition affecting any changes to this layer’s circleRadius propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
circleColor
The fill color of the circle.
color
#000000
Parameters: zoom, feature, feature-state
circleColorTransition
The transition affecting any changes to this layer’s circleColor propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
circleBlur
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
number
0
Parameters: zoom, feature, feature-state
circleBlurTransition
The transition affecting any changes to this layer’s circleBlur propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
circleOpacity
The opacity at which the circle will be drawn.
number
1
0
1
Parameters: zoom, feature, feature-state
circleOpacityTransition
The transition affecting any changes to this layer’s circleOpacity propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
circleTranslate
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
array<number>
[0,0]
pixels
Parameters: zoom
circleTranslateTransition
The transition affecting any changes to this layer’s circleTranslate propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
circleTranslateAnchor
Controls the frame of reference for circleTranslate.
enum
map
map - The circle is translated relative to the map.
viewport - The circle is translated relative to the viewport.
circleTranslate
Parameters: zoom
circlePitchScale
Controls the scaling behavior of the circle when the map is pitched.
enum
map
map - Circles are scaled according to their apparent distance to the camera.
viewport - Circles are not scaled.
Parameters: zoom
circlePitchAlignment
Orientation of circle when map is pitched.
enum
viewport
map - The circle is aligned to the plane of the map.
viewport - The circle is aligned to the plane of the viewport.
Parameters: zoom
circleStrokeWidth
The width of the circle's stroke. Strokes are placed outside of the circleRadius.
number
0
pixels
0
Parameters: zoom, feature, feature-state
circleStrokeWidthTransition
The transition affecting any changes to this layer’s circleStrokeWidth propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
circleStrokeColor
The stroke color of the circle.
color
#000000
Parameters: zoom, feature, feature-state
circleStrokeColorTransition
The transition affecting any changes to this layer’s circleStrokeColor propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
circleStrokeOpacity
The opacity of the circle's stroke.
number
1
0
1
Parameters: zoom, feature, feature-state
circleStrokeOpacityTransition
The transition affecting any changes to this layer’s circleStrokeOpacity propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}