geometryEngine | References | ArcGIS Maps SDK for JavaScript

import { extendedSpatialReferenceInfo, clip, cut, contains, crosses } from "@arcgis/core/geometry/geometryEngine.js";

Since: ArcGIS Maps SDK for JavaScript 4.0

A 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

Sample - Geodesic Buffers (2D & 3D)

Functions

Name	Return Type	Object
`extendedSpatialReferenceInfo` deprecated	`ExtendedSpatialReferenceInfo`
`clip` deprecated	`GeometryUnion`
`cut` deprecated	`GeometryUnion[]`
`contains` deprecated	`boolean`
`crosses` deprecated	`boolean`
`distance` deprecated	`number`
`equals` deprecated	`boolean`
`intersects` deprecated	`boolean`
`touches` deprecated	`boolean`
`within` deprecated	`boolean`
`disjoint` deprecated	`boolean`
`overlaps` deprecated	`boolean`
`relate` deprecated	`boolean`
`isSimple` deprecated	`boolean`
`simplify` deprecated	`GeometryUnion`
`convexHull` deprecated	`GeometryUnion \| GeometryUnion[]`
`difference` deprecated	`GeometryUnion \| GeometryUnion[]`
`symmetricDifference` deprecated	`GeometryUnion \| GeometryUnion[]`
`intersect` deprecated	`GeometryUnion \| GeometryUnion[]`
`union` deprecated	`GeometryUnion`
`offset` deprecated	`GeometryUnion \| GeometryUnion[]`
`buffer` deprecated	`Polygon \| Polygon[]`
`geodesicBuffer` deprecated	`Polygon \| Polygon[]`
`nearestCoordinate` deprecated	`NearestPointResult<Point>`
`nearestVertex` deprecated	`NearestPointResult<Point>`
`nearestVertices` deprecated	`NearestPointResult<Point>[]`
`rotate` deprecated	`GeometryUnion`
`flipHorizontal` deprecated	`GeometryUnion`
`flipVertical` deprecated	`GeometryUnion`
`generalize` deprecated	`GeometryUnion`
`densify` deprecated	`GeometryUnion`
`geodesicDensify` deprecated	`GeometryUnion`
`planarArea` deprecated	`number`
`planarLength` deprecated	`number`
`geodesicArea` deprecated	`number`
`geodesicLength` deprecated	`number`
`intersectLinesToPoints` deprecated	`Point[]`

extendedSpatialReferenceInfo

deprecated Function

Returns an object containing additional information about the input spatial reference.

See also

Unit IDs

Signature: extendedSpatialReferenceInfo (spatialReference: SpatialReference): ExtendedSpatialReferenceInfo

Parameters

Parameter	Type	Description	Required
spatialReference	`SpatialReference`	The input spatial reference.

Returns: ExtendedSpatialReferenceInfo
Resolves to a ExtendedSpatialReferenceInfo object.

clip

deprecated Function

Calculates the clipped geometry from a target geometry by an envelope.

Signature: clip (geometry: GeometryUnion, envelope: Extent): GeometryUnion

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The geometry to be clipped.
envelope	`Extent`	The envelope used to clip.

Returns: GeometryUnion
Clipped geometry.

Example

// returns a new geometry of a polygon clipped by the views extent
const clippedGeometry= geometryEngine.clip(boundaryPolygon, view.extent);

cut

deprecated Function

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.

Signature: cut (geometry: GeometryUnion, cutter: Polyline): GeometryUnion[]

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The geometry to be cut.
cutter	`Polyline`	The polyline to cut the geometry.

Returns: 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);

contains

deprecated Function

Indicates if one geometry contains another geometry.

Signature: contains (containerGeometry: GeometryUnion, insideGeometry: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
containerGeometry	`GeometryUnion`	The geometry that is tested for the "contains" relationship to the other geometry. Think of this geometry as the potential "container" of the `insideGeometry`.
insideGeometry	`GeometryUnion`	The geometry that is tested for the "within" relationship to the `containerGeometry`.

Returns: boolean
Returns true 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);

crosses

deprecated Function

Indicates if one geometry crosses another geometry.

