require(["esri/geometry/geometryEngineAsync"], (geometryEngineAsync) => { /* code goes here */ });
import * as geometryEngineAsync from "@arcgis/core/geometry/geometryEngineAsync.js";
esri/geometry/geometryEngineAsync
An asynchronous client-side geometry engine for testing, measuring, and analyzing the spatial relationship between two or more 2D geometries. If more than one geometry is required for any of the methods below, all geometries must have the same spatial reference for the methods to work as expected.
Read the following blog series to learn more about GeometryEngine:
- See also
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries. | geometryEngineAsync | ||
Calculates the clipped geometry from a target geometry by an envelope. | geometryEngineAsync | ||
Indicates if one geometry contains another geometry. | geometryEngineAsync | ||
Calculates the convex hull of one or more geometries. | geometryEngineAsync | ||
Indicates if one geometry crosses another geometry. | geometryEngineAsync | ||
Split the input Polyline or Polygon where it crosses a cutting Polyline. | geometryEngineAsync | ||
Densify geometries by plotting points between existing vertices. | geometryEngineAsync | ||
Creates the difference of two geometries. | geometryEngineAsync | ||
Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry. | geometryEngineAsync | ||
Calculates the shortest planar distance between two geometries. | geometryEngineAsync | ||
Indicates if two geometries are equal. | geometryEngineAsync | ||
Returns an object containing additional information about the input spatial reference. | geometryEngineAsync | ||
Flips a geometry on the horizontal axis. | geometryEngineAsync | ||
Flips a geometry on the vertical axis. | geometryEngineAsync | ||
Performs the generalize operation on the geometries in the cursor. | geometryEngineAsync | ||
Calculates the area of the input geometry. | geometryEngineAsync | ||
Creates geodesic buffer polygons at a specified distance around the input geometries. | geometryEngineAsync | ||
Returns a geodetically densified version of the input geometry. | geometryEngineAsync | ||
Calculates the length of the input geometry. | geometryEngineAsync | ||
Creates new geometries from the intersections between two geometries. | geometryEngineAsync | ||
Resolves to an array of points at the intersecting locations of two input polylines. | geometryEngineAsync | ||
Indicates if one geometry intersects another geometry. | geometryEngineAsync | ||
Indicates if the given geometry is topologically simple. | geometryEngineAsync | ||
Finds the coordinate of the geometry that is closest to the specified point. | geometryEngineAsync | ||
Finds vertex on the geometry nearest to the specified point. | geometryEngineAsync | ||
Finds all vertices in the given distance from the specified point, sorted from the closest to the furthest and returns them as an array of Objects. | geometryEngineAsync | ||
The offset operation creates a geometry that is a constant planar distance from an input polyline or polygon. | geometryEngineAsync | ||
Indicates if one geometry overlaps another geometry. | geometryEngineAsync | ||
Calculates the area of the input geometry. | geometryEngineAsync | ||
Calculates the length of the input geometry. | geometryEngineAsync | ||
Indicates if the given DE-9IM relation holds for the two geometries. | geometryEngineAsync | ||
Rotates a geometry counterclockwise by the specified number of degrees. | geometryEngineAsync | ||
Performs the simplify operation on the geometry, which alters the given geometries to make their definitions topologically legal with respect to their geometry type. | geometryEngineAsync | ||
Creates the symmetric difference of two geometries. | geometryEngineAsync | ||
Indicates if one geometry touches another geometry. | geometryEngineAsync | ||
All inputs must be of the same type of geometries and share one spatial reference. | geometryEngineAsync | ||
Indicates if one geometry is within another geometry. | geometryEngineAsync |
Method Details
-
Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries.
The GeometryEngine has two methods for buffering geometries client-side: buffer and geodesicBuffer. Use caution when deciding which method to use. As a general rule, use geodesicBuffer if the input geometries have a spatial reference of either WGS84 (wkid: 4326) or Web Mercator. Only use buffer (this method) when attempting to buffer geometries with a projected coordinate system other than Web Mercator. If you need to buffer geometries with a geographic coordinate system other than WGS84 (wkid: 4326), use geometryService.buffer().
ParametersThe buffer input geometry. The
geometryanddistanceparameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array.The specified distance(s) for buffering. The
geometryanddistanceparameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of thedistancearray. For example, if you pass an array of four geometries:[g1, g2, g3, g4]and an array with one distance:[d1], all four geometries will be buffered by the single distance value. If instead you use an array of three distances:[d1, d2, d3],g1will be buffered byd1,g2byd2, andg3andg4will both be buffered byd3. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries.unit LinearUnitsoptionalMeasurement unit of the distance(s). Defaults to the units of the input geometries.
unionResults BooleanoptionalDefault Value: falseDetermines whether the output geometries should be unioned into a single polygon.
ReturnsExampleconst pointBuffer = await geometryEngineAsync.buffer(point, 1000, "feet");
-
Calculates the clipped geometry from a target geometry by an envelope.
Returns- See also
Example// returns a new geometry of a polygon clipped by the views extent const clippedGeometry = await geometryEngineAsync.clip(boundaryPolygon, view.extent);
-
Indicates if one geometry contains another geometry.
ParametersReturns- See also
Example// returns true or false for one geometry containing another const isContained = await geometryEngineAsync.contains(extent, boundaryPolygon);
-
Calculates the convex hull of one or more geometries. A convex hull is the smallest convex polygon that encloses a group of geometries or vertices. The input can be a single geometry (such as a polyline) or an array of any geometry type. The hull is typically a polygon but can also be a polyline or a point in degenerate cases.
ParametersThe input geometry or geometries used to calculate the convex hull. If an array is specified, the input array can include various geometry types. When an array is provided, the output will also be an array.
merge BooleanoptionalDefault Value: falseIndicates whether to merge the output into a single geometry (usually a polygon).
Returns- See also
Examples// returns the convex hull of a multipoint as a single polygon const hull = await geometryEngineAsync.convexHull(multipoint);// returns the convex hull of an array of points as a single polygon const [ hull ] = await geometryEngineAsync.convexHull([ pointA, pointB, pointC ], true);// returns the convex hull for each input line geometry as three polygons const hulls = await geometryEngineAsync.convexHull([ lineA, lineB, lineC ]);// returns the convex hull for all input line geometries as a single polygon const [ hull ] = await geometryEngineAsync.convexHull([ lineA, lineB, lineC ], true);// returns the convex hull for all input geometries as a single polygon const [ hull ] = await geometryEngineAsync.convexHull([ point, line, polygon ], true);
-
Indicates if one geometry crosses another geometry.
Returns- See also
Example// returns true or false if a line crosses a polygon const isCrossed = await geometryEngineAsync.crosses(boundaryPolygon, polyline);
-
Split the input Polyline or Polygon where it crosses a cutting Polyline. For Polylines, all left cuts are grouped together in the first Geometry. Right cuts and coincident cuts are grouped in the second Geometry and each undefined cut, along with any uncut parts, are output as separate Polylines. For Polygons, all left cuts are grouped in the first Polygon, all right cuts are grouped in the second Polygon, and each undefined cut, along with any left-over parts after cutting, are output as a separate Polygon. If no cuts are returned then the array will be empty. An undefined cut will only be produced if a left cut or right cut was produced and there was a part left over after cutting, or a cut is bounded to the left and right of the cutter.
ParametersReturns- See also
Example// returns array of cut geometries const geometries = await geometryEngineAsync.cut(boundaryPolygon, polyline);
-
Densify geometries by plotting points between existing vertices.
Parametersgeometry GeometryThe geometry to be densified.
maxSegmentLength NumberThe maximum segment length allowed. Must be a positive value.
maxSegmentLengthUnit LinearUnitsoptionalMeasurement unit for maxSegmentLength. Defaults to the units of the input geometry.
ReturnsExample// Returns a densified geometry const geometry = await geometryEngineAsync.densify(boundaryPolygon, 25);
-
Creates the difference of two geometries. The resultant geometry is the portion of inputGeometry not in the subtractor. The dimension of the subtractor has to be equal to or greater than that of the inputGeometry.
ParametersReturns- See also
Example// Creates a new geometry based on the // difference of the two const geometry = await geometryEngineAsync.difference(boundaryPolygon, buffers);
-
Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry.
ParametersReturns- See also
Example// returns true if a geometry is not contained in another. // operates the opposite of contains const isDisjointed = await geometryEngineAsync.disjoint(polygon, boundaryPolygon);
-
Calculates the shortest planar distance between two geometries. Distance is reported in the linear units specified by
distanceUnitor, ifdistanceUnitis null, the units of the spatialReference of input geometry.To calculate the geodesic distance between two points, first construct a Polyline using the two points of interest as the beginning and ending points of a single path. Then use the polyline as input for the geodesicLength() method.
Parametersgeometry1 GeometryFirst input geometry.
geometry2 GeometrySecond input geometry.
distanceUnit LinearUnitsoptionalMeasurement unit of the return value. Defaults to the units of the input geometries.
Returns- See also
Example// returns numeric distance between two points const totalDistance = await geometryEngineAsync.distance(point1, point2, "feet");
-
Indicates if two geometries are equal.
Returns- See also
Example// returns true if two given geometries are equal const isEqual = await geometryEngineAsync.equals(line1, line2);
-
extendedSpatialReferenceInfo
MethodextendedSpatialReferenceInfo(spatialReference){Promise<SpatialReferenceInfo>} -
Returns an object containing additional information about the input spatial reference.
ParameterspatialReference SpatialReferenceThe input spatial reference.
ReturnsType Description Promise<SpatialReferenceInfo> Resolves to a SpatialReferenceInfo object.
-
Flips a geometry on the horizontal axis. Can optionally be flipped around a point.
ParametersReturns- See also
Example// Returns a geometry flipped horizontally const geometry = await geometryEngineAsync.flipHorizontal(boundaryPolygon);
-
Flips a geometry on the vertical axis. Can optionally be flipped around a point.
ParametersReturns- See also
Example// Returns a geometry flipped vertically const geometry = await geometryEngineAsync.flipVertical(boundaryPolygon);
-
Performs the generalize operation on the geometries in the cursor. Point and Multipoint geometries are left unchanged. Envelope is converted to a Polygon and then generalized.
Parametersgeometry GeometryThe input geometry to be generalized.
maxDeviation NumberThe maximum allowed deviation from the generalized geometry to the original geometry.
removeDegenerateParts BooleanoptionalWhen
truethe degenerate parts of the geometry will be removed from the output (may be undesired for drawing).maxDeviationUnit LinearUnitsoptionalMeasurement unit for maxDeviation. Defaults to the units of the input geometry.
Returns- See also
Example// Returns a generalized geometry const geometry = await geometryEngineAsync.generalize(boundaryPolygon, 2.5, true, "miles");
-
Calculates the area of the input geometry. As opposed to planarArea(), geodesicArea takes into account the curvature of the earth when performing this calculation. Therefore, when using input geometries with a spatial reference of either WGS84 (wkid: 4326) or Web Mercator, it is best practice to calculate areas using geodesicArea(). If the input geometries have a projected coordinate system other than Web Mercator, use planarArea() instead.
This method only works with WGS84 (wkid: 4326) and Web Mercator spatial references.
ParametersReturns- See also
Example// Returns the numeric geodesic area of the given polygon const area = await geometryEngineAsync.geodesicArea(boundaryPolygon, "square-miles");
-
Creates geodesic buffer polygons at a specified distance around the input geometries. When calculating distances, this method takes the curvature of the earth into account, which provides highly accurate results when dealing with very large geometries and/or geometries that spatially vary on a global scale where one projected coordinate system could not accurately plot coordinates and measure distances for all the geometries.
This method only works with WGS84 (wkid: 4326) and Web Mercator spatial references. In general, if your input geometries are assigned one of those two spatial references, you should always use geodesicBuffer() to obtain the most accurate results for those geometries. If needing to buffer points assigned a projected coordinate system other than Web Mercator, use buffer() instead. If the input geometries have a geographic coordinate system other than WGS84 (wkid: 4326), use geometryService.buffer().
ParametersThe buffer input geometry. The
geometryanddistanceparameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array.The specified distance(s) for buffering. The
geometryanddistanceparameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of thedistancearray. For example, if you pass an array of four geometries:[g1, g2, g3, g4]and an array with one distance:[d1], all four geometries will be buffered by the single distance value. If instead you use an array of three distances:[d1, d2, d3],g1will be buffered byd1,g2byd2, andg3andg4will both be buffered byd3. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries.unit LinearUnitsoptionalMeasurement unit of the distance(s). Defaults to the units of the input geometries.
unionResults BooleanoptionalDefault Value: falseDetermines whether the output geometries should merge into a single polygon.
ReturnsExampleconst pointButter = await geometryEngineAsync.geodesicBuffer(point, 1000, "kilometers");
-
Returns a geodetically densified version of the input geometry. Use this function to draw the line(s) of the geometry along great circles.
ParametersA polyline or polygon to densify.
maxSegmentLength NumberThe maximum segment length allowed (in meters if a
maxSegmentLengthUnitis not provided). This must be a positive value.maxSegmentLengthUnit LinearUnitsoptionalMeasurement unit for
maxSegmentLength. If not provided, the unit will default tometers.Returns- See also
Example// lineGeom is a line geometry const densifiedGeom = await geometryEngineAsync.geodesicDensify(lineGeom, 10000);
-
Calculates the length of the input geometry. As opposed to planarLength(), geodesicLength() takes into account the curvature of the earth when performing this calculation. Therefore, when using input geometries with a spatial reference of either WGS84 (wkid: 4326) or Web Mercator, it is best practice to calculate lengths using geodesicLength(). If the input geometries have a projected coordinate system other than Web Mercator, use planarLength() instead.
This method only works with WGS84 (wkid: 4326) and Web Mercator spatial references.
Parametersgeometry GeometryThe input geometry.
unit LinearUnitsoptionalMeasurement unit of the return value. Defaults to the units of the input geometry.
Returns- See also
Example// Returns the numeric geodesic length of the given line const length = await geometryEngineAsync.geodesicLength(riverGeometry, "miles");
-
Creates new geometries from the intersections between two geometries. If the input geometries have different dimensions (i.e. point = 0; polyline = 1; polygon = 2), then the result's dimension will be equal to the lowest dimension of the inputs. The table below describes the expected output for various combinations of geometry types. Note that
geometry1andgeometry2are interchangeable in this operation and will return the same result if flipped.Geometry1 type Geometry2 type Result geometry type Polygon Polygon Polygon Polygon Polyline Polyline Polygon Point Point Polyline Polyline Polyline Polyline Point Point Point Point Point Note that two intersecting polylines will not return Point geometries. Rather, this function will return Polyline paths that are equal between the two geometries. See intersectLinesToPoints() to find the point intersections of two polylines.
ParametersReturnsExample// Creates a new geometry from the intersection of the two geometries const intersecting = await geometryEngineAsync.intersect(boundaryPolygon, buffers);
-
Since: ArcGIS Maps SDK for JavaScript 4.25geometryEngineAsync since 4.0, intersectLinesToPoints added at 4.25. -
Resolves to an array of points at the intersecting locations of two input polylines. Use intersect for all other geometry intersect operations.
ParametersReturnsExample// Creates an array of points for the intersections of the input lines const intersections = await geometryEngineAsync.intersectLinesToPoints(line1, line2);
-
Indicates if one geometry intersects another geometry.
ParametersReturns- See also
Example// returns true if two given geometries intersect each other const isIntersecting = await geometryEngineAsync.intersects(boundaryPolygon, cityPolygon);
-
Indicates if the given geometry is topologically simple. In a simplified geometry, no polygon rings or polyline paths will overlap, and no self-intersection will occur.
Parametergeometry GeometryThe input geometry.
Returns- See also
Example// returns true if given geometry is simple const simple = await geometryEngineAsync.isSimple(polyline);
-
nearestCoordinate
MethodnearestCoordinate(geometry, inputPoint){Promise<NearestPointResult>} -
Finds the coordinate of the geometry that is closest to the specified point.
ParametersReturnsType Description Promise<NearestPointResult> Resolves to an instance of NearestPointResult, containing the nearest coordinate to the inputPoint.- See also
-
nearestVertex
MethodnearestVertex(geometry, inputPoint){Promise<NearestPointResult>} -
Finds vertex on the geometry nearest to the specified point.
ParametersReturnsType Description Promise<NearestPointResult> Resolves to an instance of NearestPointResult, containing the nearest vertex to the inputPoint.- See also
Example// Finds the nearest vertex of the polygon to the input point const { coordinate, distance } = await geometryEngineAsync.nearestVertex(boundaryPolygon, point);
-
nearestVertices
MethodnearestVertices(geometry, inputPoint, searchRadius, maxVertexCountToReturn){Promise<NearestPointResult>} -
Finds all vertices in the given distance from the specified point, sorted from the closest to the furthest and returns them as an array of Objects.
ParametersReturnsType Description Promise<NearestPointResult> Resolves to an array of NearestPointResult, containing the nearest vertices to the inputPoint.- See also
Example// Returns an array of the nearest vertices const nearest = await geometryEngineAsync.nearestVertices(boundaryPolygon, point, 500, 2);
-
The offset operation creates a geometry that is a constant planar distance from an input polyline or polygon. It is similar to buffering, but produces a one-sided result.
ParametersThe geometries to offset.
offsetDistance NumberThe planar distance to offset from the input geometry. If offsetDistance > 0, then the offset geometry is constructed to the right of the oriented input geometry, if offsetDistance = 0, then there is no change in the geometries, otherwise it is constructed to the left. For a simple polygon, the orientation of outer rings is clockwise and for inner rings it is counter clockwise. So the "right side" of a simple polygon is always its inside.
offsetUnit LinearUnitsoptionalMeasurement unit of the offset distance. Defaults to the units of the input geometries.
joinType StringoptionalThe join type.
Possible Values:"round"|"bevel"|"miter"|"square"
bevelRatio NumberoptionalApplicable when
joinType = 'miter'; bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled.flattenError NumberoptionalApplicable when
joinType = 'round'; flattenError determines the maximum distance of the resulting segments compared to the true circular arc. The algorithm never produces more than around 180 vertices for each round join.Returns- See also
Example// Creates a new geometry offset from the provided geometry const offset = await geometryEngineAsync.offset(boundaryPolygon, 500, "meters", "round");
-
Indicates if one geometry overlaps another geometry.
ParametersReturns- See also
Example// returns true if one geometry overlaps another, // but is not contained or disjointed const isOverlapping = await geometryEngineAsync.overlaps(polygon, boundaryPolygon);
-
Calculates the area of the input geometry. As opposed to geodesicArea(), planarArea() performs this calculation using projected coordinates and does not take into account the earth's curvature. When using input geometries with a spatial reference of either WGS84 (wkid: 4326) or Web Mercator, it is best practice to calculate areas using geodesicArea(). If the input geometries have a projected coordinate system other than Web Mercator, use planarArea() instead.
ParametersReturns- See also
Example// Returns the numeric area of the given polygon const area = await geometryEngineAsync.planarArea(boundaryPolygon, "square-miles");
-
Calculates the length of the input geometry. As opposed to geodesicLength(), planarLength() uses projected coordinates and does not take into account the curvature of the earth when performing this calculation. When using input geometries with a spatial reference of either WGS84 (wkid: 4326) or Web Mercator, it is best practice to calculate lengths using geodesicLength(). If the input geometries have a projected coordinate system other than Web Mercator, use planarLength() instead.
Parametersgeometry GeometryThe input geometry.
unit LinearUnitsoptionalMeasurement unit of the return value. Defaults to the units of the input geometries.
Returns- See also
Example// Returns the numeric length of the given line const length = await geometryEngineAsync.planarLength(riverGeometry, "miles");
-
Indicates if the given DE-9IM relation holds for the two geometries.
Parametersgeometry1 GeometryThe first geometry for the relation.
geometry2 GeometryThe second geometry for the relation.
relation StringThe Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to test against the relationship of the two geometries. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned:
0,1,2), a Boolean value (TorF), or a mask character (for ignoring results: '*'). For example, each of the following DE-9IM string codes are valid for testing whether a polygon geometry completely contains a line geometry:TTTFFTFFT(Boolean), 'T*****FF*' (ignore irrelevant intersections), or '102FF*FF*' (dimension form). Each returns the same result. See this article and this ArcGIS help page for more information about the DE-9IM model and how string codes are constructed.Returns- See also
Example// returns true if the polygon geometry completely // contains the polyline based on the DE-9IM string const isRelated = await geometryEngineAsync.relate(polygon, polyline, "TTTFFTFFT");
-
Rotates a geometry counterclockwise by the specified number of degrees. Rotation is around the centroid, or a given rotation point.
ParametersReturns- See also
Example// Returns a geometry rotated by 45 degrees const geometry = await geometryEngineAsync.rotate(boundaryPolygon, 45);
-
Performs the simplify operation on the geometry, which alters the given geometries to make their definitions topologically legal with respect to their geometry type. At the end of a simplify operation, no polygon rings or polyline paths will overlap, and no self-intersection will occur.
Parametergeometry GeometryThe geometry to be simplified.
Returns- See also
Example// Topologically simplifies a geometry const simplified = await geometryEngineAsync.simplify(polyline); console.log(geometryEngine.isSimple(simplified)); // true
-
Creates the symmetric difference of two geometries. The symmetric difference includes the parts that are in either of the sets, but not in both.
ParametersReturns- See also
Example// Creates a new geometry based on the // symmetric difference of the two const geometry = await geometryEngineAsync.symmetricDifference(boundaryPolygon, buffers);
-
Indicates if one geometry touches another geometry.
ParametersReturns- See also
Example// returns true if the line vertex touches the edge of the polygon const isTouching = await geometryEngineAsync.touches(polygon, line);
-
All inputs must be of the same type of geometries and share one spatial reference.
Returns- See also
Example// pt1 and pt2 are point objects to union together const response = await geometryEngine.union([pt1, pt2]);
-
Indicates if one geometry is within another geometry.
ParametersReturns- See also
Example// returns true if a geometry is completely within another const isWithin = await geometryEngineAsync.within(polygon, boundaryPolygon);
Type Definitions
-
The return object of the extendedSpatialReferenceInfo() method.