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 22
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

getFill(){ol.style.Fill} experimental

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

Get the fill style for the circle.

Returns:
Fill style.

getImage(pixelRatio){HTMLCanvasElement} experimental

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

Get the image used to render the circle.

Name Type Description
pixelRatio number

Pixel ratio.
Returns:
Canvas element.

getOpacity(){number} inherited experimental

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

Get the symbolizer opacity.

Returns:
Opacity.

getRadius(){number} experimental

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

Get the circle radius.

Returns:
Radius.

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.

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} experimental

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

Get the stroke style for the circle.

Returns:
Stroke style.

setOpacity(opacity) inherited experimental

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

Set the opacity.

Name Type Description
opacity number

Opacity.

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.