Class: Clip

ol.filter. Clip


new Clip( [options])

Clip layer or map

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

coords units percent (%) or pixel (px)

keepAspectRatio boolean <optional>

keep aspect ratio

color string <optional>

backgroundcolor

Requires:
  • module:ol.filter

Extends

Requires

  • module:ol.filter

Methods


getActive()

Get filter active

Inherited From:
Returns:
Type
boolean

setActive(b)

Activate / deactivate filter

Parameters:
Name Type Description
b boolean
Inherited From: