OpenLayers 3 API Documentation

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 130
Returns:
Fill style.

getImage(pixelRatio){HTMLCanvasElement} experimental

src/ol/style/circlestyle.js, line 148
Name Type Description
pixelRatio number

Pixel ratio.
Returns:
Canvas element.

getOpacity(){number} inherited experimental

src/ol/style/imagestyle.js, line 75
Returns:
Opacity.

getOrigin(){Array.<number>} experimental

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

getRadius(){number} experimental

src/ol/style/circlestyle.js, line 190
Returns:
Radius.

getRotateWithView(){boolean} inherited experimental

src/ol/style/imagestyle.js, line 84
Returns:
Rotate with map.

getRotation(){number} inherited experimental

src/ol/style/imagestyle.js, line 93
Returns:
Rotation.

getScale(){number} inherited experimental

src/ol/style/imagestyle.js, line 102
Returns:
Scale.

getSize(){ol.Size} experimental

src/ol/style/circlestyle.js, line 199
Returns:
Size.

getSnapToPixel(){boolean} inherited experimental

src/ol/style/imagestyle.js, line 111
Returns:
Snap to pixel?

getStroke(){ol.style.Stroke} experimental

src/ol/style/circlestyle.js, line 208
Returns:
Stroke style.

setRotation(rotation) inherited experimental

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

Set the rotation.

Name Type Description
rotation number

Rotation.

setScale(scale) inherited experimental

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

Set the scale.

Name Type Description
scale number

Scale.