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)
-
Name Type Description fillFill | undefined Fill style.
pointsnumber Number of points for stars and regular polygons. In case of a polygon, the number of points is the number of sides.
radiusnumber Radius of a regular polygon.
radius2number | undefined Second radius to make a star instead of a regular polygon.
anglenumber (defaults to 0) Shape's angle in radians. A value of 0 will have one of the shape's points facing up.
displacementArray.<number> (defaults to [0, 0]) Displacement of the shape in pixels. Positive values will shift the shape right and up.
strokeStroke | undefined Stroke style.
rotationnumber (defaults to 0) Rotation in radians (positive rotation clockwise).
rotateWithViewboolean (defaults to false) Whether to rotate the shape with the view.
scalenumber | Size (defaults to 1) Scale. Unless two dimensional scaling is required a better result may be obtained with appropriate settings for
radiusandradius2.declutterModeDeclutterMode | undefined Declutter mode.
Subclasses
Extends
Methods
-
clone(){RegularShape}
-
Clones the style.
Returns:
The cloned style.
-
getAnchor(){Array.<number>}
-
Get the anchor point in pixels. The anchor determines the center point for the symbolizer.
Returns:
Anchor.
-
getAngle(){number}
-
Get the angle used in generating the shape.
Returns:
Shape's rotation in radians.
-
getDeclutterMode(){DeclutterMode} inherited
-
Get the declutter mode of the shape
Returns:
Shape's declutter mode
-
getDisplacement(){Array.<number>} inherited
-
Get the displacement of the shape
Returns:
Shape's center displacement
-
getFill(){Fill | null}
-
Get the fill style for the shape.
Returns:
Fill style.
-
getImage(pixelRatio){HTMLCanvasElement | OffscreenCanvas}
-
Get the image icon.
Name Type Description pixelRationumber Pixel ratio.
Returns:
Image or Canvas element.
-
getOpacity(){number} inherited
-
Get the symbolizer opacity.
Returns:
Opacity.
-
getOrigin(){Array.<number>}
-
Get the origin of the symbolizer.
Returns:
Origin.
-
getPoints(){number}
-
Get the number of points for generating the shape.
Returns:
Number of points for stars and regular polygons.
-
getRadius(){number}
-
Get the (primary) radius for the shape.
Returns:
Radius.
-
getRadius2(){number | undefined}
-
Get the secondary radius for the shape.
Returns:
Radius2.
-
getRotateWithView(){boolean} inherited
-
Determine whether the symbolizer rotates with the map.
Returns:
Rotate with map.
-
getRotation(){number} inherited
-
Get the symoblizer rotation.
Returns:
Rotation.
-
Get the symbolizer scale.
Returns:
Scale.
-
getSize(){Size}
-
Get the size of the symbolizer (in pixels).
Returns:
Size.
-
getStroke(){Stroke | null}
-
Get the stroke style for the shape.
Returns:
Stroke style.
-
setDisplacement(displacement) inherited
-
Set the displacement.
Name Type Description displacementArray.<number> Displacement.
-
setFill(fill)
-
Set the fill style.
Name Type Description fillFill | null Fill style.
-
setOpacity(opacity) inherited
-
Set the opacity.
Name Type Description opacitynumber Opacity.
-
setRadius(radius)
-
Set the (primary) radius for the shape.
Name Type Description radiusnumber Radius.
-
setRadius2(radius2)
-
Set the secondary radius for the shape.
Name Type Description radius2number | undefined Radius2.
-
setRotateWithView(rotateWithView) inherited
-
Set whether to rotate the style with the view.
Name Type Description rotateWithViewboolean Rotate with map.
-
setRotation(rotation) inherited
-
Set the rotation.
Name Type Description rotationnumber Rotation.
-
setScale(scale) inherited
-
Set the scale.
Name Type Description scalenumber | Size Scale.
-
setStroke(stroke)
-
Set the stroke style.
Name Type Description strokeStroke | null Stroke style.
© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_style_RegularShape-RegularShape.html
