OpenLayers 3

Class: Circle

ol.style.Circle

Set circle style for vector features.

new ol.style.Circle(opt_options) experimental

src/ol/style/circlestyle.js, line 27
Name Type Description
options

Options.

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

Fill style.
radius number experimental

Circle radius.
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.

Extends

Methods

getAnchor(){Array.<number>} experimental

src/ol/style/circlestyle.js, line 121
Returns:
Anchor.

getFill(){ol.style.Fill} experimental

src/ol/style/circlestyle.js, line 131

Get the fill style for the circle.

Returns:
Fill style.

getImage(pixelRatio){HTMLCanvasElement} experimental

src/ol/style/circlestyle.js, line 150

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/imagestyle.js, line 76

Get the symbolizer opacity.

Returns:
Opacity.

getOrigin(){Array.<number>} experimental

src/ol/style/circlestyle.js, line 183
Returns:
Origin.

getRadius(){number} experimental

src/ol/style/circlestyle.js, line 193

Get the circle radius.

Returns:
Radius.

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/circlestyle.js, line 202
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/circlestyle.js, line 212

Get the stroke style for the circle.

Returns:
Stroke style.

setRotation(rotation) inherited experimental

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

Set the rotation.

Name Type Description
rotation number

Rotation.

setScale(scale) inherited experimental

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

Set the scale.

Name Type Description
scale number

Scale.