Class default

Helper class for the geospatial analysis. Makes use of Turf.js.

GeometryUtil

Index

Constructors

Methods

addBuffer addGeometryBuffer difference geometryDifference geometryIntersection getPolygonFromExtent intersection mergeGeometries separateGeometries splitByLine splitGeometryByLine union unionGeometries

Constructors

constructor

new default(): default
Returns default

Methods

`Static`addBuffer

addBuffer(
    geometryOrFeature: Geometry | Feature<Geometry>,
    radius?: number,
    projection?: ProjectionLike,
): Geometry | Feature<Geometry> | undefined
Adds a buffer to a given geometry.

If the target is of type ol.Feature it will return an ol.Feature. If the target is of type ol.geom.Geometry it will return ol.geom.Geometry.
Parameters
- geometryOrFeature: Geometry | Feature<Geometry>
  The geometry.
- radius: number = 0
  The buffer to add in meters.
- projection: ProjectionLike = 'EPSG:3857'
  The projection of the input geometry as EPSG code. Default is to EPSG:3857.
Returns Geometry | Feature<Geometry> | undefined
The geometry or feature with the added buffer.
- Defined in GeometryUtil/GeometryUtil.ts:130

`Static`addGeometryBuffer

addGeometryBuffer(
    geometry: Geometry,
    radius?: number,
    projection?: ProjectionLike,
): Geometry | undefined
Adds a buffer to a given geometry.
Parameters
- geometry: Geometry
  The geometry.
- radius: number = 0
  The buffer to add in meters.
- projection: ProjectionLike = 'EPSG:3857'
  The projection of the input geometry as EPSG code. Default is to EPSG:3857.
Returns Geometry | undefined
The geometry with the added buffer.
- Defined in GeometryUtil/GeometryUtil.ts:152

`Static`difference

difference(
    polygon1: Polygon | Feature<Polygon>,
    polygon2: Polygon | Feature<Polygon>,
    projection?: ProjectionLike,
): Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>
Finds the difference between two polygons by clipping the second polygon from the first.

If both polygons are of type ol.Feature it will return an ol.Feature. Else it will return an ol.geom.Geometry.
Parameters
- polygon1: Polygon | Feature<Polygon>
- polygon2: Polygon | Feature<Polygon>
- projection: ProjectionLike = 'EPSG:3857'
  The projection of the input polygons as EPSG code. Default is to EPSG:3857.
Returns Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>
A Feature or geometry with the area of polygon1 excluding the area of polygon2.
- Defined in GeometryUtil/GeometryUtil.ts:293

`Static`geometryDifference

geometryDifference(
    polygon1: Polygon,
    polygon2: Polygon,
    projection?: ProjectionLike,
): Polygon | MultiPolygon
Finds the difference between two polygons by clipping the second polygon from the first.
Parameters
- polygon1: Polygon
  An ol.geom.Geometry
- polygon2: Polygon
  An ol.geom.Geometry
- projection: ProjectionLike = 'EPSG:3857'
  The projection of the input polygons as EPSG code. Default is to EPSG:3857.
Returns Polygon | MultiPolygon
A with the area of polygon1 excluding the area of polygon2.
- Defined in GeometryUtil/GeometryUtil.ts:317

`Static`geometryIntersection

geometryIntersection(
    polygon1: Polygon | MultiPolygon,
    polygon2: Polygon | MultiPolygon,
    projection?: ProjectionLike,
): Polygon | MultiPolygon | undefined
Takes two polygons and finds their intersection.
Parameters
- polygon1: Polygon | MultiPolygon
  An ol.geom.Geometry
- polygon2: Polygon | MultiPolygon
  An ol.geom.Geometry
- projection: ProjectionLike = 'EPSG:3857'
  The projection of the input polygons as EPSG code. Default is to EPSG:3857.
Returns Polygon | MultiPolygon | undefined
A Geometry with the shared area of the two polygons or null if the polygons don't intersect.
- Defined in GeometryUtil/GeometryUtil.ts:377

`Static`getPolygonFromExtent

getPolygonFromExtent(extent?: Extent | null): Polygon | undefined
Parameters
- Optionalextent: Extent | null
Returns Polygon | undefined
- Defined in GeometryUtil/GeometryUtil.ts:403

`Static`intersection

intersection(
    polygon1: Polygon | Feature<Polygon | MultiPolygon>,
    polygon2: Polygon | Feature<Polygon | MultiPolygon>,
    projection?: ProjectionLike,
): Polygon | MultiPolygon | Feature<Polygon | MultiPolygon> | undefined
Takes two polygons and finds their intersection.

If both polygons are of type ol.Feature it will return an ol.Feature. Else it will return an ol.geom.Geometry.
Parameters
- polygon1: Polygon | Feature<Polygon | MultiPolygon>
- polygon2: Polygon | Feature<Polygon | MultiPolygon>
- projection: ProjectionLike = 'EPSG:3857'
  The projection of the input polygons as EPSG code. Default is to EPSG:3857.
Returns Polygon | MultiPolygon | Feature<Polygon | MultiPolygon> | undefined
A Feature or Geometry with the shared area of the two polygons or null if the polygons don't intersect.
- Defined in GeometryUtil/GeometryUtil.ts:350

`Static`mergeGeometries

