Module: ol/style/RegularShape

ol/style/RegularShape


Classes

RegularShape

Type Definitions

Options{Object}

Specify radius for regular polygons, or both radius and radius2 for stars.

Properties:
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.

RenderOptions{Object}

Properties:
Name Type Description
strokeStyle ColorLike | undefined

StrokeStyle.

strokeWidth number

StrokeWidth.

size number

Size.

lineCap CanvasLineCap

LineCap.

lineDash Array.<number> | null

LineDash.

lineDashOffset number

LineDashOffset.

lineJoin CanvasLineJoin

LineJoin.

miterLimit number

MiterLimit.