@vertigis/viewer-spec 61.14.0 → 61.15.0

package/messaging/schema/web-drawing-operation-definitions.md

@@ -5,7 +5,7 @@ In Web, creates graphics out of GeometryLike or CreateGraphicsArgs, with the cur
 
 In Mobile, creates graphics from the given CreateGraphicsArgs or CreateGraphicsArgs[] (or some GeometryLike args). Any provided symbol parameter is used, otherwise a default symbol is used.
 
-Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | CreateGraphicsResult | @arcgis.core.Graphic.Graphic | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | @arcgis.core.geometry.Extent.Extent | @arcgis.core.geometry.Multipoint.Multipoint | @arcgis.core.geometry.Point.Point | @arcgis.core.geometry.Polyline.Polyline | @arcgis.core.geometry.Mesh.Mesh | esri.rest-api.FeatureJson.FeatureJson | @arcgis.core.rest.support.FeatureSet.FeatureSet | ( @arcgis.core.Graphic.Graphic | esri.rest-api.FeatureJson.FeatureJson )[] | esri.rest-api.GeometryJson.PointJson | esri.rest-api.GeometryJson.MultipointJson | esri.rest-api.GeometryJson.PolylineJson | esri.rest-api.GeometryJson.PolygonJson | esri.rest-api.GeometryJson.ExtentJson | ( @arcgis.core.geometry.Extent.Extent | @arcgis.core.geometry.Multipoint.Multipoint | @arcgis.core.geometry.Point.Point | @arcgis.core.geometry.Polyline.Polyline | @arcgis.core.geometry.Mesh.Mesh | esri.rest-api.GeometryJson.PointJson | esri.rest-api.GeometryJson.MultipointJson | esri.rest-api.GeometryJson.PolylineJson | esri.rest-api.GeometryJson.PolygonJson | esri.rest-api.GeometryJson.ExtentJson )[] | CreateGraphicsArgs | CreateGraphicsArgs[] )`
+Inputs: `( CreateGraphicsResult | @arcgis.core.Graphic.Graphic | @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | @arcgis.core.geometry.Extent.Extent | @arcgis.core.geometry.Multipoint.Multipoint | @arcgis.core.geometry.Point.Point | @arcgis.core.geometry.Polyline.Polyline | @arcgis.core.geometry.Mesh.Mesh | esri.rest-api.FeatureJson.FeatureJson | @arcgis.core.rest.support.FeatureSet.FeatureSet | ( @arcgis.core.Graphic.Graphic | esri.rest-api.FeatureJson.FeatureJson )[] | esri.rest-api.GeometryJson.PointJson | esri.rest-api.GeometryJson.MultipointJson | esri.rest-api.GeometryJson.PolylineJson | esri.rest-api.GeometryJson.PolygonJson | esri.rest-api.GeometryJson.ExtentJson | ( @arcgis.core.geometry.Extent.Extent | @arcgis.core.geometry.Multipoint.Multipoint | @arcgis.core.geometry.Point.Point | @arcgis.core.geometry.Polyline.Polyline | @arcgis.core.geometry.Mesh.Mesh | esri.rest-api.GeometryJson.PointJson | esri.rest-api.GeometryJson.MultipointJson | esri.rest-api.GeometryJson.PolylineJson | esri.rest-api.GeometryJson.PolygonJson | esri.rest-api.GeometryJson.ExtentJson )[] | CreateGraphicsArgs | CreateGraphicsArgs[] )`
 
 CreateGraphicsResult properties:
 ```json
