ESM: import * as geometryEngine from "@arcgis/core/geometry/geometryEngine.js";
CDN: const geometryEngine = await $arcgis.import("@arcgis/core/geometry/geometryEngine.js");
Object: @arcgis/core/geometry/geometryEngine
Since: ArcGIS Maps SDK for JavaScript 4.0
Method Overview Method Details buffer(geometry, distance, unit, unionResults){Polygon |Polygon[]}
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().
Parameters
The buffer input geometry. The geometry and distance parameters 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 geometry and distance parameters 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 the distance array. 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], g1 will be buffered by d1, g2 by d2, and g3 and g4 will both be buffered by d3. 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.
Measurement unit of the distance(s). Defaults to the units of the input geometries.
optionalDefault Value: false
Determines whether the output geometries should be unioned into a single polygon.
Returns
Type Description Polygon | Polygon[] The resulting buffer(s). The result will be an array if an array of geometries is used as input. It will be a single polygon if a single geometry is input into the function.Example
// Buffer point by 1000 feet
const ptBuff = geometryEngine.buffer(point, 1000, "feet");Calculates the clipped geometry from a target geometry by an envelope.
Returns
Example
// returns a new geometry of a polygon clipped by the views extent
const clippedGeometry= geometryEngine.clip(boundaryPolygon, view.extent); contains(containerGeometry, insideGeometry){Boolean}
Indicates if one geometry contains another geometry.
Parameters
The geometry that is tested for the "contains" relationship to the other geometry. Think of this geometry as the potential "container" of the insideGeometry.
The geometry that is tested for the "within" relationship to the containerGeometry.
Returns
Type Description Boolean Returnstrue if the containerGeometry contains the insideGeometry.
Examples
// returns true or false for one geometry containing another
const isContained = geometryEngine.contains(boundaryPolygon, point);// returns true or false for one geometry containing another
const isContained = geometryEngine.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.
Parameters
The 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.
optionalDefault Value: false
Indicates whether to merge the output into a single geometry (usually a polygon).
Returns
Type Description GeometryUnion | GeometryUnion[] Returns the convex hull of the input geometries. This is usually a polygon, but can also be a polyline (if the input is a set of points or polylines forming a straight line), or a point (in degenerate cases).Examples
// returns the convex hull of a multipoint as a single polygon
const hull = geometryEngine.convexHull(multipoint);// returns the convex hull of an array of points as a single polygon
const [ hull ] = geometryEngine.convexHull([ pointA, pointB, pointC ], true);// returns the convex hull for each input line geometry as three polygons
const hulls = geometryEngine.convexHull([ lineA, lineB, lineC ]);// returns the convex hull for all input line geometries as a single polygon
const [ hull ] = geometryEngine.convexHull([ lineA, lineB, lineC ], true);// returns the convex hull for all input geometries as a single polygon
const [ hull ] = geometryEngine.convexHull([ point, line, polygon ], true); crosses(geometry1, geometry2){Boolean}
Indicates if one geometry crosses another geometry.
Returns
Type Description Boolean Returnstrue if geometry1 crosses geometry2.
Example
// returns true or false if a line crosses a polygon another
const isCrossed = geometryEngine.crosses(boundaryPolygon, polyline);Splits 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 leftover 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.
Returns
Type Description GeometryUnion[] Returns an array of geometries created by cutting the input geometry with the cutter.Example
// returns array of cut geometries
const geometries = geometryEngine.cut(boundaryPolygon, polyline); densify(geometry, maxSegmentLength, maxSegmentLengthUnit){GeometryUnion}
Densify geometries by plotting points between existing vertices.
Parameters
The geometry to be densified.
The maximum segment length allowed. Must be a positive value.
optionalMeasurement unit for maxSegmentLength. Defaults to the units of the input geometry.
Returns
Example
// Returns a densified geometry
const geometry = geometryEngine.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.
Returns
Example
// Creates a new geometry based on the
// difference of the two
const geometry = geometryEngine.difference(boundaryPolygon, buffers); disjoint(geometry1, geometry2){Boolean}
Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry.
Parameters
The base geometry that is tested for the "disjoint" relationship to the other geometry.
The comparison geometry that is tested for the "disjoint" relationship to the other geometry.
Returns
Type Description Boolean Returnstrue if geometry1 and geometry2 are disjoint (don't intersect in any way).
Example
// returns true if a geometry is not contained in another.
// operates the opposite of contains
const isDisjointed = geometryEngine.disjoint(polygon, boundaryPolygon); distance(geometry1, geometry2, distanceUnit){Number}
Calculates the shortest planar distance between two geometries. Distance is reported in the linear units specified by distanceUnit or, if distanceUnit is 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.
Returns
Type Description Number Distance between the two input geometries.Example
// returns numeric distance between two points
const totalDistance = geometryEngine.distance(point1, point2, "feet"); equals(geometry1, geometry2){Boolean}
Indicates if two geometries are equal.
Returns
Type Description Boolean Returnstrue if the two input geometries are equal.
Example
// returns true if two given geometries are equal
const isEqual = geometryEngine.equals(line1, line2); extendedSpatialReferenceInfo(spatialReference){SpatialReferenceInfo}
Deprecated since version 4.32.
Returns an object containing additional information about the input spatial reference.
Returns
flipHorizontal(geometry, flipOrigin){GeometryUnion}
Flips a geometry on the horizontal axis. Can optionally be flipped around a point.
Parameters
The input geometry to be flipped.
optionalPoint to flip the geometry around. Defaults to the centroid of the geometry.
Returns
Example
// Returns a geometry flipped horizontally
const geometry = geometryEngine.flipHorizontal(boundaryPolygon); flipVertical(geometry, flipOrigin){GeometryUnion}
Flips a geometry on the vertical axis. Can optionally be flipped around a point.
Parameters
The input geometry to be flipped.
optionalPoint to flip the geometry around. Defaults to the centroid of the geometry.
Returns
Example
// Returns a geometry flipped vertically
const geometry = geometryEngine.flipVertical(boundaryPolygon); generalize(geometry, maxDeviation, removeDegenerateParts, maxDeviationUnit){GeometryUnion}
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.
Parameters
The input geometry to be generalized.
The maximum allowed deviation from the generalized geometry to the original geometry.
optionalWhen true the degenerate parts of the geometry will be removed from the output (may be undesired for drawing).
Measurement unit for maxDeviation. Defaults to the units of the input geometry.
Returns
Example
// Returns a generalized geometry
const geometry = geometryEngine.generalize(boundaryPolygon, 2.5, true, "miles"); geodesicArea(geometry, unit){Number}
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.
Parameters
The input polygon.
optionalMeasurement unit of the return value. Defaults to the units of the input geometries.
Returns
Type Description Number Area of the input geometry.Example
// Returns the numeric geodesic area of the given polygon
const area = geometryEngine.geodesicArea(boundaryPolygon, "square-miles"); geodesicBuffer(geometry, distance, unit, unionResults){Polygon |Polygon[]}
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().
Parameters
The buffer input geometry. The geometry and distance parameters 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 geometry and distance parameters 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 the distance array. 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], g1 will be buffered by d1, g2 by d2, and g3 and g4 will both be buffered by d3. 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.
Measurement unit of the distance(s). Defaults to the units of the input geometries.
optionalDefault Value: false
Determines whether the output geometries should be unioned into a single polygon.
Returns
Type Description Polygon | Polygon[] The resulting buffer(s). The result will be an array if an array of geometries is used as input. It will be a single polygon if a single geometry is input into the function.Example
// point is a Point geometry
const ptBuff = geometryEngine.geodesicBuffer(point, 1000, "kilometers"); // Buffer point by 1000km geodesicDensify(geometry, maxSegmentLength, maxSegmentLengthUnit){GeometryUnion}
Returns a geodetically densified version of the input geometry. Use this function to draw the line(s) of the geometry along great circles.
Parameters
A polyline or polygon to densify.
The maximum segment length allowed (in meters if a maxSegmentLengthUnit is not provided). This must be a positive value.
Measurement unit for maxSegmentLength. If not provided, the unit will default to meters.
Returns
Example
// lineGeom is a line geometry
const densifiedGeom = geometryEngine.geodesicDensify(lineGeom, 10000); geodesicLength(geometry, unit){Number}
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.
Parameters
The input geometry.
optionalMeasurement unit of the return value. Defaults to the units of the input geometry.
Returns
Type Description Number Length of the input geometry.Example
// Returns the numeric geodesic length of the given line
const length = geometryEngine.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 geometry1 and geometry2 are interchangeable in this operation and will return the same result if flipped.
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.
Returns
Example
// Creates a new geometry from the intersection
// of the two geometries
const intersecting = geometryEngine.intersect(boundaryPolygon, buffers); intersectLinesToPoints(line1, line2){Point[]}
Since: ArcGIS Maps SDK for JavaScript 4.25 geometryEngine since 4.0, intersectLinesToPoints added at 4.25.
Returns an array of points at the intersecting locations of two input polylines. Use intersect for all other geometry intersect operations.
Parameters
The first polyline to use in the intersect operation.
The second polyline to use in the intersect operation.
Returns
Type Description Point[] The point intersections of the input polylines.Example
// Creates an array of points for the intersections of the input lines
const intersections = geometryEngine.intersectLinesToPoints(line1, line2); intersects(geometry1, geometry2){Boolean}
Indicates if one geometry intersects another geometry.
Parameters
The geometry that is tested for the intersects relationship to the other geometry.
The geometry being intersected.
Returns
Type Description Boolean Returnstrue if the input geometries intersect each other.
Example
// returns true if two given geometries intersect each other
const isIntersecting = geometryEngine.intersects(boundaryPolygon, cityPolygon); isSimple(geometry){Boolean}
Indicates if the given geometry is non-OGC topologically simple. No polygon rings self-intersect. Polylines paths that self-intersect are considered simple.
Returns
Type Description Boolean Returnstrue if the geometry is topologically simple.
Example
// returns true if given geometry is simple
const simple = geometryEngine.isSimple(polyline);Finds the coordinate of the geometry that is closest to the specified point.
Parameters
The geometry to consider.
The point used to search the nearest coordinate in the geometry.
Returns
Finds the vertex on the geometry nearest to the specified point.
Parameters
The geometry to consider.
The point used to search the nearest vertex in the geometry.
Returns
Example
// Finds the nearest vertex of the polygon to the input point
const {
coordinate,
distance
} = geometryEngine.nearestVertex(boundaryPolygon, point); nearestVertices(geometry, inputPoint, searchRadius, maxVertexCountToReturn){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.
Parameters
The geometry to consider.
The point from which to measure.
The distance to search from the inputPoint in the units of the view's spatial reference.
The maximum number of vertices to return.
Returns
Type Description NearestPointResult[] An array of objects containing the nearest vertices within the givensearchRadius.
Example
// Returns an array of the nearest vertices
const nearest = geometryEngine.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.
Parameters
The geometries to offset.
The 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.
optionalMeasurement unit of the offset distance. Defaults to the units of the input geometries.
optionalThe join type.
Possible Values:"round"|"bevel"|"miter"|"square"
optionalApplicable 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.
Applicable 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
Example
// Creates a new geometry offset from the provided geometry
const offset = geometryEngine.offset(boundaryPolygon, 500, "meters", "round"); overlaps(geometry1, geometry2){Boolean}
Indicates if one geometry overlaps another geometry.
Parameters
The base geometry that is tested for the "overlaps" relationship with the other geometry.
The comparison geometry that is tested for the "overlaps" relationship with the other geometry.
Returns
Type Description Boolean Returnstrue if the two geometries overlap.
Example
// returns true if one geometry overlaps another,
// but is not contained or disjointed
const isOverlapping = geometryEngine.overlaps(polygon, boundaryPolygon); planarArea(geometry, unit){Number}
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.
Parameters
The input polygon.
optionalMeasurement unit of the return value. Defaults to the units of the input geometries.
Returns
Type Description Number The area of the input geometry.Example
// Returns the numeric area of the given polygon
const area = geometryEngine.planarArea(boundaryPolygon, "square-miles"); planarLength(geometry, unit){Number}
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.
Parameters
The input geometry.
optionalMeasurement unit of the return value. Defaults to the units of the input geometries.
Returns
Type Description Number The length of the input geometry.Example
// Returns the numeric length of the given line
const length = geometryEngine.planarLength(riverGeometry, "miles"); relate(geometry1, geometry2, relation){Boolean}
Indicates if the given DE-9IM relation is true for the two geometries.
Parameters
The first geometry for the relation.
The second geometry for the relation.
The 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 (T or F), 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
Type Description Boolean Returnstrue if the relation of the input geometries is accurate.
Example
// returns true if the polygon geometry completely
// contains the polyline based on the DE-9IM string
const isRelated = geometryEngine.relate(polygon, polyline, "TTTFFTFFT"); rotate(geometry, angle, rotationOrigin){GeometryUnion}
Rotates a geometry counterclockwise by the specified number of degrees. Rotation is around the centroid, or a given rotation point.
Parameters
The geometry to rotate.
The rotation angle in degrees.
optionalPoint to rotate the geometry around. Defaults to the centroid of the geometry.
Returns
Example
// Returns a geometry rotated by 45 degrees
const geometry = geometryEngine.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.
Returns
Example
// Topologically simplifies a geometry
const simplified = geometryEngine.simplify(polyline);
console.log(geometryEngine.isSimple(simplified)); // trueCreates the symmetric difference of two geometries. The symmetric difference includes the parts that are in either of the sets, but not in both.
Returns
Example
// Creates a new geometry based on the
// symmetric difference of the two
const geometry = geometryEngine.symmetricDifference(boundaryPolygon, buffers); touches(geometry1, geometry2){Boolean}
Indicates if one geometry touches another geometry.
Parameters
The geometry to test the "touches" relationship with the other geometry.
The geometry to be touched.
Returns
Type Description Boolean Whentrue, geometry1 touches geometry2.
Example
// returns true if the line vertex touches the edge of the polygon
const isTouching = geometryEngine.touches(polygon, line);All inputs must be of the same type of geometries and share one spatial reference.
Returns
Example
// pt1 and pt2 are Point geometries to union together
const union = geometryEngine.union([pt1, pt2]); within(innerGeometry, outerGeometry){Boolean}
Indicates if one geometry is within another geometry.
Parameters
The base geometry that is tested for the "within" relationship to the other geometry.
The comparison geometry that is tested for the "contains" relationship to the other geometry.
Returns
Type Description Boolean Returnstrue if innerGeometry is within outerGeometry.
Example
// returns true if a geometry is completely within another
const isWithin = geometryEngine.within(polygon, boundaryPolygon);Units for area measurements. Use one of the string values below or a numerical value from here or here.
Possible Values:"acres" |"ares" |"hectares" |"square-feet" |"square-meters" |"square-yards" |"square-kilometers" |"square-miles" |Number
Units for linear measurements. Use one of the string values below or a numerical value from here or here.
Possible Values:"meters" |"feet" |"kilometers" |"miles" |"nautical-miles" |"yards" |Number
NearestPointResult
Object returned from the nearestCoordinate(), nearestVertex(), and nearestVertices() methods.
A vertex within the specified distance of the search.
The distance from the inputPoint in the units of the view's spatial reference.
The index of the vertex within the geometry's rings or paths.
Indicates if it is an empty geometry.
SpatialReferenceInfo
Deprecated since version 4.32.
The return object of the extendedSpatialReferenceInfo() method.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4