OpenLayers 3 API Documentation

Class: Stroke

ol.style.Stroke

Set stroke style for vector features. Note that the defaults given are the Canvas defaults, which will be used if option is not defined. The get functions return whatever was entered in the options; they will not return the default.

new ol.style.Stroke(opt_options) experimental

src/ol/style/strokestyle.js, line 22
Name Type Description
options

Options.

Name Type Description
color ol.Color | string | undefined experimental

Color. See ol.color for possible formats. Default null; if null, the Canvas/renderer default black will be used.
lineCap string | undefined experimental

Line cap style: butt, round, or square. Default is round.
lineJoin string | undefined experimental

Line join style: bevel, round, or miter. Default is round.
lineDash Array.<number> | undefined experimental

Line dash pattern. Default is undefined (no dash).
miterLimit number | undefined experimental

Miter limit. Default is 10.
width number | undefined experimental

Width.

Extends

Methods

getColor(){ol.Color|string} experimental

src/ol/style/strokestyle.js, line 74
Returns:
Color.

getLineCap(){string|undefined} experimental

src/ol/style/strokestyle.js, line 83
Returns:
Line cap.

getLineDash(){Array.<number>} experimental

src/ol/style/strokestyle.js, line 92
Returns:
Line dash.

getLineJoin(){string|undefined} experimental

src/ol/style/strokestyle.js, line 101
Returns:
Line join.

getMiterLimit(){number|undefined} experimental

src/ol/style/strokestyle.js, line 110
Returns:
Miter limit.

getWidth(){number|undefined} experimental

src/ol/style/strokestyle.js, line 119
Returns:
Width.

setColor(color) experimental

src/ol/style/strokestyle.js, line 130

Set the color.

Name Type Description
color ol.Color | string

Color.

setLineCap(lineCap) experimental

src/ol/style/strokestyle.js, line 142

Set the line cap.

Name Type Description
lineCap string | undefined

Line cap.

setLineDash(lineDash) experimental

src/ol/style/strokestyle.js, line 154

Set the line dash.

Name Type Description
lineDash Array.<number>

Line dash.

setLineJoin(lineJoin) experimental

src/ol/style/strokestyle.js, line 166

Set the line join.

Name Type Description
lineJoin string | undefined

Line join.

setMiterLimit(miterLimit) experimental

src/ol/style/strokestyle.js, line 178

Set the miter limit.

Name Type Description
miterLimit number | undefined

Miter limit.

setWidth(width) experimental

src/ol/style/strokestyle.js, line 190

Set the width.

Name Type Description
width number | undefined

Width.