@@ -29,15 +29,98 @@ esri.rest-api.FeatureJson.FeatureJson properties:
 ```json
 {
   "attributes": {
+    "anyOf": [
+      {
+        "description": "Construct a type with a set of properties K of type T"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The feature attributes. It is a JSON object that contains a dictionary of name-value pairs. The names are the feature field names. The values are the field values and they can be any of the standard JSON types - string, number and boolean. Note that date values are encoded as numbers. The number represents the number of milliseconds since epoch (January 1,\n1970) in UTC."
   },
   "geometry": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.PointJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.MultipointJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.PolylineJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.PolygonJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.GeometryJson.ExtentJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The feature geometry."
   },
   "popupInfo": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "A popupInfo object defining the content of popup window when you click a feature on the map. Applicable to features in a map notes feature layer only."
   },
   "symbol": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.LabelSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.MeshSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.StyleSymbolReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Symbol used for drawing the feature."
   }
 }
@@ -48,14 +131,26 @@ esri.rest-api.GeometryJson.PointJson properties:
 {
   "m": {
     "description": "M coordinate which contains measures used for linear referencing.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   },
   "x": {
     "description": "X coordinate which is measured along the east/west axis.",
     "type": [
+      "null",
       "string",
       "number"
     ],
@@ -64,6 +159,7 @@ esri.rest-api.GeometryJson.PointJson properties:
   "y": {
     "description": "Y coordinate which is measured along the north/south axis.",
     "type": [
+      "null",
       "string",
       "number"
     ],
@@ -72,6 +168,7 @@ esri.rest-api.GeometryJson.PointJson properties:
   "z": {
     "description": "Z coordinate which measures height or elevation.",
     "type": [
+      "null",
       "string",
       "number"
     ]
@@ -84,11 +181,17 @@ esri.rest-api.GeometryJson.MultipointJson properties:
 {
   "hasM": {
     "description": "Indicates whether the geometry contains M coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "hasZ": {
     "description": "Indicates whether the geometry contains Z coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "points": {
     "description": "An array that corresponds to 2D and 3D points.",
@@ -102,6 +205,14 @@ esri.rest-api.GeometryJson.MultipointJson properties:
     "isRequired": "true"
   },
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   }
 }
@@ -112,11 +223,17 @@ esri.rest-api.GeometryJson.PolylineJson properties:
 {
   "hasM": {
     "description": "Indicates whether the geometry contains M coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "hasZ": {
     "description": "Indicates whether the geometry contains Z coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "paths": {
     "description": "Three nested arrays which corresponds to a polyline.",
@@ -133,6 +250,14 @@ esri.rest-api.GeometryJson.PolylineJson properties:
     "isRequired": "true"
   },
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   }
 }
@@ -143,11 +268,17 @@ esri.rest-api.GeometryJson.PolygonJson properties:
 {
   "hasM": {
     "description": "Indicates whether the geometry contains M coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "hasZ": {
     "description": "Indicates whether the geometry contains Z coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "rings": {
     "description": "Represents an array of points. Each point is an array of numbers.",
@@ -164,6 +295,14 @@ esri.rest-api.GeometryJson.PolygonJson properties:
     "isRequired": "true"
   },
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   }
 }
@@ -173,23 +312,43 @@ esri.rest-api.GeometryJson.ExtentJson properties:
 ```json
 {
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   },
   "xmax": {
     "description": "A numeric value indicating the top-right X-coordinate of an extent envelope.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "xmin": {
     "description": "A numeric value indicating the bottom-left X-coordinate of an extent envelope.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "ymax": {
     "description": "A numeric value indicating the top-right Y-coordinate of an extent envelope.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "ymin": {
     "description": "A numeric value indicating the bottom-left Y-coordinate of an extent envelope.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   }
 }
 ```
@@ -199,14 +358,26 @@ esri.rest-api.GeometryJson.PointJson properties:
 {
   "m": {
     "description": "M coordinate which contains measures used for linear referencing.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   },
   "x": {
     "description": "X coordinate which is measured along the east/west axis.",
     "type": [
+      "null",
       "string",
       "number"
     ],
@@ -215,6 +386,7 @@ esri.rest-api.GeometryJson.PointJson properties:
   "y": {
     "description": "Y coordinate which is measured along the north/south axis.",
     "type": [
+      "null",
       "string",
       "number"
     ],
@@ -223,6 +395,7 @@ esri.rest-api.GeometryJson.PointJson properties:
   "z": {
     "description": "Z coordinate which measures height or elevation.",
     "type": [
+      "null",
       "string",
       "number"
     ]
@@ -235,11 +408,17 @@ esri.rest-api.GeometryJson.MultipointJson properties:
 {
   "hasM": {
     "description": "Indicates whether the geometry contains M coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "hasZ": {
     "description": "Indicates whether the geometry contains Z coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "points": {
     "description": "An array that corresponds to 2D and 3D points.",
@@ -253,6 +432,14 @@ esri.rest-api.GeometryJson.MultipointJson properties:
     "isRequired": "true"
   },
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   }
 }
@@ -263,11 +450,17 @@ esri.rest-api.GeometryJson.PolylineJson properties:
 {
   "hasM": {
     "description": "Indicates whether the geometry contains M coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "hasZ": {
     "description": "Indicates whether the geometry contains Z coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "paths": {
     "description": "Three nested arrays which corresponds to a polyline.",
@@ -284,6 +477,14 @@ esri.rest-api.GeometryJson.PolylineJson properties:
     "isRequired": "true"
   },
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   }
 }
@@ -294,11 +495,17 @@ esri.rest-api.GeometryJson.PolygonJson properties:
 {
   "hasM": {
     "description": "Indicates whether the geometry contains M coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "hasZ": {
     "description": "Indicates whether the geometry contains Z coordinate values.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "rings": {
     "description": "Represents an array of points. Each point is an array of numbers.",
@@ -315,6 +522,14 @@ esri.rest-api.GeometryJson.PolygonJson properties:
     "isRequired": "true"
   },
   "spatialReference": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SpatialReferenceJson.SpatialReferenceJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
   }
 }
@@ -334,6 +549,9 @@ CreateGraphicsArgs properties:
       {
         "$ref": "#/definitions/@arcgis.core.Graphic.Graphic"
       },
+      {
+        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+      },
       {
         "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
       },
@@ -348,6 +566,9 @@ CreateGraphicsArgs properties:
           "anyOf": [
             {
               "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
+            },
+            {
+              "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
             }
           ]
         },
@@ -560,6 +781,14 @@ EditSymbolArgs properties:
     "description": "Map(s) to use for the command/operation."
   },
   "parent": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/Model"
+      },
+      {
+        "type": "string"
+      }
+    ],
     "description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
   },
   "showOnlySymbolPresets": {
@@ -675,7 +904,16 @@ Outputs: `EditSymbolResult`
 # operation: drawing.get-default-symbol
 Description: Gets the value of the default point, line, or polygon symbol for the provided geometry type. Web only.
 
-Inputs: `None`
+Inputs: `( GetDefaultSymbolArgs | "extent" | "mesh" | "multipatch" | "multipoint" | "point" | "polygon" | "polyline" )`
+
+GetDefaultSymbolArgs properties:
+```json
+{
+  "geometryType": {
+    "description": "The geometry type for the default symbol to retrieve."
+  }
+}
+```
 
 Outputs: `DrawingSymbolConfig`
 
@@ -683,7 +921,16 @@ Outputs: `DrawingSymbolConfig`
 # operation: drawing.get-default-symbol3-d
 Description: Gets the value of the default 3D point, line, or polygon symbol for the provided geometry type. Web only.
 
-Inputs: `None`
+Inputs: `( GetDefaultSymbolArgs | "extent" | "mesh" | "multipatch" | "multipoint" | "point" | "polygon" | "polyline" )`
+
+GetDefaultSymbolArgs properties:
+```json
+{
+  "geometryType": {
+    "description": "The geometry type for the default symbol to retrieve."
+  }
+}
+```
 
 Outputs: `DrawingSymbolConfig`
 

package/messaging/schema/web-edit-command-definitions.md

@@ -303,11 +303,11 @@ DisplayAddFeatureArgs properties:
 # command: edit.display-add-related-feature
 Description: Begin an interactive feature editing session for a new related feature. The specified feature will be the original feature that the new related feature will be added to in the relationship.
 
-**Example:** Create and edit a new record on a related table, with the option to add attachments. Make sure the 'COMMENTS' field is included in the editable attributes and make it required.
+**Example (Web):** Create and edit a new record on a related table, with the option to add attachments. Make sure the 'COMMENTS' field is included in the editable attributes and make it required.
 
 _Notes:_.
 
-1. The feature used here must come from the running viewer, and cannot be an    ad-hoc feature created from a JSON object. For example, you can use    the output of `results.get-active-features`, or the feature provided    in a command chain context.
+1. The feature used here must come from the running viewer, and cannot be an    ad-hoc feature created from a JSON object. For example, you can use    the output of `results.get-active-features` (Web only), or the feature    provided in a command chain context.
 2. `editableExpression` and `requiredExpression` both take an Arcade    expression, and here the string "true" is just a simple Arcade    expression that always returns true. You can also use a more complex    expression, or reference one from your webmap.
 
 ```
