CircleLayer.md
March 19, 2018 ยท View on GitHub
<MapboxGL.CircleLayer />
CircleLayer is a style layer that renders one or more filled circles 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 |
styles
- visibility
- circleRadius
- circleColor
- circleBlur
- circleOpacity
- circleTranslate
- circleTranslateAnchor
- circlePitchScale
- circlePitchAlignment
- circleStrokeWidth
- circleStrokeColor
- circleStrokeOpacity
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
circleRadius
Description
Circle radius.
Type
number
Default Value
5
Units
pixels
Minimum
0
Supported Style Functions
camera, source, composite
Name
circleColor
Description
The fill color of the circle.
Type
color
Default Value
#000000
Supported Style Functions
camera, source, composite
Name
circleBlur
Description
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
Type
number
Default Value
0
Supported Style Functions
camera, source, composite
Name
circleOpacity
Description
The opacity at which the circle will be drawn.
Type
number
Default Value
1
Minimum
0
Maximum
1
Supported Style Functions
camera, source, composite
Name
circleTranslate
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
circleTranslateAnchor
Description
Controls the frame of reference for circleTranslate.
Type
enum
Default Value
map
Supported Values
map - The circle is translated relative to the map.
viewport - The circle is translated relative to the viewport.
Requires
circleTranslate
Supported Style Functions
camera
Name
circlePitchScale
Description
Controls the scaling behavior of the circle when the map is pitched.
Type
enum
Default Value
map
Supported Values
map - Circles are scaled according to their apparent distance to the camera.
viewport - Circles are not scaled.
Supported Style Functions
camera
Name
circlePitchAlignment
Description
Orientation of circle when map is pitched.
Type
enum
Default Value
viewport
Supported Values
map - The circle is aligned to the plane of the map.
viewport - The circle is aligned to the plane of the viewport.
Supported Style Functions
camera
Name
circleStrokeWidth
Description
The width of the circle's stroke. Strokes are placed outside of the circleRadius.
Type
number
Default Value
0
Units
pixels
Minimum
0
Supported Style Functions
camera, source, composite
Name
circleStrokeColor
Description
The stroke color of the circle.
Type
color
Default Value
#000000
Supported Style Functions
camera, source, composite
Name
circleStrokeOpacity
Description
The opacity of the circle's stroke.
Type
number
Default Value
1
Minimum
0
Maximum
1
Supported Style Functions
camera, source, composite