@arcgis/core 5.2.0-next.94 → 5.2.0-next.96

package/geometry/operators/projectOperator.d.ts

@@ -49,11 +49,28 @@ import type { ProjectOptions } from "./types.js";
  *
  * @returns Returns `true` if this module's dependencies have been loaded.
  */
+export function projectIsLoaded(): boolean;
+
+/**
+ * Indicates if all dependencies of this module have been loaded.
+ *
+ * @deprecated since 5.2 use [projectIsLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#projectIsLoaded)
+ * @returns Returns `true` if this module's dependencies have been loaded.
+ */
 export function isLoaded(): boolean;
 
+/**
+ * Loads this module's dependencies. This method must be called first if `projectIsLoaded` returns `false`.
+ *
+ * @returns Resolves when the dependencies have been loaded.
+ * @see [projectIsLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#projectIsLoaded)
+ */
+export function projectLoad(): Promise<void>;
+
 /**
  * Loads this module's dependencies. This method must be called first if `isLoaded` returns `false`.
  *
+ * @deprecated since 5.2 use [projectLoad()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#projectLoad)
  * @returns Resolves when the dependencies have been loaded.
  * @see [isLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#isLoaded)
  */
@@ -67,8 +84,8 @@ export function load(): Promise<void>;
  * @param options - Additional options.
  * @returns Returns the projected geometry or null.
  * @example
