@arcgis/core 5.0.0-next.55 → 5.0.0-next.57

package/geometry/operators/areaOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Returns the planar area of a 2D geometry.
+ *
+ * ![Area operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/area.png "Area operator")
+ *
+ * @since 4.31
+ */
 import type { AreaUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/autoCompleteOperator.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Fills the closed gaps between 2D polygons using polygon boundaries and polylines as the boundary for creating new polygons.
+ *
+ * @since 4.31
+ */
 import type Polygon from "../Polygon.js";
 import type Polyline from "../Polyline.js";
 

package/geometry/operators/boundaryOperator.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Calculates the topological boundary of a 2D geometry.
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/bufferOperator.d.ts

@@ -1,3 +1,14 @@
+/**
+ * Creates planar buffers around 2D geometries. A planar buffer calculates the area around a geometry using the straight line distance between points based on a flat, two-dimensional surface.
+ * This is suitable for rendering smaller areas within a projected coordinate system where the curvature of the Earth can be ignored, such as when all features are contained in one UTM zone.
+ * Planar buffers can introduce distortions and inaccuracies when applied over larger areas.
+ *
+ * ![Buffer operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/buffer.png "Buffer operator")
+ *
+ * @since 4.31
+ * @see [How Buffer (Analysis) works](https://pro.arcgis.com/en/pro-app/latest/tool-reference/analysis/how-buffer-analysis-works.htm)
+ * @see [Sample - Geometry operator - using a worker for analysis](https://developers.arcgis.com/javascript/latest/sample-code/geometry-operator-worker/)
+ */
 import type Polygon from "../Polygon.js";
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../support/typeUtils.js";

package/geometry/operators/centroidOperator.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Calculates the centroid for a 2D geometry. The centroid represents the geometric center of mass,
+ * where the mass is equally distributed at each point/vertex of the geometry.
+ * For example, the centroid of a straight line is the midpoint. The centroid of a point is the point itself.
+ * It is not guaranteed to be within or on the geometry. The centroid of a donut polygon is
+ * the center of the hole, which is outside the polygon. The centroid of a curved polyline is not located on the line itself, but will be some distance away from it.
+ *
+ * ![Centroid operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/centroid.png "Centroid operator")
+ *
+ * @since 4.31
+ * @see [labelPointOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-labelPointOperator.html)
+ * @see [Sample - Geometry operator - centroid analysis](https://developers.arcgis.com/javascript/latest/sample-code/geometry-operator-centroid/)
+ * @see [Centroid - wikipedia](https://en.wikipedia.org/wiki/Centroid)
+ */
 import type Point from "../Point.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/clipOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Clips geometries with a 2D extent.
+ *
+ * ![Clip operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/clip.png "Clip operator")
+ *
+ * @since 4.31
+ */
 import type Extent from "../Extent.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 

package/geometry/operators/containsOperator.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Performs a relational operation to determine if one 2D geometry contains another 2D geometry.
+ * Geometry A contains geometry B, when B is the intersection of A and B.
+ * A contains B is equivalent to B within A. Geometry B can be non-simple geometry.
+ *
+ * ![Contains operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/contains.png "Contains operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/convexHullOperator.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Calculates the convex hull of 2D geometries.
+ * A convex hull is the smallest convex polygon that encloses a group of geometries or vertices.
+ * The hull is typically a polygon but can also be a polyline or a point in degenerate cases.
+ *
+ * ![Convex hull operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/convexHull.png "Convex hull operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 export interface Options {

package/geometry/operators/crossesOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Performs a relational operation to determine if one 2D geometry crosses another 2D geometry.
+ *
+ * ![Crosses operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/crosses.png "Crosses operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/cutOperator.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Cut 2D geometries with a polyline.
+ *
+ * For polylines, all left cuts will be grouped together in the first
+ * geometry, right cuts and coincident cuts are grouped in the second geometry, and each undefined
+ * cut, along with any uncut parts, are output as separate polylines.
+ *
+ * For polygons, all left cuts are grouped in the first polygon, all right cuts are in the second
+ * polygon, and each undefined cut, along with any left-over parts after cutting, are output as a
+ * separate polygon. If there were no cuts then no geometry will be returned.
+ * If the left or right cut does not exist, the returned geometry will be empty for this type of cut.
+ * An undefined cut will only be produced if a left cut or right cut was produced, and there was a
+ * part left over after cutting or a cut is bounded to the left and right of the polyline that is used to cut.
+ *
+ * ![Cut operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/cut.png "Cut operator")
+ *
+ * @since 4.31
+ */
 import type Polyline from "../Polyline.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 

package/geometry/operators/densifyOperator.d.ts

@@ -1,3 +1,24 @@
+/**
+ * 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.
+ * The piecewise approximation of curves will be within the specified deviation from the original curve,
+ * and the angle between tangent segments does not exceed the specified value.
+ *
+ * If `maxAngleInDegrees` is not zero, vertices are added at points along the curve where the angle between tangent segments reaches this value.
+ * These vertices are then connected by straight-line segments.
+ *
+ * If `maxSegmentLength` is zero, only curves are affected and other geometries remain unchanged.
+ * The process always starts from the highest point on a segment, so equal segments will be densified in the same way.
+ *
+ * When the `maxSegmentLength`, `maxDeviation`, and `maxAngleInDegrees` parameters are all set to `0`,
+ * curves are replaced with the line segments connecting the curve endpoints.
+ *
+ * Suggestion: to limit the number of segments that are produced, if you have an area of interest such as a visible extent,
+ * clip the input geometries before densifying.
+ *
+ * ![Densify operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/densify.png "Densify operator")
+ *
+ * @since 4.31
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 

package/geometry/operators/differenceOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Performs a topological difference operation on 2D geometries.
+ *
+ * ![Difference operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/difference.png "Difference operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/disjointOperator.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Performs a relational operation to determine if one 2D geometry is disjoint (doesn't intersect in any way) with another 2D geometry.
+ * This operator can be used with non-simple geometries.
+ *
+ * ![Disjoint operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/disjoint.png "Disjoint operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/distanceOperator.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Calculates planar distance between 2D geometries.
+ *
+ * ![Distance operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/distance.png "Distance operator")
+ *
+ * @since 4.31
+ * @see [Blog - Geodesic or planar: which to use for distance analysis](https://www.esri.com/arcgis-blog/products/arcgis-pro/analytics/geodesic-or-planar-which-to-use-for-distance-analysis)
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/equalsOperator.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Performs a relational operation to determine if two 2D geometries are topologically equal.
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/extendOperator.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Extend 2D polylines with a polyline.
+ *
+ * By default, this considers both ends of parts. The old ends remain and new points are added at the extended ends.
+ * The new points have attributes that are extrapolated from adjacent existing segments.
+ *
+ * @since 4.31
+ */
 import type Polyline from "../Polyline.js";
 
 export interface Options {

package/geometry/operators/generalizeOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Generalizes 2D geometries using Douglas-Peucker algorithm.
+ *
+ * ![Generalize operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/generalize.png "Generalize operator")
+ *
+ * @since 4.31
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 

package/geometry/operators/geodesicBufferOperator.d.ts

@@ -1,3 +1,16 @@
+/**
+ * Geodesically buffer 2D geometries. A geodesic buffer creates an area around a geometry by calculating the shortest distance between points on the curved surface of the Earth, minimizing the distortion caused by map projections.
+ * This results in a more accurate buffer when applied over larger geographic areas such as those covering multiple UTM zones, or when using global scales.
+ *
+ * > [!WARNING]
+ * >
+ * > **Notes**
+ * > Verify that `isLoaded()` returns `true` before using this module.
+ * > Use `load()` to load this module's dependencies.
+ *
+ * @since 4.31
+ * @see [Sample - Geometry operator - geodesic buffers](https://developers.arcgis.com/javascript/latest/sample-code/gx-geodesicbuffer/)
+ */
 import type Polygon from "../Polygon.js";
 import type { LengthUnit } from "../../core/units.js";
 import type { GeodeticCurveType } from "./support/geodeticCurveType.js";

package/geometry/operators/geodesicProximityOperator.d.ts

@@ -1,3 +1,16 @@
+/**
+ * Finds closest vertices of a 2D geometry using geodesic distance.
+ *
+ * > [!WARNING]
+ * >
+ * > **Notes**
+ * > Verify that `isLoaded()` returns `true` before using this module.
+ * > Use `load()` to load this module's dependencies.
+ *
+ * ![Geodesic proximity operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/geodesicProximity.png "Geodesic proximity operator")
+ *
+ * @since 4.31
+ */
 import type Point from "../Point.js";
 import type * as proximityResult from "./support/proximityResult.js";
 import type { LengthUnit } from "../../core/units.js";

package/geometry/operators/geodeticAreaOperator.d.ts

@@ -1,3 +1,14 @@
+/**
+ * Returns the geodetic area of a 2D geometry.
+ *
+ * > [!WARNING]
+ * >
+ * > **Notes**
+ * > Verify that `isLoaded()` returns `true` before using this module.
+ * > Use `load()` to load this module's dependencies.
+ *
+ * @since 4.31
+ */
 import type { AreaUnit } from "../../core/units.js";
 import type { GeodeticCurveType } from "./support/geodeticCurveType.js";
 import type { GeometryUnion } from "../support/typeUtils.js";

package/geometry/operators/geodeticDensifyOperator.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Densifies line segments by length in a 2D plane, making them run along specified geodetic curves. There are no segments longer than the specified maximum segment length.
+ *
+ * > [!WARNING]
+ * >
+ * > **Notes**
+ * > If you have an area of interest such as a visible extent, clip the input geometries before densifying to limit the amount of segments produced.
+ * > Verify that `isLoaded()` returns `true` before using this module.
+ * > Use `load()` to load this module's dependencies.
+ *
+ * @since 4.31
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeodeticCurveType } from "./support/geodeticCurveType.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";

package/geometry/operators/geodeticDistanceOperator.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Calculates the shortest geodetic distance between two 2D geometries.
+ *
+ * > [!WARNING]
+ * >
+ * > **Notes**
+ * > Verify that `isLoaded()` returns `true` before using this module.
+ * > Use `load()` to load this module's dependencies.
+ *
+ * ![Geodetic distance operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/geodeticDistance.png "Geodetic distance operator")
+ *
+ * @since 4.31
+ * @see [Blog - Geodesic or planar: which to use for distance analysis](https://www.esri.com/arcgis-blog/products/arcgis-pro/analytics/geodesic-or-planar-which-to-use-for-distance-analysis)
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeodeticCurveType } from "./support/geodeticCurveType.js";
 import type { GeometryUnion } from "../support/typeUtils.js";

package/geometry/operators/geodeticLengthOperator.d.ts

@@ -1,3 +1,14 @@
+/**
+ * Returns the geodetic length of a 2D geometry.
+ *
+ * > [!WARNING]
+ * >
+ * > **Notes**
+ * > Verify that `isLoaded()` returns `true` before using this module.
+ * > Use `load()` to load this module's dependencies.
+ *
+ * @since 4.31
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeodeticCurveType } from "./support/geodeticCurveType.js";
 import type { GeometryUnion } from "../support/typeUtils.js";

package/geometry/operators/geodeticUtilsOperator.d.ts

@@ -1,3 +1,14 @@
+/**
+ * A set of utilities for working with geodetic calculations.
+ *
+ * > [!WARNING]
+ * >
+ * > **Notes**
+ * > Verify that `isLoaded()` returns `true` before using this module.
+ * > Use `load()` to load this module's dependencies.
+ *
+ * @since 4.34
+ */
 import type Point from "../Point.js";
 import type { LengthUnit } from "../../core/units.js";
 import type { GeodeticCurveType } from "./support/geodeticCurveType.js";

package/geometry/operators/graphicBufferOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Creates planar buffers around 2D geometries using graphical joins and caps.
+ *
+ * ![Graphic buffer operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/graphicBuffer.png "Graphic buffer operator")
+ *
+ * @since 4.31
+ */
 import type Polygon from "../Polygon.js";
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../support/typeUtils.js";

package/geometry/operators/integrateOperator.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Performs an Integration operation on a set of 2D geometries.
+ * This operator cleans up topological inconsistencies in the set.
+ * It inserts vertices where segments intersect other segments or points.
+ * It removes slivers and collapses close vertices.
+ * As a result of the operation, the geometries returned in the integrated set intersect only at vertices and there are no points that are closer than the spatial reference tolerance in the XY plane.
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/intersectionOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Create new geometries using the topological intersection of 2D geometries.
+ *
+ * ![Intersection operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/intersection.png "Intersection operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/intersectsOperator.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Performs a relational operation to determine if one 2D geometry intersects another 2D geometry.
+ * Intersect is same as not disjoint.
+ * This operator can be used with non-simple geometries.
+ *
+ * ![Intersects operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/intersects.png "Intersects operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/isNearOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Performs a 2D relational operation that checks if two geometries are near each other.
+ *
+ * ![isNear operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/isNear.png "isNear operator")
+ *
+ * @since 4.31
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/labelPointOperator.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Calculates a label point for the given 2D geometries. The point is guaranteed to be on the interior of the geometry.
+ * It can be used to place a label on a feature and help to ensure readability on the map.
+ *
+ * Based on the input geometry type, the label point is defined as follows:
+ * * Extent - the center of the extent.
+ * * Multipoint - the point which is closest to the center of the geometry's envelope.
+ * * Point - the point itself.
+ * * Polygon - a point near the centroid of the ring with greatest area.
+ * * Polyline - a vertex near the middle of the longest segment.
+ *
+ * @since 4.31
+ * @see [Sample - Geometry operator - centroid analysis](https://developers.arcgis.com/javascript/latest/sample-code/geometry-operator-centroid/)
+ */
 import type Point from "../Point.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/lengthOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Returns the planar length of a 2D geometry.
+ *
+ * ![Length operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/length.png "Length operator")
+ *
+ * @since 4.31
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/linesToPolygonsOperator.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Performs the topological operation of breaking the input set of 2D polygons and polylines into segments and rebuilding a new set of polygons from the non-intersecting areas.
+ *
+ * @since 4.31
+ */
 import type Polygon from "../Polygon.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/locateBetweenOperator.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Performs an OGC locate between operation on M values for the given 2D geometries.
+ * Calculates the geometry between given M values.
+ * This can also be used for locate along operations, which is a variation of locate between when the start and end M values are equal.
+ * This is a linear referencing operation. Polygons and extents are not supported.
+ *
+ * ![Locate between operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/locateBetween.png "Locate between operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/minimumBoundingCircleOperator.d.ts

@@ -1,3 +1,16 @@
+/**
+ * Create a minimum bounding circle for the input geometry.
+ * The output is a polygon with a single closed circular segment containing curves.
+ * Implements the Welzl's algorithm using greedy heuristic with expected O(n) time complexity.
+ *
+ * > [!WARNING]
+ * >
+ * > **Note**
+ * >
+ * > If curves are not needed, then [densify](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-densifyOperator.html) the output geometry.
+ *
+ * @since 4.31
+ */
 import type Polygon from "../Polygon.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/multiPartToSinglePartOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Convert multipart 2D geometries to single part geometries.
+ *
+ * ![Multipart to singlepart operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/multiPartToSinglePart.png "Multipart to singlepart operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 export interface Options {

package/geometry/operators/offsetOperator.d.ts

@@ -1,3 +1,47 @@
+/**
+ * Offset 2D geometries. The offset operation creates a geometry that is a constant distance from an input polyline or polygon.
+ * It is similar to buffering, but produces a one-sided result.
+ * Point and multipoint geometries are not supported.
+ *
+ * The offset distance can be positive or negative, and it will have the following effects based on the input geometry types. This is also dependent on the input polygon being [Esri simple](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-simplifyOGCOperator.html#isSimple).
+ *
+ * | Geometry type | positive offset | negative offset |
+ * |---|---|---|
+ * | Polyline | To the right | To the left |
+ * | Extent | Expands | Contracts |
+ * | Polygon exterior ring (Esri simple) | Expands exterior | Contracts exterior |
+ * | Polygon interior ring (Esri simple) | Contracts interior | Expands interior |
+ *
+ * If the input polygon is not simple, then the offset geometry will be produced to the right or left as though the ring were a polyline and dependent on the ring's orientation.
+ * For a simple polygon, the orientation of outer rings is clockwise and for inner rings it is counter clockwise. So the right side of a simple polygon is always its inside.
+ *
+ * The miter limit is multiplied by the offset distance and the result determines how far a mitered offset intersection can be from the input curve before it is beveled.
+ *
+ * ![Offset operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/offset.png "Offset operator")
+ *
+ * ### Join types
+ * The join type controls how corners in the offset geometry are represented.
+ * Inner corners are always mitered. The following join types are supported:
+ *
+ * * Round - a circular arc that is tangent to the ends of both offset line segments.
+ *
+ * ![Round joins](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/roundJoin.png "Round joins")
+ *
+ * * Miter - the offset line segments are extended to their intersection point forming a sharp angle, unless that extension exceeds the `miterLimit`, in which case the result is a bevel.
+ *
+ * ![Miter joins](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/miterDiagram.png "Miter joins")
+ *
+ * * Bevel - the offset line segments are not extended; their endpoints are joined by a straight line.
+ *
+ * ![Bevel joins](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/bevelJoin.png "Bevel joins")
+ *
+ * * Square - same as `miter` for minor arcs greater than 90 degrees. For all other minor arcs, the offset line segments are extended by an extra `distance` before their endpoints are joined.
+ *
+ * ![Square joins](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/squareDiagram.png "Square joins")
+ *
+ * @since 4.31
+ * @see ![Sample - Geometry operator - offset analysis](https://developers.arcgis.com/javascript/latest/sample-code/geometry-operator-offset-visualizer/)
+ */
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 

package/geometry/operators/overlapsOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Performs a relational operation to determine if two 2D geometries of the same dimension overlap.
+ *
+ * ![Overlaps operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/overlaps.png "Overlaps operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/polygonOverlayOperator.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Performs an overlay operation on a set of 2D polygons in the XY plane.
+ * This operation produces similar results to the Union tool in Geoprocessing.
+ *
+ * @since 4.31
+ */
 import type Polygon from "../Polygon.js";
 
 export interface Options {

package/geometry/operators/polygonSlicerOperator.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Performs a topological operation for slicing a 2D polygon into smaller polygons.
+ *
+ * @since 4.31
+ */
 import type Polygon from "../Polygon.js";
 import type Transformation from "./support/Transformation.js";
 import type { AreaUnit } from "../../core/units.js";

package/geometry/operators/projectOperator.d.ts

@@ -1,3 +1,44 @@
+/**
+ * Projects geometries (with or without Z/elevation data) from one [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) to another.
+ * You can specify a geographic (datum) transformation for this operation, accept the default transformation if one is needed, or set the area of interest.
+ *
+ * Projecting your data between coordinate systems sometimes requires transforming
+ * between geographic coordinate systems. Geographic transformations are used
+ * to transform coordinates between spatial references that have different geographic
+ * coordinate systems, and thus different datums.
+ * Using the most suitable transformation ensures the best possible accuracy when
+ * converting geometries from one spatial reference to another.
+ *
+ * The [geographicTransformationUtils](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-support-geographicTransformationUtils.html) module provides methods which
+ * return the default geographic transformation for the given projection or a list of suitable geographic
+ * transformations.
+ *
+ * The operator supports limited Z value conversion when the units of the spatial references are different
+ * (for example when projecting from NAD83 to WGS84). Full vertical coordinate projection is not available and the
+ * operator will throw an exception if the input and output have different vertical coordinate systems.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > This operator currently only supports [equation-based geographic transformations](https://pro.arcgis.com/en/pro-app/latest/help/mapping/properties/geographic-coordinate-system-transformation.htm).
+ * > The result geometry is not guaranteed to be simple. Apply the [simplifyOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-simplifyOperator.html) to ensure the result is topologically simple.
+ * > Projecting an Extent may return an Extent with a larger area than the input.
+ * > Vertical coordinate system projections are not supported.
+ *
+ * > [!WARNING]
+ * >
+ * > **Notes**
+ * >
+ * > Verify that `isLoaded()` returns `true` before using this module.
+ * > Use `load()` to load this module's dependencies.
+ *
+ * @since 4.32
+ * @see [Spatial References](https://developers.arcgis.com/documentation/spatial-references/)
+ * @see [Coordinate systems, map projections, and transformations](https://pro.arcgis.com/en/pro-app/latest/help/mapping/properties/coordinate-systems-and-projections.htm)
+ * @see [Geographic datum transformations](https://pro.arcgis.com/en/pro-app/latest/help/mapping/properties/geographic-coordinate-system-transformation.htm)
+ * @see [Sample - Client-side projection](https://developers.arcgis.com/javascript/latest/sample-code/client-projection/)
+ */
 import type SpatialReference from "../SpatialReference.js";
 import type { Options as ProjectionTransformationOptions } from "./support/projectionTransformation.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";