ol-ext

Class: Clip

ol.interaction. Clip

Clip interaction to clip layers in a circle

new Clip(options)

Parameters:
Name Type Description
options ol.interaction.Clip.options

flashlight param

Properties
Name Type Description
radius number

radius of the clip, default 100
layers ol.layer | Array.<ol.layer>

layers to clip

Extends

  • ol.interaction.Pointer

Methods

_setPosition(e)

Set position of the clip

Parameters:
Name Type Description
e ol.MapBrowserEvent

addLayer(layer)

Add a layer to clip

Parameters:
Name Type Description
layer ol.layer | Array.<ol.layer>

to clip

getPixelPosition()

Get position of the clip

Returns:

pixel

Type
ol.Pixel

getPosition()

Get position of the clip

Returns:
Type
ol.coordinate

getRadius()

Get clip radius

Returns:

radius

Type
integer

removeLayer(layer)

Remove a layer to clip

Parameters:
Name Type Description
layer ol.layer | Array.<ol.layer>

to clip

removeLayers()

Remove all layers

setActive(active)

Activate or deactivate the interaction.

Parameters:
Name Type Description
active boolean

Active.

setMap()

Set the map > start postcompose

setPixelPosition(pixel)

Set position of the clip

Parameters:
Name Type Description
pixel ol.Pixel

setPosition(coord)

Set position of the clip

Parameters:
Name Type Description
coord ol.coordinate

setRadius(radius)

Set clip radius

Parameters:
Name Type Description
radius integer