OpenLayers 3

Class: RegularShape

ol.style.RegularShape

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

new ol.style.RegularShape(options) experimental

src/ol/style/regularshapestyle.js, line 26
Name Type Description
options

Options.

Name Type Description
fill ol.style.Fill | undefined experimental

Fill style.
points number experimental

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

Radius of a regular polygon.
radius1 number | undefined experimental

Inner radius of a star.
radius2 number | undefined experimental

Outer radius of a star.
angle number | undefined experimental

Shape's angle in radians. A value of 0 will have one of the shape's point facing up. Default value is 0.
snapToPixel boolean | undefined experimental

If true integral numbers of pixels are used as the X and Y pixel coordinate when drawing the shape in the output canvas. If false fractional numbers may be used. Using true allows for "sharp" rendering (no blur), while using false allows for "accurate" rendering. Note that accuracy is important if the shape's position is animated. Without it, the shape may jitter noticeably. Default value is true.
stroke ol.style.Stroke | undefined experimental

Stroke style.
rotation number | undefined experimental

Rotation in radians (positive rotation clockwise). Default is 0.

Extends

Methods

getAnchor(){Array.<number>} experimental

src/ol/style/regularshapestyle.js, line 142

Get the anchor point. The anchor determines the center point for the symbolizer. Its units are determined by anchorXUnits and anchorYUnits.

Returns:
Anchor.

getAngle(){number} experimental

src/ol/style/regularshapestyle.js, line 152

Get the angle used in generating the shape.

Returns:
Shape's rotation in radians.

getFill(){ol.style.Fill} experimental

src/ol/style/regularshapestyle.js, line 162

Get the fill style for the shape.

Returns:
Fill style.

getImage(pixelRatio){HTMLCanvasElement|HTMLVideoElement|Image} experimental

src/ol/style/regularshapestyle.js, line 179

Get the image element for the symbolizer.

Name Type Description
pixelRatio number

Pixel ratio.
Returns:
Image element.

getOpacity(){number} inherited experimental

src/ol/style/imagestyle.js, line 76

Get the symbolizer opacity.

Returns:
Opacity.

getOrigin(){Array.<number>} experimental

src/ol/style/regularshapestyle.js, line 212

Get the origin of the symbolizer.

Returns:
Origin.

getPoints(){number} experimental

src/ol/style/regularshapestyle.js, line 222

Get the number of points for generating the shape.

Returns:
Number of points for stars and regular polygons.

getRadius(){number} experimental

src/ol/style/regularshapestyle.js, line 232

Get the (primary) radius for the shape.

Returns:
Radius.

getRadius2(){number} experimental

src/ol/style/regularshapestyle.js, line 242

Get the secondary radius for the shape.

Returns:
Radius2.

getRotateWithView(){boolean} inherited experimental

src/ol/style/imagestyle.js, line 86

Determine whether the symbolizer rotates with the map.

Returns:
Rotate with map.

getRotation(){number} inherited experimental

src/ol/style/imagestyle.js, line 96

Get the symoblizer rotation.

Returns:
Rotation.

getScale(){number} inherited experimental

src/ol/style/imagestyle.js, line 106

Get the symbolizer scale.

Returns:
Scale.

getSize(){ol.Size} experimental

src/ol/style/regularshapestyle.js, line 251

Get the size of the symbolizer (in pixels).

Returns:
Size.

getSnapToPixel(){boolean} inherited experimental

src/ol/style/imagestyle.js, line 116

Determine whether the symbolizer should be snapped to a pixel.

Returns:
The symbolizer should snap to a pixel.

getStroke(){ol.style.Stroke} experimental

src/ol/style/regularshapestyle.js, line 261

Get the stroke style for the shape.

Returns:
Stroke style.

setOpacity(opacity) inherited experimental

src/ol/style/imagestyle.js, line 186

Set the opacity.

Name Type Description
opacity number

Opacity.

setRotation(rotation) inherited experimental

src/ol/style/imagestyle.js, line 207

Set the rotation.

Name Type Description
rotation number

Rotation.

setScale(scale) inherited experimental

src/ol/style/imagestyle.js, line 218

Set the scale.

Name Type Description
scale number

Scale.