@vertigis/viewer-spec 60.7.0 → 60.8.0

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

@@ -0,0 +1,30 @@
+# operation: app.get-persistent-data
+Description: Gets stored data, specified by the arguments (key and scope).
+
+Inputs: `StorageDataArgs`
+
+StorageDataArgs properties:
+```json
+{
+  "key": {
+    "description": "The key of the data to store.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "scope": {
+    "description": "The scope the data is stored in. Defaults to"
+  }
+}
+```
+
+Outputs: `unknown`
+
+---
+# operation: app.get-version
+Description: Gets the current version stamped in the application (i.e. the version of the viewer this application was created with). Web only.
+
+Inputs: `None`
+
+Outputs: `string`
+
+---

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

@@ -0,0 +1,93 @@
+# operation: arcade.run
+Description: Runs a stringified Arcade script. Web only.
+
+- If only a string is passed in as an argument, it is interpreted as an   executeScript.
+- If an executeScript is provided, the operation will return its result.
+- If only a canExecute script is provided and it returns a truthy result,   the operation will return its input arguments.
+- If a canExecuteScript returns a falsy value, the operation will throw a   `Cancellation`.
+
+**Example:** Use an Arcade script to query a portal for a featureset, and return the area in square kilometers of the first feature. The output type of this operation is determined by the Arcade script, see https://developers.arcgis.com/arcade/function-reference/ for more information.
+
+```
+{
+    "executeScript": "Area(First(FeatureSetByPortalItem(Portal(\"https://www.arcgis.com\"),\"6200db0b80de4341ae8ee2b62d606e67\",0,[\"*\"],true)),\"square-kilometers\");"
+}
+```
+
+Inputs: `( RunArcadeArgs | string )`
+
+RunArcadeArgs properties:
+```json
+{
+  "arguments": {
+    "description": "An arguments object that provides named variables and associated values, which can be referenced from within the executeScript and canExecuteScript. Note that context variables will be passed in if available under the well known arcade variable names: $feature, $features, $map, $layer and $featuremap which is a constructed Arcade dictionary that exposes a feature mapping dictionary keyed via feature source ID with the following values: id, title and features.\n\nNOTE: All variable keys must consist of only lowercase letters; camel-cased context variables will break the script when they are referenced at runtime."
+  },
+  "canExecuteScript": {
+    "description": "The stringified Arcade script used to determine whether or not the executeScript can/should be run. If no executeScript is provided and the canExecuteScript returns a truthy value, the operation will return its input arguments; otherwise, if the canExecuteScript returns a falsy value, it will throw a {@link Cancellation}.",
+    "type": "string"
+  },
+  "executeScript": {
+    "description": "The stringified Arcade script to run. If this property is included, the operation will return the result of the script.",
+    "type": "string"
+  },
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "includeContext": {
+    "description": "Whether to pass the operation context object into the script. If included, the context object uses the variable name $context.",
+    "type": "boolean"
+  },
+  "includeWorkflowApplicationData": {
+    "description": "Whether to pass the current workflow application state into the script. If included, the application state object uses the variable name $workflowdata.",
+    "type": "boolean"
+  },
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  },
+  "watchHandles": {
+    "description": "Properties used to set a series of watch handles and/or event listeners on an item that will trigger the canExecuteChanged event for the 'arcade.run' operation.",
+    "items": {
+      "$ref": "#/definitions/WatchEventHandleProperties",
+      "WatchEventHandleProperties": {
+        "item": {
+          "description": "The item whose properties will be watched for changes and/or events.",
+          "isRequired": "true"
+        },
+        "watch": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/WatchEventProperty"
+            },
+            {
+              "items": {
+                "anyOf": [
+                  {
+                    "$ref": "#/definitions/WatchEventProperty"
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "type": "array"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "One or more properties on the item that will be watched for changes and/or events. Any strings will be used as propertyPaths that will be watched for changes; for this to work, the item and all properties referenced within the path (except for the last) must implement {@link Observable}.",
+          "isRequired": "true"
+        }
+      }
+    },
+    "type": "array"
+  }
+}
+```
+
+Outputs: `unknown`
+
+---

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

@@ -0,0 +1,12 @@
+# command: auth.sign-in
+Description: Initiates user sign-in if they aren't already signed in. The argument indicates whether or not the map should be reloaded when the sign-in is complete. This argument is optional and only supported by VertiGIS Studio Mobile. Default is true.
+
+Inputs: `boolean`
+
+---
+# command: auth.sign-out
+Description: Signs the user out. The argument indicates whether or not the map should be reloaded when the sign-out is complete. This argument is optional and only supported by VertiGIS Studio Mobile. Default is true.
+
+Inputs: `boolean`
+
+---

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

@@ -0,0 +1,16 @@
+# operation: auth.get-current-user
+Description: Gets the user that is currently signed into the application.
+
+Inputs: `None`
+
+Outputs: `Principal`
+
+---
+# operation: auth.is-sign-in-available
+Description: Check if sign-in is currently supported by the authentication manager. Web only.
+
+Inputs: `None`
+
+Outputs: `boolean`
+
+---

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

@@ -0,0 +1,20 @@
+# command: basemap.set
+Description: Switch to a configured basemap.
+
+Inputs: `SetBasemapArgs`
+
+SetBasemapArgs properties:
+```json
+{
+  "basemap": {
+    "description": "Basemap to be set.",
+    "isRequired": "true"
+  },
+  "map": {
+    "description": "Target map.",
+    "isRequired": "true"
+  }
+}
+```
+
+---

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

