@arcgis/core 5.0.0-next.51 → 5.0.0-next.53

package/geometry/SpatialReference.d.ts

@@ -1,4 +1,239 @@
-import "../interfaces";
+import type { JSONSupport, JSONSupportMixinProperties } from "../core/JSONSupport.js";
+import type { APIUnitString } from "../core/units.js";
 
-import SpatialReference = __esri.SpatialReference;
-export default SpatialReference;
+export interface SpatialReferenceProperties extends JSONSupportMixinProperties, Partial<Pick<SpatialReference, "falseM" | "falseX" | "falseY" | "falseZ" | "imageCoordinateSystem" | "latestVcsWkid" | "latestWkid" | "mTolerance" | "mUnits" | "vcsWkid" | "wkid" | "wkt" | "wkt2" | "xyTolerance" | "xyUnits" | "zTolerance" | "zUnits">> {}
+
+/**
+ * Defines the spatial reference of a view, layer, or method parameters.
+ * This indicates the projected or geographic coordinate system used to locate geographic features in the map.
+ * Each projected and geographic coordinate system is defined by either a
+ * well-known ID [(WKID)](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) or a definition string [(WKT)](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt). Note that for versions prior to ArcGIS 10, only [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) was supported.
+ * For a full list of supported spatial reference IDs and their corresponding definition strings, see
+ * [Using spatial references](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm).
+ *
+ * @since 4.0
+ * @example
+ * // set the spatial reference of a view to WebMercator using wkid
+ * const view = new SceneView({
+ *   container: "viewDiv",
+ *   map: map,
+ *   spatialReference: {
+ *     wkid: 3857
+ *   }
+ * });
+ * @example
+ * // set the spatial reference of a geometry
+ * // to WGS84 using the WGS84 property
+ * const point = new Point({
+ *   x: 10.1,
+ *   y: 47.4,
+ *   spatialReference: SpatialReference.WGS84
+ * });
+ */
+export default class SpatialReference extends JSONSupport {
+  /**
+   * A convenience spatial reference instance for Web Mercator.
+   *
+   * @example
+   * // returns true if the webMercatorUtils can
+   * // project geometries from WGS84 to Web Mercator
+   * let canProjectWGS84toWebMercator = webMercatorUtils.canProject(SpatialReference.WGS84, SpatialReference.WebMercator);
+   */
+  static readonly WebMercator: SpatialReference;
+  /**
+   * A convenience spatial reference instance for WGS84.
+   *
+   * @example
+   * // returns true if the webMercatorUtils can
+   * // project geometries from WGS84 to Web Mercator
+   * let canProjectWGS84toWebMercator = webMercatorUtils.canProject(SpatialReference.WGS84, SpatialReference.WebMercator);
+   */
+  static readonly WGS84: SpatialReference;
+  constructor(properties?: SpatialReferenceProperties);
+  /** The false origin of coordinate M values. The default is determined by the spatial reference. */
+  accessor falseM: number | null | undefined;
+  /** The false origin of coordinate X values. The default is determined by the spatial reference. */
+  accessor falseX: number | null | undefined;
+  /** The false origin of coordinate Y values. The default is determined by the spatial reference. */
+  accessor falseY: number | null | undefined;
+  /** The false origin of coordinate Z values. The default is determined by the spatial reference. */
+  accessor falseZ: number | null | undefined;
+  /**
+   * An [image coordinate system](https://developers.arcgis.com/rest/services-reference/raster-ics.htm) defines the
+   * spatial reference used to display the image in its original coordinates
+   * without distortion, map transformations or ortho-rectification. Typically, [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)
+   * is displayed in the [MapView#spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#spatialReference) of the view.
+   * In some cases, converting images into map coordinates can cause your images to look skewed or distorted because
+   * of the various transformations and terrain corrections that are used.
+   * Since there is no distortion with images in the image coordinate system, it is ideal for using with oblique imagery
+   * and mensuration.
+   *
+   * The image can be displayed in its original coordinates only in 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) with a
+   * `top-up`rotation which is always oriented in the look of direction of the dataset. This works similarly to an in-car navigation
+   * system where the choices are often either north is at the top of the screen (therefore, not using a top up option) or
+   * the screen rotates so the travel direction is always displayed at the top.
+   *
+   * @since 4.13
+   * @see [Sample - ImageryLayer image coordinate system](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-coordinatesystem/)
+   * @see [Image coordinate system](https://developers.arcgis.com/documentation/common-data-types/image-coordinate-system.htm)
+   * @see [Image space analysis](https://pro.arcgis.com/en/pro-app/latest/help/analysis/image-analyst/what-is-image-space-analysis-.htm)
+   * @see [ImageryLayer#getCatalogItemICSInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#getCatalogItemICSInfo)
+   * @example
+   * // get image coordinate system of the specified catalog item
+   * // for example Raster.OBJECTID = 1600
+   * layer.getCatalogItemICSInfo(imageId).then(function(info) {
+   * // create a spatialReference object and set its
+   * // imageCoordinateSystem property
+   *  let sr = { // autocasts to esri/geometry/SpatialReference
+   *    imageCoordinateSystem: { id: imageId }
+   *  };
+   *
+   *  // Calculate an extent for the mapview based on the image's extent
+   *  // in its original coordinate system
+   *  const width = document.getElementById("viewDiv").getBoundingClientRect().width;
+   *  const height = document.getElementById("viewDiv").getBoundingClientRect().height;
+   *  const newExt = info.icsExtent.clone();
+   *  const scaleFactor = 5;
+   *  newExt.xmin = (newExt.xmin + newExt.xmax - width * scaleFactor) / 2;
+   *  newExt.xmax = newExt.xmin + width * scaleFactor;
+   *  newExt.ymin = (newExt.ymin + newExt.ymax - height * scaleFactor) / 2;
+   *  newExt.ymax = newExt.ymin + height * scaleFactor;
+   *  newExt.spatialReference = sr;
+   *
+   *  // set the MapView's spatialReference to the image's coordinate system
+   *  // and the extent to the extent calculated above
+   *  view = new MapView({
+   *    container: "viewDiv",
+   *    map: map,
+   *    spatialReference: sr,
+   *    extent: newExt
+   *  });
+   * });
+   */
+  accessor imageCoordinateSystem: any | null | undefined;
+  /** Indicates if the spatial reference refers to a geographic coordinate system. */
+  get isGeographic(): boolean;
+  /**
+   * Indicates if the [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) of the spatial reference object is one of the following values:
+   * `102113`, `102100`, `3857`.
+   */
+  get isWebMercator(): boolean;
+  /**
+   * Indicates if the [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) of the spatial reference object is
+   * `4326`.
+   */
+  get isWGS84(): boolean;
+  /**
+   * Indicates if the spatial reference of the map supports wrapping around the International
+   * Date Line. Value is `true` if the spatial reference is Web Mercator or WGS84.
+   */
+  get isWrappable(): boolean;
+  /** The latest vertical coordinate system well-known ID of the spatial reference. */
+  accessor latestVcsWkid: number | null | undefined;
+  /** The latest well-known ID of the spatial reference. */
+  accessor latestWkid: number | null | undefined;
+  /**
+   * The factor to convert one unit value in the spatial reference's [unit](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#unit) to meters.
+   *
+   * @since 4.26
+   * @example
+   * // Convert 1 pixel in a MapView to meters
+   * const pixelInMeter = view.resolution * view.spatialReference.metersPerUnit;
+   * @example
+   * // Measure the geodesic distance between two points in the view's unit
+   * const distanceInViewUnit = geodesicUtils.geodesicDistance(pointA, pointB, "meters")  / view.spatialReference.metersPerUnit;
+   * @example
+   * const DPI = 96
+   * const inchesPerMeter = 39.37;
+   *
+   * // Get the scale for an extent
+   * function getScale(extent, viewWidth) {
+   *   const unitValue = extent.spatialReference.metersPerUnit;
+   *   return (extent.width / viewWidth) * unitValue * inchesPerMeter * DPI;
+   * }
+   */
+  get metersPerUnit(): number;
+  /**
+   * The tolerance value reflects the accuracy of coordinates.
+   * If one coordinate is within the tolerance value of another, they are interpreted as being at the same location.
+   * This value is used in relational and topological operations when determining whether two points are close enough to be given the same coordinate value or they are far enough apart to each have their own coordinate value.
+   * The default tolerance is set to 0.001 meters or its equivalent in map units.
+   */
+  accessor mTolerance: number | null | undefined;
+  /**
+   * The number of distinct values that can be represented per one unit of floating point coordinates.
+   * The resolution for M is 1/mUnits. The default resolution is set to 0.0001 meters or its equivalent in map units.
+   */
+  accessor mUnits: number | null | undefined;
+  /**
+   * The unit of the spatial reference. Returns `null` if no unit could be determined.
+   *
+   * Some values of the possible values listed here cannot be used as parameters for certain functions.
+   * For example, [geodesicDistance()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-geodesicUtils.html#geodesicDistance) only accepts `meters`, `feet`, `us-feet`.
+   * For other values, you can use the `meters` unit and use [metersPerUnit](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#metersPerUnit) convert to the spatial reference's `unit`.
+   *
+   * @since 4.26
+   * @see [metersPerUnit](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#metersPerUnit)
+   */
+  get unit(): APIUnitString | "degrees" | null | undefined;
+  /** The vertical coordinate system well-known ID of the spatial reference. */
+  accessor vcsWkid: number | null | undefined;
+  /**
+   * The well-known ID of a spatial reference.
+   * See [Using spatial references](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm)
+   * for a list of supported spatial references.
+   */
+  accessor wkid: number | null | undefined;
+  /** The well-known text that defines a spatial reference. */
+  accessor wkt: string | null | undefined;
+  /**
+   * The well-known text of the coordinate system as defined by OGC standard for well-known text strings.
+   *
+   * @since 4.28
+   */
+  accessor wkt2: string | null | undefined;
+  /**
+   * The tolerance value reflects the accuracy of coordinates.
+   * If one coordinate is within the tolerance value of another, they are interpreted as being at the same location.
+   * This value is used in relational and topological operations when determining whether two points are close enough to be given the same coordinate value or they are far enough apart to each have their own coordinate value.
+   * The default tolerance is set to 0.001 meters or its equivalent in map units.
+   */
+  accessor xyTolerance: number | null | undefined;
+  /**
+   * The number of distinct values that can be represented per one unit of floating point coordinates.
+   * The resolution for X and Y is 1/xyUnits. The default resolution is set to 0.0001 meters or its equivalent in map units.
+   */
+  accessor xyUnits: number | null | undefined;
+  /**
+   * The tolerance value reflects the accuracy of coordinates.
+   * If one coordinate is within the tolerance value of another, they are interpreted as being at the same location.
+   * This value is used in relational and topological operations when determining whether two points are close enough to be given the same coordinate value or they are far enough apart to each have their own coordinate value.
+   * The default tolerance is set to 0.001 meters or its equivalent in map units.
+   */
+  accessor zTolerance: number | null | undefined;
+  /**
+   * The number of distinct values that can be represented per one unit of floating point coordinates.
+   * The resolution for Z is 1/zUnits. The default resolution is set to 0.0001 meters or its equivalent in map units.
+   */
+  accessor zUnits: number | null | undefined;
+  /**
+   * Returns a deep clone of the spatial reference object.
+   *
+   * @returns Returns a deep clone of the spatial reference object.
+   */
+  clone(): SpatialReference;
+  /**
+   * Checks if the specified spatial reference object has the same [wkid](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkid) or
+   * [wkt](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#wkt) as this spatial reference object.
+   *
+   * @param spatialReference - The spatial reference to compare to.
+   * @returns Returns `true` if the input spatial reference object has the
+   *                   same wkid or wkt as this spatial reference object.
+   * @example
+   * const SpatialReference = await $arcgis.import("@arcgis/core/geometry/SpatialReference.js");
+   * const sr1 = new SpatialReference({ wkid: 4326 });
+   * const sr2 = new SpatialReference({ wkid: 4326 });
+   * console.log(sr1.equals(sr2)); // true
+   */
+  equals(spatialReference: SpatialReference | null | undefined): boolean;
+}

