Skip to content

Latest commit

 

History

History
470 lines (289 loc) · 7.76 KB

CircleLayer.md

File metadata and controls

470 lines (289 loc) · 7.76 KB

<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 true 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.
Inferred from parent source only if the layer is a direct child to it.
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


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


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


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


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


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


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


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


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


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}