@vertigis/viewer-spec 61.14.0 → 61.14.1

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
@@ -334,6 +334,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 +351,9 @@ CreateGraphicsArgs properties:
           "anyOf": [
             {
               "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
+            },
+            {
+              "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
             }
           ]
         },

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
@@ -488,7 +523,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

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

@@ -104,7 +104,7 @@ ReverseGeocodeArgs properties:
 }
 ```
 
-Outputs: `unknown`
+Outputs: `@vertigis.arcgis-extensions.data.Feature.Feature`
 
 ---
 # operation: geocode.suggest

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

@@ -82,7 +82,7 @@ TargetsResultsSetArgs properties:
 # command: results.display
 Description: Presents features to the user within any components that can display features, such as a feature list, feature table, or feature details component. The argument is the features to display, or an object specifying both features and the target results component to update (Web only). If features are specified, they will overwrite any incoming features from previous operations up the action chain.
 
-Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateResultsFeaturesArgs )`
+Inputs: `( @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateResultsFeaturesArgs )`
 
 Results properties:
 ```json
@@ -116,7 +116,7 @@ UpdateResultsFeaturesArgs properties:
 # command: results.display-details
 Description: Presents feature details to the user within the feature-details component. The argument is the feature(s) to display, or an object specifying both features and the target results component to update (this object, UpdateResultsFeaturesArgs, is Web only).
 
-Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateResultsFeaturesArgs )`
+Inputs: `( @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateResultsFeaturesArgs )`
 
 Results properties:
 ```json
@@ -150,7 +150,7 @@ UpdateResultsFeaturesArgs properties:
 # command: results.display-new-details
 Description: Presents new feature details to the user within the feature-details component. If the feature-details component is contained within a panel, a 'back' button will be provided to navigate to the previous content; otherwise, the content of the feature-details component will be replaced.
 
-Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateResultsFeaturesArgs )`
+Inputs: `( @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateResultsFeaturesArgs )`
 
 Results properties:
 ```json

package/package.json

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

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export declare const version = "61.14.0";
+export declare const version = "61.14.1";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "61.14.0";
+export const version = "61.14.1";