Skip to main content
Version: Next

clipToPolygonFeatures()

function clipToPolygonFeatures(
feature,
clipOperations,
options): Promise<Feature<Polygon | MultiPolygon>>

Takes a Polygon feature and returns the portion remaining after performing clipOperations against one or more Polygon features

Parameters

ParameterTypeDescription
featureFeature<Geometry, GeoJsonProperties>feature to clip
clipOperationsFeatureClipOperation[]array of DatasourceClipOperations
optionsClipOptionsclip options

Returns

Promise<Feature<Polygon | MultiPolygon>>

clipped polygon

Throws

if a datasource fetch returns no features or if nothing remains of feature after clip operations