OpenLayers 3

Class: Circle

ol.style.Circle

Set circle style for vector features.

new ol.style.Circle(opt_options) experimental

src/ol/style/circle.js, line 16
Name Type Description
options

Options.

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

Fill style.
radius number experimental

Circle radius. Required.
snapToPixel boolean | undefined experimental

If true integral numbers of pixels are used as the X and Y pixel coordinate when drawing the circle 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 circle's position is animated. Without it, the circle may jitter noticeably. Default value is true.
stroke ol.style.Stroke | undefined experimental

Stroke style.
atlasManager ol.style.AtlasManager | undefined

The atlas manager to use for this circle. When using WebGL it is recommended to use an atlas manager to avoid texture switching. If an atlas manager is given, the circle is added to an atlas. By default no atlas manager is used.

Extends

Methods

clone(){ol.style.Circle} experimental

src/ol/style/circle.js, line 38

Clones the style. If an atlasmanager was provided to the original style it will be used in the cloned style, too.

Returns:
The cloned style.

getAnchor(){Array.<number>} inherited experimental

src/ol/style/regularshape.js, line 175

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

Returns:
Anchor.

getAngle(){number} inherited experimental

src/ol/style/regularshape.js, line 185

Get the angle used in generating the shape.

Returns:
Shape's rotation in radians.

getFill(){ol.style.Fill} inherited experimental

src/ol/style/regularshape.js, line 195

Get the fill style for the shape.

Returns:
Fill style.

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

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

Get the image element for the symbolizer.

Name Type Description
pixelRatio number

Pixel ratio.
Returns:
Image element.

getOpacity(){number} inherited experimental

src/ol/style/image.js, line 54

Get the symbolizer opacity.

Returns:
Opacity.

getOrigin(){Array.<number>} inherited experimental

src/ol/style/regularshape.js, line 245

Get the origin of the symbolizer.

Returns:
Origin.

getPoints(){number} inherited experimental

src/ol/style/regularshape.js, line 255

Get the number of points for generating the shape.

Returns:
Number of points for stars and regular polygons.

getRadius(){number} inherited experimental

src/ol/style/regularshape.js, line 265

Get the (primary) radius for the shape.

Returns:
Radius.

getRadius2(){number} inherited experimental

src/ol/style/regularshape.js, line 275

Get the secondary radius for the shape.

Returns:
Radius2.

getRotateWithView(){boolean} inherited experimental

src/ol/style/image.js, line 64

Determine whether the symbolizer rotates with the map.

Returns:
Rotate with map.

getRotation(){number} inherited experimental

src/ol/style/image.js, line 74

Get the symoblizer rotation.

Returns:
Rotation.

getScale(){number} inherited experimental

src/ol/style/image.js, line 84

Get the symbolizer scale.

Returns:
Scale.

getSize(){ol.Size} inherited experimental

src/ol/style/regularshape.js, line 284

Get the size of the symbolizer (in pixels).

Returns:
Size.

getSnapToPixel(){boolean} inherited experimental

src/ol/style/image.js, line 94

Determine whether the symbolizer should be snapped to a pixel.

Returns:
The symbolizer should snap to a pixel.

getStroke(){ol.style.Stroke} inherited experimental

src/ol/style/regularshape.js, line 294

Get the stroke style for the shape.

Returns:
Stroke style.

setOpacity(opacity) inherited experimental

src/ol/style/image.js, line 168

Set the opacity.

Name Type Description
opacity number

Opacity.

setRadius(radius) experimental

src/ol/style/circle.js, line 58

Set the circle radius.

Name Type Description
radius number

Circle radius.

setRotation(rotation) inherited experimental

src/ol/style/image.js, line 189

Set the rotation.

Name Type Description
rotation number

Rotation.

setScale(scale) inherited experimental

src/ol/style/image.js, line 200

Set the scale.

Name Type Description
scale number

Scale.