- * if (!projectOperator.isLoaded()) {
- *   await projectOperator.load();
+ * if (!projectIsLoaded()) {
+ *   await projectLoad();
  * }
  *
  * const outSpatialReference = new SpatialReference({
@@ -76,7 +93,29 @@ export function load(): Promise<void>;
  * });
  *
  * // Project a geometry to a different spatial reference
- * const geometry = projectOperator.execute(polygon, outSpatialReference);
+ * const geometry = projectExecute(polygon, outSpatialReference);
+ */
+export function projectExecute(geometry: GeometryUnion, outSpatialReference: SpatialReference, options?: ProjectOptions): GeometryWithoutMeshUnion | null | undefined;
+
+/**
+ * Projects a geometry to the specified output spatial reference.
+ *
+ * @deprecated since 5.2 use [projectExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#projectExecute)
+ * @param geometry - The geometry to project.
+ * @param outSpatialReference - The spatial reference to which the input geometry is projected.
+ * @param options - Additional options.
+ * @returns Returns the projected geometry or null.
+ * @example
+ * if (!projectIsLoaded()) {
+ *   await projectLoad();
+ * }
+ *
+ * const outSpatialReference = new SpatialReference({
+ *   wkid: 53008 //Sphere_Sinusoidal projection
+ * });
+ *
+ * // Project a geometry to a different spatial reference
+ * const geometry = projectExecute(polygon, outSpatialReference);
  */
 export function execute(geometry: GeometryUnion, outSpatialReference: SpatialReference, options?: ProjectOptions): GeometryWithoutMeshUnion | null | undefined;
 
@@ -89,6 +128,18 @@ export function execute(geometry: GeometryUnion, outSpatialReference: SpatialRef
  * @param options - Additional options.
  * @returns Returns the projected geometries or null.
  */
+export function projectExecuteMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
+
+/**
+ * Projects an array of geometries to the specified output spatial reference.
+ *
+ * @deprecated since 5.2 use [projectExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#projectExecuteMany)
+ * @param geometries - An array of geometries to project.
+ * All the geometries must have the same spatial reference.
+ * @param outSpatialReference - The spatial reference to which the input geometry is projected.
+ * @param options - Additional options.
+ * @returns Returns the projected geometries or null.
+ */
 export function executeMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
 
 /**
@@ -96,4 +147,13 @@ export function executeMany(geometries: GeometryUnion[], outSpatialReference: Sp
  * The value is `null` or `undefined` until the operator is loaded, then it will always be `true`.
  * This will produce densified output geometries.
  */
+export const projectSupportsCurves: boolean | null | undefined;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value is `null` or `undefined` until the operator is loaded, then it will always be `true`.
+ * This will produce densified output geometries.
+ *
+ * @deprecated since 5.2 use [projectSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#projectSupportsCurves)
+ */
 export const supportsCurves: boolean | null | undefined;

package/geometry/operators/projectOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{execute as o,executeMany as e,load as r,supportsCurves as t,isLoaded as n}from"./gx/operatorProject.js";import{applyZConversionAfterProjection as a}from"./support/projectionZScaling.js";let s,i,p,c,m,u;function f(){return!!s&&n()}async function l(){if(!f()){const[o,e]=await Promise.all([import("./support/apiConverter.js"),import("./support/projectionTransformation.js"),r()]);s=o.fromGeometry,i=o.fromSpatialReference,p=o.getSpatialReference,c=o.toGeometry,m=e.createProjectionTransformation,u=t()}}function j(e,r,t){const n=p(e),u=m(i(n),i(r),t),f=c(o(s(e),u),r);return!t?.zConversionDisabled&&f?.hasZ&&a([f],n,r),f}function d(o,r,t){const n=o.map(s),u=p(o),f=m(i(u),i(r),t),l=e(n,f).map(o=>c(o,r));return!t?.zConversionDisabled&&l&&a(l,u,r),l}export{j as execute,d as executeMany,f as isLoaded,l as load,u as supportsCurves};
+import{deprecatedFunction as e}from"../../core/deprecate.js";import r from"../../core/Logger.js";import{execute as t,executeMany as o,load as a,supportsCurves as n,isLoaded as c}from"./gx/operatorProject.js";import{applyZConversionAfterProjection as s}from"./support/projectionZScaling.js";let p,i,u,d,m,j,g;function f(){return!!p&&c()}function l(){return e(r.getLogger("esri.geometry.operators.projectOperator"),"isLoaded is deprecated. Use projectIsLoaded instead.",{replacement:"projectIsLoaded",warnOnce:!0}),f()}async function y(){if(!f()){const[e,r]=await Promise.all([import("./support/apiConverter.js"),import("./support/projectionTransformation.js"),a()]);p=e.fromGeometry,i=e.fromSpatialReference,u=e.getSpatialReference,d=e.toGeometry,m=r.createProjectionTransformation,j=n(),g=j}}function L(){return e(r.getLogger("esri.geometry.operators.projectOperator"),"load is deprecated. Use projectLoad instead.",{replacement:"projectLoad",warnOnce:!0}),y()}function x(e,r,o){const a=u(e),n=m(i(a),i(r),o),c=d(t(p(e),n),r);return!o?.zConversionDisabled&&c?.hasZ&&s([c],a,r),c}function O(t,o,a){return e(r.getLogger("esri.geometry.operators.projectOperator"),"execute is deprecated. Use projectExecute instead.",{replacement:"projectExecute",warnOnce:!0}),x(t,o,a)}function w(e,r,t){const a=e.map(p),n=u(e),c=m(i(n),i(r),t),j=o(a,c).map(e=>d(e,r));return!t?.zConversionDisabled&&j&&s(j,n,r),j}function v(t,o,a){return e(r.getLogger("esri.geometry.operators.projectOperator"),"executeMany is deprecated. Use projectExecuteMany instead.",{replacement:"projectExecuteMany",warnOnce:!0}),w(t,o,a)}export{O as execute,v as executeMany,l as isLoaded,L as load,x as projectExecute,w as projectExecuteMany,f as projectIsLoaded,y as projectLoad,j as projectSupportsCurves,g as supportsCurves};

package/geometry/operators/proximityOperator.d.ts

@@ -11,7 +11,7 @@ import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../types.js";
 import type { ProximityResult } from "./types.js";
 
-export interface Options {
+export interface ProximityOptions {
   /**
    * The length unit of the search radius and result distances.
    * The default is the input geometry's spatial reference unit.
@@ -20,7 +20,10 @@ export interface Options {
   unit?: LengthUnit;
 }
 
-export interface GetNearestCoordinateOptions extends Options {
+/** @deprecated since 5.2 use [ProximityOptions](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/proximityOperator/#ProximityOptions) */
+export type Options = ProximityOptions;
+
+export interface ProximityGetNearestCoordinateOptions extends ProximityOptions {
   /**
    * When the parameter is set to true, this function will calculate the left/right side of a polyline or polygon.
    * Look for the result in the `isRightSide` property of the returned `ProximityResult` object.
@@ -38,31 +41,62 @@ export interface GetNearestCoordinateOptions extends Options {
   testPolygonInterior?: boolean;
 }
 
+/** @deprecated since 5.2 use [ProximityGetNearestCoordinateOptions](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/proximityOperator/#ProximityGetNearestCoordinateOptions) */
+export type GetNearestCoordinateOptions = ProximityGetNearestCoordinateOptions;
+
+/**
+ * Returns the nearest coordinate on the geometry to the given input point.
+ *
+ * @param geometry - The input geometry.
+ * @param point - The point used to search for the nearest coordinate in `geometry`.
+ * @param options - Additional options.
+ * @returns Returns the proximity result which contains the nearest coordinate on the input `geometry` to the given `inputPoint`.
+ * @example
+ * // Return the nearest result on a polygon to the given point
+ * const proximityResult = proximityGetNearestCoordinate(polygon, point);
+ */
+export function proximityGetNearestCoordinate(geometry: GeometryUnion, point: Point, options?: ProximityGetNearestCoordinateOptions): ProximityResult;
+
 /**
  * Returns the nearest coordinate on the geometry to the given input point.
  *
+ * @deprecated since 5.2 use [proximityGetNearestCoordinate()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/proximityOperator/#proximityGetNearestCoordinate)
  * @param geometry - The input geometry.
  * @param point - The point used to search for the nearest coordinate in `geometry`.
  * @param options - Additional options.
  * @returns Returns the proximity result which contains the nearest coordinate on the input `geometry` to the given `inputPoint`.
  * @example
  * // Return the nearest result on a polygon to the given point
- * const proximityResult = proximityOperator.getNearestCoordinate(polygon, point);
+ * const proximityResult = proximityGetNearestCoordinate(polygon, point);
+ */
+export function getNearestCoordinate(geometry: GeometryUnion, point: Point, options?: ProximityGetNearestCoordinateOptions): ProximityResult;
+
+/**
+ * Returns the nearest vertex on the geometry.
+ *
+ * @param geometry - The input geometry.
+ * @param point - The point used to search for the nearest coordinate in the input `geometry`.
+ * @param options - Additional options.
+ * @returns Returns the proximity result which contains the nearest vertex on the `geometry` to the given `inputPoint`.
+ * @example
+ * // Return the nearest vertex on a polygon to the given point
+ * const proximityResult = proximityGetNearestCoordinate(polygon, point);
  */
-export function getNearestCoordinate(geometry: GeometryUnion, point: Point, options?: GetNearestCoordinateOptions): ProximityResult;
+export function proximityGetNearestVertex(geometry: GeometryUnion, point: Point, options?: ProximityOptions): ProximityResult;
 
 /**
  * Returns the nearest vertex on the geometry.
  *
+ * @deprecated since 5.2 use [proximityGetNearestVertex()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/proximityOperator/#proximityGetNearestVertex)
  * @param geometry - The input geometry.
  * @param point - The point used to search for the nearest coordinate in the input `geometry`.
  * @param options - Additional options.
  * @returns Returns the proximity result which contains the nearest vertex on the `geometry` to the given `inputPoint`.
  * @example
  * // Return the nearest vertex on a polygon to the given point
- * const proximityResult = proximityOperator.getNearestVertex(polygon, point);
+ * const proximityResult = proximityGetNearestVertex(polygon, point);
  */
-export function getNearestVertex(geometry: GeometryUnion, point: Point, options?: Options): ProximityResult;
+export function getNearestVertex(geometry: GeometryUnion, point: Point, options?: ProximityOptions): ProximityResult;
 
 /**
  * Returns vertices of the geometry that are closer to the given point than the given radius.
@@ -79,12 +113,40 @@ export function getNearestVertex(geometry: GeometryUnion, point: Point, options?
  * The array will be empty when `geometry` is empty.
  * @example
  * // Return the nearest vertices on a polygon to the given point
- * const proximityResultsArray = proximityOperator.getNearestVertices(polygon, point, 100, 5);
+ * const proximityResultsArray = proximityGetNearestVertices(polygon, point, 100, 5);
  */
-export function getNearestVertices(geometry: GeometryUnion, point: Point, searchRadius: number, maxVertexCountToReturn: number, options?: Options): ProximityResult[];
+export function proximityGetNearestVertices(geometry: GeometryUnion, point: Point, searchRadius: number, maxVertexCountToReturn: number, options?: ProximityOptions): ProximityResult[];
+
+/**
+ * Returns vertices of the geometry that are closer to the given point than the given radius.
+ *
+ * @deprecated since 5.2 use [proximityGetNearestVertices()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/proximityOperator/#proximityGetNearestVertices)
+ * @param geometry - The input geometry.
+ * @param point - The point used to search for the nearest coordinate in `geometry`.
+ * @param searchRadius - The planar distance from the `inputPoint` to search for vertices.
+ * Unless the `unit` option is set, the default is the geometry's spatial reference unit.
+ * @param maxVertexCountToReturn - The maximum number of vertices that will be returned. Must be a positive number.
+ * @param options - Additional options.
+ * @returns Returns an array of proximity results which contain the nearest vertices on `geometry` to the given `inputPoint` that are less than or equal to the planar distance of search radius.
+ * The array is sorted by distance to the `inputPoint` with the closest point first.
+ * When there are more than the `maxVertexCountToReturn` vertices to return, it returns the closest vertices.
+ * The array will be empty when `geometry` is empty.
+ * @example
+ * // Return the nearest vertices on a polygon to the given point
+ * const proximityResultsArray = proximityGetNearestVertices(polygon, point, 100, 5);
+ */
+export function getNearestVertices(geometry: GeometryUnion, point: Point, searchRadius: number, maxVertexCountToReturn: number, options?: ProximityOptions): ProximityResult[];
 
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const proximitySupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [proximitySupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/proximityOperator/#proximitySupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/proximityOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{O as t}from"../../chunks/OperatorProximity.js";import{convertFromSpatialReferenceUnit as e,convertToSpatialReferenceUnit as n}from"../../core/units.js";import{fromGeometry as r,fromPoint as s,getSpatialReference as i}from"./support/apiConverter.js";import{toProximityResult as o}from"./support/proximityResult.js";const c=new t;function m(t,n,m={}){const{calculateLeftRightSide:a=!1,testPolygonInterior:u=!0,unit:p}=m,d=c.getNearestCoordinate(r(t),s(n).getXY(),u,a);if(p&&d.m_distance){const n=i(t);d.m_distance=e(d.m_distance,n,p)}return o(d,t,a)}function a(t,n,m={}){const{unit:a}=m,u=c.getNearestVertex(r(t),s(n).getXY());if(a&&u.m_distance){const n=i(t);u.m_distance=e(u.m_distance,n,a)}return o(u,t)}function u(t,m,a,u,p={}){const{unit:d}=p,f=i(t);return d&&a&&(a=n(a,d,f)),c.getNearestVertices(r(t),s(m).getXY(),a,u).map(n=>(d&&n.m_distance&&(n.m_distance=e(n.m_distance,f,d)),o(n,t)))}const p=c.supportsCurves();export{m as getNearestCoordinate,a as getNearestVertex,u as getNearestVertices,p as supportsCurves};
+import{O as e}from"../../chunks/OperatorProximity.js";import{deprecatedFunction as t}from"../../core/deprecate.js";import r from"../../core/Logger.js";import{convertFromSpatialReferenceUnit as o,convertToSpatialReferenceUnit as i}from"../../core/units.js";import{fromGeometry as s,fromPoint as n,getSpatialReference as a}from"./support/apiConverter.js";import{toProximityResult as c}from"./support/proximityResult.js";const m=new e;function p(e,t,r={}){const{calculateLeftRightSide:i=!1,testPolygonInterior:p=!0,unit:g}=r,d=m.getNearestCoordinate(s(e),n(t).getXY(),p,i);if(g&&d.m_distance){const t=a(e);d.m_distance=o(d.m_distance,t,g)}return c(d,e,i)}function g(e,o,i={}){return t(r.getLogger("esri.geometry.operators.proximityOperator"),"getNearestCoordinate is deprecated. Use proximityGetNearestCoordinate instead.",{replacement:"proximityGetNearestCoordinate",warnOnce:!0}),p(e,o,i)}function d(e,t,r={}){const{unit:i}=r,p=m.getNearestVertex(s(e),n(t).getXY());if(i&&p.m_distance){const t=a(e);p.m_distance=o(p.m_distance,t,i)}return c(p,e)}function u(e,o,i={}){return t(r.getLogger("esri.geometry.operators.proximityOperator"),"getNearestVertex is deprecated. Use proximityGetNearestVertex instead.",{replacement:"proximityGetNearestVertex",warnOnce:!0}),d(e,o,i)}function x(e,t,r,p,g={}){const{unit:d}=g,u=a(e);return d&&r&&(r=i(r,d,u)),m.getNearestVertices(s(e),n(t).getXY(),r,p).map(t=>(d&&t.m_distance&&(t.m_distance=o(t.m_distance,u,d)),c(t,e)))}function f(e,o,i,s,n={}){return t(r.getLogger("esri.geometry.operators.proximityOperator"),"getNearestVertices is deprecated. Use proximityGetNearestVertices instead.",{replacement:"proximityGetNearestVertices",warnOnce:!0}),x(e,o,i,s,n)}const y=m.supportsCurves(),N=Boolean(y);export{g as getNearestCoordinate,u as getNearestVertex,f as getNearestVertices,p as proximityGetNearestCoordinate,d as proximityGetNearestVertex,x as proximityGetNearestVertices,y as proximitySupportsCurves,N as supportsCurves};

package/geometry/operators/relateOperator.d.ts

@@ -13,6 +13,15 @@ import type { GeometryUnion } from "../types.js";
  * @param geometry - The geometry to accelerate.
  * @returns Returns `true` if the geometry was successfully accelerated.
  */
+export function relateAccelerateGeometry(geometry: GeometryUnion): boolean;
+
+/**
+ * Accelerate a geometry. This method prepares the geometry for faster relate operations when the same geometry is tested multiple times (e.g. in a loop with hundreds of iterations). See the [Acceleration](https://developers.arcgis.com/javascript/latest/spatial-analysis/intro-geometry-operators/#acceleration) guide topic for more information.
+ *
+ * @deprecated since 5.2 use [relateAccelerateGeometry()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/relateOperator/#relateAccelerateGeometry)
+ * @param geometry - The geometry to accelerate.
+ * @returns Returns `true` if the geometry was successfully accelerated.
+ */
 export function accelerateGeometry(geometry: GeometryUnion): boolean;
 
 /**
@@ -23,7 +32,20 @@ export function accelerateGeometry(geometry: GeometryUnion): boolean;
  * @example
  * // Returns true if the polygon geometry completely
  * // contains the polyline based on the DE-9IM string
- * const isRelated = relateOperator.execute(polygon, polyline, "TTTFFTFFT");
+ * const isRelated = relateExecute(polygon, polyline, "TTTFFTFFT");
+ */
+export function relateExecute(geometry1: GeometryUnion, geometry2: GeometryUnion, relation: string): boolean;
+
+/**
+ * @deprecated since 5.2 use [relateExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/relateOperator/#relateExecute)
+ * @param geometry1 - The first geometry for the relation.
+ * @param geometry2 - The second geometry for the relation.
+ * @param relation - The DE-9IM matrix relation encoded as a string to test against the relationship of the two geometries
+ * @returns Returns `true` if the two geometries satisfy the DE-9IM matrix relation.
+ * @example
+ * // Returns true if the polygon geometry completely
+ * // contains the polyline based on the DE-9IM string
+ * const isRelated = relateExecute(polygon, polyline, "TTTFFTFFT");
  */
 export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion, relation: string): boolean;
 
@@ -33,10 +55,27 @@ export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion, rela
  * @param relation - The DE-9IM matrix relation encoded as a string.
  * @returns Returns `true` if the DE-9IM matrix relation is valid.
  */
+export function relateIsValidDE9IM(relation: string): boolean;
+
+/**
+ * Indicates if the DE-9IM matrix relation is valid.
+ *
+ * @deprecated since 5.2 use [relateIsValidDE9IM()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/relateOperator/#relateIsValidDE9IM)
+ * @param relation - The DE-9IM matrix relation encoded as a string.
+ * @returns Returns `true` if the DE-9IM matrix relation is valid.
+ */
 export function isValidDE9IM(relation: string): boolean;
 
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const relateSupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [relateSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/relateOperator/#relateSupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/relateOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{OperatorRelate as e}from"../../chunks/OperatorRelate.js";import{getSpatialReference as r,fromGeometry as t,fromSpatialReference as n}from"./support/apiConverter.js";const o=new e;function s(e){const s=r(e);return o.accelerateGeometry(t(e),n(s),1)}function u(e,r,s){return o.execute(t(e),t(r),n(e.spatialReference),s,null)}function c(e){return o.isValidDE9IM(e)}const p=o.supportsCurves();export{s as accelerateGeometry,u as execute,c as isValidDE9IM,p as supportsCurves};
+import{OperatorRelate as e}from"../../chunks/OperatorRelate.js";import{deprecatedFunction as r}from"../../core/deprecate.js";import t from"../../core/Logger.js";import{getSpatialReference as o,fromGeometry as a,fromSpatialReference as n}from"./support/apiConverter.js";const c=new e;function s(e){const r=o(e);return c.accelerateGeometry(a(e),n(r),1)}function i(e){return r(t.getLogger("esri.geometry.operators.relateOperator"),"accelerateGeometry is deprecated. Use relateAccelerateGeometry instead.",{replacement:"relateAccelerateGeometry",warnOnce:!0}),s(e)}function l(e,r,t){return c.execute(a(e),a(r),n(e.spatialReference),t,null)}function p(e,o,a){return r(t.getLogger("esri.geometry.operators.relateOperator"),"execute is deprecated. Use relateExecute instead.",{replacement:"relateExecute",warnOnce:!0}),l(e,o,a)}function u(e){return c.isValidDE9IM(e)}function m(e){return r(t.getLogger("esri.geometry.operators.relateOperator"),"isValidDE9IM is deprecated. Use relateIsValidDE9IM instead.",{replacement:"relateIsValidDE9IM",warnOnce:!0}),u(e)}const d=c.supportsCurves(),g=Boolean(d);export{i as accelerateGeometry,p as execute,m as isValidDE9IM,s as relateAccelerateGeometry,l as relateExecute,u as relateIsValidDE9IM,d as relateSupportsCurves,g as supportsCurves};

package/geometry/operators/reshapeOperator.d.ts

@@ -19,7 +19,25 @@ import type Polyline from "../Polyline.js";
  * If the `geometry` cannot be reshaped, then the return type is null.
  * @example
  * // Reshape a polygon geometry
- * const reshapedPolygon = reshapeOperator.execute(polygon, reshaperPolyline);
+ * const reshapedPolygon = reshapeExecute(polygon, reshaperPolyline);
+ */
+export function reshapeExecute(geometry: Polygon | Polyline, reshaper: Polyline): Polygon | Polyline | null | undefined;
+
+/**
+ * Performs the reshape operation on a polygon or polyline using a single path polyline as the reshaper.
+ *
+ * The output geometry takes the shape of the multipath where it first intersects the reshaper to the last intersection.
+ * The first and last intersection points of the reshaper are chosen closest to the end points of the reshaper in the case that multiple intersections are found.
+ * For polygons, only individual paths can be reshaped. However, polylines can be reshaped across paths.
+ *
+ * @deprecated since 5.2 use [reshapeExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/reshapeOperator/#reshapeExecute)
+ * @param geometry - The polygon or polyline to be reshaped.
+ * @param reshaper - The single path polyline reshaper.
+ * @returns If the `geometry` is a polygon, the return type is polygon, and if the `geometry` is a polyline, the return type is polyline.
+ * If the `geometry` cannot be reshaped, then the return type is null.
+ * @example
+ * // Reshape a polygon geometry
+ * const reshapedPolygon = reshapeExecute(polygon, reshaperPolyline);
  */
 export function execute(geometry: Polygon | Polyline, reshaper: Polyline): Polygon | Polyline | null | undefined;
 
@@ -27,4 +45,12 @@ export function execute(geometry: Polygon | Polyline, reshaper: Polyline): Polyg
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `false`.
  */
-export const supportsCurves: boolean;
+export const reshapeSupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `false`.
+ *
+ * @deprecated since 5.2 use [reshapeSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/reshapeOperator/#reshapeSupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/reshapeOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{t as e,p as t,G as r,d as s}from"../../chunks/Geometry.js";import{a,S as n,P as m}from"../../chunks/MultiPathImpl.js";import{Envelope2D as i}from"../../chunks/Envelope2D.js";import{c as o,P as h}from"../../chunks/Envelope.js";import{J as l}from"../../chunks/UnitFactory.js";import{getSpatialReference as c,fromGeometry as u,fromPolyline as g,fromSpatialReference as _,toGeometry as d}from"./support/apiConverter.js";function A(s,n,m,h){if(n.getPathCount()>1&&e(""),s.isEmpty()||n.isEmpty())return null;t(s),t(n);let l=null;const c=new i;s.queryEnvelope(c);const u=new i;n.queryEnvelope(u);const g=new i;g.setCoords({env2D:c}),g.mergeEnvelope2D(u);const _=o(m,g,!1).total(),d=new x(h);let A=d.setIndicesAndScalars(s,n,_);if(A){const e=d.getTrimmedPolyline(s,n);if(e.isEmpty())return null;l=d.getReshapedMultiPath(s,e,m)}else{if(Number.isNaN(d.m_scalarB0)||s.getGeometryType()===r.enumPolyline)return null;const e=new a;if(e.add(n,!0),d.clearIndicesAndScalars(),A=d.setIndicesAndScalars(s,e,_),!A)return null;const t=d.getTrimmedPolyline(s,e);if(t.isEmpty())return null;l=d.getReshapedMultiPath(s,t,m)}return l}class x{m_pathA0;m_pathA1;m_vertexA0;m_vertexA1;m_vertexB0;m_vertexB1;m_scalarA0;m_scalarA1;m_scalarB0;m_scalarB1;m_progressTracker;constructor(e){this.m_progressTracker=e,this.clearIndicesAndScalars()}setIndicesAndScalars(e,t,s){const a=new i,n=new i;e.queryEnvelope(a),e.queryEnvelope(n),a.inflateCoords(s,s);if(!a.intersect(n))return!1;const m=e.getImpl().querySegmentIterator(),o=t.getImpl().querySegmentIterator(),h=[0,0],l=[0,0];let c=-1,u=-1,g=-1,_=-1,d=-1,A=-1,x=Number.NaN,p=Number.NaN,S=Number.NaN,v=Number.NaN;for(o.nextPath();o.hasNextSegment();){const e=o.nextSegment(),t=new i;for(e.queryEnvelope(t),t.inflateCoords(s,s),m.resetToFirstPath();m.nextPath();){for(;m.hasNextSegment();){const r=m.nextSegment(),a=new i;if(r.queryEnvelope(a),t.isIntersecting(a)){if(0!==e.intersect(r,null,l,h,s)&&(Number.isNaN(S)||l[0]<S)&&(c=m.getPathIndex(),g=m.getStartPointIndex(),d=o.getStartPointIndex(),x=h[0],S=l[0],0===S))break}}if(0===S)break}if(!Number.isNaN(S)&&1!==S)break}if(Number.isNaN(S))return!1;this.m_pathA0=c,this.m_vertexA0=g,this.m_vertexB0=d,this.m_scalarA0=x,this.m_scalarB0=S;const y=e.getGeometryType();for(o.resetToLastSegment();o.hasPreviousSegment();){const e=o.previousSegment(),t=new i;for(e.queryEnvelope(t),t.inflateCoords(s,s),y===r.enumPolygon?m.resetToPath(c):m.resetToFirstPath();m.nextPath();){for(;m.hasNextSegment();){const r=m.nextSegment(),a=new i;if(r.queryEnvelope(a),t.isIntersecting(a)){const t=e.intersect(r,null,l,h,s);if(0!==t&&(Number.isNaN(v)||l[t-1]>v)&&(o.getStartPointIndex()!==this.m_vertexB0||l[t-1]!==this.m_scalarB0)&&(u=m.getPathIndex(),_=m.getStartPointIndex(),A=o.getStartPointIndex(),p=h[t-1],v=l[t-1],1===v))break}}if(1===v)break;if(y===r.enumPolygon)break}if(!Number.isNaN(v))break}return!Number.isNaN(v)&&(this.m_pathA1=u,this.m_vertexA1=_,this.m_vertexB1=A,this.m_scalarA1=p,this.m_scalarB1=v,!0)}getTrimmedPolyline(e,t){const r=new n,s=t.createInstance();let a=!0;const m=t.getImpl().querySegmentIterator();if(m.resetToVertex(this.m_vertexB0,0),this.m_vertexB0>this.m_vertexB1)return s;if(this.m_vertexB0===this.m_vertexB1){m.nextSegment().queryCut(this.m_scalarB0,this.m_scalarB1,r,!1),s.addSegment(r.get(),!0)}else for(;;){const e=m.nextSegment(),t=m.getStartPointIndex();if(t===this.m_vertexB0)1!==this.m_scalarB0&&(e.queryCut(this.m_scalarB0,1,r,!1),s.addSegment(r.get(),a),a=!1);else{if(t===this.m_vertexB1){0!==this.m_scalarB1&&(e.queryCut(0,this.m_scalarB1,r),s.addSegment(r.get(),a),a=!1);break}s.addSegment(e,a)}}if(s.isEmpty())return s;if(e.getDescription().getAttributeCount()>1){const t=e.getImpl().querySegmentIterator(),r=new h,a=s.getPointCount();t.resetToVertex(this.m_vertexA0,this.m_pathA0);t.nextSegment().queryCoord(this.m_scalarA0,r),s.setPointByVal(0,r),t.resetToVertex(this.m_vertexA1,this.m_pathA1);t.nextSegment().queryCoord(this.m_scalarA1,r),s.setPointByVal(a-1,r),s.interpolateAttributesRange(0,0,0,a-1)}return s}getReshapedMultiPath(e,t,s){let a;return a=e.getGeometryType()===r.enumPolygon?this.getReshapedPolygon(e,t,s):this.getReshapedPolyline(e,t),a}getReshapedPolygon(e,t,r){const s=e.getImpl().querySegmentIterator();s.setCirculator(!0);const a=new n;new h;const i=new m({vd:e.getDescription()});if(i.addSegmentsFromPath(t,0,0,t.getSegmentCountPath(0),!0),s.resetToVertex(this.m_vertexA1,this.m_pathA0),this.m_vertexA1===this.m_vertexA0&&this.m_scalarA1<=this.m_scalarA0){s.nextSegment().queryCut(this.m_scalarA1,this.m_scalarA0,a),i.addSegment(a.get(),!1)}else{{const e=s.nextSegment();1!==this.m_scalarA1&&(e.queryCut(this.m_scalarA1,1,a),i.addSegment(a.get(),!1))}for(;;){const e=s.nextSegment();if(s.getStartPointIndex()===this.m_vertexA0){0!==this.m_scalarA0&&(e.queryCut(0,this.m_scalarA0,a),i.addSegment(a.get(),!1));break}i.addSegment(e,!1)}}const o=new m({vd:e.getDescription()}),c=t.clone();if(c.reversePath(0),o.addSegmentsFromPath(c,0,0,c.getSegmentCountPath(0),!0),s.resetToVertex(this.m_vertexA0,this.m_pathA0),this.m_vertexA0===this.m_vertexA1&&this.m_scalarA0<this.m_scalarA1){s.nextSegment().queryCut(this.m_scalarA0,this.m_scalarA1,a),o.addSegment(a.get(),!1)}else{{const e=s.nextSegment();1!==this.m_scalarA0&&(e.queryCut(this.m_scalarA0,1,a),o.addSegment(a.get(),!1))}for(;;){const e=s.nextSegment();if(s.getStartPointIndex()===this.m_vertexA1){0!==this.m_scalarA1&&(e.queryCut(0,this.m_scalarA1,a),o.addSegment(a.get(),!1));break}o.addSegment(e,!1)}}const u=Math.abs(i.calculateArea2D()),g=Math.abs(o.calculateArea2D());let _=e.createInstance();for(let n=0;n<e.getPathCount();n++)n===this.m_pathA0?u>=g?_.add(i,!1):_.add(o,!1):_.addPath(e,n,!0);return _=(new l).execute(_,r,!1,this.m_progressTracker),_}getReshapedPolyline(e,t){const r=e.getImpl().querySegmentIterator(),m=new a,i=new n;let o=!1,h=-1,l=Number.NaN;o=this.m_pathA0>this.m_pathA1||this.m_pathA0===this.m_pathA1&&(this.m_vertexA0>this.m_vertexA1||this.m_vertexA0===this.m_vertexA1&&this.m_scalarA0>this.m_scalarA1),o?(h=this.m_vertexA1,l=this.m_scalarA1,r.resetToPath(this.m_pathA1)):(h=this.m_vertexA0,l=this.m_scalarA0,r.resetToPath(this.m_pathA0));let c=!0;for(r.nextPath()||s("reshaper");;){const e=r.nextSegment();if(r.getStartPointIndex()===h){0!==l&&(e.queryCut(0,l,i),m.addSegment(i.get(),c),c=!1);break}m.addSegment(e,c),c=!1}if(o){const e=t.clone();e.reversePath(0),m.addSegmentsFromPath(e,0,0,e.getSegmentCount(),c)}else m.addSegmentsFromPath(t,0,0,t.getSegmentCount(),c);o?(l=this.m_scalarA0,r.resetToVertex(this.m_vertexA0,this.m_pathA0)):(l=this.m_scalarA1,r.resetToVertex(this.m_vertexA1,this.m_pathA1));{const e=r.nextSegment();1!==l&&(e.queryCut(l,1,i),m.addSegment(i.get(),!1))}for(;r.hasNextSegment();){const e=r.nextSegment();m.addSegment(e,!1)}const u=e.createInstance();let g=!1;for(let s=0;s<e.getPathCount();s++)s===this.m_pathA0||s===this.m_pathA1?g||(u.add(m,!1),g=!0):u.addPath(e,s,!0);return u}clearIndicesAndScalars(){this.m_pathA0=-1,this.m_pathA1=-1,this.m_vertexA0=-1,this.m_vertexA1=-1,this.m_vertexB0=-1,this.m_vertexB1=-1,this.m_scalarA0=Number.NaN,this.m_scalarA1=Number.NaN,this.m_scalarB0=Number.NaN,this.m_scalarB1=Number.NaN}}class p{getOperatorType(){return 10006}accelerateGeometry(e,t,r){return!1}canAccelerateGeometry(e){return!1}supportsCurves(){return!1}execute(e,t,r,s){return A(e,t,r,s)}}const S=new p;function v(e,t){const r=c(e),s=S.execute(u(e),g(t),_(r),null);return d(s,r)}const y=S.supportsCurves();export{v as execute,y as supportsCurves};
+import{t as e,p as t,G as r,d as s}from"../../chunks/Geometry.js";import{a,S as n,P as m}from"../../chunks/MultiPathImpl.js";import{Envelope2D as i}from"../../chunks/Envelope2D.js";import{c as o,P as h}from"../../chunks/Envelope.js";import{J as c}from"../../chunks/UnitFactory.js";import{deprecatedFunction as l}from"../../core/deprecate.js";import u from"../../core/Logger.js";import{getSpatialReference as g,fromGeometry as _,fromPolyline as d,fromSpatialReference as p,toGeometry as x}from"./support/apiConverter.js";function A(s,n,m,h){if(n.getPathCount()>1&&e(""),s.isEmpty()||n.isEmpty())return null;t(s),t(n);let c=null;const l=new i;s.queryEnvelope(l);const u=new i;n.queryEnvelope(u);const g=new i;g.setCoords({env2D:l}),g.mergeEnvelope2D(u);const _=o(m,g,!1).total(),d=new S(h);let p=d.setIndicesAndScalars(s,n,_);if(p){const e=d.getTrimmedPolyline(s,n);if(e.isEmpty())return null;c=d.getReshapedMultiPath(s,e,m)}else{if(Number.isNaN(d.m_scalarB0)||s.getGeometryType()===r.enumPolyline)return null;const e=new a;if(e.add(n,!0),d.clearIndicesAndScalars(),p=d.setIndicesAndScalars(s,e,_),!p)return null;const t=d.getTrimmedPolyline(s,e);if(t.isEmpty())return null;c=d.getReshapedMultiPath(s,t,m)}return c}class S{m_pathA0;m_pathA1;m_vertexA0;m_vertexA1;m_vertexB0;m_vertexB1;m_scalarA0;m_scalarA1;m_scalarB0;m_scalarB1;m_progressTracker;constructor(e){this.m_progressTracker=e,this.clearIndicesAndScalars()}setIndicesAndScalars(e,t,s){const a=new i,n=new i;e.queryEnvelope(a),e.queryEnvelope(n),a.inflateCoords(s,s);if(!a.intersect(n))return!1;const m=e.getImpl().querySegmentIterator(),o=t.getImpl().querySegmentIterator(),h=[0,0],c=[0,0];let l=-1,u=-1,g=-1,_=-1,d=-1,p=-1,x=Number.NaN,A=Number.NaN,S=Number.NaN,v=Number.NaN;for(o.nextPath();o.hasNextSegment();){const e=o.nextSegment(),t=new i;for(e.queryEnvelope(t),t.inflateCoords(s,s),m.resetToFirstPath();m.nextPath();){for(;m.hasNextSegment();){const r=m.nextSegment(),a=new i;if(r.queryEnvelope(a),t.isIntersecting(a)){if(0!==e.intersect(r,null,c,h,s)&&(Number.isNaN(S)||c[0]<S)&&(l=m.getPathIndex(),g=m.getStartPointIndex(),d=o.getStartPointIndex(),x=h[0],S=c[0],0===S))break}}if(0===S)break}if(!Number.isNaN(S)&&1!==S)break}if(Number.isNaN(S))return!1;this.m_pathA0=l,this.m_vertexA0=g,this.m_vertexB0=d,this.m_scalarA0=x,this.m_scalarB0=S;const y=e.getGeometryType();for(o.resetToLastSegment();o.hasPreviousSegment();){const e=o.previousSegment(),t=new i;for(e.queryEnvelope(t),t.inflateCoords(s,s),y===r.enumPolygon?m.resetToPath(l):m.resetToFirstPath();m.nextPath();){for(;m.hasNextSegment();){const r=m.nextSegment(),a=new i;if(r.queryEnvelope(a),t.isIntersecting(a)){const t=e.intersect(r,null,c,h,s);if(0!==t&&(Number.isNaN(v)||c[t-1]>v)&&(o.getStartPointIndex()!==this.m_vertexB0||c[t-1]!==this.m_scalarB0)&&(u=m.getPathIndex(),_=m.getStartPointIndex(),p=o.getStartPointIndex(),A=h[t-1],v=c[t-1],1===v))break}}if(1===v)break;if(y===r.enumPolygon)break}if(!Number.isNaN(v))break}return!Number.isNaN(v)&&(this.m_pathA1=u,this.m_vertexA1=_,this.m_vertexB1=p,this.m_scalarA1=A,this.m_scalarB1=v,!0)}getTrimmedPolyline(e,t){const r=new n,s=t.createInstance();let a=!0;const m=t.getImpl().querySegmentIterator();if(m.resetToVertex(this.m_vertexB0,0),this.m_vertexB0>this.m_vertexB1)return s;if(this.m_vertexB0===this.m_vertexB1){m.nextSegment().queryCut(this.m_scalarB0,this.m_scalarB1,r,!1),s.addSegment(r.get(),!0)}else for(;;){const e=m.nextSegment(),t=m.getStartPointIndex();if(t===this.m_vertexB0)1!==this.m_scalarB0&&(e.queryCut(this.m_scalarB0,1,r,!1),s.addSegment(r.get(),a),a=!1);else{if(t===this.m_vertexB1){0!==this.m_scalarB1&&(e.queryCut(0,this.m_scalarB1,r),s.addSegment(r.get(),a),a=!1);break}s.addSegment(e,a)}}if(s.isEmpty())return s;if(e.getDescription().getAttributeCount()>1){const t=e.getImpl().querySegmentIterator(),r=new h,a=s.getPointCount();t.resetToVertex(this.m_vertexA0,this.m_pathA0);t.nextSegment().queryCoord(this.m_scalarA0,r),s.setPointByVal(0,r),t.resetToVertex(this.m_vertexA1,this.m_pathA1);t.nextSegment().queryCoord(this.m_scalarA1,r),s.setPointByVal(a-1,r),s.interpolateAttributesRange(0,0,0,a-1)}return s}getReshapedMultiPath(e,t,s){let a;return a=e.getGeometryType()===r.enumPolygon?this.getReshapedPolygon(e,t,s):this.getReshapedPolyline(e,t),a}getReshapedPolygon(e,t,r){const s=e.getImpl().querySegmentIterator();s.setCirculator(!0);const a=new n;new h;const i=new m({vd:e.getDescription()});if(i.addSegmentsFromPath(t,0,0,t.getSegmentCountPath(0),!0),s.resetToVertex(this.m_vertexA1,this.m_pathA0),this.m_vertexA1===this.m_vertexA0&&this.m_scalarA1<=this.m_scalarA0){s.nextSegment().queryCut(this.m_scalarA1,this.m_scalarA0,a),i.addSegment(a.get(),!1)}else{{const e=s.nextSegment();1!==this.m_scalarA1&&(e.queryCut(this.m_scalarA1,1,a),i.addSegment(a.get(),!1))}for(;;){const e=s.nextSegment();if(s.getStartPointIndex()===this.m_vertexA0){0!==this.m_scalarA0&&(e.queryCut(0,this.m_scalarA0,a),i.addSegment(a.get(),!1));break}i.addSegment(e,!1)}}const o=new m({vd:e.getDescription()}),l=t.clone();if(l.reversePath(0),o.addSegmentsFromPath(l,0,0,l.getSegmentCountPath(0),!0),s.resetToVertex(this.m_vertexA0,this.m_pathA0),this.m_vertexA0===this.m_vertexA1&&this.m_scalarA0<this.m_scalarA1){s.nextSegment().queryCut(this.m_scalarA0,this.m_scalarA1,a),o.addSegment(a.get(),!1)}else{{const e=s.nextSegment();1!==this.m_scalarA0&&(e.queryCut(this.m_scalarA0,1,a),o.addSegment(a.get(),!1))}for(;;){const e=s.nextSegment();if(s.getStartPointIndex()===this.m_vertexA1){0!==this.m_scalarA1&&(e.queryCut(0,this.m_scalarA1,a),o.addSegment(a.get(),!1));break}o.addSegment(e,!1)}}const u=Math.abs(i.calculateArea2D()),g=Math.abs(o.calculateArea2D());let _=e.createInstance();for(let n=0;n<e.getPathCount();n++)n===this.m_pathA0?u>=g?_.add(i,!1):_.add(o,!1):_.addPath(e,n,!0);return _=(new c).execute(_,r,!1,this.m_progressTracker),_}getReshapedPolyline(e,t){const r=e.getImpl().querySegmentIterator(),m=new a,i=new n;let o=!1,h=-1,c=Number.NaN;o=this.m_pathA0>this.m_pathA1||this.m_pathA0===this.m_pathA1&&(this.m_vertexA0>this.m_vertexA1||this.m_vertexA0===this.m_vertexA1&&this.m_scalarA0>this.m_scalarA1),o?(h=this.m_vertexA1,c=this.m_scalarA1,r.resetToPath(this.m_pathA1)):(h=this.m_vertexA0,c=this.m_scalarA0,r.resetToPath(this.m_pathA0));let l=!0;for(r.nextPath()||s("reshaper");;){const e=r.nextSegment();if(r.getStartPointIndex()===h){0!==c&&(e.queryCut(0,c,i),m.addSegment(i.get(),l),l=!1);break}m.addSegment(e,l),l=!1}if(o){const e=t.clone();e.reversePath(0),m.addSegmentsFromPath(e,0,0,e.getSegmentCount(),l)}else m.addSegmentsFromPath(t,0,0,t.getSegmentCount(),l);o?(c=this.m_scalarA0,r.resetToVertex(this.m_vertexA0,this.m_pathA0)):(c=this.m_scalarA1,r.resetToVertex(this.m_vertexA1,this.m_pathA1));{const e=r.nextSegment();1!==c&&(e.queryCut(c,1,i),m.addSegment(i.get(),!1))}for(;r.hasNextSegment();){const e=r.nextSegment();m.addSegment(e,!1)}const u=e.createInstance();let g=!1;for(let s=0;s<e.getPathCount();s++)s===this.m_pathA0||s===this.m_pathA1?g||(u.add(m,!1),g=!0):u.addPath(e,s,!0);return u}clearIndicesAndScalars(){this.m_pathA0=-1,this.m_pathA1=-1,this.m_vertexA0=-1,this.m_vertexA1=-1,this.m_vertexB0=-1,this.m_vertexB1=-1,this.m_scalarA0=Number.NaN,this.m_scalarA1=Number.NaN,this.m_scalarB0=Number.NaN,this.m_scalarB1=Number.NaN}}class v{getOperatorType(){return 10006}accelerateGeometry(e,t,r){return!1}canAccelerateGeometry(e){return!1}supportsCurves(){return!1}execute(e,t,r,s){return A(e,t,r,s)}}const y=new v;function f(e,t){const r=g(e),s=y.execute(_(e),d(t),p(r),null);return x(s,r)}function P(e,t){return l(u.getLogger("esri.geometry.operators.reshapeOperator"),"execute is deprecated. Use reshapeExecute instead.",{replacement:"reshapeExecute",warnOnce:!0}),f(e,t)}const N=y.supportsCurves(),I=Boolean(N);export{P as execute,f as reshapeExecute,N as reshapeSupportsCurves,I as supportsCurves};

package/geometry/operators/shapePreservingProjectOperator.d.ts

@@ -42,7 +42,7 @@ import type SpatialReference from "../SpatialReference.js";
 import type GeographicTransformation from "./support/GeographicTransformation.js";
 import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
 
-export interface Options {
+export interface ShapePreservingProjectOptions {
   /**
    * An extent used to help pick the correct transform.
    * This is not used if the `geographicTransformation` option is provided.
@@ -70,16 +70,36 @@ export interface Options {
   minSegmentLengthInDegrees?: number;
 }
 
+/** @deprecated since 5.2 use [ShapePreservingProjectOptions](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#ShapePreservingProjectOptions) */
+export type Options = ShapePreservingProjectOptions;
+
 /**
  * Indicates if all dependencies of this module have been loaded.
  *
  * @returns Returns `true` if this module's dependencies have been loaded.
  */
+export function shapePreservingProjectIsLoaded(): boolean;
+
+/**
+ * Indicates if all dependencies of this module have been loaded.
+ *
+ * @deprecated since 5.2 use [shapePreservingProjectIsLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#shapePreservingProjectIsLoaded)
+ * @returns Returns `true` if this module's dependencies have been loaded.
+ */
 export function isLoaded(): boolean;
 
+/**
+ * Loads this module's dependencies. This method must be called first if `shapePreservingProjectIsLoaded` returns `false`.
+ *
+ * @returns Resolves when the dependencies have been loaded.
+ * @see [shapePreservingProjectIsLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#shapePreservingProjectIsLoaded)
+ */
+export function shapePreservingProjectLoad(): Promise<void>;
+
 /**
  * Loads this module's dependencies. This method must be called first if `isLoaded` returns `false`.
  *
+ * @deprecated since 5.2 use [shapePreservingProjectLoad()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#shapePreservingProjectLoad)
  * @returns Resolves when the dependencies have been loaded.
  * @see [isLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#isLoaded)
  */
@@ -93,28 +113,66 @@ export function load(): Promise<void>;
  * @param options - Additional options.
  * @returns The projected geometry or null.
  * @example
- * if (!shapePreservingProjectOperator.isLoaded()) {
- *   await shapePreservingProjectOperator.load();
+ * if (!shapePreservingProjectIsLoaded()) {
+ *   await shapePreservingProjectLoad();
  * }
  *
  * // Project a geometry to a different spatial reference while preserving its shape.
- * const geometry = shapePreservingProjectOperator.execute(polyline, spatialReference);
+ * const geometry = shapePreservingProjectExecute(polyline, spatialReference);
  */
-export function execute(geometry: GeometryUnion, outSpatialReference: SpatialReference, options?: Options): GeometryWithoutMeshUnion | null | undefined;
+export function shapePreservingProjectExecute(geometry: GeometryUnion, outSpatialReference: SpatialReference, options?: ShapePreservingProjectOptions): GeometryWithoutMeshUnion | null | undefined;
+
+/**
+ * Performs the shape preserving project operation on a single geometry.
+ *
+ * @deprecated since 5.2 use [shapePreservingProjectExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#shapePreservingProjectExecute)
+ * @param geometry - The geometry to be projected.
+ * @param outSpatialReference - The spatial reference to which the input geometry is projected.
+ * @param options - Additional options.
+ * @returns The projected geometry or null.
+ * @example
+ * if (!shapePreservingProjectIsLoaded()) {
+ *   await shapePreservingProjectLoad();
+ * }
+ *
+ * // Project a geometry to a different spatial reference while preserving its shape.
+ * const geometry = shapePreservingProjectExecute(polyline, spatialReference);
+ */
+export function execute(geometry: GeometryUnion, outSpatialReference: SpatialReference, options?: ShapePreservingProjectOptions): GeometryWithoutMeshUnion | null | undefined;
+
+/**
+ * Performs the shape preserving project operation on multiple geometries.
+ *
+ * @param geometries - The geometries to be projected.
+ * All the geometries must have the same spatial reference.
+ * @param outSpatialReference - The spatial reference to which the input geometries are projected.
+ * @param options - Additional options.
+ * @returns Returns the projected geometries or null.
+ */
+export function shapePreservingProjectExecuteMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ShapePreservingProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
 
 /**
  * Performs the shape preserving project operation on multiple geometries.
  *
+ * @deprecated since 5.2 use [shapePreservingProjectExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#shapePreservingProjectExecuteMany)
  * @param geometries - The geometries to be projected.
  * All the geometries must have the same spatial reference.
  * @param outSpatialReference - The spatial reference to which the input geometries are projected.
  * @param options - Additional options.
  * @returns Returns the projected geometries or null.
  */
-export function executeMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: Options): (GeometryWithoutMeshUnion | null | undefined)[];
+export function executeMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ShapePreservingProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value is `null` or `undefined` until the operator is loaded, then it will always be `false`.
+ */
+export const shapePreservingProjectSupportsCurves: boolean | null | undefined;
 
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value is `null` or `undefined` until the operator is loaded, then it will always be `false`.
+ *
+ * @deprecated since 5.2 use [shapePreservingProjectSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#shapePreservingProjectSupportsCurves)
  */
 export const supportsCurves: boolean | null | undefined;

package/geometry/operators/shapePreservingProjectOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{execute as e,executeMany as t,load as r,supportsCurves as o,isLoaded as n}from"./gx/operatorShapePreservingProject.js";let a,i,s,m,p,c;function u(){return!!a&&n()}async function f(){if(!u()){const[e,t]=await Promise.all([import("./support/apiConverter.js"),import("./support/projectionTransformation.js"),r()]);a=e.fromGeometry,i=e.fromSpatialReference,s=e.getSpatialReference,m=e.toGeometry,p=t.createProjectionTransformation,c=o()}}function g(t,r,o){const n=s(t),c=p(i(n),i(r),o),u=o?.maxDeviationInSrTo??0,f=o?.minSegmentLengthInDegrees??0;return m(e(a(t),c,f,u),r)}function S(e,r,o){const n=e.map(a),c=s(e),u=p(i(c),i(r),o),f=o?.maxDeviationInSrTo??0;return t(n,u,o?.minSegmentLengthInDegrees??0,f).map(e=>m(e,r))}export{g as execute,S as executeMany,u as isLoaded,f as load,c as supportsCurves};
+import{deprecatedFunction as e}from"../../core/deprecate.js";import r from"../../core/Logger.js";import{execute as t,executeMany as o,load as n,supportsCurves as a,isLoaded as s}from"./gx/operatorShapePreservingProject.js";let i,c,p,g,m,P,u;function d(){return!!i&&s()}function j(){return e(r.getLogger("esri.geometry.operators.shapePreservingProjectOperator"),"isLoaded is deprecated. Use shapePreservingProjectIsLoaded instead.",{replacement:"shapePreservingProjectIsLoaded",warnOnce:!0}),d()}async function f(){if(!d()){const[e,r]=await Promise.all([import("./support/apiConverter.js"),import("./support/projectionTransformation.js"),n()]);i=e.fromGeometry,c=e.fromSpatialReference,p=e.getSpatialReference,g=e.toGeometry,m=r.createProjectionTransformation,P=a(),u=P}}function v(){return e(r.getLogger("esri.geometry.operators.shapePreservingProjectOperator"),"load is deprecated. Use shapePreservingProjectLoad instead.",{replacement:"shapePreservingProjectLoad",warnOnce:!0}),f()}function h(e,r,o){const n=p(e),a=m(c(n),c(r),o),s=o?.maxDeviationInSrTo??0,P=o?.minSegmentLengthInDegrees??0;return g(t(i(e),a,P,s),r)}function L(t,o,n){return e(r.getLogger("esri.geometry.operators.shapePreservingProjectOperator"),"execute is deprecated. Use shapePreservingProjectExecute instead.",{replacement:"shapePreservingProjectExecute",warnOnce:!0}),h(t,o,n)}function x(e,r,t){const n=e.map(i),a=p(e),s=m(c(a),c(r),t),P=t?.maxDeviationInSrTo??0;return o(n,s,t?.minSegmentLengthInDegrees??0,P).map(e=>g(e,r))}function l(t,o,n){return e(r.getLogger("esri.geometry.operators.shapePreservingProjectOperator"),"executeMany is deprecated. Use shapePreservingProjectExecuteMany instead.",{replacement:"shapePreservingProjectExecuteMany",warnOnce:!0}),x(t,o,n)}export{L as execute,l as executeMany,j as isLoaded,v as load,h as shapePreservingProjectExecute,x as shapePreservingProjectExecuteMany,d as shapePreservingProjectIsLoaded,f as shapePreservingProjectLoad,P as shapePreservingProjectSupportsCurves,u as supportsCurves};