@@ -325,7 +325,27 @@ _Notes:_.
 }
 ```
 
-Inputs: `DisplayAddRelatedFeatureArgs`
+**Example (Mobile):** Create and edit a new record on a feature.
+
+_Notes:_.
+
+1. The feature used here must come from the running viewer, and cannot be an
+   ad-hoc feature created from a JSON object. For example, the feature
+   provided to a Workflow from a Feature Action context (as in this
+   example), or from a query.
+2. The relatedFeatureSource in this example is a table passed in to the
+   Workflow as an input like so: `{ "tableSource":
+   "item://table-extension/your-table-extension-id" }`
+
+```
+{
+    "feature": $getWorkflowInputs.inputs.context[0]
+    "relationshipId": "1",
+    "relatedFeatureSource": $getWorkflowInputs.inputs.tableSource
+}
+```
+
+Inputs: `( DisplayAddRelatedFeatureArgs | DisplayAddRelatedFeatureMobileArgs )`
 
 DisplayAddRelatedFeatureArgs properties:
 ```json
@@ -378,10 +398,6 @@ DisplayAddRelatedFeatureArgs properties:
   "pluginSettings": {
     "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
   },
-  "relatedFeatureSource": {
-    "description": "The feature source for the related feature to create. Mobile only.",
-    "isRequired": "true"
-  },
   "relationshipId": {
     "description": "The ID of the relationship to add a feature to.",
     "type": "string",
@@ -409,11 +425,30 @@ DisplayAddRelatedFeatureArgs properties:
 }
 ```
 
+DisplayAddRelatedFeatureMobileArgs properties:
+```json
+{
+  "feature": {
+    "description": "The original feature to add a related feature to.",
+    "isRequired": "true"
+  },
+  "relatedFeatureSource": {
+    "description": "The feature source the related feature belongs to.",
+    "isRequired": "true"
+  },
+  "relationshipId": {
+    "description": "The ID of the relationship to add a feature to.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
 ---
 # command: edit.display-update-feature
 Description: Begin an interactive feature editing session with an existing feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.
 
-Inputs: `( DisplayUpdateFeatureArgs )`
+Inputs: `( @vertigis.api-docs.Features Feature | DisplayUpdateFeatureArgs )`
 
 DisplayUpdateFeatureArgs properties:
 ```json
@@ -468,6 +503,14 @@ DisplayUpdateFeatureArgs properties:
     "type": "string"
   },
   "parent": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/Model"
+      },
+      {
+        "type": "string"
+      }
+    ],
     "description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
   },
   "pluginSettings": {
@@ -488,7 +531,7 @@ DisplayUpdateFeatureArgs properties:
 # command: edit.update-feature
 Description: Updates a layer feature or features. Edits to the geometry and attributes of the supplied features will be committed to their respective feature sources. `Features` and `EditCommandArgs` are not supported on Mobile.
 
-Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | EditCommandArgs )`
+Inputs: `( @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | EditCommandArgs )`
 
 Results properties:
 ```json