@vertigis/viewer-spec 60.6.0 → 60.8.0

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

@@ -0,0 +1,720 @@
+# operation: drawing.create-graphics
+Description: Creates graphics.
+
+In Web, creates graphics out of GeometryLike or CreateGraphicsArgs, with the current symbols that are set on the DrawManager.
+
+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: `( CreateGraphicsResult | esri.Graphic | @vertigis.api-docs.Features Feature|FeatureSet|FeatureList|FeatureStream|Feature[] | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | esri.Extent | esri.Multipoint | esri.Point | esri.Polygon | esri.Polyline | esri.Mesh | esri.rest-api.FeatureJson.FeatureJson | esri.FeatureSet | ( esri.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 | ( esri.Extent | esri.Multipoint | esri.Point | esri.Polygon | esri.Polyline | esri.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
+{
+  "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.rest-api.FeatureJson.FeatureJson properties:
+```json
+{
+  "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 feature geometry."
+  },
+  "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.rest-api.GeometryJson.PointJson properties:
+```json
+{
+  "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"
+    ]
+  }
+}
+```
+
+esri.rest-api.GeometryJson.MultipointJson properties:
+```json
+{
+  "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"
+  },
+  "spatialReference": {
+    "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
+  }
+}
+```
+
+esri.rest-api.GeometryJson.PolylineJson properties:
+```json
+{
+  "hasM": {
+    "description": "Indicates whether the geometry contains M coordinate values.",
+    "type": "boolean"
+  },
+  "hasZ": {
+    "description": "Indicates whether the geometry contains Z coordinate values.",
+    "type": "boolean"
+  },
+  "paths": {
+    "description": "Three nested arrays which corresponds to a polyline.",
+    "items": {
+      "items": {
+        "items": {
+          "type": "number"
+        },
+        "type": "array"
+      },
+      "type": "array"
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "spatialReference": {
+    "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
+  }
+}
+```
+
+esri.rest-api.GeometryJson.PolygonJson properties:
+```json
+{
+  "hasM": {
+    "description": "Indicates whether the geometry contains M coordinate values.",
+    "type": "boolean"
+  },
+  "hasZ": {
+    "description": "Indicates whether the geometry contains Z coordinate values.",
+    "type": "boolean"
+  },
+  "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"
+  },
+  "spatialReference": {
+    "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
+  }
+}
+```
+
+esri.rest-api.GeometryJson.ExtentJson properties:
+```json
+{
+  "spatialReference": {
+    "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"
+  },
+  "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"
+  }
+}
+```
+
+esri.rest-api.GeometryJson.PointJson properties:
+```json
+{
+  "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"
+    ]
+  }
+}
+```
+
+esri.rest-api.GeometryJson.MultipointJson properties:
+```json
+{
+  "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"
+  },
+  "spatialReference": {
+    "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
+  }
+}
+```
+
+esri.rest-api.GeometryJson.PolylineJson properties:
+```json
+{
+  "hasM": {
+    "description": "Indicates whether the geometry contains M coordinate values.",
+    "type": "boolean"
+  },
+  "hasZ": {
+    "description": "Indicates whether the geometry contains Z coordinate values.",
+    "type": "boolean"
+  },
+  "paths": {
+    "description": "Three nested arrays which corresponds to a polyline.",
+    "items": {
+      "items": {
+        "items": {
+          "type": "number"
+        },
+        "type": "array"
+      },
+      "type": "array"
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "spatialReference": {
+    "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
+  }
+}
+```
+
+esri.rest-api.GeometryJson.PolygonJson properties:
+```json
+{
+  "hasM": {
+    "description": "Indicates whether the geometry contains M coordinate values.",
+    "type": "boolean"
+  },
+  "hasZ": {
+    "description": "Indicates whether the geometry contains Z coordinate values.",
+    "type": "boolean"
+  },
+  "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"
+  },
+  "spatialReference": {
+    "description": "The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT)."
+  }
+}
+```
+
+CreateGraphicsArgs properties:
+```json
+{
+  "features": {
+    "description": "Features containing geometry to create graphics from. Web only."
+  },
+  "geometry": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/CreateGraphicsResult"
+      },
+      {
+        "$ref": "#/definitions/esri.Graphic"
+      },
+      {
+        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+      },
+      {
+        "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
+      },
+      {
+        "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
+      },
+      {
+        "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
+      },
+      {
+        "items": {
+          "anyOf": [
+            {
+              "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
+            },
+            {
+              "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+            }
+          ]
+        },
+        "type": "array"
+      },
+      {
+        "$ref": "#/definitions/esri.Extent"
+      },
+      {
+        "$ref": "#/definitions/esri.Multipoint"
+      },
+      {
+        "$ref": "#/definitions/esri.Point"
+      },
+      {
+        "$ref": "#/definitions/esri.Polygon"
+      },
+      {
+        "$ref": "#/definitions/esri.Polyline"
+      },
+      {
+        "$ref": "#/definitions/esri.Mesh"
+      },
+      {
+        "$ref": "#/definitions/esri.rest-api.FeatureJson.FeatureJson"
+      },
+      {
+        "$ref": "#/definitions/esri.FeatureSet"
+      },
+      {
+        "items": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/esri.Graphic"
+            },
+            {
+              "$ref": "#/definitions/esri.rest-api.FeatureJson.FeatureJson"
+            }
+          ]
+        },
+        "type": "array"
+      },
+      {
+        "$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"
+      },
+      {
+        "items": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/esri.Extent"
+            },
+            {
+              "$ref": "#/definitions/esri.Multipoint"
+            },
+            {
+              "$ref": "#/definitions/esri.Point"
+            },
+            {
+              "$ref": "#/definitions/esri.Polygon"
+            },
+            {
+              "$ref": "#/definitions/esri.Polyline"
+            },
+            {
+              "$ref": "#/definitions/esri.Mesh"
+            },
+            {
+              "$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": "array"
+      },
+      {
+        "$ref": "#/definitions/esri.Geometry"
+      }
+    ],
+    "description": "The geometry that was captured.",
+    "isRequired": "true"
+  },
+  "maps": {
+    "description": "Map(s) to use for the command/operation."
+  },
+  "symbol": {
+    "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": "esri.LabelSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.LineSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.MeshSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.PointSymbol3D"
+      },
+      {
+        "$ref": "#/definitions/esri.PolygonSymbol3D"
+      },
+      {
+        "$ref": "esri.WebStyleSymbol"
+      },
+      {
+        "$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"
+      }
+    ],
+    "description": "The symbol that should be used to create the graphic. If null, a default is provided."
+  }
+}
+```
+
+Outputs: `CreateGraphicsResult`
+
+---
+# operation: drawing.edit-symbol
+Description: Opens the symbol editor toolbox for the specified geometry or type. Web only.
+
+Inputs: `( EditSymbolArgs | Symbol )`
+
+EditSymbolArgs properties:
+```json
+{
+  "attributes": {
+    "description": "Optional layout XML attributes to be used for the transient UI container."
+  },
+  "features": {
+    "description": "Features to use for the command/operation."
+  },
+  "geometryType": {
+    "description": "The geometry type for the symbol to create."
+  },
+  "graphics": {
+    "description": "Graphics to use for the command/operation."
+  },
+  "icon": {
+    "description": "Optional icon that may be used by the transient UI container.",
+    "type": "string"
+  },
+  "layers": {
+    "description": "Layer(s) to use for the command/operation."
+  },
+  "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."
+  },
+  "showOnlySymbolPresets": {
+    "description": "If the fine-grain controls should be hidden and only the symbol presets should be shown. If no valid symbol presets are configured, this property will be ignored. If defined, this will override the value of the DrawService's 'showOnlySymbolPresets' property. Default is false.",
+    "type": "boolean"
+  },
+  "symbolPresets": {
+    "description": "Symbol presets that can be assigned to a graphic. If defined, these presets will override any that are configured in the DrawService.",
+    "items": {
+      "$ref": "SymbolPresetProperties",
+      "SymbolPresetProperties": {
+        "description": {
+          "description": "A description of the SymbolPreset.",
+          "type": "string"
+        },
+        "geometryType": {
+          "description": "The geometry type associated with the symbol."
+        },
+        "id": {
+          "description": "The unique ID.",
+          "type": "string"
+        },
+        "symbol": {
+          "description": "The Symbol.",
+          "isRequired": "true"
+        },
+        "title": {
+          "description": "The title of the the SymbolPreset.",
+          "type": "string",
+          "isRequired": "true"
+        }
+      }
+    },
+    "type": "array"
+  },
+  "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: `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: `( 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: 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: `( GetDefaultSymbolArgs | "extent" | "mesh" | "multipatch" | "multipoint" | "point" | "polygon" | "polyline" )`
+
+GetDefaultSymbolArgs properties:
+```json
+{
+  "geometryType": {
+    "description": "The geometry type for the default symbol to retrieve."
+  }
+}
+```
+
+Outputs: `DrawingSymbolConfig`
+
+---