Types
import type { ProximityResult, ProjectOptions } from "@arcgis/core/geometry/operators/types.js";

Type definitions

ProximityResult

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Object returned from the getNearestCoordinate(), proximityOperator's getNearestVertex(), and getNearestVertices() methods.

coordinate

Property
Type
Point
Since
ArcGIS Maps SDK for JavaScript 5.0

The nearest coordinate on the geometry to the given input point.

distance

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The planar distance between the input point and the nearest coordinate on the geometry. Unless the unit option is set, the default is the spatial reference unit of the input geometries.

isEmpty

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates if the result is empty.

isRightSide

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates if the nearest coordinate is on the right side or left side of the input point.

This property will only be present when calculateLeftRightSide is set to true when calling getNearestCoordinate().

vertexIndex

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The index of the vertex on the geometry that is closest to the input point.

ProjectOptions

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

areaOfInterestExtent

readonly Property
Type
Extent | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

An extent used to help pick the correct transform. This is not used if the geographicTransformation option is provided. The extent's spatial reference should be the same as the geometries spatial reference.

geographicTransformation

readonly Property
Type
GeographicTransformation | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The geographic transformation used to transform the geometries. Specify this parameter to project a geometry when the default transformation is not appropriate for your requirements.