Constructor

# new RegularShape(opts)

Initialization object

Parameters:

Name	Type	Attributes	Default	Description
`opts`	object			Options
`fill`	Fill	<optional>		Fill style.
`points`	number	<optional>		Number of points for stars and regular polygons. In case of a polygon, the number of points is the number of sides.
`radius`	number	<optional>		Radius of a regular polygon.
`radius1`	number	<optional>		Outer radius of a star.
`radius2`	number	<optional>		Inner radius of a star.
`angle`	number	<optional>	0	Shape's angle in radians. A value of 0 will have one of the shape's point facing up.
`displacement`	Array.<number>	<optional>	[0,0]	Displacement of the shape
`stroke`	stroke	<optional>		Stroke style.
`rotation`	number	<optional>	0	Rotation in radians (positive rotation clockwise).
`rotateWithView`	boolean	<optional>	false	Whether to rotate the shape with the view.
`scale`	number	<optional>	1	Scale. Unless two dimensional scaling is required a better result may be obtained with appropriate settings for `radius`, `radius1` and `radius2`.

Tutorials:

Point shapes styles

Classes

RegularShape

Methods

# getAnchor() → {Array.<number>}

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

Returns:

Anchor.

Type: Array.<number>

# getAngle() → {number}

Get the angle used in generating the shape.

Returns:

Shape's rotation in radians.

Type: number

# getDisplacement() → {Array.<number>}

Get the displacement of the shape

Returns:

Shape's center displacement

Type: Array.<number>

# getFill() → {Fill}

Get the fill style for the shape.

Returns:

Fill style.

Type: Fill

# getOpacity() → {number}

Get the symbolizer opacity.

Returns:

Opacity.

Type: number

# getPoints() → {number}

Get the number of points for generating the shape.

Returns:

Number of points for stars and regular polygons.

Type: number

# getRadius() → {number}

Get the (primary) radius for the shape.

Returns:

Radius.

Type: number

# getRadius2() → {number|undefined}

Get the secondary radius for the shape.

Returns:

Radius2.

Type: number | undefined

# getRotateWithView() → {boolean}

Determine whether the symbolizer rotates with the map.

Returns:

Rotate with map.

Type: boolean

# getRotation() → {number}

Get the symoblizer rotation.

Returns:

Rotation.

Type: number

# getScale() → {number}

Get the symbolizer scale.

Returns:

Scale.

Type: number

# getSize() → {number}

Get the size of the symbolizer (in pixels).

Returns:

Size.

Type: number

# getStroke() → {Stroke}

Get the stroke style for the shape.

Returns:

Stroke style.

Type: Stroke

# setFill(fill)

Set the fill style.

Parameters:

Name	Type	Description
`fill`	Fill

# setOpacity(opacity)

Set the opacity.

Parameters:

Name	Type	Description
`opacity`	number	Opacity.

# setRotateWithView(rotateWithView)

Set whether to rotate the style with the view.

Parameters:

Name	Type	Description
`rotateWithView`	boolean	Rotate with map.

# setRotation(rotation)

Set the rotation.

Parameters:

Name	Type	Description
`rotation`	number	Rotation.

# setScale(scale)

Set the scale.

Parameters:

Name	Type	Description
`scale`	number	Scale.