@arcgis/core 5.2.0-next.168 → 5.2.0-next.169

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/assets/esri/core/workers/RemoteClient.js +1 -1
  2. package/assets/esri/core/workers/chunks/546f5f57c9249627bb89.js +1 -0
  3. package/assets/esri/core/workers/chunks/{c0a956d57fa28fd31052.js → 8d86b0cb0e004ad72040.js} +1 -1
  4. package/config.js +1 -1
  5. package/form/elements/inputs/DynamicChoiceInput.d.ts +2 -2
  6. package/geometry/operators/containsOperator.d.ts +1 -1
  7. package/geometry/operators/densifyOperator.d.ts +1 -1
  8. package/geometry/operators/differenceOperator.d.ts +6 -4
  9. package/geometry/operators/distanceOperator.d.ts +1 -1
  10. package/geometry/operators/geodesicProximityOperator.d.ts +8 -8
  11. package/geometry/operators/graphicBufferOperator.d.ts +6 -6
  12. package/geometry/operators/integrateOperator.d.ts +2 -2
  13. package/geometry/operators/intersectsOperator.d.ts +3 -3
  14. package/geometry/operators/linesToPolygonsOperator.d.ts +2 -2
  15. package/geometry/operators/locateBetweenOperator.d.ts +2 -2
  16. package/geometry/operators/minimumBoundingCircleOperator.d.ts +1 -1
  17. package/geometry/operators/multiPartToSinglePartOperator.d.ts +2 -2
  18. package/geometry/operators/polygonSlicerOperator.d.ts +2 -2
  19. package/geometry/operators/projectOperator.d.ts +2 -2
  20. package/geometry/operators/proximityOperator.d.ts +15 -15
  21. package/geometry/operators/shapePreservingProjectOperator.d.ts +2 -2
  22. package/geometry/operators/simplifyOperator.d.ts +2 -2
  23. package/geometry/operators/support/GeographicTransformationStep.d.ts +3 -3
  24. package/geometry/operators/support/Transformation.d.ts +8 -8
  25. package/geometry/operators/support/geographicTransformationUtils.d.ts +3 -3
  26. package/geometry/operators/symmetricDifferenceOperator.d.ts +2 -2
  27. package/geometry/operators/withinOperator.d.ts +3 -3
  28. package/kernel.js +1 -1
  29. package/layers/GeospatialPDFLayer.d.ts +2 -2
  30. package/layers/ParquetLayer.d.ts +1 -1
  31. package/package.json +2 -2
  32. package/popup/FeaturesModel.js +1 -1
  33. package/popup/support/featureUtils.js +1 -1
  34. package/rest/featureService/FeatureService.d.ts +0 -5
  35. package/rest/networks/support/TraceLocation.d.ts +2 -1
  36. package/rest/networks/support/TraceResult.d.ts +0 -4
  37. package/rest/support/OutDistance.d.ts +0 -1
  38. package/smartMapping/statistics/histogramForTimeSeries.js +1 -1
  39. package/smartMapping/statistics/summaryStatisticsForTimeSeries.js +1 -1
  40. package/symbols/cim/types.d.ts +7 -9
  41. package/views/2d/engine/webgl/collisions/LabelMetric.js +1 -1
  42. package/views/2d/engine/webgl/collisions/LabelStore.js +1 -1
  43. package/views/2d/layers/features/FeatureContainer.js +1 -1
  44. package/views/2d/layers/support/visualVariableSimpleUtils.js +1 -1
  45. package/views/3d/environment/SunLighting.d.ts +15 -2
  46. package/views/3d/environment/VirtualLighting.d.ts +15 -2
  47. package/views/3d/interactive/editingTools/reshape/ReshapeOperation.js +1 -1
  48. package/views/3d/layers/support/FeatureTileFetcher3D.js +1 -1
  49. package/views/draw/DrawOperation.js +1 -1
  50. package/views/draw/DrawScreenTool.js +1 -1
  51. package/views/input/types.d.ts +2 -4
  52. package/views/interactive/options/LabelOptions.d.ts +5 -5
  53. package/views/interactive/options/SnappingOptions.d.ts +2 -2
  54. package/widgets/BatchAttributeForm/inputs/FieldInput.d.ts +0 -1
  55. package/widgets/Editor/VisibleElements.d.ts +4 -0
  56. package/widgets/Editor.d.ts +2 -0
  57. package/widgets/FeatureTable/FeatureTableViewModel.js +1 -1
  58. package/widgets/FeatureTable.js +1 -1
  59. package/widgets/Features/FeaturesViewModel.js +1 -1
  60. package/widgets/OrientedImageryViewer/OrientedImageryViewerViewModel.js +1 -1
  61. package/widgets/OrientedImageryViewer/support/NonPanoramicMedia.js +1 -1
  62. package/widgets/OrientedImageryViewer/support/dataCaptureUtils.js +1 -1
  63. package/widgets/PanoramicViewer/utils.js +1 -1
  64. package/widgets/Search/LayerSearchSource.d.ts +1 -1
  65. package/widgets/Sketch/VisibleElements.d.ts +4 -0
  66. package/widgets/Sketch.d.ts +2 -0
  67. package/widgets/support/iconUtils.js +1 -1
  68. package/assets/esri/core/workers/chunks/181b58bbbbfe4557ab5d.js +0 -1
package/config.js CHANGED
@@ -1,2 +1,2 @@
1
1
  /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