@@ -0,0 +1,31 @@
+# operation: basemap.get-all
+Description: Gets all configured basemaps.
+
+Having argument:
+
+- Multiple maps: the union of all basemap options from each
+- No maps: the union of all basemap options for every map in the   application.
+
+Inputs: `MapsLike`
+
+MapsLike properties:
+```json
+{}
+```
+
+Outputs: `@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapExtension[]`
+
+---
+# operation: basemap.get-current
+Description: Gets currently selected basemap for the given map. If more than one map is specified, only the first map is used.
+
+Inputs: `MapsLike`
+
+MapsLike properties:
+```json
+{}
+```
+
+Outputs: `@vertigis.arcgis-extensions.mapping.BasemapExtension.BasemapExtension`
+
+---

package/messaging/schema/web-bulk-editing-command-definitions.md

@@ -0,0 +1,54 @@
+# command: bulk-editing.add
+Description: Adds features to the bulk editing session. Used to stage features for updating. Web only.
+
+Inputs: `BulkEditingArgs`
+
+BulkEditingArgs properties:
+```json
+{
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  }
+}
+```
+
+---
+# command: bulk-editing.display
+Description: Displays the bulk editing interface for a given set of features. Updates the UI to show editable attributes for the provided features. Web only.
+
+Inputs: `BulkEditingArgs`
+
+BulkEditingArgs properties:
+```json
+{
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  }
+}
+```
+
+---
+# command: bulk-editing.remove
+Description: Removes features from the bulk editing session. Web only.
+
+Inputs: `BulkEditingArgs`
+
+BulkEditingArgs properties:
+```json
+{
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  }
+}
+```
+
+---

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

@@ -0,0 +1,135 @@
+# command: charts.add-features
+Description: Adds one or more features to charts. If `chart` is specified, then only the given chart will be updated, otherwise all charts will. Web only.
+
+Inputs: `( @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateChartFeaturesArgs )`
+
+Results properties:
+```json
+{
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  }
+}
+```
+
+UpdateChartFeaturesArgs properties:
+```json
+{
+  "chart": {
+    "description": "The chart(s) to update, referenced by layout ID or chart model.",
+    "isRequired": "true"
+  },
+  "features": {
+    "description": "Features to use for the command/operation."
+  }
+}
+```
+
+---
+# command: charts.clear
+Description: Clear features from active charts. If a chart is specified, then only the given chart will be updated, otherwise all charts will. Web only.
+
+Inputs: `( Model | string )`
+
+Model properties:
+```json
+{
+  "id": {
+    "description": "The unique ID for this entity.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "itemType": {
+    "description": "The item type for this entity when it participates in an App.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+---
+# command: charts.display
+Description: Updates charts with provided features. Only activated charts that receive features from all required feature sources will get displayed. Web only.
+
+Inputs: `( @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateChartFeaturesArgs )`
+
+Results properties:
+```json
+{
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  }
+}
+```
+
+UpdateChartFeaturesArgs properties:
+```json
+{
+  "chart": {
+    "description": "The chart(s) to update, referenced by layout ID or chart model.",
+    "isRequired": "true"
+  },
+  "features": {
+    "description": "Features to use for the command/operation."
+  }
+}
+```
+
+---
+# command: charts.remove-features
+Description: Remove one or more features from active charts. If `chart` is specified, then only the given chart will be updated, otherwise all charts will. Web only.
+
+Inputs: `( @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateChartFeaturesArgs )`
+
+Results properties:
+```json
+{
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  }
+}
+```
+
+UpdateChartFeaturesArgs properties:
+```json
+{
+  "chart": {
+    "description": "The chart(s) to update, referenced by layout ID or chart model.",
+    "isRequired": "true"
+  },
+  "features": {
+    "description": "Features to use for the command/operation."
+  }
+}
+```
+
+---
+# command: charts.update-definition
+Description: Updates the definition of a chart. Web only.
+
+Inputs: `UpdateChartDefinitionArgs`
+
+UpdateChartDefinitionArgs properties:
+```json
+{
+  "chart": {
+    "description": "The chart to update, referenced by chart model or its ID.",
+    "isRequired": "true"
+  },
+  "definition": {
+    "description": "The Highcharts definition with which to update the chart.",
+    "isRequired": "true"
+  }
+}
+```
+
+---

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

@@ -0,0 +1,48 @@
+# operation: charts.get-definition
+Description: Gets the definition of a chart that corresponds to the ID or the ChartModel instance that's passed in as an argument. Web only.
+
+Inputs: `ModelRef`
+
+ModelRef properties:
+```json
+{
+  "id": {
+    "description": "The unique ID for this entity.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "itemType": {
+    "description": "The item type for this entity when it participates in an App.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+Outputs: `highcharts.highcharts.Options`
+
+---
+# operation: charts.get-features
+Description: Returns the current set of features from all active charts. Web only.
+
+Inputs: `( Model | string )`
+
+Model properties:
+```json
+{
+  "id": {
+    "description": "The unique ID for this entity.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "itemType": {
+    "description": "The item type for this entity when it participates in an App.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+Outputs: `Features`
+
+---