@vertigis/viewer-spec 60.7.0 → 60.8.1

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

@@ -0,0 +1,612 @@
+# operation: layers.edit-label-settings
+Description: Shows a UI for editing the label classes on an existing layer or layers. Note that changes will not be applied to the supplied layers by this operation. Use `layers.set-label-classes` for this. Web only.
+
+Inputs: `LayerSettingsArgs`
+
+LayerSettingsArgs properties:
+```json
+{
+  "definitionExpression": {
+    "description": "The definitionExpression of the layer.",
+    "type": "string"
+  },
+  "labelingInfo": {
+    "anyOf": [
+      {
+        "items": {
+          "$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
+        },
+        "type": "array"
+      },
+      {
+        "items": {
+          "items": {
+            "$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
+          },
+          "type": "array"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "The labeling class of the layer."
+  },
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  },
+  "popupTemplate": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
+      },
+      {
+        "items": {
+          "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "Configuration for a popup template to be used by features in the layer."
+  },
+  "symbols": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.PictureFillSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.PictureMarkerSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleFillSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleLineSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleMarkerSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.TextSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.CIMSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.LineSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.PointSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.PolygonSymbol3D"
+      },
+      {
+        "$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.LineSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
+      },
+      {
+        "items": {
+          "$ref": "SymbolLike"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "The symbols to use for the command/operation."
+  },
+  "taskSettings": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
+      },
+      {
+        "items": {
+          "$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "Settings relevant to layer tasks."
+  },
+  "title": {
+    "anyOf": [
+      {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      {
+        "type": "string"
+      }
+    ],
+    "description": "The title of the layer."
+  }
+}
+```
+
+Outputs: `LayerSettingsArgs`
+
+---
+# operation: layers.edit-settings
+Description: Shows a UI for editing the settings on an existing layer or layers. Note that changes will not be applied to the supplied layers by this operation. Use `layers.set-*` for this. Web only.
+
+Inputs: `LayerSettingsArgs`
+
+LayerSettingsArgs properties:
+```json
+{
+  "definitionExpression": {
+    "description": "The definitionExpression of the layer.",
+    "type": "string"
+  },
+  "labelingInfo": {
+    "anyOf": [
+      {
+        "items": {
+          "$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
+        },
+        "type": "array"
+      },
+      {
+        "items": {
+          "items": {
+            "$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
+          },
+          "type": "array"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "The labeling class of the layer."
+  },
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  },
+  "popupTemplate": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
+      },
+      {
+        "items": {
+          "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "Configuration for a popup template to be used by features in the layer."
+  },
+  "symbols": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.PictureFillSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.PictureMarkerSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleFillSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleLineSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleMarkerSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.TextSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.CIMSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.LineSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.PointSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.PolygonSymbol3D"
+      },
+      {
+        "$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.LineSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
+      },
+      {
+        "items": {
+          "$ref": "SymbolLike"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "The symbols to use for the command/operation."
+  },
+  "taskSettings": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
+      },
+      {
+        "items": {
+          "$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "Settings relevant to layer tasks."
+  },
+  "title": {
+    "anyOf": [
+      {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      {
+        "type": "string"
+      }
+    ],
+    "description": "The title of the layer."
+  }
+}
+```
+
+Outputs: `LayerSettingsArgs`
+
+---
+# operation: layers.edit-symbols
+Description: Edit the symbol from an existing layer or layers. Note that changes to these symbols will not be applied to the layers by this operation. Use `layers.set-symbol` for this. Web only.
+
+Inputs: `SetSymbolArgs`
+
+SetSymbolArgs properties:
+```json
+{
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  },
+  "renderers": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.ClassBreaksRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.HeatmapRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudClassBreaksRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudRGBRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudStretchRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudUniqueValueRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.PredominanceRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.SimpleRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.TemporalRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.UniqueValueFromStyleRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.UniqueValueRendererJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.RendererJson.VectorFieldRendererJson"
+      },
+      {
+        "$ref": "esri.HeatmapRenderer"
+      },
+      {
+        "$ref": "esri.SimpleRenderer"
+      },
+      {
+        "$ref": "esri.ClassBreaksRenderer"
+      },
+      {
+        "$ref": "esri.UniqueValueRenderer"
+      },
+      {
+        "$ref": "esri.DotDensityRenderer"
+      },
+      {
+        "$ref": "esri.DictionaryRenderer"
+      },
+      {
+        "$ref": "esri.PieChartRenderer"
+      },
+      {
+        "items": {
+          "$ref": "#/definitions/RendererLike"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "The renderers to use for the command/operation."
+  },
+  "symbols": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.PictureFillSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.PictureMarkerSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleFillSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleLineSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.SimpleMarkerSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.TextSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.CIMSymbol"
+      },
+      {
+        "$ref": "#/definitions/esri.LineSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.PointSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.PolygonSymbol3D"
+      },
+      {
+        "$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.LineSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
+      },
+      {
+        "items": {
+          "$ref": "SymbolLike"
+        },
+        "type": "array"
+      }
+    ],
+    "description": "The symbols to use for the command/operation."
+  }
+}
+```
+
+Outputs: `object`
+
+---
+# operation: layers.from-dxf
+Description: Convert the specified DXF blob to layers. If spatial references are not specified, Web defaults both the input and output to the active map's spatial reference.
+
+Inputs: `( FromDxfArgs | global.Blob | global.Blob[] )`
+
+FromDxfArgs properties:
+```json
+{
+  "blobs": {
+    "description": "The data files to use for the command/operation.",
+    "items": {
+      "$ref": "FileLike",
+      "FileLike": {}
+    },
+    "type": "array"
+  },
+  "inputSpatialReference": {
+    "description": "The spatial reference of the source DXF content. If not set, the active map's spatial reference is used for the input."
+  },
+  "outputSpatialReference": {
+    "description": "The spatial reference to project the resulting layers to. If not set, the active map's spatial reference is used for the output."
+  }
+}
+```
+
+Outputs: `HasLayers`
+
+---
+# operation: layers.from-kml
+Description: Convert the specified KML blob to layers. Web only.
+
+Inputs: `( FromKmlArgs | global.Blob | global.Blob[] )`
+
+FromKmlArgs properties:
+```json
+{
+  "blobs": {
+    "description": "The data files to use for the command/operation.",
+    "items": {
+      "$ref": "FileLike",
+      "FileLike": {}
+    },
+    "type": "array"
+  }
+}
+```
+
+Outputs: `HasLayers`
+
+---
+# operation: layers.from-url
+Description: Attempts to create layer(s) from a url. Web only.
+
+The url could be to an ArcGIS Server Url, WMS, WFS, WMTS, GeoJson, GeoRss, Csv, Kml, kmz, OGC Feature Layer, or an Arcgis Portal Item.
+
+Inputs: `( FromUrlArgs | string )`
+
+FromUrlArgs properties:
+```json
+{
+  "url": {
+    "description": "The Url to add to the map.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+Outputs: `HasLayers`
+
+---
+# operation: layers.get-label-classes
+Description: Retrieves the label classes for supplied layer(s). Web only.
+
+Inputs: `HasLayers`
+
+HasLayers properties:
+```json
+{
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  }
+}
+```
+
+Outputs: `LayerSettingsArgs`
+
+---
+# operation: layers.get-popup-template
+Description: Retrieves the popup configuration applied to the supplied layer(s). Web only.
+
+Inputs: `HasLayers`
+
+HasLayers properties:
+```json
+{
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  }
+}
+```
+
+Outputs: `LayerSettingsArgs`
+
+---
+# operation: layers.get-task-settings
+Description: Retrieves the values for the 'taskSettings' applied to the supplied layer(s). Web only.
+
+Inputs: `HasLayers`
+
+HasLayers properties:
+```json
+{
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  }
+}
+```
+
+Outputs: `LayerSettingsArgs`
+
+---
+# operation: layers.get-title
+Description: Retrieves the titles of the supplied layer(s). Web only.
+
+Inputs: `HasLayers`
+
+HasLayers properties:
+```json
+{
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  }
+}
+```
+
+Outputs: `LayerSettingsArgs`
+
+---

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

@@ -0,0 +1,24 @@
+# command: licensing.validate-license
+Description: Validate the current application license and show appropriate prompts or errors. Web only.
+
+Inputs: `LicenseRequestArgs`
+
+LicenseRequestArgs properties:
+```json
+{
+  "accountId": {
+    "description": "The accountId (orgId) that we want to check licensing for.",
+    "type": "string"
+  },
+  "applicationName": {
+    "description": "The human readable application name, used for any licensing related ui. Web only.",
+    "type": "string"
+  },
+  "sku": {
+    "description": "Overwrite the default SKU (if any) for license checking.",
+    "type": "string"
+  }
+}
+```
+
+---

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

@@ -0,0 +1,26 @@
+# operation: licensing.get-license-state
+Description: Retrieve the license state for the specified account and SKU. Defaults to returning the current state.
+
+Inputs: `LicenseRequestArgs`
+
+LicenseRequestArgs properties:
+```json
+{
+  "accountId": {
+    "description": "The accountId (orgId) that we want to check licensing for.",
+    "type": "string"
+  },
+  "applicationName": {
+    "description": "The human readable application name, used for any licensing related ui. Web only.",
+    "type": "string"
+  },
+  "sku": {
+    "description": "Overwrite the default SKU (if any) for license checking.",
+    "type": "string"
+  }
+}
+```
+
+Outputs: `string`
+
+---