Class: RegularShape

ol/style/RegularShape~RegularShape 


import RegularShape from 'ol/style/RegularShape.js';

Set regular shape style for vector features. The resulting shape will be a regular polygon when radius is provided, or a star when both radius and radius2 are provided.

new RegularShape(options)

style/RegularShape.js, line 57
Name Type Description
fill Fill | undefined

Fill style.
points number

Number of points for stars and regular polygons. In case of a polygon, the number of points is the number of sides.
radius number

Radius of a regular polygon.
radius2 number | undefined

Second radius to make a star instead of a regular polygon.
angle number (defaults to 0)

Shape's angle in radians. A value of 0 will have one of the shape's points facing up.
displacement Array.<number> (defaults to [0, 0])

Displacement of the shape in pixels. Positive values will shift the shape right and up.
stroke Stroke | undefined

Stroke style.
rotation number (defaults to 0)

Rotation in radians (positive rotation clockwise).
rotateWithView boolean (defaults to false)

Whether to rotate the shape with the view.
scale number | Size (defaults to 1)

Scale. Unless two dimensional scaling is required a better result may be obtained with appropriate settings for radius and radius2.
declutterMode DeclutterMode | undefined

Declutter mode.

Subclasses

Extends

Methods

clone(){RegularShape}

style/RegularShape.js, line 158

Clones the style.

Returns:
The cloned style.

getAnchor(){Array.<number>}

style/RegularShape.js, line 184

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

Returns:
Anchor.

getAngle(){number}

style/RegularShape.js, line 201

Get the angle used in generating the shape.

Returns:
Shape's rotation in radians.

getDeclutterMode(){DeclutterMode} 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}

style/RegularShape.js, line 210

Get the fill style for the shape.

Returns:
Fill style.

getImage(pixelRatio){HTMLCanvasElement}

style/RegularShape.js, line 244

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>}

style/RegularShape.js, line 292

Get the origin of the symbolizer.

Returns:
Origin.

getPoints(){number}

style/RegularShape.js, line 301

Get the number of points for generating the shape.

Returns:
Number of points for stars and regular polygons.

getRadius(){number}

style/RegularShape.js, line 310

Get the (primary) radius for the shape.

Returns:
Radius.

getRadius2(){number | undefined}

style/RegularShape.js, line 319

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}

style/RegularShape.js, line 329

Get the size of the symbolizer (in pixels).

Returns:
Size.

getStroke(){Stroke | null}

style/RegularShape.js, line 338

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)

style/RegularShape.js, line 219

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.

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)

style/RegularShape.js, line 347

Set the stroke style.

Name Type Description
stroke Stroke | null

Stroke style.