Class: Clip

ol.filter. Clip


new Clip(options)

Clip layer or map

Parameters:
Name Type Description
options *
Properties
Name Type Description
coords Array.<ol.Coordinate>
extent ol.Extent
units string

coords units percent (%) or pixel (px)

keepAspectRatio boolean

keep aspect ratio

color string

backgroundcolor

Requires:
  • module:ol.filter

Extends

Requires

  • module:ol.filter

Methods


getActive()

Get filter active

Inherited From:
Returns:
Type
bool

setActive(b)

Activate / deactivate filter

Parameters:
Name Type Description
b bool
Inherited From: