@vertigis/viewer-spec 60.7.0 → 60.8.0

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

@@ -0,0 +1,314 @@
+# operation: measurement.capture-geometry
+Description: Allows the user to create geometry by sketching on a map with live measurement labels. Returns the geometry that was drawn, along with the map that it was drawn on. Web only.
+
+Inputs: `CaptureGeometryArgs`
+
+CaptureGeometryArgs properties:
+```json
+{
+  "disableFreehand": {
+    "description": "Disables freehand sketching during the draw session. Web only.",
+    "type": "boolean"
+  },
+  "editorSettings": {
+    "description": "The settings to be applied to the sketch. Mobile only."
+  },
+  "geometryType": {
+    "anyOf": [
+      {
+        "items": {
+          "$ref": "#/definitions/SketchTool"
+        },
+        "type": "array"
+      },
+      {
+        "enum": [
+          "circle",
+          "extent",
+          "line",
+          "multipoint",
+          "point",
+          "polygon",
+          "polyline",
+          "square"
+        ],
+        "type": "string"
+      }
+    ],
+    "description": "The geometry/shape to use for sketching. * Multiple sketch tools are only supported by VertiGIS Studio Web. When multiple sketch tools are provided, the sketch will begin with the first one in the list. If \"point\" is the first of multiple options in the list, click actions will create points while click-and-drag actions will automatically begin the freehand variation of the next included geometry type. The types \"point\", \"line\" and \"square\" are supported only in Web.",
+    "isRequired": "true"
+  },
+  "maps": {
+    "description": "The maps to activate drawing on. By default it will be all maps."
+  },
+  "maxSegments": {
+    "description": "The maximum number of segments permitted for a polyline or polygon sketch. Default is no limit. Mobile only.",
+    "type": "number"
+  },
+  "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. Web 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"
+      },
+      {
+        "$ref": "SymbolSet"
+      }
+    ],
+    "description": "An optional symbol to use. SymbolSets are not supported by VertiGIS Studio Mobile."
+  }
+}
+```
+
+Outputs: `CaptureGeometryResult`
+
+---
+# operation: measurement.create-graphics
+Description: Creates graphics out of geometries with the default symbology set by the "measurement.set-default-symbol" command. Web only.
+
+Inputs: `Geometries`
+
+Geometries properties:
+```json
+{
+  "graphics": {
+    "description": "The resulting graphics.",
+    "items": {
+      "$ref": "#/definitions/esri.Graphic"
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "maps": {
+    "description": "The map that the graphics were created on. Only available in Web.",
+    "isRequired": "true"
+  },
+  "esri.Graphic": {
+    "$ref": "esri/Graphic"
+  },
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "esri.Extent": {
+    "$ref": "esri/geometry/Extent"
+  },
+  "esri.Multipoint": {
+    "$ref": "esri/geometry/Multipoint"
+  },
+  "esri.Point": {
+    "$ref": "esri/geometry/Point"
+  },
+  "esri.Polygon": {
+    "$ref": "esri/geometry/Polygon"
+  },
+  "esri.Polyline": {
+    "$ref": "esri/geometry/Polyline"
+  },
+  "esri.Mesh": {
+    "$ref": "esri/geometry/Mesh"
+  },
+  "attributes": {
+    "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": {
+    "description": "The geometry to use for the command/operation."
+  },
+  "popupInfo": {
+    "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": {
+    "description": "Symbol used for drawing the feature."
+  },
+  "esri.FeatureSet": {
+    "$ref": "esri/rest/support/FeatureSet"
+  },
+  "m": {
+    "description": "M coordinate which contains measures used for linear referencing.",
+    "type": "number"
+  },
+  "spatialReference": {
+    "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": [
+      "string",
+      "number"
+    ],
+    "isRequired": "true"
+  },
+  "y": {
+    "description": "Y coordinate which is measured along the north/south axis.",
+    "type": [
+      "string",
+      "number"
+    ],
+    "isRequired": "true"
+  },
+  "z": {
+    "description": "Z coordinate which measures height or elevation.",
+    "type": [
+      "string",
+      "number"
+    ]
+  },
+  "hasM": {
+    "description": "Indicates whether the geometry contains M coordinate values.",
+    "type": "boolean"
+  },
+  "hasZ": {
+    "description": "Indicates whether the geometry contains Z coordinate values.",
+    "type": "boolean"
+  },
+  "points": {
+    "description": "An array that corresponds to 2D and 3D points.",
+    "items": {
+      "items": {
+        "type": "number"
+      },
+      "type": "array"
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "paths": {
+    "description": "Three nested arrays which corresponds to a polyline.",
+    "items": {
+      "items": {
+        "items": {
+          "type": "number"
+        },
+        "type": "array"
+      },
+      "type": "array"
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "rings": {
+    "description": "Represents an array of points. Each point is an array of numbers.",
+    "items": {
+      "items": {
+        "items": {
+          "type": "number"
+        },
+        "type": "array"
+      },
+      "type": "array"
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "xmax": {
+    "description": "A numeric value indicating the top-right X-coordinate of an extent envelope.",
+    "type": "number"
+  },
+  "xmin": {
+    "description": "A numeric value indicating the bottom-left X-coordinate of an extent envelope.",
+    "type": "number"
+  },
+  "ymax": {
+    "description": "A numeric value indicating the top-right Y-coordinate of an extent envelope.",
+    "type": "number"
+  },
+  "ymin": {
+    "description": "A numeric value indicating the bottom-left Y-coordinate of an extent envelope.",
+    "type": "number"
+  }
+}
+```
+
+Outputs: `CreateMeasurementGraphicsResult`
+
+---
+# operation: measurement.get-area-units
+Description: Gets the area units used for measurements. If undefined the units will be selected intelligently based on dimensions. Web only.
+
+Inputs: `None`
+
+Outputs: `AreaMeasurementUnits`
+
+---
+# operation: measurement.get-default-symbol
+Description: Gets the value of the default point, line, or polygon symbol for the provided geometry type. Web only.
+
+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`
+
+---
+# operation: measurement.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: `( GetDefaultSymbolArgs | "extent" | "mesh" | "multipatch" | "multipoint" | "point" | "polygon" | "polyline" )`
+
+GetDefaultSymbolArgs properties:
+```json
+{
+  "geometryType": {
+    "description": "The geometry type for the default symbol to retrieve."
+  }
+}
+```
+
+Outputs: `DrawingSymbolConfig`
+
+---
+# operation: measurement.get-length-units
+Description: Gets the length units used for measurements. If undefined the units will be selected intelligently based on dimensions. Web only.
+
+Inputs: `None`
+
+Outputs: `LengthMeasurementUnits`
+
+---

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

@@ -0,0 +1,16 @@
+# operation: messaging.mix-in-args
+Description: Attempts to merge an array of values into a single value that can be used as an argument for a command or operation. For example:
+
+[features, { chart: "average-household-income" }];
+
+This would mix `features` obtained from some other source into arguments intended for the "charts.display" command.
+
+If the values cannot be merged, then the leftmost value is returned.
+
+Note that argument merging already occurs automatically in command chains; this explicit operation exists for advanced scenarios like VertiGIS Studio Workflow or custom code written using the SDK. Web only.
+
+Inputs: `unknown[]`
+
+Outputs: `unknown`
+
+---

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

@@ -0,0 +1,44 @@
+# command: panel.pop-in
+Description: Closes the popout window for a panel and restores the original layout. 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: panel.pop-out
+Description: Removes a panel from the main layout and opens it in a new popout window. 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"
+  }
+}
+```
+
+---

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

@@ -0,0 +1,87 @@
+# operation: portal.choose-layers
+Description: Allows the user to browse/search the application's associated portal for one or more layers. Web only.
+
+Inputs: `ChooseLayersOptions`
+
+ChooseLayersOptions properties:
+```json
+{
+  "allowMultiple": {
+    "description": "Whether the user can choose multiple layers, or just one. Default is `false`.",
+    "type": "boolean"
+  },
+  "attributes": {
+    "description": "Optional layout XML attributes to be used for the transient UI container."
+  },
+  "icon": {
+    "description": "Optional icon that may be used by the transient UI container.",
+    "type": "string"
+  },
+  "initialSource": {
+    "description": "Optionally specify the source that will be initially selected. If specified this will overwrite the configured default in the Portal Model."
+  },
+  "layerFilterTags": {
+    "description": "Optionally specify the tags by which the Choose Layer modal will filter out the displayed layers. If specified this will overwrite the configured default in the Portal Model.",
+    "items": {
+      "type": "string"
+    },
+    "type": "array"
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  },
+  "parent": {
+    "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."
+  },
+  "sources": {
+    "description": "Optionally specify the sources that we want to expose. If specified this will overwrite the configured default in the Portal Model.",
+    "items": {
+      "$ref": "#/definitions/Source"
+    },
+    "type": "array"
+  }
+}
+```
+
+Outputs: `ChooseLayersResult`
+
+---
+# operation: portal.create-or-update-item
+Description: Creates or updates a portal item from the supplied data. Web only.
+
+Inputs: `CreateOrUpdateItemArgs`
+
+CreateOrUpdateItemArgs properties:
+```json
+{
+  "data": {
+    "description": "The JSON data associated with the item.",
+    "isRequired": "true"
+  },
+  "promptForOverwrite": {
+    "description": "Whether to prompt before overwriting an existing item. This must be set to `false` to allow overwriting if `showUI` is also `false`. Defaults to `true`.",
+    "type": "boolean"
+  },
+  "showUI": {
+    "description": "Whether to show UI elements associated with this operation. Defaults to `true`.",
+    "type": "boolean"
+  },
+  "thumbnail": {
+    "description": "The URL of a thumbnail for the item.",
+    "type": "string"
+  },
+  "title": {
+    "description": "The title of the resulting portal item. Must be provided if `showUI` is `false`.",
+    "type": "string"
+  },
+  "type": {
+    "description": "The portal type of the item.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+Outputs: `esri.PortalItem`
+
+---

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

@@ -0,0 +1,105 @@
+# command: printing.run
+Description: Run a print job with a given map and template/layout.
+
+Inputs: `( RunLayoutPrintArgs | RunPrintArgs )`
+
+RunLayoutPrintArgs properties:
+```json
+{
+  "dpi": {
+    "description": "The DPI with which to print.",
+    "type": "number"
+  },
+  "extent": {
+    "description": "The map extent. Defaults to the map's current extent. The actual print extent is calculated from the center point of the map extent, the print scale and the layout frame- or the output dimensions."
+  },
+  "id": {
+    "description": "The ID of the layout item to print with. Deprecated; use portalItem instead.",
+    "type": "string"
+  },
+  "instanceId": {
+    "description": "A unique ID used to track a print job.",
+    "type": "string"
+  },
+  "layoutId": {
+    "description": "The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with. Deprecated; use portalItem instead.",
+    "type": "string"
+  },
+  "maps": {
+    "description": "The map(s) to print.",
+    "isRequired": "true"
+  },
+  "outputDimensions": {
+    "description": "The print output dimensions for a MAP ONLY print."
+  },
+  "outputFormat": {
+    "description": "The print output format. Defaults to PDF if undefined or if layout package print is performed."
+  },
+  "parameters": {
+    "description": "Custom layout field parameters, specified as key-value pairs. The key is related to the layout field key. If a field for a specified key has an auto-filled value, this value is overwritten by the value provided here. NOTE: See VGS Printing documentation to learn more about layout fields."
+  },
+  "portalItem": {
+    "description": "The portal item where the print layout or layout package is located. If not defined, a MAP ONLY print is performed."
+  },
+  "scale": {
+    "description": "The print scale.",
+    "type": "number",
+    "isRequired": "true"
+  },
+  "title": {
+    "description": "The title of the print.",
+    "type": "string"
+  }
+}
+```
+
+RunPrintArgs properties:
+```json
+{
+  "dpi": {
+    "description": "The DPI with which to print.",
+    "type": "number"
+  },
+  "extent": {
+    "description": "The initial extent of the 2D map(s). Defaults to the map's current extent. If scale is provided, only the center point is used."
+  },
+  "grid": {
+    "description": "The WKID of the spatial reference used to draw a grid on the map(s)."
+  },
+  "id": {
+    "description": "The ID of the report item.",
+    "type": "string"
+  },
+  "instanceId": {
+    "description": "A unique ID used to track a print job.",
+    "type": "string"
+  },
+  "maps": {
+    "description": "The map(s) to print.",
+    "isRequired": "true"
+  },
+  "parameters": {
+    "description": "Additional parameters used in the print template, specified as key-value pairs."
+  },
+  "portalItem": {
+    "description": "The portal item where the print template is located."
+  },
+  "rotation": {
+    "description": "The rotation of the map(s). Defaults to the map's current rotation.",
+    "type": "number"
+  },
+  "scale": {
+    "description": "The scale of the map(s). Defaults to the map's current scale.",
+    "type": "number"
+  },
+  "title": {
+    "description": "The title of the print.",
+    "type": "string"
+  },
+  "viewpoint": {
+    "description": "The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint."
+  }
+}
+```
+
+---

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

@@ -0,0 +1,21 @@
+# operation: printing.update-args
+Description: Allows the user to update the intercepted prepared print request arguments.
+
+Inputs: `PreparedPrintJobUpdateArgs`
+
+PreparedPrintJobUpdateArgs properties:
+```json
+{
+  "printJobArgs": {
+    "description": "The prepared print job arguments.",
+    "isRequired": "true"
+  },
+  "update": {
+    "description": "The print job update arguments."
+  }
+}
+```
+
+Outputs: `PrintJobArgs`
+
+---