2
- import"./core/has.js";import{deepMerge as e}from"./core/object.js";const t={apiKey:void 0,apiKeys:{scopes:[]},applicationName:``,applicationUrl:globalThis.location?.href,assetsPath:``,fontsUrl:`https://static.arcgis.com/fonts`,geometryServiceUrl:`https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer`,geoRSSServiceUrl:`https://utility.arcgis.com/sharing/rss`,kmlServiceUrl:`https://utility.arcgis.com/sharing/kml`,userPrivilegesApplied:!0,portalUrl:`https://www.arcgis.com`,respectPrefersReducedMotion:!0,routeServiceUrl:`https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World`,workers:{loaderConfig:{has:{},paths:{},map:{},packages:[]}},request:{crossOriginNoCorsDomains:null,httpsDomains:[`arcgis.com`,`arcgisonline.com`,`esrikr.com`,`premiumservices.blackbridge.com`,`esripremium.accuweather.com`,`gbm.digitalglobe.com`,`firstlook.digitalglobe.com`,`msi.digitalglobe.com`],interceptors:[],internalInterceptors:[],maxUrlLength:2e3,priority:`high`,proxyRules:[],proxyUrl:null,timeout:62e3,trustedServers:[],useIdentity:!0},log:{interceptors:[],level:null}};globalThis.esriConfig&&(e(t,globalThis.esriConfig,!0),delete t.has),!t.assetsPath&&(t.assetsPath=`https://cdn.jsdelivr.net/npm/@arcgis/core@5.2.0-next.168/assets`,t.defaultAssetsPath=t.assetsPath);export{t as default};
2
+ import"./core/has.js";import{deepMerge as e}from"./core/object.js";const t={apiKey:void 0,apiKeys:{scopes:[]},applicationName:``,applicationUrl:globalThis.location?.href,assetsPath:``,fontsUrl:`https://static.arcgis.com/fonts`,geometryServiceUrl:`https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer`,geoRSSServiceUrl:`https://utility.arcgis.com/sharing/rss`,kmlServiceUrl:`https://utility.arcgis.com/sharing/kml`,userPrivilegesApplied:!0,portalUrl:`https://www.arcgis.com`,respectPrefersReducedMotion:!0,routeServiceUrl:`https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World`,workers:{loaderConfig:{has:{},paths:{},map:{},packages:[]}},request:{crossOriginNoCorsDomains:null,httpsDomains:[`arcgis.com`,`arcgisonline.com`,`esrikr.com`,`premiumservices.blackbridge.com`,`esripremium.accuweather.com`,`gbm.digitalglobe.com`,`firstlook.digitalglobe.com`,`msi.digitalglobe.com`],interceptors:[],internalInterceptors:[],maxUrlLength:2e3,priority:`high`,proxyRules:[],proxyUrl:null,timeout:62e3,trustedServers:[],useIdentity:!0},log:{interceptors:[],level:null}};globalThis.esriConfig&&(e(t,globalThis.esriConfig,!0),delete t.has),!t.assetsPath&&(t.assetsPath=`https://cdn.jsdelivr.net/npm/@arcgis/core@5.2.0-next.169/assets`,t.defaultAssetsPath=t.assetsPath);export{t as default};
@@ -12,13 +12,13 @@ export interface DynamicChoiceInputProperties extends SingleChoiceInputPropertie
12
12
  *
13
13
  * @since 5.2
