OpenLayers

Class: Style

ol/style/Style~Style 


import Style from '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 or layer that uses the style is re-rendered.

new Style(opt_options)

style/Style.js, line 148
Name Type Description
options

Style options.

Name Type Description
geometry string | module:ol/geom/Geometry~Geometry | module:ol/style/Style~GeometryFunction

Feature property or geometry or function returning a geometry to render for this style.
fill module:ol/style/Fill~Fill

Fill style.
image module:ol/style/Image~ImageStyle

Image style.
renderer module:ol/style/Style~RenderFunction

Custom renderer. When configured, fill, stroke and image will be ignored, and the provided function will be called with each render frame for each geometry.
stroke module:ol/style/Stroke~Stroke

Stroke style.
text module:ol/style/Text~Text

Text style.
zIndex number

Z index.

Methods

clone(){module:ol/style/Style~Style}

style/Style.js, line 215

Clones the style.

Returns:
The cloned style.

getFill(){module:ol/style/Fill~Fill}

style/Style.js, line 276

Get the fill style.

Returns:
Fill style.

getGeometry(){string|module:ol/geom/Geometry~Geometry|module:ol/style/Style~GeometryFunction}

style/Style.js, line 257

Get the geometry to be rendered.

Returns:
Feature property or geometry or function that returns the geometry that will be rendered with this style.

getGeometryFunction(){module:ol/style/Style~GeometryFunction}

style/Style.js, line 267

Get the function used to generate a geometry for rendering.

Returns:
Function that is called with a feature and returns the geometry to render instead of the feature's geometry.

getImage(){module:ol/style/Image~ImageStyle}

style/Style.js, line 294

Get the image style.

Returns:
Image style.

getRenderer(){module:ol/style/Style~RenderFunction|null}

style/Style.js, line 236

Get the custom renderer function that was configured with #setRenderer or the renderer constructor option.

Returns:
Custom renderer function.

getStroke(){module:ol/style/Stroke~Stroke}

style/Style.js, line 312

Get the stroke style.

Returns:
Stroke style.

getText(){module:ol/style/Text~Text}

style/Style.js, line 330

Get the text style.

Returns:
Text style.

getZIndex(){number|undefined}

style/Style.js, line 348

Get the z-index for the style.

Returns:
ZIndex.

setFill(fill)

style/Style.js, line 285

Set the fill style.

Name Type Description
fill module:ol/style/Fill~Fill

Fill style.

setGeometry(geometry)

style/Style.js, line 360

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

Name Type Description
geometry string | module:ol/geom/Geometry~Geometry | module:ol/style/Style~GeometryFunction

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

setImage(image)

style/Style.js, line 303

Set the image style.

Name Type Description
image module:ol/style/Image~ImageStyle

Image style.

setRenderer(renderer)

style/Style.js, line 246

Sets a custom renderer function for this style. When set, fill, stroke and image options of the style will be ignored.

Name Type Description
renderer module:ol/style/Style~RenderFunction | null

Custom renderer function.

setStroke(stroke)

style/Style.js, line 321

Set the stroke style.

Name Type Description
stroke module:ol/style/Stroke~Stroke

Stroke style.

setText(text)

style/Style.js, line 339

Set the text style.

Name Type Description
text module:ol/style/Text~Text

Text style.

setZIndex(zIndex)

style/Style.js, line 387

Set the z-index.

Name Type Description
zIndex number | undefined

ZIndex.