package/geometry/coordinateFormatter.d.ts

@@ -1,13 +1,254 @@
-import "../interfaces";
-
-export const fromLatitudeLongitude: __esri.coordinateFormatter["fromLatitudeLongitude"];
-export const fromMgrs: __esri.coordinateFormatter["fromMgrs"];
-export const fromUsng: __esri.coordinateFormatter["fromUsng"];
-export const fromUtm: __esri.coordinateFormatter["fromUtm"];
-export const isLoaded: __esri.coordinateFormatter["isLoaded"];
-export const isSupported: __esri.coordinateFormatter["isSupported"];
-export const load: __esri.coordinateFormatter["load"];
-export const toLatitudeLongitude: __esri.coordinateFormatter["toLatitudeLongitude"];
-export const toMgrs: __esri.coordinateFormatter["toMgrs"];
-export const toUsng: __esri.coordinateFormatter["toUsng"];
-export const toUtm: __esri.coordinateFormatter["toUtm"];
+import type Point from "./Point.js";
+import type SpatialReference from "./SpatialReference.js";
+import type { LatitudeLongitudeFormat } from "./interfaces.js";
+
+export type MgrsConversionMode = "automatic" | "new-180-in-zone-01" | "new-180-in-zone-60" | "old-180-in-zone-01" | "old-180-in-zone-60";
+
+export type UtmConversionMode = "latitude-band-indicators" | "north-south-indicators";
+
+/**
+ * Indicates if all dependencies of this module have been loaded.
+ *
+ * @returns Returns `true` if this module's dependencies have been loaded.
+ */
+export function isLoaded(): boolean;
+
+/**
+ * Indicates if this module is supported in the current browser.
+ * The browser must support [WebAssembly](https://caniuse.com/#feat=wasm).
+ *
+ * @returns Returns `true` if this module is supported in the current browser.
+ */
+export function isSupported(): boolean;
+
+/**
+ * Load this module's dependencies.
+ *
+ * @returns Resolves when the dependencies have been loaded.
+ * @see [isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#isLoaded)
+ */
+export function load(): Promise<void>;
+
+/**
+ * Parses coordinates in latitude/longitude notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location.
+ * The coordinates may use decimal degrees, degrees and decimal minutes, or degrees, minutes, and seconds format.
+ * The spatial reference provided must have an ellipsoid and datum matching those used by the source of the latitude/longitude string.
+ * If no spatial reference is provided, it is assumed the latitude/longitude coordinates are in WGS84.
+ *
+ * #### Supported characters
+ * | Symbol | Character | Name | Unicode number | HTML code |
+ * |---|---|---|---|---|
+ * | Degree | * | Asterisk                    | U+002A | &amp;#42;   |
+ * |        | ^ | Circumflex Accent           | U+005E | &amp;#94;   |
+ * |        | ~ | Tilde                       | U+007E | &amp;#126;  |
+ * |        | ° | Degree Sign                 | U+00B0 | &amp;#176;  |
+ * |        | º | Masculine Ordinal Indicator | U+00BA | &amp;#186;  |
+ * | Minute | ' | Apostrophe                  | U+0027 | &amp;#39;   |
+ * |        | ′ | Prime                       | U+2032 | &amp;#8242; |
+ * | Second | " | Quotation Mark              | U+0022 | &amp;#34;   |
+ * |        | ″ | Double prime                | U+2033 | &amp;#8243; |
+ *
+ * The latitude/longitude string may contain leading and trailing whitespace, and may also contain a space,
+ * comma, or vertical bar symbol to separate the latitude from the longitude. It may also contain the characters
+ * 'N', 'S', 'E' and 'W', or use a minus (-) symbol to indicate the hemisphere of each value.
+ *
+ * Latitude/longitude notation examples:
+ * - 55 56 39.123N 003 09 43.034W
+ * - 55°56′39″N 3°09′43″W
+ * - 55*56′39″N 3°09′43″W
+ * - 55~56.65205', -003~09.71723'
+ * - 55.9442008* | -3.1619539*
+ *
+ * @param coordinates - The latitude/longitude notation string for the coordinates.
+ * @param spatialReference - A spatial reference object representing a
+ * [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm).
+ * If `null`, WGS84 will be used.
+ * @returns Returns a point with the location from the coordinates string in the spatial reference provided.
+ */
+export function fromLatitudeLongitude(coordinates: string, spatialReference?: SpatialReference | null): Point | null | undefined;
+
+/**
+ * Parses coordinates in Military Grid Reference System (MGRS) notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location.
+ * The spatial reference provided must have an ellipsoid and datum matching those used by the source of the MGRS string.
+ * If no spatial reference is provided, it is assumed the MGRS string is referenced to WGS84.
+ *
+ * Note that the choice between zone 01 and 60 has no impact when reading from an MGRS notation string.
+ * The MGRS string can contain leading and trailing whitespace and can have whitespace between the grid zone designator, the 100km square identifier,
+ * and the numerical eastings and northings.
+ *
+ * MGRS notation examples:
+ * - 30UVG898998
+ * - 30UVG 89885 99877
+ *
+ * @param coordinates - The MGRS notation string for the coordinates.
+ * @param spatialReference - A spatial reference object representing
+ * a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm) referenced by the MGRS coordinates.
+ * If `null`, WGS84 will be used.
+ * @param conversionMode - The mode used by the given MGRS coordinates.
+ * @returns Returns a point with the location from the MGRS string in the spatial reference provided.
+ */
+export function fromMgrs(coordinates: string, spatialReference: SpatialReference | null | undefined, conversionMode: MgrsConversionMode): Point | null | undefined;
+
+/**
+ * Parses coordinates in United States National Grid (USNG) notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location.
+ *
+ * The spatial reference provided must have an ellipsoid and datum matching those used by the source of the USNG string.
+ * If no spatial reference is provided and the USNG string is suffixed with "(NAD 27)",
+ * it is assumed the USNG string is referenced to NAD 27. If no spatial reference is provided and no such suffix exists,
+ * it is assumed the USNG string is referenced to WGS84.
+ *
+ * USNG notation examples:
+ * - 13TFJ 23 59
+ * - 13TFJ2374159574
+ *
+ * @param coordinates - The USNG notation string for the coordinates.
+ * @param spatialReference - A spatial reference object representing a
+ * [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm) that the USNG coordinates are in.
+ * If `null`, WGS84 will be used.
+ * @returns Returns a point with the location from the USNG string in the spatial reference provided.
+ */
+export function fromUsng(coordinates: string, spatialReference?: SpatialReference | null): Point | null | undefined;
+
+/**
+ * Parses coordinates in Universal Transverse Mercator (UTM) notation, and returns a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing that location.
+ * The spatial reference provided must have an ellipsoid and datum matching those used by the source of the UTM string.
+ * If no spatial reference is provided, it is assumed the UTM string is referenced to WGS84. The UTM string can contain
+ * leading and trailing whitespace and can have whitespace between the zone and latitude designator and the numerical eastings and northings.
+ *
+ * UTM notation examples:
+ * - 30U 489885 6199877
+ * - 30U4898856199877
+ * - 30N 489885 6199877 (using N/S indicator)
+ *
+ * @param coordinates - The UTM notation string for the coordinates.
+ * @param spatialReference - A spatial reference object representing a
+ * [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm) that the UTM coordinates are in.
+ * If `null`, WGS84 will be used.
+ * @param conversionMode - The latitude notation scheme used by the given UTM coordinates,
+ * either a latitudinal band, or a hemisphere designator.
+ * @returns Returns a point with the location from the UTM string in the spatial reference provided.
+ */
+export function fromUtm(coordinates: string, spatialReference: SpatialReference | null | undefined, conversionMode: UtmConversionMode): Point | null | undefined;
+
+/**
+ * Returns formatted coordinates in latitude/longitude notation representing the given point's location.
+ *
+ * The latitude/longitude string will contain a space separating the latitude from the longitude value,
+ * and the characters 'N' or 'S', and 'E' or 'W', to indicate the hemisphere of each value. The string
+ * will also contain spaces separating the components (degrees, minutes, seconds) of each value.
+ * The precision of the output is controlled by both the `format` and `decimalPlaces` parameters.
+ *
+ * For example:
+ * | Decimal places | Format | Example output | Angular precision | Linear precision |
+ * |---|---|---|---|---|
+ * | 0 | dd | 56N 003W | 1° | ~100km |
+ * | 1 | dd | 55.9N 003.2W | 0.1° | ~10km |
+ * | 2 | dd | 55.94N 003.16W | 0.01° | ~1km |
+ * | 3 | dd | 55.944N 003.162W | 0.001° | ~100m |
+ * | 0 | ddm | 55 57N 003 10W | 1' | ~2km |
+ * | 1 | ddm | 55 56.7N 003 09.7W | 0.1' | ~200m |
+ * | 2 | ddm | 55 56.65N 003 09.72W | 0.01' | ~20m |
+ * | 3 | ddm | 55 56.650N 003 09.717W | 0.001' | ~2m |
+ * | 0 | dms | 55 56 39N 003 09 43W | 1" | ~30m |
+ * | 1 | dms | 55 56 39.1N 003 09 43.0W | 0.1" | ~3m |
+ * | 2 | dms | 55 56 39.12N 003 09 43.03W | 0.01" | ~300mm |
+ * | 3 | dms | 55 56 39.123N 003 09 43.034W | 0.001" | ~30mm |
+ *
+ * @param point - The location to be represented as a formatted latitude/longitude string.
+ * The point's [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) should either be WGS84 or another
+ * [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm).
+ * @param format - The mode to use when formatting the latitude/longitude string.
+ * @param decimalPlaces - The number of decimal places to use, it should be an integer from 0 to 16.
+ * @returns Returns a string representing the latitude/longitude of the given point.
+ */
+export function toLatitudeLongitude(point: Point, format: LatitudeLongitudeFormat, decimalPlaces?: number): string | null | undefined;
+
+/**
+ * Returns formatted coordinates in Military Grid Reference System (MGRS) notation representing the given point's location.
+ *
+ * Note that the choice between zone 01 and 60 has an impact only when generating the MGRS notation string for a point with
+ * longitude of exactly 180deg. The precision value controls the number of digits used to represent each numerical easting
+ * and northing value within the MGRS string.
+ *
+ * For example:
+ * | precision | add_spaces | Example output | Approximate precision |
+ * | --- | --- | --- | --- |
+ * | 0 | false | 30UVG | 100km |
+ * | 1 | false | 30UVG89 | 10km |
+ * | 2 | false | 30UVG8999 | 1km |
+ * | 3 | false | 30UVG898998 | 100m |
+ * | 4 | false | 30UVG89889988 | 10m |
+ * | 5 | false | 30UVG8988499881 | 1m |
+ * | 0 | true | 30U VG | 100km |
+ * | 1 | true | 30U VG 8 9 | 10m |
+ * | 2 | true | 30U VG 89 99 | 1km |
+ * | 3 | true | 30U VG 898 998 | 100m |
+ * | 4 | true | 30U VG 8988 9988 | 10m |
+ * | 5 | true | 30U VG 89884 99881 | 1m |
+ *
+ * @param point - The location to be represented in MGRS notation.
+ * The point's [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) should either be WGS84 or another
+ * [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm)
+ * @param conversionMode - The mode to use for the returned MGRS notation string.
+ * @param precision - The precision with which to represent the coordinates, it should be an integer from 0 to 8.
+ * @param addSpaces - If `false`, the generated string will contain no spaces. If `true`, a space separates
+ * the grid zone designator, the 100km square identifier, and the numerical easting and northing values.
+ * @returns Returns a MGRS notation string representing the position of the given point.
+ */
+export function toMgrs(point: Point, conversionMode: MgrsConversionMode, precision?: number, addSpaces?: boolean): string | null | undefined;
+
+/**
+ * Returns formatted coordinates in United States National Grid (USNG) notation representing the given point's location.
+ * The precision value controls the number of digits used to represent each numerical easting and northing value within the USNG string.
+ *
+ * For example:
+ * | precision | add_spaces | Example output | Approximate precision |
+ * | --- | --- | --- | --- |
+ * | 0 | false | 13TFJ | 100km |
+ * | 1 | false | 13TFJ25 | 10km |
+ * | 2 | false | 13TFJ2359 | 1km |
+ * | 3 | false | 13TFJ237595 | 100m |
+ * | 4 | false | 13TFJ23745951 | 10m |
+ * | 5 | false | 13TFJ2374359512 | 1m |
+ * | 0 | true | 13T FJ | 100km |
+ * | 1 | true | 13T FJ 2 5 | 10m |
+ * | 2 | true | 13T FJ 23 59 | 1km |
+ * | 3 | true | 13T FJ 237 595 | 100m |
+ * | 4 | true | 13T FJ 2374 5951 | 10m |
+ * | 5 | true | 13T FJ 23743 59512 | 1m |
+ * | 4* | false | 13TFJ23795929 (NAD 27) | 10m |
+ * | 2* | true | 13T FJ 23 59 (NAD 27) | 1km |
+ *
+ * &ast; *When the point's spatial reference is based on NAD 27.*
+ *
+ * @param point - The location to be represented in USNG notation.
+ * The point's [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) should either be WGS84 or another
+ * [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm).
+ * @param precision - The precision with which to represent the coordinates, it should be an integer from 0 to 8.
+ * @param addSpaces - If `false`, the generated string will contain no spaces. If `true`, a space separates
+ * the grid zone designator, the 100km square identifier, and the numerical easting and northing values.
+ * @returns Returns a USNG notation string representing the position of the given point.
+ */
+export function toUsng(point: Point, precision?: number, addSpaces?: boolean): string | null | undefined;
+
+/**
+ * Returns formatted coordinates in Universal Transverse Mercator (UTM) notation representing the given point's location.
+ *
+ * Example output for a point in the southern hemisphere:
+ * | conversionMode | add_spaces | Example output |
+ * | --- | --- | --- |
+ * | latitude-band-indicators | false | 30U4898846199881 |
+ * | latitude-band-indicators | true | 30U 489884 6199881 |
+ * | north-south-indicators | false | 30N4898846199881 |
+ * | north-south-indicators | true | 30N 489884 6199881 |
+ *
+ * @param point - The location to be represented in UTM notation.
+ * The point's [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) should either be WGS84 or another
+ * [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm)
+ * @param conversionMode - The latitude notation scheme to use in the returned UTM notation string,
+ * either a latitudinal band, or a hemisphere designator.
+ * @param addSpaces - If `false`, the generated string will contain no spaces. If `true`, a space separates
+ * the UTM zone and latitude designator and each numerical easting and northing value.
+ * @returns Returns a UTM notation string representing the position of the given point.
+ */
+export function toUtm(point: Point, conversionMode: UtmConversionMode, addSpaces?: boolean): string | null | undefined;

package/geometry/geodesicUtils.d.ts

@@ -0,0 +1,19 @@
+
+/**
+ * Computed distance and direction between two known locations.
+ *
+ * @deprecated since version 4.33. Use [geodeticUtilsOperator's CalculateDistanceAndAzimuthResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-geodeticUtilsOperator.html#CalculateDistanceAndAzimuthResult) instead.
+ */
+export class InverseGeodeticSolverResult {
+  constructor(distance?: number, azimuth?: number | undefined, reverseAzimuth?: number | undefined);
+  /** The azimuth (or "bearing") in degrees. Value will be in the range of 0-360°. */
+  azimuth?: number;
+  /**
+   * The distance between the two locations.
+   *
+   * @default 0
+   */
+  distance: number;
+  /** The azimuth in degrees in the reverse direction. Value will be in the range of 0-360°. */
+  reverseAzimuth?: number;
+}