@vertigis/viewer-spec 43.5.0 → 43.6.0

package/messaging/registry/geometry.d.ts

@@ -1,4 +1,7 @@
 import type Geometry from "@arcgis/core/geometry/Geometry";
+import type Point from "@arcgis/core/geometry/Point";
+import type Polygon from "@arcgis/core/geometry/Polygon";
+import type Polyline from "@arcgis/core/geometry/Polyline";
 import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
 import type GeographicTransformation from "@arcgis/core/geometry/support/GeographicTransformation";
 import type { Command } from "../Command.js";
@@ -29,6 +32,10 @@ export interface ProjectArgs {
  * The units for distance buffers supported by ArcGIS.
  */
 export declare type LengthUnits = "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards";
+/**
+ * The units for distance supported by Mobile.
+ */
+export declare type LengthUnitsMobile = LengthUnits | "millimeters" | "centimeters" | "inches" | "mm" | "cm" | "m" | "km" | "in" | "ft" | "yd" | "mi" | "nm";
 /**
  * The result of a geometry.buffer operation.
  */
@@ -42,6 +49,142 @@ export interface BufferResult {
      */
     maps?: MapsLike;
 }
+/**
+ * Arguments for the geometry.add-point operation.
+ */
+export interface AddPointArgs {
+    /**
+     * The starting geometry.
+     */
+    geometry: Polyline | Polygon;
+    /**
+     * The index of the part to which the point will be added.
+     * If null, the last part will be used.
+     */
+    partIndex?: number;
+    /**
+     * The index at which the point will be added.
+     * If null, the point will be added as the last point.
+     */
+    pointIndex?: number;
+    /**
+     * The new point to be added to 'geometry'. The spatial reference must
+     * match 'geometry' or an error will be thrown.
+     */
+    newPoint: Point;
+}
+/**
+ * Arguments for the geometry.add-part operation.
+ */
+export interface AddPartArgs {
+    /**
+     * The starting geometry.
+     */
+    geometry: Polyline | Polygon;
+    /**
+     * The new part to be added to 'geometry'.
+     */
+    part: Point[];
+}
+/**
+ * A reference line used by the geometry.get-point operation.
+ */
+export interface ReferenceLine {
+    /**
+     * The geometry that contains the reference line.
+     */
+    geometry: Polyline | Polygon;
+    /**
+     * The index of the part in 'geometry' that contains the reference line.
+     * If null, the last part will be used.
+     */
+    partIndex?: number;
+    /**
+     * The index of the segment that will be used as the reference line.
+     * If null, the last segment will be used.
+     */
+    segmentIndex?: number;
+}
+/**
+ * The different types of curves that can be used for geodetic distance
+ * calculations.
+ */
+export declare type GeodeticCurveType = "geodesic" | "loxodrome" | "normal-section" | "great-elliptic";
+/**
+ * Arguments for the geometry.calculate-point operation.
+ */
+export interface CalculatePointArgs {
+    /**
+     * The units to be used for 'distance' and 'offset'.
+     * Defaults to the default units of the map.
+     */
+    units: LengthUnitsMobile;
+    /**
+     * The reference line that will be used to calculate the new point.
+     */
+    referenceLine: ReferenceLine;
+    /**
+     * The distance that will be used to calculate the new point.
+     *
+     * If using 'offset', this indicates the distance along
+     * the reference line.
+     *
+     * If using 'angle', this indicates the distance directly
+     * from the new point to the start point of the reference line.
+     *
+     * Cannot be negative.
+     */
+    distance: number;
+    /**
+     * The offset that will be used to calculate the new point.
+     * The 'offset' corresponds to the distance perpendicularly away from the
+     * reference line.
+     *
+     * Positive values will result in a point to the right of the reference
+     * line, negative values will be to the left.
+     *
+     * Exactly one of 'offset' and 'angle' must be set.
+     */
+    offset?: number;
+    /**
+     * The angle, relative to the angle of the reference line, that
+     * will be used to calculate the new point. Positive angles are
+     * calculated clockwise from the angle of the reference line,
+     * negative angles are calculated counter-clockwise.
+     *
+     * Exactly one of 'offset' and 'angle' must be set.
+     */
+    angle?: number;
+    /**
+     * Gets or sets a value indicating whether the distance calculations will
+     * be geodetic or planar. Defaults to true.
+     */
+    geodetic?: boolean;
+    /**
+     * Gets or sets the geodetic curve type used when calculating the new point.
+     * Only applies when 'geodetic' is true. Defaults to 'geodesic'.
+     */
+    geodeticCurveType: GeodeticCurveType;
+}
+/**
+ * Arguments for the geometry.remove-point operation.
+ */
+export interface RemovePointArgs {
+    /**
+     * The starting geometry.
+     */
+    geometry: Polyline | Polygon;
+    /**
+     * The index of the part from which the point will be removed.
+     * If null, the last part will be used.
+     */
+    partIndex?: number;
+    /**
+     * The index of the point to be removed.
+     * If null, the last point wil be removed.
+     */
+    pointIndex?: number;
+}
 export declare class GeometryOperations extends OperationRegistry {
     /**
      * Projects a set of geometries to a new spatial reference.
@@ -76,6 +219,30 @@ export declare class GeometryOperations extends OperationRegistry {
      * @webOnly
      */
     get getBufferUnits(): Operation<void, LengthUnits>;
+    /**
+     * Adds a point to a given geometry.
+     *
+     * @mobileOnly
+     */
+    get addPoint(): Operation<AddPointArgs, Geometry>;
+    /**
+     * Adds a part to a given geometry.
+     *
+     * @mobileOnly
+     */
+    get addPart(): Operation<AddPartArgs, Geometry>;
+    /**
+     * Calculates a point relative to a given reference line.
+     *
+     * @mobileOnly
+     */
+    get calculatePoint(): Operation<CalculatePointArgs, Point>;
+    /**
+     * Removes a point from a given geometry.
+     *
+     * @mobileOnly
+     */
+    get removePoint(): Operation<RemovePointArgs, Geometry>;
 }
 export declare class GeometryCommands extends CommandRegistry {
     /**

package/messaging/registry/geometry.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class GeometryOperations extends OperationRegistry{get project(){return this._messages.operation("geometry.project")}get addPixelTolerance(){return this._messages.operation("geometry.add-pixel-tolerance")}get buffer(){return this._messages.operation("geometry.buffer")}get getBufferDistance(){return this._messages.operation("geometry.get-buffer-distance")}get getBufferUnits(){return this._messages.operation("geometry.get-buffer-units")}}export class GeometryCommands extends CommandRegistry{get setBufferDistance(){return this._messages.command("geometry.set-buffer-distance")}get setBufferUnits(){return this._messages.command("geometry.set-buffer-units")}get showSettings(){return this._messages.command("geometry.show-settings")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class GeometryOperations extends OperationRegistry{get project(){return this._messages.operation("geometry.project")}get addPixelTolerance(){return this._messages.operation("geometry.add-pixel-tolerance")}get buffer(){return this._messages.operation("geometry.buffer")}get getBufferDistance(){return this._messages.operation("geometry.get-buffer-distance")}get getBufferUnits(){return this._messages.operation("geometry.get-buffer-units")}get addPoint(){return this._messages.operation("geometry.add-point")}get addPart(){return this._messages.operation("geometry.add-part")}get calculatePoint(){return this._messages.operation("geometry.calculate-point")}get removePoint(){return this._messages.operation("geometry.remove-point")}}export class GeometryCommands extends CommandRegistry{get setBufferDistance(){return this._messages.command("geometry.set-buffer-distance")}get setBufferUnits(){return this._messages.command("geometry.set-buffer-units")}get showSettings(){return this._messages.command("geometry.show-settings")}}

package/messaging/registry/sketching.d.ts

@@ -456,6 +456,8 @@ export declare class SketchingOperations extends OperationRegistry {
     /**
      * Adds a point to a given polyline or polygon geometry. Returns the
      * resulting geometry.
+     *
+     * Deprecated in Mobile, use geometry.add-point instead.
      */
     get addNodeToGeometry(): Operation<AddNodeToGeometryArgs, Geometry>;
     /**

package/messaging/schema/common-action.schema.json

@@ -11124,7 +11124,7 @@
             ]
         },
         "sketching.add-node-to-geometry": {
-            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry.",
+            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry. Deprecated in Mobile, use geometry.add-point instead.",
             "enum": [
                 "sketching.add-node-to-geometry"
             ]

package/messaging/schema/mobile-action.schema.json

@@ -506,6 +506,69 @@
             ],
             "type": "object"
         },
+        "AddPartArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the geometry.add-part operation.",
+            "properties": {
+                "geometry": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/esri.Polygon"
+                        },
+                        {
+                            "$ref": "#/definitions/esri.Polyline"
+                        }
+                    ],
+                    "description": "The starting geometry."
+                },
+                "part": {
+                    "description": "The new part to be added to 'geometry'.",
+                    "items": {
+                        "$ref": "#/definitions/esri.Point"
+                    },
+                    "type": "array"
+                }
+            },
+            "required": [
+                "geometry",
+                "part"
+            ],
+            "type": "object"
+        },
+        "AddPointArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the geometry.add-point operation.",
+            "properties": {
+                "geometry": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/esri.Polygon"
+                        },
+                        {
+                            "$ref": "#/definitions/esri.Polyline"
+                        }
+                    ],
+                    "description": "The starting geometry."
+                },
+                "newPoint": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "The new point to be added to 'geometry'. The spatial reference must match 'geometry' or an error will be thrown."
+                },
+                "partIndex": {
+                    "description": "The index of the part to which the point will be added. If null, the last part will be used.",
+                    "type": "number"
+                },
+                "pointIndex": {
+                    "description": "The index at which the point will be added. If null, the point will be added as the last point.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "geometry",
+                "newPoint"
+            ],
+            "type": "object"
+        },
         "AlertCommandArgs": {
             "additionalProperties": false,
             "description": "Arguments for the 'ui.alert' command.",
@@ -549,6 +612,47 @@
             ],
             "type": "object"
         },
+        "CalculatePointArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the geometry.calculate-point operation.",
+            "properties": {
+                "angle": {
+                    "description": "The angle, relative to the angle of the reference line, that will be used to calculate the new point. Positive angles are calculated clockwise from the angle of the reference line, negative angles are calculated counter-clockwise. Exactly one of 'offset' and 'angle' must be set.",
+                    "type": "number"
+                },
+                "distance": {
+                    "description": "The distance that will be used to calculate the new point. If using 'offset', this indicates the distance along the reference line. If using 'angle', this indicates the distance directly from the new point to the start point of the reference line. Cannot be negative.",
+                    "type": "number"
+                },
+                "geodetic": {
+                    "description": "Gets or sets a value indicating whether the distance calculations will be geodetic or planar. Defaults to true.",
+                    "type": "boolean"
+                },
+                "geodeticCurveType": {
+                    "$ref": "#/definitions/GeodeticCurveType",
+                    "description": "Gets or sets the geodetic curve type used when calculating the new point. Only applies when 'geodetic' is true. Defaults to 'geodesic'."
+                },
+                "offset": {
+                    "description": "The offset that will be used to calculate the new point. The 'offset' corresponds to the distance perpendicularly away from the reference line. Positive values will result in a point to the right of the reference line, negative values will be to the left. Exactly one of 'offset' and 'angle' must be set.",
+                    "type": "number"
+                },
+                "referenceLine": {
+                    "$ref": "#/definitions/ReferenceLine",
+                    "description": "The reference line that will be used to calculate the new point."
+                },
+                "units": {
+                    "$ref": "#/definitions/LengthUnitsMobile",
+                    "description": "The units to be used for 'distance' and 'offset'. Defaults to the default units of the map."
+                }
+            },
+            "required": [
+                "distance",
+                "geodeticCurveType",
+                "referenceLine",
+                "units"
+            ],
+            "type": "object"
+        },
         "CaptureGeometryArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.capture-geometry\" operation.",
@@ -1185,6 +1289,16 @@
             ],
             "type": "object"
         },
+        "GeodeticCurveType": {
+            "description": "The different types of curves that can be used for geodetic distance calculations.",
+            "enum": [
+                "geodesic",
+                "great-elliptic",
+                "loxodrome",
+                "normal-section"
+            ],
+            "type": "string"
+        },
         "GeolocateCurrentState": {
             "additionalProperties": false,
             "description": "Result for the \"geolocation.get-current-state\" operation.",
@@ -1592,6 +1706,30 @@
             ],
             "type": "object"
         },
+        "LengthUnitsMobile": {
+            "description": "The units for distance supported by Mobile.",
+            "enum": [
+                "centimeters",
+                "cm",
+                "feet",
+                "ft",
+                "in",
+                "inches",
+                "kilometers",
+                "km",
+                "m",
+                "meters",
+                "mi",
+                "miles",
+                "millimeters",
+                "mm",
+                "nautical-miles",
+                "nm",
+                "yards",
+                "yd"
+            ],
+            "type": "string"
+        },
         "MapExtensionArgs": {
             "additionalProperties": false,
             "description": "One or more map extensions.",
@@ -1850,6 +1988,64 @@
             ],
             "type": "object"
         },
+        "ReferenceLine": {
+            "additionalProperties": false,
+            "description": "A reference line used by the geometry.get-point operation.",
+            "properties": {
+                "geometry": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/esri.Polygon"
+                        },
+                        {
+                            "$ref": "#/definitions/esri.Polyline"
+                        }
+                    ],
+                    "description": "The geometry that contains the reference line."
+                },
+                "partIndex": {
+                    "description": "The index of the part in 'geometry' that contains the reference line. If null, the last part will be used.",
+                    "type": "number"
+                },
+                "segmentIndex": {
+                    "description": "The index of the segment that will be used as the reference line. If null, the last segment will be used.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "geometry"
+            ],
+            "type": "object"
+        },
+        "RemovePointArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the geometry.remove-point operation.",
+            "properties": {
+                "geometry": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/esri.Polygon"
+                        },
+                        {
+                            "$ref": "#/definitions/esri.Polyline"
+                        }
+                    ],
+                    "description": "The starting geometry."
+                },
+                "partIndex": {
+                    "description": "The index of the part from which the point will be removed. If null, the last part will be used.",
+                    "type": "number"
+                },
+                "pointIndex": {
+                    "description": "The index of the point to be removed. If null, the last point wil be removed.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "geometry"
+            ],
+            "type": "object"
+        },
         "ReplaceMapArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"map.replace*\" operations.",
@@ -2681,9 +2877,15 @@
         "esri.PointSymbol3D": {
             "$ref": "esri/symbols/PointSymbol3D"
         },
+        "esri.Polygon": {
+            "$ref": "esri/geometry/Polygon"
+        },
         "esri.PolygonSymbol3D": {
             "$ref": "esri/symbols/PolygonSymbol3D"
         },
+        "esri.Polyline": {
+            "$ref": "esri/geometry/Polyline"
+        },
         "esri.PopupTemplate": {
             "$ref": "esri/PopupTemplate"
         },
@@ -11592,6 +11794,54 @@
                 }
             ]
         },
+        "geometry.add-part": {
+            "description": "Adds a part to a given geometry.",
+            "enum": [
+                "geometry.add-part"
+            ]
+        },
+        "geometry.add-part:input": {
+            "$ref": "#/definitions/AddPartArgs"
+        },
+        "geometry.add-part:output": {
+            "$ref": "#/definitions/esri.Geometry"
+        },
+        "geometry.add-point": {
+            "description": "Adds a point to a given geometry.",
+            "enum": [
+                "geometry.add-point"
+            ]
+        },
+        "geometry.add-point:input": {
+            "$ref": "#/definitions/AddPointArgs"
+        },
+        "geometry.add-point:output": {
+            "$ref": "#/definitions/esri.Geometry"
+        },
+        "geometry.calculate-point": {
+            "description": "Calculates a point relative to a given reference line.",
+            "enum": [
+                "geometry.calculate-point"
+            ]
+        },
+        "geometry.calculate-point:input": {
+            "$ref": "#/definitions/CalculatePointArgs"
+        },
+        "geometry.calculate-point:output": {
+            "$ref": "#/definitions/esri.Point"
+        },
+        "geometry.remove-point": {
+            "description": "Removes a point from a given geometry.",
+            "enum": [
+                "geometry.remove-point"
+            ]
+        },
+        "geometry.remove-point:input": {
+            "$ref": "#/definitions/RemovePointArgs"
+        },
+        "geometry.remove-point:output": {
+            "$ref": "#/definitions/esri.Geometry"
+        },
         "highlights.add": {
             "description": "Applies highlighting to one or more features.",
             "enum": [
@@ -12693,7 +12943,7 @@
             "type": "string"
         },
         "sketching.add-node-to-geometry": {
-            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry.",
+            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry. Deprecated in Mobile, use geometry.add-point instead.",
             "enum": [
                 "sketching.add-node-to-geometry"
             ]
@@ -15015,6 +15265,70 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geometry.add-part:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geometry.add-part"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geometry.add-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geometry.add-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geometry.calculate-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geometry.calculate-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geometry.remove-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geometry.remove-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15519,6 +15833,18 @@
                 {
                     "$ref": "#/definitions/geolocation.get-position"
                 },
+                {
+                    "$ref": "#/definitions/geometry.add-part"
+                },
+                {
+                    "$ref": "#/definitions/geometry.add-point"
+                },
+                {
+                    "$ref": "#/definitions/geometry.calculate-point"
+                },
+                {
+                    "$ref": "#/definitions/geometry.remove-point"
+                },
                 {
                     "$ref": "#/definitions/map.export-image"
                 },

package/messaging/schema/web-action.schema.json

@@ -16543,7 +16543,7 @@
             ]
         },
         "sketching.add-node-to-geometry": {
-            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry.",
+            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry. Deprecated in Mobile, use geometry.add-point instead.",
             "enum": [
                 "sketching.add-node-to-geometry"
             ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "43.5.0",
+  "version": "43.6.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export declare const version = "43.5.0";
+export declare const version = "43.6.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export const version = "43.5.0";
+export const version = "43.6.0";