ol-ext

Class: Mask

ol.filter. Mask

Mask drawing using an ol.Feature

new Mask( [options])

Parameters:
Name Type Argument Description
options Object <optional>
Properties
Name Type Argument Default Description
feature ol.Feature <optional>

feature to mask with
fill ol.style.Fill <optional>

style to fill with
shadowWidth number <optional>
 0

shadow width, default no shadow
shadowMapUnits boolean <optional>
 false

true if the shadow width is in mapUnits
shadowColor ol.colorLike <optional>
 'rgba(0,0,0,.5)'

shadow color, default
inner boolean <optional>
 false

mask inner, default false
wrapX boolean <optional>
 false

wrap around the world, default false
Requires:
  • module:ol.filter

Extends

Requires

  • module:ol.filter

Methods

getActive()

Get filter active

Inherited From:
Overrides:
Returns:
Type
boolean

setActive(b)

Activate / deactivate filter

Parameters:
Name Type Description
b boolean
Inherited From:
Overrides:

setFillColor(color)

Set filter fill color

Parameters:
Name Type Description
color ol/colorLike

setShadowColor(color)

Set filter shadow color

Parameters:
Name Type Description
color ol/colorLike