@vertigis/viewer-spec 43.5.0 → 45.1.0

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.",
@@ -2287,6 +2483,21 @@
             ],
             "type": "object"
         },
+        "StartStreamingArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"sketching.start-streaming\" command.",
+            "properties": {
+                "interval": {
+                    "description": "An optional value indicating, in seconds, how often points should be recorded.",
+                    "type": "number"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                }
+            },
+            "type": "object"
+        },
         "StopGeometryEditArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.stop\" operation.",
@@ -2681,9 +2892,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 +11809,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 +12958,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"
             ]
@@ -12755,6 +13020,18 @@
         "sketching.edit-geometry:output": {
             "$ref": "#/definitions/EditGeometryResult"
         },
+        "sketching.is-streaming": {
+            "description": "Checks whether streaming is active.",
+            "enum": [
+                "sketching.is-streaming"
+            ]
+        },
+        "sketching.is-streaming:input": {
+            "$ref": "#/definitions/HasMaps"
+        },
+        "sketching.is-streaming:output": {
+            "type": "boolean"
+        },
         "sketching.redo": {
             "description": "Redoes the last undone edit while editing a geometry.",
             "enum": [
@@ -12791,12 +13068,30 @@
         "sketching.set-point-at-current-location:input": {
             "$ref": "#/definitions/HasMaps"
         },
+        "sketching.start-streaming": {
+            "description": "Starts streaming: recording your location at regular intervals and adding the collected points to the currently active geometry editor.",
+            "enum": [
+                "sketching.start-streaming"
+            ]
+        },
+        "sketching.start-streaming:input": {
+            "$ref": "#/definitions/StartStreamingArgs"
+        },
         "sketching.stop": {
             "description": "Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, returns null.",
             "enum": [
                 "sketching.stop"
             ]
         },
+        "sketching.stop-streaming": {
+            "description": "Stops streaming.",
+            "enum": [
+                "sketching.stop-streaming"
+            ]
+        },
+        "sketching.stop-streaming:input": {
+            "$ref": "#/definitions/HasMaps"
+        },
         "sketching.stop:input": {
             "anyOf": [
                 {
@@ -14359,6 +14654,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.start-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.start-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.stop-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.stop-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -14877,6 +15204,12 @@
                 {
                     "$ref": "#/definitions/sketching.set-point-at-current-location"
                 },
+                {
+                    "$ref": "#/definitions/sketching.start-streaming"
+                },
+                {
+                    "$ref": "#/definitions/sketching.stop-streaming"
+                },
                 {
                     "$ref": "#/definitions/sketching.undo"
                 },
@@ -15015,6 +15348,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": {
@@ -15431,6 +15828,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.is-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.is-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15519,6 +15932,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"
                 },
@@ -15603,6 +16028,9 @@
                 {
                     "$ref": "#/definitions/sketching.edit-geometry"
                 },
+                {
+                    "$ref": "#/definitions/sketching.is-streaming"
+                },
                 {
                     "$ref": "#/definitions/sketching.stop"
                 },