CircleStyle — OpenLayers API reference

new CircleStyle(options) style/Circle.js, line 27

Name	Type	Description
`fill`	Fill \| undefined	Fill style.
`radius`	number	Circle radius.
`stroke`	Stroke \| undefined	Stroke style.
`displacement`	Array.<number> (defaults to [0,0])	displacement
`scale`	number \| Size (defaults to 1)	Scale. A two dimensional scale will produce an ellipse. Unless two dimensional scaling is required a better result may be obtained with an appropriate setting for `radius`.
`rotation`	number (defaults to 0)	Rotation in radians (positive rotation clockwise, meaningful only when used in conjunction with a two dimensional scale).
`rotateWithView`	boolean (defaults to false)	Whether to rotate the shape with the view (meaningful only when used in conjunction with a two dimensional scale).
`declutterMode`	DeclutterMode \| undefined	Declutter mode

Extends

RegularShape

Methods

clone(){CircleStyle} style/Circle.js, line 55

Clones the style.

Returns:

The cloned style.

getAnchor(){Array.<number>} inherited style/RegularShape.js, line 180

Get the anchor point in pixels. The anchor determines the center point for the symbolizer.

Returns:

Anchor.

getAngle(){number} inherited style/RegularShape.js, line 197

Get the angle used in generating the shape.

Returns:

Shape's rotation in radians.

getDeclutterMode(){DeclutterMode | undefined} inherited style/Image.js, line 148

Get the declutter mode of the shape

Returns:

Shape's declutter mode

getDisplacement(){Array.<number>} inherited style/Image.js, line 139

Get the displacement of the shape

Returns:

Shape's center displacement

getFill(){Fill | null} inherited style/RegularShape.js, line 206

Get the fill style for the shape.

Returns:

Fill style.

getImage(pixelRatio){HTMLCanvasElement | OffscreenCanvas} inherited style/RegularShape.js, line 240

Get the image icon.

Name	Type	Description
`pixelRatio`	number	Pixel ratio.

Returns:

Image or Canvas element.

getOpacity(){number} inherited style/Image.js, line 95

Get the symbolizer opacity.

Returns:

Opacity.

getOrigin(){Array.<number>} inherited style/RegularShape.js, line 303

Get the origin of the symbolizer.

Returns:

Origin.

getPoints(){number} inherited style/RegularShape.js, line 312

Get the number of points for generating the shape.

Returns:

Number of points for stars and regular polygons.

getRadius(){number} inherited style/RegularShape.js, line 321

Get the (primary) radius for the shape.

Returns:

Radius.

getRadius2(){number | undefined} inherited style/RegularShape.js, line 343

Get the secondary radius for the shape.

Returns:

Radius2.

getRotateWithView(){boolean} inherited style/Image.js, line 104

Determine whether the symbolizer rotates with the map.

Returns:

Rotate with map.

getRotation(){number} inherited style/Image.js, line 113

Get the symoblizer rotation.

Returns:

Rotation.

getScale(){number | Size} inherited style/Image.js, line 122

Get the symbolizer scale.

Returns:

Scale.

getSize(){Size} inherited style/RegularShape.js, line 366

Get the size of the symbolizer (in pixels).

Returns:

Size.

getStroke(){Stroke | null} inherited style/RegularShape.js, line 375

Get the stroke style for the shape.

Returns:

Stroke style.

setDisplacement(displacement) inherited style/Image.js, line 229

Set the displacement.

Name	Type	Description
`displacement`	Array.<number>	Displacement.

setFill(fill) inherited style/RegularShape.js, line 215

Set the fill style.

Name	Type	Description
`fill`	Fill \| null	Fill style.

setOpacity(opacity) inherited style/Image.js, line 239

Set the opacity.

Name	Type	Description
`opacity`	number	Opacity.

setRadius(radius) inherited style/RegularShape.js, line 330

Set the (primary) radius for the shape.

Name	Type	Description
`radius`	number	Radius.

setRadius2(radius2) inherited style/RegularShape.js, line 352

Set the secondary radius for the shape.

Name	Type	Description
`radius2`	number \| undefined	Radius2.

setRotateWithView(rotateWithView) inherited style/Image.js, line 249

Set whether to rotate the style with the view.

Name	Type	Description
`rotateWithView`	boolean	Rotate with map.

setRotation(rotation) inherited style/Image.js, line 259

Set the rotation.

Name	Type	Description
`rotation`	number	Rotation.

setScale(scale) inherited style/Image.js, line 269

Set the scale.

Name	Type	Description
`scale`	number \| Size	Scale.

setStroke(stroke) inherited style/RegularShape.js, line 384

Set the stroke style.

Name	Type	Description
`stroke`	Stroke \| null	Stroke style.