Signature: crosses (geometry1: GeometryUnion, geometry2: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion`	The geometry to cross.
geometry2	`GeometryUnion`	The geometry being crossed.

Returns: boolean
Returns true if geometry1 crosses geometry2.

Example

// returns true or false if a line crosses a polygon another
const isCrossed = geometryEngine.crosses(boundaryPolygon, polyline);

distance

deprecated Function

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.

Signature: distance (geometry1: GeometryUnion, geometry2: GeometryUnion, distanceUnit?: number | LinearUnit | null | undefined): number

Parameters

Parameter	Type	Description
geometry1	`GeometryUnion`	First input geometry.
geometry2	`GeometryUnion`	Second input geometry.
distanceUnit	`number \| LinearUnit \| null \| undefined`	Measurement unit of the return value. Defaults to the units of the input geometries.

Returns: number
Distance between the two input geometries.

Example

// returns numeric distance between two points
const totalDistance = geometryEngine.distance(point1, point2, "feet");

equals

deprecated Function

Indicates if two geometries are equal.

Signature: equals (geometry1: GeometryUnion, geometry2: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion`	First input geometry.
geometry2	`GeometryUnion`	Second input geometry.

Returns: boolean
Returns true if the two input geometries are equal.

Example

// returns true if two given geometries are equal
const isEqual = geometryEngine.equals(line1, line2);

intersects

deprecated Function

Indicates if one geometry intersects another geometry.

Signature: intersects (geometry1: GeometryUnion, geometry2: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion`	The geometry that is tested for the intersects relationship to the other geometry.
geometry2	`GeometryUnion`	The geometry being intersected.

Returns: boolean
Returns true if the input geometries intersect each other.

Example

// returns true if two given geometries intersect each other
const isIntersecting = geometryEngine.intersects(boundaryPolygon, cityPolygon);

touches

deprecated Function

Indicates if one geometry touches another geometry.

Signature: touches (geometry1: GeometryUnion, geometry2: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion`	The geometry to test the "touches" relationship with the other geometry.
geometry2	`GeometryUnion`	The geometry to be touched.

Returns: boolean
When true, geometry1 touches geometry2.

Example

// returns true if the line vertex touches the edge of the polygon
const isTouching = geometryEngine.touches(polygon, line);

within

deprecated Function

Indicates if one geometry is within another geometry.

Signature: within (innerGeometry: GeometryUnion, outerGeometry: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
innerGeometry	`GeometryUnion`	The base geometry that is tested for the "within" relationship to the other geometry.
outerGeometry	`GeometryUnion`	The comparison geometry that is tested for the "contains" relationship to the other geometry.

Returns: boolean
Returns true if innerGeometry is within outerGeometry.

Example

// returns true if a geometry is completely within another
const isWithin = geometryEngine.within(polygon, boundaryPolygon);

disjoint

deprecated Function

Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry.

Signature: disjoint (geometry1: GeometryUnion, geometry2: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion`	The base geometry that is tested for the "disjoint" relationship to the other geometry.
geometry2	`GeometryUnion`	The comparison geometry that is tested for the "disjoint" relationship to the other geometry.

Returns: boolean
Returns true 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);

overlaps

deprecated Function

Indicates if one geometry overlaps another geometry.

Signature: overlaps (geometry1: GeometryUnion, geometry2: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion`	The base geometry that is tested for the "overlaps" relationship with the other geometry.
geometry2	`GeometryUnion`	The comparison geometry that is tested for the "overlaps" relationship with the other geometry.

Returns: boolean
Returns true 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);

relate

deprecated Function

Indicates if the given DE-9IM relation is true for the two geometries.

Signature: relate (geometry1: GeometryUnion, geometry2: GeometryUnion, relation: string): boolean

Parameters

Parameter	Type	Description
geometry1	`GeometryUnion`	The first geometry for the relation.
geometry2	`GeometryUnion`	The second geometry for the relation.
relation	`string`	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 '102FFFF' (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: boolean
Returns true 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");

isSimple

deprecated Function

Indicates if the given geometry is non-OGC topologically simple. No polygon rings self-intersect. Polylines paths that self-intersect are considered simple.

Signature: isSimple (geometry: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The input geometry.

Returns: boolean
Returns true if the geometry is topologically simple.

Example

// returns true if given geometry is simple
const simple = geometryEngine.isSimple(polyline);

simplify

deprecated Function

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.

Signature: simplify (geometry: GeometryUnion): GeometryUnion

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The geometry to be simplified.

Returns: GeometryUnion
The simplified geometry.

Example

// Topologically simplifies a geometry
const simplified = geometryEngine.simplify(polyline);
console.log(geometryEngine.isSimple(simplified)); // true

convexHull

deprecated Function

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.

Signature: convexHull (geometries: GeometryUnion | GeometryUnion[], merge: boolean): GeometryUnion | GeometryUnion[]

Parameters

Parameter	Type	Description	Required
geometries	`GeometryUnion \| GeometryUnion[]`	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.
merge	`boolean`	= false - Indicates whether to merge the output into a single geometry (usually a polygon).

Returns: 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);

difference

deprecated Function

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.

Signature: difference (inputGeometry: GeometryUnion | GeometryUnion[], subtractor: GeometryUnion): GeometryUnion | GeometryUnion[]

Parameters

Parameter	Type	Description	Required
inputGeometry	`GeometryUnion \| GeometryUnion[]`	The input geometry to subtract from.
subtractor	`GeometryUnion`	The geometry being subtracted from inputGeometry.

Returns: GeometryUnion | GeometryUnion[]
Returns the geometry of inputGeometry minus the subtractor geometry.

Example

// Creates a new geometry based on the
// difference of the two
const geometry = geometryEngine.difference(boundaryPolygon, buffers);

symmetricDifference

deprecated Function

Creates the symmetric difference of two geometries. The symmetric difference includes the parts that are in either of the sets, but not in both.

Signature: symmetricDifference (leftGeometry: GeometryUnion | GeometryUnion[], rightGeometry: GeometryUnion): GeometryUnion | GeometryUnion[]

Parameters

Parameter	Type	Description	Required
leftGeometry	`GeometryUnion \| GeometryUnion[]`	One of the Geometry instances in the XOR operation.
rightGeometry	`GeometryUnion`	One of the Geometry instances in the XOR operation.

Returns: GeometryUnion | GeometryUnion[]
The symmetric differences of the two geometries.

Example

// Creates a new geometry based on the
// symmetric difference of the two
const geometry = geometryEngine.symmetricDifference(boundaryPolygon, buffers);

intersect

deprecated Function

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.

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.

See also

intersectLinesToPoints()

Signature: intersect (geometry1: GeometryUnion | GeometryUnion[], geometry2: GeometryUnion): GeometryUnion | GeometryUnion[]

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion \| GeometryUnion[]`	The input geometry or array of geometries.
geometry2	`GeometryUnion`	The geometry to intersect with geometry1.

Returns: GeometryUnion | GeometryUnion[]
The intersections of the geometries.

Example

// Creates a new geometry from the intersection
// of the two geometries
const intersecting = geometryEngine.intersect(boundaryPolygon, buffers);

union

deprecated Function

All inputs must be of the same type of geometries and share one spatial reference.

Signature: union (geometries: GeometryUnion[]): GeometryUnion

Parameters

Parameter	Type	Description	Required
geometries	`GeometryUnion[]`	An array of Geometries to union.

Returns: GeometryUnion
The union of the geometries.

Example

// pt1 and pt2 are Point geometries to union together
const union = geometryEngine.union([pt1, pt2]);

offset

deprecated Function

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.

Signature: offset (geometry: GeometryUnion | GeometryUnion[], offsetDistance: number, offsetUnit?: number | LinearUnit, joinType?: any, bevelRatio?: number, flattenError?: number): GeometryUnion | GeometryUnion[]

Parameters

Parameter	Type	Description
geometry	`GeometryUnion \| GeometryUnion[]`	The geometries to offset.
offsetDistance	`number`	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.
offsetUnit	`number \| LinearUnit`	Measurement unit of the offset distance. Defaults to the units of the input geometries.
joinType	`any`	The join type.
bevelRatio	`number`	Applicable 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	`number`	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: GeometryUnion | GeometryUnion[]
The offset geometries.

Example

// Creates a new geometry offset from the provided geometry
const offset = geometryEngine.offset(boundaryPolygon, 500, "meters", "round");

buffer

deprecated Function

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 buffer().

See also

geodesicBuffer()

Signature: buffer (geometry: GeometryUnion | GeometryUnion[], distance: number, unit?: number | LinearUnit, toUnionResults?: boolean): Polygon | Polygon[]

Parameters

Parameter	Type	Description
geometry	`GeometryUnion \| GeometryUnion[]`	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.
distance	`number`	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.
unit	`number \| LinearUnit`	Measurement unit of the distance(s). Defaults to the units of the input geometries.
toUnionResults	`boolean`	= false - Determines whether the output geometries should be unioned into a single polygon.

Returns: 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");

geodesicBuffer

deprecated Function

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 buffer().

Signature: geodesicBuffer (geometry: GeometryUnion | GeometryUnion[], distance: number | number[], unit?: number | LinearUnit, toUnionResults?: boolean): Polygon | Polygon[]

Parameters

Parameter	Type	Description
geometry	`GeometryUnion \| GeometryUnion[]`	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.
distance	`number \| number[]`	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.
unit	`number \| LinearUnit`	Measurement unit of the distance(s). Defaults to the units of the input geometries.
toUnionResults	`boolean`	= false - Determines whether the output geometries should be unioned into a single polygon.

Returns: 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

nearestCoordinate

deprecated Function

Finds the coordinate of the geometry that is closest to the specified point.

Signature: nearestCoordinate (geometry: GeometryUnion, inputPoint: Point): NearestPointResult<Point>

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The geometry to consider.
inputPoint	`Point`	The point used to search the nearest coordinate in the geometry.

Returns: NearestPointResult<Point>
Returns an object containing the nearest coordinate.

nearestVertex

deprecated Function

Finds the vertex on the geometry nearest to the specified point.

Signature: nearestVertex (geometry: GeometryUnion, inputPoint: Point): NearestPointResult<Point>

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The geometry to consider.
inputPoint	`Point`	The point used to search the nearest vertex in the geometry.

Returns: NearestPointResult<Point>
Returns an object containing the nearest vertex.

Example

// Finds the nearest vertex of the polygon to the input point
const {
 coordinate,
 distance
} = geometryEngine.nearestVertex(boundaryPolygon, point);

nearestVertices

deprecated Function

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.

Signature: nearestVertices (geometry: GeometryUnion, inputPoint: Point, searchRadius: number, maxVertexCountToReturn: number): NearestPointResult<Point>[]

Parameters

Parameter	Type	Description
geometry	`GeometryUnion`	The geometry to consider.
inputPoint	`Point`	The point from which to measure.
searchRadius	`number`	The distance to search from the inputPoint in the units of the view's spatial reference.
maxVertexCountToReturn	`number`	The maximum number of vertices to return.

Returns: NearestPointResult<Point>[]
An array of objects containing the nearest vertices within the given searchRadius.

Example

// Returns an array of the nearest vertices
const nearest = geometryEngine.nearestVertices(boundaryPolygon, point, 500, 2);

rotate

deprecated Function

Rotates a geometry counterclockwise by the specified number of degrees. Rotation is around the centroid, or a given rotation point.

Signature: rotate (geometry: GeometryUnion, angle: number, rotationOrigin?: Point | null): GeometryUnion

Parameters

Parameter	Type	Description
geometry	`GeometryUnion`	The geometry to rotate.
angle	`number`	The rotation angle in degrees.
rotationOrigin	`Point \| null`	Point to rotate the geometry around. Defaults to the centroid of the geometry.

Returns: GeometryUnion
The rotated geometry.

Example

// Returns a geometry rotated by 45 degrees
const geometry = geometryEngine.rotate(boundaryPolygon, 45);

flipHorizontal

deprecated Function

Flips a geometry on the horizontal axis. Can optionally be flipped around a point.

Signature: flipHorizontal (geometry: GeometryUnion, flipOrigin?: Point | null | undefined): GeometryUnion

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The input geometry to be flipped.
flipOrigin	`Point \| null \| undefined`	Point to flip the geometry around. Defaults to the centroid of the geometry.

Returns: GeometryUnion
The flipped geometry.

Example

// Returns a geometry flipped horizontally
const geometry = geometryEngine.flipHorizontal(boundaryPolygon);

flipVertical

deprecated Function

Flips a geometry on the vertical axis. Can optionally be flipped around a point.

Signature: flipVertical (geometry: GeometryUnion, flipOrigin?: Point | null | undefined): GeometryUnion

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The input geometry to be flipped.
flipOrigin	`Point \| null \| undefined`	Point to flip the geometry around. Defaults to the centroid of the geometry.

Returns: GeometryUnion
The flipped geometry.

Example

// Returns a geometry flipped vertically
const geometry = geometryEngine.flipVertical(boundaryPolygon);

generalize

deprecated Function

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.

Signature: generalize (geometry: GeometryUnion, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: number | LinearUnit): GeometryUnion

Parameters

Parameter	Type	Description
geometry	`GeometryUnion`	The input geometry to be generalized.
maxDeviation	`number`	The maximum allowed deviation from the generalized geometry to the original geometry.
removeDegenerateParts	`boolean`	When `true` the degenerate parts of the geometry will be removed from the output (may be undesired for drawing).
maxDeviationUnit	`number \| LinearUnit`	Measurement unit for maxDeviation. Defaults to the units of the input geometry.

Returns: GeometryUnion
The generalized geometry.

Example

// Returns a generalized geometry
const geometry = geometryEngine.generalize(boundaryPolygon, 2.5, true, "miles");

densify

deprecated Function

Densify geometries by plotting points between existing vertices.

See also

geodesicDensify()

Signature: densify (geometry: GeometryUnion, maxSegmentLength: number, maxSegmentLengthUnit?: number | LinearUnit): GeometryUnion

Parameters

Parameter	Type	Description
geometry	`GeometryUnion`	The geometry to be densified.
maxSegmentLength	`number`	The maximum segment length allowed. Must be a positive value.
maxSegmentLengthUnit	`number \| LinearUnit`	Measurement unit for maxSegmentLength. Defaults to the units of the input geometry.

Returns: GeometryUnion
The densified geometry.

Example

// Returns a densified geometry
const geometry = geometryEngine.densify(boundaryPolygon, 25);

geodesicDensify

deprecated Function

Returns a geodetically densified version of the input geometry. Use this function to draw the line(s) of the geometry along great circles.

Signature: geodesicDensify (geometry: Polyline | Polygon, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnit): GeometryUnion

Parameters

Parameter	Type	Description
geometry	`Polyline \| Polygon`	A polyline or polygon to densify.
maxSegmentLength	`number`	The maximum segment length allowed (in meters if a `maxSegmentLengthUnit` is not provided). This must be a positive value.
maxSegmentLengthUnit	`LinearUnit`	Measurement unit for `maxSegmentLength`. If not provided, the unit will default to `meters`.

Returns: GeometryUnion
Returns the densified geometry.

Example

// lineGeom is a line geometry
const densifiedGeom = geometryEngine.geodesicDensify(lineGeom, 10000);

planarArea

deprecated Function

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.

Signature: planarArea (geometry: Polygon, unit?: number | AreaUnit): number

Parameters

Parameter	Type	Description	Required
geometry	`Polygon`	The input polygon.
unit	`number \| AreaUnit`	Measurement unit of the return value. Defaults to the units of the input geometries.

Returns: number
The area of the input geometry.

Example

// Returns the numeric area of the given polygon
const area = geometryEngine.planarArea(boundaryPolygon, "square-miles");

planarLength

deprecated Function

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.

Signature: planarLength (geometry: GeometryUnion, unit?: number | LinearUnit): number

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The input geometry.
unit	`number \| LinearUnit`	Measurement unit of the return value. Defaults to the units of the input geometries.

Returns: number
The length of the input geometry.

Example

// Returns the numeric length of the given line
const length = geometryEngine.planarLength(riverGeometry, "miles");

geodesicArea

deprecated Function

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.

Signature: geodesicArea (geometry: Polygon, unit?: number | AreaUnit): number

Parameters

Parameter	Type	Description	Required
geometry	`Polygon`	The input polygon.
unit	`number \| AreaUnit`	Measurement unit of the return value. Defaults to the units of the input geometries.

Returns: number
Area of the input geometry.

Example

// Returns the numeric geodesic area of the given polygon
const area = geometryEngine.geodesicArea(boundaryPolygon, "square-miles");

geodesicLength

deprecated Function

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.

Signature: geodesicLength (geometry: GeometryUnion, unit?: number | LinearUnit): number

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The input geometry.
unit	`number \| LinearUnit`	Measurement unit of the return value. Defaults to the units of the input geometry.

Returns: number
Length of the input geometry.

Example

// Returns the numeric geodesic length of the given line
const length = geometryEngine.geodesicLength(riverGeometry, "miles");

intersectLinesToPoints

deprecated Function

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns an array of points at the intersecting locations of two input polylines. Use intersect() for all other geometry intersect operations.

See also

intersect()

Signature: intersectLinesToPoints (line1: Polyline, line2: Polyline): Point[]

Parameters

Parameter	Type	Description	Required
line1	`Polyline`	The first polyline to use in the intersect operation.
line2	`Polyline`	The second polyline to use in the intersect operation.

Returns: 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);