normalizeUtils | References | ArcGIS Maps SDK for JavaScript

import { normalizeCentralMeridian, getDenormalizedExtent } from "@arcgis/core/geometry/support/normalizeUtils.js";

Since: ArcGIS Maps SDK for JavaScript 4.3

Provides a utility method that normalizes geometries that intersect the central meridian or fall outside the world extent so they stay within the coordinate system of the view. Support is limited to geometries in Web Mercator and WGS-84 spatial references.

Type definitions

Geometry

Type definition

Type: Extent | Multipoint | Point | Polygon | Polyline | Mesh

Functions

Name	Return Type	Object
`Geometry`
`normalizeCentralMeridian`	`Promise<(Geometry \| null \| undefined)[]>`
`getDenormalizedExtent`	`Extent \| null \| undefined`

normalizeCentralMeridian

Function

Normalizes geometries that intersect the central meridian or fall outside the world extent so they stay within the coordinate system of the view. Only supported for Web Mercator and WGS84 spatial references.

Signature: normalizeCentralMeridian (geometries: (Geometry | null | undefined) | (Geometry | null | undefined)[], url?: string | null, requestOptions?: RequestOptions): Promise<(Geometry | null | undefined)[]>

Parameters

Parameter	Type	Description
geometries	`(Geometry \| null \| undefined) \| (Geometry \| null \| undefined)[]`	An array of geometries to normalize.
url	`string \| null`	A geometry service URL used to perform the normalization. If this value is `null` then the default geometry service URL in esriConfig.geometryServiceUrl is used.
requestOptions	`RequestOptions`	Additional options to be used for the data request.

Returns: Promise<(Geometry | null | undefined)[]>
Resolves to an array of the normalized geometries.

Example

// create a non-normalized line that crosses the dateline
const polyline = new Polyline({
  paths: [
    [170, 52.68],
    [190, 49.5]
  ]
});

normalizeUtils.normalizeCentralMeridian([polyline])
  .then(function(polylines){
    // returns a line representing the same geometry, but
    // now is normalized between -180 and 180 on the x-coordinate.
    // but represents the same feature
    const graphic = new Graphic({
      geometry: polylines[0],
      symbol: { type: "simple-line" }
    });

getDenormalizedExtent

Function

Since: ArcGIS Maps SDK for JavaScript 4.21

Returns an Extent over the dateline that is smaller than the normalized width if it visually contains the geometry. The input geometry must be normalized and its Geometry.spatialReference must be Web Mercator or WGS84.

Signature: getDenormalizedExtent (geometry: Polygon | Polyline | Multipoint | Extent | null | undefined): Extent | null | undefined

Parameters

Parameter	Type	Description	Required
geometry	`Polygon \| Polyline \| Multipoint \| Extent \| null \| undefined`	The geometry used to create the denormalized extent. The geometry should be a Polygon, Polyline, or a Multipoint geometry. This method returns `null` if a Point or a Multipoint with only one point is used as the input geometry. It returns a cloned extent if an Extent is used as the input geometry.

Returns: Extent | null | undefined
The denormalized extent. The new extent is either the same as the normal extent of the geometry or a smaller extent.

Example

// create an extent that goes over the dateline
// as the points are cross the dateline
const multipoint = new Multipoint({
  points: [
    [158.6082458495678, 59.91028747107214],
    [-145.98220825200923, 60.23981116998903]
  ]
});
const extent = normalizeUtils.getDenormalizedExtent(multipoint);