OpenLayers 3 API Documentation

Class: Style

ol.style.Style

Container for vector feature rendering styles. Any changes made to the style or its children through set*() methods will not take effect until the feature, layer or FeatureOverlay that uses the style is re-rendered.

new ol.style.Style(opt_options) experimental

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

Style options.

Name Type Description
geometry undefined | string | ol.geom.Geometry | ol.style.GeometryFunction experimental

Feature property or geometry or function returning a geometry to render for this style.
fill ol.style.Fill | undefined experimental

Fill style.
image ol.style.Image | undefined experimental

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

Stroke style.
text ol.style.Text | undefined experimental

Text style.
zIndex number | undefined experimental

Z index.

Methods

getFill(){ol.style.Fill} experimental

src/ol/style/style.js, line 103
Returns:
Fill style.

getGeometry(){string|ol.geom.Geometry|ol.style.GeometryFunction} experimental

src/ol/style/style.js, line 84
Returns:
Feature property or geometry or function that returns the geometry that will be rendered with this style.

getGeometryFunction(){ol.style.GeometryFunction} experimental

src/ol/style/style.js, line 94
Returns:
Function that is called with a feature and returns the geometry to render instead of the feature's geometry.

getImage(){ol.style.Image} experimental

src/ol/style/style.js, line 112
Returns:
Image style.

getStroke(){ol.style.Stroke} experimental

src/ol/style/style.js, line 121
Returns:
Stroke style.

getText(){ol.style.Text} experimental

src/ol/style/style.js, line 130
Returns:
Text style.

getZIndex(){number|undefined} experimental

src/ol/style/style.js, line 139
Returns:
ZIndex.

setGeometry(geometry) experimental

src/ol/style/style.js, line 152

Set a geometry that is rendered instead of the feature's geometry.

Name Type Description
geometry string | ol.geom.Geometry | ol.style.GeometryFunction

Feature property or geometry or function returning a geometry to render for this style.

setZIndex(zIndex) experimental

src/ol/style/style.js, line 181

Set the zIndex.

Name Type Description
zIndex number | undefined

ZIndex.