mergeGeometries<Geom extends Geometry>(
geometries: Geom[],
): MultiPolygon | MultiLineString | MultiPoint
Merges multiple geometries into one MultiGeometry.
Type Parameters
- Geom extends Geometry
Parameters
- geometries: Geom[]
  An array of ol.geom.geometries;
Returns MultiPolygon | MultiLineString | MultiPoint
A Multigeometry.
- Defined in GeometryUtil/GeometryUtil.ts:177

`Static`separateGeometries

separateGeometries(geometry: Geometry | Geometry[]): Geometry[]
Splits an array of geometries (and multi geometries) or a single MultiGeom into an array of single geometries.
Parameters
- geometry: Geometry | Geometry[]
  An (array of) ol.geom.geometries;
Returns Geometry[]
An array of geometries.
- Defined in GeometryUtil/GeometryUtil.ts:210

`Static`splitByLine

splitByLine(
    polygon: Polygon | Feature<Polygon>,
    line: Feature<LineString>,
    projection?: ProjectionLike,
): Polygon[] | Feature<Polygon>[]
Splits an OlFeature with/or ol.geom.Polygon by an OlFeature with/or ol.geom.LineString into an array of instances of OlFeature with/or ol.geom.Polygon. If the target polygon (first param) is of type ol.Feature it will return an array with ol.Feature. If the target polygon (first param) is of type ol.geom.Geometry it will return an array with ol.geom.Geometry.
Parameters
- polygon: Polygon | Feature<Polygon>
  The polygon geometry to split.
- line: Feature<LineString>
  The line geometry to split the polygon geometry with.
- projection: ProjectionLike = 'EPSG:3857'
  The EPSG code of the input features. Default is to EPSG:3857.
Returns Polygon[] | Feature<Polygon>[]
An array of instances of OlFeature with/or ol.geom.Polygon
- Defined in GeometryUtil/GeometryUtil.ts:70

`Static`splitGeometryByLine

splitGeometryByLine(
    polygon: Polygon,
    line: LineString,
    projection?: ProjectionLike,
): Polygon[]
Splits an ol.geom.Polygon by an ol.geom.LineString into an array of instances of ol.geom.Polygon.
Parameters
- polygon: Polygon
  The polygon geometry to split.
- line: LineString
  The line geometry to split the polygon geometry with.
- projection: ProjectionLike = 'EPSG:3857'
  The EPSG code of the input features. Default is to EPSG:3857.
Returns Polygon[]
An array of instances of ol.geom.Polygon
- Defined in GeometryUtil/GeometryUtil.ts:95

`Static`union

union(
inputPolygonalObjects: Polygon[] | Feature<Polygon | MultiPolygon>[],
projection?: ProjectionLike,
): Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>
Takes two or more polygons and returns a combined (Multi-)polygon.
Parameters
- inputPolygonalObjects: Polygon[] | Feature<Polygon | MultiPolygon>[]
  An array of ol.Feature or ol.geom.Geometry instances of type (Multi)-Polygon.
- projection: ProjectionLike = 'EPSG:3857'
  The projection of the input polygons as EPSG code. Default is to EPSG:3857.
Returns Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>
A Feature or Geometry with the combined area of the (Multi-)polygons.
- Defined in GeometryUtil/GeometryUtil.ts:236

`Static`unionGeometries

unionGeometries(
polygons: Polygon[] | MultiPolygon[],
projection?: ProjectionLike,
): Polygon | MultiPolygon
Takes two or more polygons and returns a combined (Multi-)polygon.
Parameters
- polygons: Polygon[] | MultiPolygon[]
  An array of ol.geom.Geometry instances of type (Multi-)polygon.
- projection: ProjectionLike = 'EPSG:3857'
  The projection of the input polygons as EPSG code. Default is to EPSG:3857.
Returns Polygon | MultiPolygon
A FGeometry with the combined area of the (Multi-)polygons.
- Defined in GeometryUtil/GeometryUtil.ts:257

Class default

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

StaticaddBuffer

Parameters

Returns Geometry | Feature<Geometry> | undefined

StaticaddGeometryBuffer

Parameters

Returns Geometry | undefined

Staticdifference

Parameters

Returns Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>

StaticgeometryDifference

Parameters

Returns Polygon | MultiPolygon

StaticgeometryIntersection

Parameters

Returns Polygon | MultiPolygon | undefined

StaticgetPolygonFromExtent

Parameters

Returns Polygon | undefined

Staticintersection

Parameters

Returns Polygon | MultiPolygon | Feature<Polygon | MultiPolygon> | undefined

StaticmergeGeometries

Type Parameters

Parameters

Returns MultiPolygon | MultiLineString | MultiPoint

StaticseparateGeometries

Parameters

Returns Geometry[]

StaticsplitByLine

Parameters

Returns Polygon[] | Feature<Polygon>[]

StaticsplitGeometryByLine

Parameters

Returns Polygon[]

Staticunion

Parameters

Returns Polygon | MultiPolygon | Feature<Polygon | MultiPolygon>

StaticunionGeometries

Parameters

Returns Polygon | MultiPolygon

Settings

On This Page

`Static`addBuffer

`Static`addGeometryBuffer

`Static`difference

`Static`geometryDifference

`Static`geometryIntersection

`Static`getPolygonFromExtent

`Static`intersection

`Static`mergeGeometries

`Static`separateGeometries

`Static`splitByLine

`Static`splitGeometryByLine

`Static`union

`Static`unionGeometries