14
14
  * @see [FieldElement](https://developers.arcgis.com/javascript/latest/references/core/form/elements/FieldElement/)
15
- * @see [Sample - Edit features with dynamic choices ](https://developers.arcgis.com/javascript/latest/sample-code/editor-dynamic-choices/)
15
+ * @see [Sample - Edit features with dynamic choices](https://developers.arcgis.com/javascript/latest/sample-code/editor-dynamic-choices/)
16
16
  * @example
17
17
  * // Creates a new dynamic choice input for a field element within a form
18
18
  * const dynamicChoiceInput = new DynamicChoiceInput({
19
19
  * choiceExpression: dynamicChoiceExpression.name, // reference to the defined expression
20
20
  * noValueOptionLabel: "No Value (null)", // label for the option representing a null value
21
- * showNoValueOption: false, // whether to display the choice representing a null value (ie. "No Value")
21
+ * showNoValueOption: false, // whether to display the choice representing a null value (i.e., "No Value")
22
22
  * });
23
23
  */
24
24
  export default class DynamicChoiceInput extends SingleChoiceInput {
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Performs a relational operation to determine if one 2D geometry contains another 2D geometry.
3
- * Geometry A contains geometry B, when B is the intersection of A and B.
3
+ * Geometry A contains geometry B when B is the intersection of A and B.
4
4
  * A contains B is equivalent to B within A. Geometry B can be non-simple geometry.
5
5
  *
6
6
  * ![Contains operator](https://developers.arcgis.com/javascript/latest/assets/references/core/operators/contains.avif "Contains operator")
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Densifies 2D geometries by length, deviation and/or angle in a 2D plane. The result geometry contains segments less than or equal to `maxSegementLength`, and it will not contain curves.
2
+ * Densifies 2D geometries by length, deviation and/or angle in a 2D plane. The result geometry contains segments less than or equal to `maxSegmentLength`, and it will not contain curves.
3
3
  * The piecewise approximation of curves will be within the specified deviation from the original curve,
4
4
  * and the angle between tangent segments does not exceed the specified value.
5
5
  *
@@ -36,18 +36,19 @@ export function differenceExecute(geometry: GeometryUnion, subtractor: GeometryU
36
36
  export function execute(geometry: GeometryUnion, subtractor: GeometryUnion): GeometryWithoutMeshUnion | null | undefined;
37
37
 
38
38
  /**
39
- * Performs the Topological difference operation on the geometry set.
39
+ * Performs the topological difference operation on the geometry set.
40
40
  *
41
41
  * @param geometries - The set of geometry instances to be subtracted by the `subtractor`.
42
42
  * All the geometries must have the same spatial reference.
43
43
  * @param subtractor - The geometry on the right-hand side being subtracted.
44
- * @returns Returns an array whose elements are the result of subtracting each input geometry from `geometries`, or null. The result has the dimensions of the `geometries`.
44
+ * @returns Returns an array whose elements are the result of subtracting `subtractor` from each input geometry in `geometries`.
45
+ * Individual entries may be `null` or `undefined`. Each result has the dimensions of its corresponding input geometry.
45
46
  * @since 5.2
46
47
  */
47
48
  export function differenceExecuteMany(geometries: GeometryUnion[], subtractor: GeometryUnion): (GeometryWithoutMeshUnion | null | undefined)[];
48
49
 
49
50
  /**
50
- * Performs the Topological difference operation on the geometry set.
51
+ * Performs the topological difference operation on the geometry set.
51
52
  *
52
53
  * @deprecated
53
54
  * since 5.2. Refactor using \@arcgis/codemod or manually replace usages
@@ -55,7 +56,8 @@ export function differenceExecuteMany(geometries: GeometryUnion[], subtractor: G
55
56
  * @param geometries - An array of geometries.
56
57
  * All the geometries must have the same spatial reference.
57
58
  * @param subtractor - The geometry to be subtracted from each and every geometry in `geometries`.
58
- * @returns An array of computed geometries. The size of the array will be equivalent to the size of `geometries`.
59
+ * @returns Returns an array whose elements are the result of subtracting `subtractor` from each input geometry in `geometries`.
60
+ * Individual entries may be `null` or `undefined`. Each result has the dimensions of its corresponding input geometry.
59
61
  */
60
62
  export function executeMany(geometries: GeometryUnion[], subtractor: GeometryUnion): (GeometryWithoutMeshUnion | null | undefined)[];
61
63
 
@@ -49,7 +49,7 @@ export function distanceExecute(geometry1: GeometryUnion, geometry2: GeometryUni
49
49
  * @param geometry1 - The first input geometry.
50
50
  * @param geometry2 - The second input geometry.
51
51
  * @param options - Additional options.
52
- * @returns The distance between the two geometries. Will return NaN if either input geometries are empty.
52
+ * @returns The distance between the two geometries. Will return NaN if either input geometry is empty.
53
53
  * @example
54
54
  * // Calculate the planar distance between two points
55
55
  * const distance = distanceExecute(point1, point2);
@@ -109,7 +109,7 @@ export function load(): Promise<void>;
109
109
 
110
110
  /**
111
111
  * Returns the nearest coordinate on the geometry to the given input point.
112
- * The operator interprets all segments in the shape preserving manner, that is it treats segments as if they are densified with a small step in the input spatial reference and then the calculation is performed geodesicly.
112
+ * The operator interprets all segments in a shape-preserving manner, that is, it treats segments as if they are densified with a small step in the input spatial reference and then the calculation is performed geodesically.
113
113
  *
114
114
  * @param geometry - The input geometry.
115
115
  * @param point - The point used to search for the nearest coordinate in `geometry`.
@@ -128,7 +128,7 @@ export function geodesicProximityGetNearestCoordinate(geometry: GeometryUnion, p
128
128
 
129
129
  /**
130
130
  * Returns the nearest coordinate on the geometry to the given input point.
131
- * The operator interprets all segments in the shape preserving manner, that is it treats segments as if they are densified with a small step in the input spatial reference and then the calculation is performed geodesicly.
131
+ * The operator interprets all segments in a shape-preserving manner, that is, it treats segments as if they are densified with a small step in the input spatial reference and then the calculation is performed geodesically.
132
132
  *
133
133
  * @deprecated
134
134
  * since 5.2. Refactor using \@arcgis/codemod or manually replace usages
@@ -151,7 +151,7 @@ export function getNearestCoordinate(geometry: GeometryUnion, point: Point, opti
151
151
  * Returns the nearest vertex on the geometry.
152
152
  *
153
153
  * @param geometry - The input geometry.
154
- * @param point - The point used to search for the nearest coordinate in the input `geometry`.
154
+ * @param point - The point used to search for the nearest vertex in the input `geometry`.
155
155
  * @param options - Additional options.
156
156
  * @returns Returns the result of proximity operation.
157
157
  * @since 5.2
@@ -172,7 +172,7 @@ export function geodesicProximityGetNearestVertex(geometry: GeometryUnion, point
172
172
  * since 5.2. Refactor using \@arcgis/codemod or manually replace usages
173
173
  * with [geodesicProximityGetNearestVertex()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/geodesicProximityOperator/#geodesicProximityGetNearestVertex).
174
174
  * @param geometry - The input geometry.
175
- * @param point - The point used to search for the nearest coordinate in the input `geometry`.
175
+ * @param point - The point used to search for the nearest vertex in the input `geometry`.
176
176
  * @param options - Additional options.
177
177
  * @returns Returns the result of proximity operation.
178
178
  * @example
@@ -189,13 +189,13 @@ export function getNearestVertex(geometry: GeometryUnion, point: Point, options?
189
189
  * Returns vertices of the geometry that are closer to the given point than the given radius.
190
190
  *
191
191
  * @param geometry - The input geometry.
192
- * @param point - The point used to search for the nearest coordinate in `geometry`.
192
+ * @param point - The point used to search for the nearest vertices in `geometry`.
193
193
  * @param searchRadius - The distance to search from the `point` to the nearest vertices in the `geometry`.
194
194
  * Unless the `unit` option is set, the default is meters.
195
195
  * @param maxVertexCountToReturn - The maximum number of vertices that will be returned. Must be a positive number.
196
196
  * @param options - Additional options.
197
197
  * @returns The array of vertices that are in the given search radius to the point.
198
- * The array is sorted by distance to the queryPoint with the closest point first.
198
+ * The array is sorted by distance to the query point, with the closest vertex first.
199
199
  * When there are more than the `maxVertexCountToReturn` vertices to return, it returns the closest vertices.
200
200
  * The array will be empty when `geometry` is empty.
201
201
  * @since 5.2
@@ -216,13 +216,13 @@ export function geodesicProximityGetNearestVertices(geometry: GeometryUnion, poi
216
216
  * since 5.2. Refactor using \@arcgis/codemod or manually replace usages
217
217
  * with [geodesicProximityGetNearestVertices()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/geodesicProximityOperator/#geodesicProximityGetNearestVertices).
218
218
  * @param geometry - The input geometry.
219
- * @param point - The point used to search for the nearest coordinate in `geometry`.
219
+ * @param point - The point used to search for the nearest vertices in `geometry`.
220
220
  * @param searchRadius - The distance to search from the `point` to the nearest vertices in the `geometry`.
221
221
  * Unless the `unit` option is set, the default is meters.
222
222
  * @param maxVertexCountToReturn - The maximum number of vertices that will be returned. Must be a positive number.
223
223
  * @param options - Additional options.
224
224
  * @returns The array of vertices that are in the given search radius to the point.
225
- * The array is sorted by distance to the queryPoint with the closest point first.
225
+ * The array is sorted by distance to the query point, with the closest vertex first.
226
226
  * When there are more than the `maxVertexCountToReturn` vertices to return, it returns the closest vertices.
227
227
  * The array will be empty when `geometry` is empty.
228
228
  * @example
@@ -67,8 +67,8 @@ export type Options = GraphicBufferOptions;
67
67
  * * Miter joins are replaced with bevel when the ratio of the miter thickness to the buffer distance is greater than miter limit. The miter thickness is the distance from the vertex to the mitered corner of the buffer that this vertex generates.
68
68
  * @param caps - Defines the buffer's shape at the end points of the geometries.
69
69
  * * Points with square caps will be drawn as squares.
70
- * * Open polylines paths with square caps degenerate to a point and will be drawn as squares (degenerate with zero tolerance).
71
- * * Open polylines paths with round caps degenerate to a point and will be drawn as circles (degenerate with zero tolerance).
70
+ * * Open polyline paths with square caps degenerate to a point and will be drawn as squares (degenerate with zero tolerance).
71
+ * * Open polyline paths with round caps degenerate to a point and will be drawn as circles (degenerate with zero tolerance).
72
72
  * @param options - Additional options.
73
73
  * @returns Returns the buffered geometries.
74
74
  * @since 5.2
@@ -79,7 +79,7 @@ export type Options = GraphicBufferOptions;
79
79
  * [1000, 1500],
80
80
  * "square",
81
81
  * "round",
82
- * 10,
82
+ * { miterLimit: 10 },
83
83
  * );
84
84
  */
85
85
  export function graphicBufferExecuteMany(geometries: GeometryUnion[], distances: number[], joins: "round" | "miter" | "bevel", caps: "round" | "butt" | "square", options?: GraphicBufferOptions): Polygon[];
@@ -102,8 +102,8 @@ export function graphicBufferExecuteMany(geometries: GeometryUnion[], distances:
102
102
  * * Miter joins are replaced with bevel when the ratio of the miter thickness to the buffer distance is greater than miter limit. The miter thickness is the distance from the vertex to the mitered corner of the buffer that this vertex generates.
103
103
  * @param caps - Defines the buffer's shape at the end points of the geometries.
104
104
  * * Points with square caps will be drawn as squares.
105
- * * Open polylines paths with square caps degenerate to a point and will be drawn as squares (degenerate with zero tolerance).
106
- * * Open polylines paths with round caps degenerate to a point and will be drawn as circles (degenerate with zero tolerance).
105
+ * * Open polyline paths with square caps degenerate to a point and will be drawn as squares (degenerate with zero tolerance).
106
+ * * Open polyline paths with round caps degenerate to a point and will be drawn as circles (degenerate with zero tolerance).
107
107
  * @param options - Additional options.
108
108
  * @returns Returns the buffered geometries.
109
109
  * @example
@@ -113,7 +113,7 @@ export function graphicBufferExecuteMany(geometries: GeometryUnion[], distances:
113
113
  * [1000, 1500],
114
114
  * "square",
115
115
  * "round",
116
- * 10,
116
+ * { miterLimit: 10 },
117
117
  * );
118
118
  */
119
119
  export function executeMany(geometries: GeometryUnion[], distances: number[], joins: "round" | "miter" | "bevel", caps: "round" | "butt" | "square", options?: GraphicBufferOptions): Polygon[];
@@ -14,7 +14,7 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
14
14
  *
15
15
  * @param geometries - The set of geometries to integrate.
16
16
  * All the geometries must have the same spatial reference.
17
- * @returns Returns the result of the subtraction.
17
+ * @returns Returns the result of the integration.
18
18
  * The operation filters out degenerate segments and returns `null` for empty geometries.
19
19
  * @since 5.2
20
20
  * @example
@@ -31,7 +31,7 @@ export function integrateExecuteMany(geometries: GeometryUnion[]): (GeometryWith
31
31
  * with [integrateExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/integrateOperator/#integrateExecuteMany).
32
32
  * @param geometries - The set of geometries to integrate.
33
33
  * All the geometries must have the same spatial reference.
34
- * @returns Returns the result of the subtraction.
34
+ * @returns Returns the result of the integration.
35
35
  * The operation filters out degenerate segments and returns `null` for empty geometries.
36
36
  * @example
37
37
  * // Integrate a set of geometries
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Performs a relational operation to determine if one 2D geometry intersects another 2D geometry.
3
- * Intersect is same as not disjoint.
3
+ * Intersects is the same as not being disjoint.
4
4
  * This operator can be used with non-simple geometries.
5
5
  *
6
6
  * ![Intersects operator](https://developers.arcgis.com/javascript/latest/assets/references/core/operators/intersects.avif "Intersects operator")
@@ -30,7 +30,7 @@ export function intersectsAccelerateGeometry(geometry: GeometryUnion): boolean;
30
30
  export function accelerateGeometry(geometry: GeometryUnion): boolean;
31
31
 
32
32
  /**
33
- * Perform a intersects operation on two geometries.
33
+ * Performs the intersects operation on two geometries.
34
34
  *
35
35
  * @param geometry1 - The geometry that is tested for the intersects relationship to `geometry2`.
36
36
  * @param geometry2 - The geometry being intersected.
@@ -43,7 +43,7 @@ export function accelerateGeometry(geometry: GeometryUnion): boolean;
43
43
  export function intersectsExecute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean;
44
44
 
45
45
  /**
46
- * Perform a intersects operation on two geometries.
46
+ * Performs the intersects operation on two geometries.
47
47
  *
48
48
  * @deprecated
49
49
  * since 5.2. Refactor using \@arcgis/codemod or manually replace usages
@@ -11,7 +11,7 @@ import type { GeometryUnion } from "../types.js";
11
11
  *
12
12
  * @param geometries - The set of input geometries.
13
13
  * All the geometries must have the same spatial reference.
14
- * @returns Returns the result of polygons.
14
+ * @returns Returns the resulting polygons.
15
15
  * @since 5.2
16
16
  * @example
17
17
  * // Perform the lines to polygons operation
@@ -27,7 +27,7 @@ export function linesToPolygonsExecuteMany(geometries: GeometryUnion[]): Polygon
27
27
  * with [linesToPolygonsExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/linesToPolygonsOperator/#linesToPolygonsExecuteMany).
28
28
  * @param geometries - The set of input geometries.
29
29
  * All the geometries must have the same spatial reference.
30
- * @returns Returns the result of polygons.
30
+ * @returns Returns the resulting polygons.
31
31
  * @example
32
32
  * // Perform the lines to polygons operation
33
33
  * const polygons = linesToPolygonsExecuteMany([polyline1, polyline2]);
@@ -18,7 +18,7 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
18
18
  * All the geometries must have the same spatial reference.
19
19
  * @param startM - The M value to start the operation.
20
20
  * @param endM - The M value to end the operation.
21
- * @returns Returns the result of geometries.
21
+ * @returns Returns the resulting geometries.
22
22
  * For 1-dimensional geometries, the result could be either point, multipoint, or polyline.
23
23
  * For polylines, the result can be both polyline and multipoint.
24
24
  * @since 5.2
@@ -39,7 +39,7 @@ export function locateBetweenExecuteMany(geometries: GeometryUnion[], startM: nu
39
39
  * All the geometries must have the same spatial reference.
40
40
  * @param startM - The M value to start the operation.
41
41
  * @param endM - The M value to end the operation.
42
- * @returns Returns the result of geometries.
42
+ * @returns Returns the resulting geometries.
43
43
  * For 1-dimensional geometries, the result could be either point, multipoint, or polyline.
44
44
  * For polylines, the result can be both polyline and multipoint.
45
45
  * @example
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Create a minimum bounding circle for the input geometry.
3
3
  * The output is a polygon with a single closed circular segment containing curves.
4
- * Implements the Welzl's algorithm using greedy heuristic with expected O(n) time complexity.
4
+ * Implements Welzl's algorithm using a greedy heuristic with expected O(n) time complexity.
5
5
  *
6
6
  * > [!WARNING]
7
7
  * >
@@ -34,7 +34,7 @@ export type Options = MultiPartToSinglePartOptions;
34
34
  * All the geometries must have the same spatial reference.
35
35
  * @param options - Additional options.
36
36
  * @returns Returns the single part geometries.
37
- * For non-simple polygons, the output of the method is not guaranteed to be correct if the `simplifyPolgons` option is set to `false`.
37
+ * For non-simple polygons, the output of the method is not guaranteed to be correct if the `simplifyPolygons` option is set to `false`.
38
38
  * In that case, the method may either throw an error, or produce some output which is not guaranteed to be correct.
39
39
  * @since 5.2
40
40
  * @example
@@ -55,7 +55,7 @@ export function multiPartToSinglePartExecuteMany(geometries: GeometryUnion[], op
55
55
  * All the geometries must have the same spatial reference.
56
56
  * @param options - Additional options.
57
57
  * @returns Returns the single part geometries.
58
- * For non-simple polygons, the output of the method is not guaranteed to be correct if the `simplifyPolgons` option is set to `false`.
58
+ * For non-simple polygons, the output of the method is not guaranteed to be correct if the `simplifyPolygons` option is set to `false`.
59
59
  * In that case, the method may either throw an error, or produce some output which is not guaranteed to be correct.
60
60
  * @example
61
61
  * // Convert multipart geometries to single part geometries
@@ -45,7 +45,7 @@ export type FindSlicesByAreaOptions = PolygonSlicerFindSlicesByAreaOptions;
45
45
  *
46
46
  * @param polygon - The input polygon.
47
47
  * @param partCount - The number of parts to slice into.
48
- * @param remainingArea - The size of the remaining piece of the uncut polygon. Pass zero, if you want to slice the whole polygon.
48
+ * @param remainingArea - The size of the remaining piece of the uncut polygon. Pass zero if you want to slice the whole polygon.
49
49
  * Unless the `unit` option is set, the default is the spatial reference unit of `polygon`.
50
50
  * @param options - Additional options.
51
51
  * @returns Returns the y-coordinate set for the slice positions sorted in increasing y-order. The set can be used as input to the
@@ -65,7 +65,7 @@ export function polygonSlicerFindSlicesByArea(polygon: Polygon, partCount: numbe
65
65
  * with [polygonSlicerFindSlicesByArea()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/polygonSlicerOperator/#polygonSlicerFindSlicesByArea).
66
66
  * @param polygon - The input polygon.
67
67
  * @param partCount - The number of parts to slice into.
68
- * @param remainingArea - The size of the remaining piece of the uncut polygon. Pass zero, if you want to slice the whole polygon.
68
+ * @param remainingArea - The size of the remaining piece of the uncut polygon. Pass zero if you want to slice the whole polygon.
69
69
  * Unless the `unit` option is set, the default is the spatial reference unit of `polygon`.
70
70
  * @param options - Additional options.
71
71
  * @returns Returns the y-coordinate set for the slice positions sorted in increasing y-order. The set can be used as input to the
@@ -135,7 +135,7 @@ export function execute(geometry: GeometryUnion, outSpatialReference: SpatialRef
135
135
  * All the geometries must have the same spatial reference.
136
136
  * @param outSpatialReference - The spatial reference to which the input geometry is projected.
137
137
  * @param options - Additional options.
138
- * @returns Returns the projected geometries or null.
138
+ * @returns Returns an array of projected geometries, and individual entries may be `null` or `undefined`.
139
139
  * @since 5.2
140
140
  */
141
141
  export function projectExecuteMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
@@ -150,7 +150,7 @@ export function projectExecuteMany(geometries: GeometryUnion[], outSpatialRefere
150
150
  * All the geometries must have the same spatial reference.
151
151
  * @param outSpatialReference - The spatial reference to which the input geometry is projected.
152
152
  * @param options - Additional options.
153
- * @returns Returns the projected geometries or null.
153
+ * @returns Returns an array of projected geometries, and individual entries may be `null` or `undefined`.
154
154
  */
155
155
  export function executeMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
156
156
 
@@ -60,7 +60,7 @@ export type GetNearestCoordinateOptions = ProximityGetNearestCoordinateOptions;
60
60
  * @param geometry - The input geometry.
61
61
  * @param point - The point used to search for the nearest coordinate in `geometry`.
62
62
  * @param options - Additional options.
63
- * @returns Returns the proximity result which contains the nearest coordinate on the input `geometry` to the given `inputPoint`.
63
+ * @returns Returns the proximity result which contains the nearest coordinate on the input `geometry` to the given `point`.
64
64
  * @since 5.2
65
65
  * @example
66
66
  * // Return the nearest result on a polygon to the given point
@@ -77,7 +77,7 @@ export function proximityGetNearestCoordinate(geometry: GeometryUnion, point: Po
77
77
  * @param geometry - The input geometry.
78
78
  * @param point - The point used to search for the nearest coordinate in `geometry`.
79
79
  * @param options - Additional options.
80
- * @returns Returns the proximity result which contains the nearest coordinate on the input `geometry` to the given `inputPoint`.
80
+ * @returns Returns the proximity result which contains the nearest coordinate on the input `geometry` to the given `point`.
81
81
  * @example
82
82
  * // Return the nearest result on a polygon to the given point
83
83
  * const proximityResult = proximityGetNearestCoordinate(polygon, point);
@@ -88,13 +88,13 @@ export function getNearestCoordinate(geometry: GeometryUnion, point: Point, opti
88
88
  * Returns the nearest vertex on the geometry.
89
89
  *
90
90
  * @param geometry - The input geometry.
91
- * @param point - The point used to search for the nearest coordinate in the input `geometry`.
91
+ * @param point - The point used to search for the nearest vertex in the input `geometry`.
92
92
  * @param options - Additional options.
93
- * @returns Returns the proximity result which contains the nearest vertex on the `geometry` to the given `inputPoint`.
93
+ * @returns Returns the proximity result which contains the nearest vertex on the `geometry` to the given `point`.
94
94
  * @since 5.2
95
95
  * @example
96
96
  * // Return the nearest vertex on a polygon to the given point
97
- * const proximityResult = proximityGetNearestCoordinate(polygon, point);
97
+ * const proximityResult = proximityGetNearestVertex(polygon, point);
98
98
  */
99
99
  export function proximityGetNearestVertex(geometry: GeometryUnion, point: Point, options?: ProximityOptions): ProximityResult;
100
100
 
@@ -105,9 +105,9 @@ export function proximityGetNearestVertex(geometry: GeometryUnion, point: Point,
105
105
  * since 5.2. Refactor using \@arcgis/codemod or manually replace usages
106
106
  * with [proximityGetNearestVertex()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/proximityOperator/#proximityGetNearestVertex).
107
107
  * @param geometry - The input geometry.
108
- * @param point - The point used to search for the nearest coordinate in the input `geometry`.
108
+ * @param point - The point used to search for the nearest vertex in the input `geometry`.
109
109
  * @param options - Additional options.
110
- * @returns Returns the proximity result which contains the nearest vertex on the `geometry` to the given `inputPoint`.
110
+ * @returns Returns the proximity result which contains the nearest vertex on the `geometry` to the given `point`.
111
111
  * @example
112
112
  * // Return the nearest vertex on a polygon to the given point
113
113
  * const proximityResult = proximityGetNearestVertex(polygon, point);
@@ -118,13 +118,13 @@ export function getNearestVertex(geometry: GeometryUnion, point: Point, options?
118
118
  * Returns vertices of the geometry that are closer to the given point than the given radius.
119
119
  *
120
120
  * @param geometry - The input geometry.
121
- * @param point - The point used to search for the nearest coordinate in `geometry`.
122
- * @param searchRadius - The planar distance from the `inputPoint` to search for vertices.
121
+ * @param point - The point used to search for the nearest vertices in `geometry`.
122
+ * @param searchRadius - The planar distance from the `point` to search for vertices.
123
123
  * Unless the `unit` option is set, the default is the geometry's spatial reference unit.
124
124
  * @param maxVertexCountToReturn - The maximum number of vertices that will be returned. Must be a positive number.
125
125
  * @param options - Additional options.
126
- * @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.
127
- * The array is sorted by distance to the `inputPoint` with the closest point first.
126
+ * @returns Returns an array of proximity results which contain the nearest vertices on `geometry` to the given `point` that are less than or equal to the planar distance of search radius.
127
+ * The array is sorted by distance to the query point, with the closest vertex first.
128
128
  * When there are more than the `maxVertexCountToReturn` vertices to return, it returns the closest vertices.
129
129
  * The array will be empty when `geometry` is empty.
130
130
  * @since 5.2
@@ -141,13 +141,13 @@ export function proximityGetNearestVertices(geometry: GeometryUnion, point: Poin
141
141
  * since 5.2. Refactor using \@arcgis/codemod or manually replace usages
142
142
  * with [proximityGetNearestVertices()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/proximityOperator/#proximityGetNearestVertices).
143
143
  * @param geometry - The input geometry.
144
- * @param point - The point used to search for the nearest coordinate in `geometry`.
145
- * @param searchRadius - The planar distance from the `inputPoint` to search for vertices.
144
+ * @param point - The point used to search for the nearest vertices in `geometry`.
145
+ * @param searchRadius - The planar distance from the `point` to search for vertices.
146
146
  * Unless the `unit` option is set, the default is the geometry's spatial reference unit.
147
147
  * @param maxVertexCountToReturn - The maximum number of vertices that will be returned. Must be a positive number.
148
148
  * @param options - Additional options.
149
- * @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.
150
- * The array is sorted by distance to the `inputPoint` with the closest point first.
149
+ * @returns Returns an array of proximity results which contain the nearest vertices on `geometry` to the given `point` that are less than or equal to the planar distance of search radius.
150
+ * The array is sorted by distance to the query point, with the closest vertex first.
151
151
  * When there are more than the `maxVertexCountToReturn` vertices to return, it returns the closest vertices.
152
152
  * The array will be empty when `geometry` is empty.
153
153
  * @example
@@ -161,7 +161,7 @@ export function execute(geometry: GeometryUnion, outSpatialReference: SpatialRef
161
161
  * All the geometries must have the same spatial reference.
162
162
  * @param outSpatialReference - The spatial reference to which the input geometries are projected.
163
163
  * @param options - Additional options.
164
- * @returns Returns the projected geometries or null.
164
+ * @returns Returns an array of projected geometries, and individual entries may be `null` or `undefined`.
165
165
  * @since 5.2
166
166
  */
167
167
  export function shapePreservingProjectExecuteMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ShapePreservingProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
@@ -176,7 +176,7 @@ export function shapePreservingProjectExecuteMany(geometries: GeometryUnion[], o
176
176
  * All the geometries must have the same spatial reference.
177
177
  * @param outSpatialReference - The spatial reference to which the input geometries are projected.
178
178
  * @param options - Additional options.
179
- * @returns Returns the projected geometries or null.
179
+ * @returns Returns an array of projected geometries, and individual entries may be `null` or `undefined`.
180
180
  */
181
181
  export function executeMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ShapePreservingProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
182
182
 
@@ -41,7 +41,7 @@ export function execute(geometry: GeometryUnion): GeometryWithoutMeshUnion | nul
41
41
  /**
42
42
  * Performs the simplify operation on the geometry set.
43
43
  *
44
- * @param geometries - The array of geometries to be simplified,
44
+ * @param geometries - The array of geometries to be simplified.
45
45
  * All the geometries must have the same spatial reference.
46
46
  * @returns Returns an array whose elements may either be simplified geometries or null.
47
47
  * @since 5.2
@@ -54,7 +54,7 @@ export function simplifyExecuteMany(geometries: GeometryUnion[]): (GeometryWitho
54
54
  * @deprecated
55
55
  * since 5.2. Refactor using \@arcgis/codemod or manually replace usages
56
56
  * with [simplifyExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/simplifyOperator/#simplifyExecuteMany).
57
- * @param geometries - The array of geometries to be simplified,
57
+ * @param geometries - The array of geometries to be simplified.
58
58
  * All the geometries must have the same spatial reference.
59
59
  * @returns Returns an array whose elements may either be simplified geometries or null.
60
60
  */
@@ -7,7 +7,7 @@ export interface GeographicTransformationStepProperties extends Partial<Pick<Geo
7
7
  /**
8
8
  * Represents a step in the process of transforming coordinates from one geographic coordinate system to another.
9
9
  * A geographic transformation step can be constructed from a
10
- * well-known ID [(wkid)](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/support/GeographicTransformationStep/#wkid) or a well known text [(wkt)](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/support/GeographicTransformationStep/#wkt) that represents a geographic datum transformation.
10
+ * well-known ID [(wkid)](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/support/GeographicTransformationStep/#wkid) or well-known text [(wkt)](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/support/GeographicTransformationStep/#wkt) that represents a geographic datum transformation.
11
11
  *
12
12
  * @since 5.2
13
13
  * @since 4.32
@@ -34,7 +34,7 @@ export default class GeographicTransformationStep extends GeographicTransformati
34
34
  */
35
35
  accessor isUsable: boolean | null | undefined;
36
36
  /**
37
- * The well-known id (wkid) hat represents a known geographic transformation.
37
+ * The well-known ID (WKID) that represents a known geographic transformation.
38
38
  * See [Geographic datum transformations](https://pro.arcgis.com/en/pro-app/latest/help/mapping/properties/geographic-coordinate-system-transformation.htm)
39
39
  * for the list of supported equation-based geographic transformations.
40
40
  *
@@ -50,7 +50,7 @@ export default class GeographicTransformationStep extends GeographicTransformati
50
50
  *
51
51
  * @example
52
52
  * // Create a geographic transformation step for NAD_1927_To_WGS_1984_1
53
- * // using its well known text or wkt
53
+ * // using its well-known text (WKT)
54
54
  * let wkt = "GEOGTRAN[\"NAD_1927_To_WGS_1984_1\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],METHOD[\"Geocentric_Translation\"],PARAMETER[\"X_Axis_Translation\",-3.0],PARAMETER[\"Y_Axis_Translation\",142.0],PARAMETER[\"Z_Axis_Translation\",183.0]]";
55
55
  *
56
56
  * let geoStep = new GeographicTransformationStep({ wkt });
@@ -37,13 +37,13 @@ export default class Transformation {
37
37
  * @param x1 - The x-coordinate of the second geometry.
38
38
  * @example
39
39
  * // Flip the x-coordinates of a geometry on the vertical axis
40
- * const transform = new Transformation();
41
- * transform.flipX(0, 10);
40
+ * const transformation = new Transformation();
41
+ * transformation.flipX(0, 10);
42
42
  * const result = affineTransformExecute(polygon, transform);
43
43
  *
44
44
  * // Flip the x-coordinates of a geometry on the vertical axis centered at the geometry's center
45
45
  * const centerX = polygon.extent.center.x;
46
- * transform.flipX(centerX, centerX);
46
+ * transformation.flipX(centerX, centerX);
47
47
  * const result = affineTransformExecute(polygon, transform);
48
48
  */
49
49
  flipX(x0: number, x1: number): this;
@@ -62,7 +62,7 @@ export default class Transformation {
62
62
  *
63
63
  * // Flip the y-coordinates of a geometry on the horizontal axis centered at the geometry's center
64
64
  * const centerY = polygon.extent.center.y;
65
- * transform.flipY(centerY, centerY);
65
+ * transformation.flipY(centerY, centerY);
66
66
  * const result = affineTransformExecute(polygon, transform);
67
67
  */
68
68
  flipY(y0: number, y1: number): this;
@@ -107,7 +107,7 @@ export default class Transformation {
107
107
  * @example
108
108
  * // Rotate a geometry
109
109
  * transformation.rotate(90, 0, 0);
110
- * const result = affineTransformExecute(polygon, transform);
110
+ * const result = affineTransformExecute(polygon, transformation);
111
111
  */
112
112
  rotate(angleInDegrees: number, rotationX?: number, rotationY?: number): this;
113
113
  /**
@@ -121,7 +121,7 @@ export default class Transformation {
121
121
  * @example
122
122
  * // Scale a geometry
123
123
  * transformation.scale(2, 2);
124
- * const result = affineTransformExecute(polygon, transform);
124
+ * const result = affineTransformExecute(polygon, transformation);
125
125
  */
126
126
  scale(x: number, y: number): this;
127
127
  /**
@@ -149,7 +149,7 @@ export default class Transformation {
149
149
  * @example
150
150
  * // Shear a geometry
151
151
  * transformation.shear(0.5, 0.5);
152
- * const result = affineTransformExecute(polygon, transform);
152
+ * const result = affineTransformExecute(polygon, transformation);
153
153
  */
154
154
  shear(proportionX: number, proportionY: number): this;
155
155
  /**
@@ -162,7 +162,7 @@ export default class Transformation {
162
162
  * @example
163
163
  * // Shift the coordinates of a geometry
164
164
  * transformation.shift(5, 2);
165
- * const result = affineTransformExecute(polygon, transform);
165
+ * const result = affineTransformExecute(polygon, transformation);
166
166
  */
167
167
  shift(x: number, y: number): this;
168
168
  }
@@ -79,7 +79,7 @@ export function load(): Promise<void>;
79
79
  * await geographicTransformationUtils.load();
80
80
  * }
81
81
  *
82
- * const geogtrans = projection.getTransformation(cs1, cs2, extent);
82
+ * const geogtrans = geographicTransformationUtils.getTransformation(cs1, cs2, extent);
83
83
  */
84
84
  export function getTransformation(inSpatialReference: SpatialReference, outSpatialReference: SpatialReference, areaOfInterestExtent?: Extent | null, returnUnusable?: boolean): GeographicTransformation | null | undefined;
85
85
 
@@ -96,7 +96,7 @@ export function getTransformation(inSpatialReference: SpatialReference, outSpati
96
96
  * >
97
97
  * > Grid-based datum transformations are not supported in the SDK.
98
98
  * > Geographic transformations are returned with their maximum number of [GeographicTransformation.steps](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/support/GeographicTransformation/#steps).
99
- * > Currently, number of steps is limited to 2.
99
+ * > Currently, the number of steps is limited to 2.
100
100
  *
101
101
  * @param inSpatialReference - The spatial reference that the geometries are currently using.
102
102
  * @param outSpatialReference - The spatial reference to which you are converting the geometries to.
@@ -128,7 +128,7 @@ export function getTransformation(inSpatialReference: SpatialReference, outSpati
128
128
  * await geographicTransformationUtils.load();
129
129
  * }
130
130
  *
131
- * const geogtrans = projection.getTransformations(cs1, cs2, extent);
131
+ * const geogtrans = geographicTransformationUtils.getTransformations(cs1, cs2, extent);
132
132
  * geogtrans.forEach((geogtran, index) => {
133
133
  * geogtran.steps.forEach((step, index) => {
134
134
  * console.log("step wkid: ", step.wkid);
@@ -17,7 +17,7 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
17
17
  *
18
18
  * @param leftGeometry - The first geometry to be XOR'd.
19
19
  * @param rightGeometry - The second geometry to be XOR'd.
20
- * @returns Returns the symmetric difference of the two geometries. The result has the higher of dimensions of the two geometries.
20
+ * @returns Returns the symmetric difference of the two geometries. The result has the higher dimension of the two geometries.
21
21
  * @since 5.2
22
22
  * @example
23
23
  * // Calculate the symmetric difference of two polygons.
@@ -33,7 +33,7 @@ export function symmetricDifferenceExecute(leftGeometry: GeometryUnion, rightGeo
33
33
  * with [symmetricDifferenceExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/symmetricDifferenceOperator/#symmetricDifferenceExecute).
34
34
  * @param leftGeometry - The first geometry to be XOR'd.
35
35
  * @param rightGeometry - The second geometry to be XOR'd.
36
- * @returns Returns the symmetric difference of the two geometries. The result has the higher of dimensions of the two geometries.
36
+ * @returns Returns the symmetric difference of the two geometries. The result has the higher dimension of the two geometries.
37
37
  * @example
38
38
  * // Calculate the symmetric difference of two polygons.
39
39
  * const differencePolygon = symmetricDifferenceExecute(polygon1, polygon2);