OpenLayers 3 API Documentation

Class: Text

ol.style.Text

Set text style for vector features.

new ol.style.Text(opt_options) experimental

src/ol/style/textstyle.js, line 13
Name Type Description
options

Options.

Name Type Description
font string | undefined experimental

Font.
offsetX number | undefined experimental

Horizontal text offset in pixels. A positive will shift the text right. Default is 0.
offsetY number | undefined experimental

Vertical text offset in pixels. A positive will shift the text down. Default is 0.
scale number | undefined experimental

Scale.
rotation number | undefined experimental

Rotation.
text string | undefined experimental

Text.
textAlign string | undefined experimental

Text alignment.
textBaseline string | undefined experimental

Text base line.
fill ol.style.Fill | undefined experimental

Fill style.
stroke ol.style.Stroke | undefined experimental

Stroke style.

Methods

getFill(){ol.style.Fill} experimental

src/ol/style/textstyle.js, line 110
Returns:
Fill style.

getFont(){string|undefined} experimental

src/ol/style/textstyle.js, line 83
Returns:
Font.

getOffsetX(){number} experimental

src/ol/style/textstyle.js, line 92
Returns:
Horizontal text offset.

getOffsetY(){number} experimental

src/ol/style/textstyle.js, line 101
Returns:
Vertical text offset.

getRotation(){number|undefined} experimental

src/ol/style/textstyle.js, line 119
Returns:
Rotation.

getScale(){number|undefined} experimental

src/ol/style/textstyle.js, line 128
Returns:
Scale.

getStroke(){ol.style.Stroke} experimental

src/ol/style/textstyle.js, line 137
Returns:
Stroke style.

getText(){string|undefined} experimental

src/ol/style/textstyle.js, line 146
Returns:
Text.

getTextAlign(){string|undefined} experimental

src/ol/style/textstyle.js, line 155
Returns:
Text align.

getTextBaseline(){string|undefined} experimental

src/ol/style/textstyle.js, line 164
Returns:
Text baseline.

setFill(fill) experimental

src/ol/style/textstyle.js, line 206

Set the fill.

Name Type Description
fill ol.style.Fill

Fill style.

setFont(font) experimental

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

Set the font.

Name Type Description
font string | undefined

Font.

setRotation(rotation) experimental

src/ol/style/textstyle.js, line 217

Set the rotation.

Name Type Description
rotation number | undefined

Rotation.

setScale(scale) experimental

src/ol/style/textstyle.js, line 228

Set the scale.

Name Type Description
scale number | undefined

Scale.

setStroke(stroke) experimental

src/ol/style/textstyle.js, line 239

Set the stroke.

Name Type Description
stroke ol.style.Stroke

Stroke style.

setText(text) experimental

src/ol/style/textstyle.js, line 250

Set the text.

Name Type Description
text string | undefined

Text.

setTextAlign(textAlign) experimental

src/ol/style/textstyle.js, line 261

Set the text alignment.

Name Type Description
textAlign string | undefined

Text align.

setTextBaseline(textBaseline) experimental

src/ol/style/textstyle.js, line 272

Set the text baseline.

Name Type Description
textBaseline string | undefined

Text baseline.