CircleLayer
CircleLayer¶
- CircleLayer is a style layer that renders one or more filled circles on the map.
Props¶
| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| style | CircleLayerStyleProps |
none |
false |
Customizable style attributes |
| sourceID | `` | Vietmap.StyleSource.DefaultSourceID |
false |
Styles¶
- circleSortKey
- visibility
- circleRadius
- circleColor
- circleBlur
- circleOpacity
- circleTranslate
- circleTranslateAnchor
- circlePitchScale
- circlePitchAlignment
- circleStrokeWidth
- circleStrokeColor
- circleStrokeOpacity
CircleSortKey¶
Name
circleSortKey
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
number
Expression
Parameters: zoom, feature
Visibility¶
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.
CircleRadius¶
Name
circleRadius
Description Circle radius.
Type
number
Default Value
5
Units
pixels
Minimum
0
Expression
Parameters: zoom, feature, feature-state
CircleRadiusTransition¶
Name
circleRadiusTransition
Description
The transition affecting any changes to this layer’s circleRadius propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
CircleColor¶
Name
circleColor
Description The fill color of the circle.
Type
color
Default Value
#000000
Expression
Parameters: zoom, feature, feature-state
CircleColorTransition¶
Name
circleColorTransition
Description
The transition affecting any changes to this layer’s circleColor propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
CircleBlur¶
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
Expression
Parameters: zoom, feature, feature-state
CircleBlurTransition¶
Name
circleBlurTransition
Description
The transition affecting any changes to this layer’s circleBlur propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
CircleOpacity¶
Name
circleOpacity
Description The opacity at which the circle will be drawn.
Type
number
Default Value
1
Minimum
0
Maximum
1
Expression
Parameters: zoom, feature, feature-state
CircleOpacityTransition¶
Name
circleOpacityTransition
Description
The transition affecting any changes to this layer’s circleOpacity propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
CircleTranslate¶
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
Expression
Parameters: zoom
CircleTranslateTransition¶
Name
circleTranslateTransition
Description
The transition affecting any changes to this layer’s circleTranslate propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
CircleTranslateAnchor¶
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
Expression
Parameters: zoom
CirclePitchScale¶
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.
Expression
Parameters: zoom
CirclePitchAlignment¶
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.
Expression
Parameters: zoom
CircleStrokeWidth¶
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
Expression
Parameters: zoom, feature, feature-state
CircleStrokeWidthTransition¶
Name
circleStrokeWidthTransition
Description
The transition affecting any changes to this layer’s circleStrokeWidth propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
CircleStrokeColor¶
Name
circleStrokeColor
Description The stroke color of the circle.
Type
color
Default Value
#000000
Expression
Parameters: zoom, feature, feature-state
CircleStrokeColorTransition¶
Name
circleStrokeColorTransition
Description
The transition affecting any changes to this layer’s circleStrokeColor propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
CircleStrokeOpacity¶
Name
circleStrokeOpacity
Description The opacity of the circle's stroke.
Type
number
Default Value
1
Minimum
0
Maximum
1
Expression
Parameters: zoom, feature, feature-state
CircleStrokeOpacityTransition¶
Name
circleStrokeOpacityTransition
Description
The transition affecting any changes to this layer’s circleStrokeOpacity propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}