@vertigis/viewer-spec 60.7.0 → 60.8.1

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

@@ -0,0 +1,551 @@
+# command: drawing.set-default-symbol
+Description: Sets the value of the default point, line, or polygon symbol. The symbol can be configured with an instance of the Esri symbol or with the Esri WebMap JSON. Web only.
+
+**Example:** Set the default point symbol to a square.
+
+```
+{
+    "type": "esriSMS",
+    "color": [251, 43, 17, 85],
+    "size": 12,
+    "style": "esriSMSSquare",
+    "outline": {
+        "type": "esriSLS",
+        "color": [251, 43, 17, 255],
+        "width": 1.5,
+        "style": "esriSLSSolid"
+    }
+}
+```
+
+Inputs: `( esri.PictureFillSymbol | esri.PictureMarkerSymbol | esri.SimpleFillSymbol | esri.SimpleLineSymbol | esri.SimpleMarkerSymbol | esri.TextSymbol | esri.CIMSymbol | esri.LineSymbol3D | esri.PointSymbol3D | esri.PolygonSymbol3D | esri.rest-api.SymbolJson.CIMSymbolReferenceJson | esri.rest-api.SymbolJson.PictureFillSymbolJson | esri.rest-api.SymbolJson.PictureMarkerSymbolJson | esri.rest-api.SymbolJson.SimpleFillSymbolJson | esri.rest-api.SymbolJson.SimpleLineSymbolJson | esri.rest-api.SymbolJson.SimpleMarkerSymbolJson | esri.rest-api.SymbolJson.TextSymbolJson | esri.rest-api.SymbolJson.LineSymbol3DJson | esri.rest-api.SymbolJson.PointSymbol3DJson | esri.rest-api.SymbolJson.PolygonSymbol3DJson | HasSymbols )`
+
+esri.rest-api.SymbolJson.CIMSymbolReferenceJson properties:
+```json
+{
+  "symbol": {
+    "anyOf": [
+      {
+        "$ref": "esri.CIMLineSymbol"
+      },
+      {
+        "$ref": "esri.CIMPointSymbol"
+      },
+      {
+        "$ref": "esri.CIMPolygonSymbol"
+      }
+    ],
+    "description": "The symbol. Supported values are CIMPointSymbol, CIMLineSymbol, and CIMPolygonSymbol."
+  },
+  "type": {
+    "const": "CIMSymbolReference",
+    "description": "Specifies the type of symbol used.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+esri.rest-api.SymbolJson.PictureFillSymbolJson properties:
+```json
+{
+  "angle": {
+    "description": "Numeric value that defines the number of degrees ranging from 0-360, that a marker symbol is rotated. The rotation is from East in a counter-clockwise direction where East is the 0° axis.",
+    "type": "number"
+  },
+  "contentType": {
+    "description": "String value indicating the content type for the image.",
+    "type": "string"
+  },
+  "height": {
+    "description": "Numeric value used if needing to resize the symbol. Specify a value in points. If images are to be displayed in their original size, leave this blank.",
+    "type": "number"
+  },
+  "imageData": {
+    "description": "String value indicating the base64 encoded data.",
+    "type": "string"
+  },
+  "outline": {
+    "description": "Sets the outline of the symbol."
+  },
+  "type": {
+    "const": "esriPFS",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "url": {
+    "description": "Relative URL for static layers and full URL for dynamic layers. Access relative URL using http://<mapservice-url>/<layerId1>/images/<imageUrl11>.",
+    "type": "string"
+  },
+  "width": {
+    "description": "Numeric value used if needing to resize the symbol. If images are to be displayed in their original size, leave this blank.",
+    "type": "number"
+  },
+  "xoffset": {
+    "description": "Numeric value indicating the offset on the x-axis in pixels.",
+    "type": "number"
+  },
+  "xscale": {
+    "description": "Numeric value indicating the scale factor in x direction.",
+    "type": "number"
+  },
+  "yoffset": {
+    "description": "Numeric value indicating the offset on the y-axis in pixels.",
+    "type": "number"
+  },
+  "yscale": {
+    "description": "Numeric value indicating the scale factor in y direction.",
+    "type": "number"
+  }
+}
+```
+
+esri.rest-api.SymbolJson.PictureMarkerSymbolJson properties:
+```json
+{
+  "angle": {
+    "description": "Numeric value that defines the number of degrees ranging from 0-360, that a marker symbol is rotated. The rotation is from East in a counter-clockwise direction where East is the 0° axis.",
+    "type": "number"
+  },
+  "contentType": {
+    "description": "String value indicating the content type for the image.",
+    "type": "string"
+  },
+  "height": {
+    "description": "Numeric value used if needing to resize the symbol. If images are to be displayed in their original size, leave this blank.",
+    "type": "number"
+  },
+  "imageData": {
+    "description": "String value indicating the base64 encoded data.",
+    "type": "string"
+  },
+  "type": {
+    "const": "esriPMS",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "url": {
+    "description": "String value indicating the URL of the image. The URL should be relative if working with static layers. A full URL should be used for map service dynamic layers. A relative URL can be dereferenced by accessing the map layer image resource or the feature layer image resource.",
+    "type": "string"
+  },
+  "width": {
+    "description": "Numeric value used if needing to resize the symbol. If images are to be displayed in their original size, leave this blank.",
+    "type": "number"
+  },
+  "xoffset": {
+    "description": "Numeric value indicating the offset on the x-axis in pixels.",
+    "type": "number"
+  },
+  "yoffset": {
+    "description": "Numeric value indicating the offset on the y-axis in pixels.",
+    "type": "number"
+  }
+}
+```
+
+esri.rest-api.SymbolJson.SimpleFillSymbolJson properties:
+```json
+{
+  "color": {
+    "description": "Color is represented as a four-element array. The four elements represent values for red, green, blue, and alpha in that order. Values range from 0 through 255. If color is undefined for a symbol, the color value is null.",
+    "items": {
+      "type": "number"
+    },
+    "type": "array"
+  },
+  "outline": {
+    "description": "Sets the outline of the fill symbol."
+  },
+  "style": {
+    "description": "The fill style.",
+    "enum": [
+      "esriSFSBackwardDiagonal",
+      "esriSFSCross",
+      "esriSFSDiagonalCross",
+      "esriSFSForwardDiagonal",
+      "esriSFSHorizontal",
+      "esriSFSNull",
+      "esriSFSSolid",
+      "esriSFSVertical"
+    ],
+    "type": "string"
+  },
+  "type": {
+    "const": "esriSFS",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+esri.rest-api.SymbolJson.SimpleLineSymbolJson properties:
+```json
+{
+  "color": {
+    "description": "Color is represented as a four-element array. The four elements represent values for red, green, blue, and alpha in that order. Values range from 0 through 255. If color is undefined for a symbol, the color value is null.",
+    "items": {
+      "type": "number"
+    },
+    "type": "array"
+  },
+  "style": {
+    "description": "The line style.",
+    "enum": [
+      "esriSLSDash",
+      "esriSLSDashDot",
+      "esriSLSDashDotDot",
+      "esriSLSDot",
+      "esriSLSNull",
+      "esriSLSSolid"
+    ],
+    "type": "string"
+  },
+  "type": {
+    "const": "esriSLS",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "width": {
+    "description": "Numeric value indicating the width of the line in pixels.",
+    "type": "number"
+  }
+}
+```
+
+esri.rest-api.SymbolJson.SimpleMarkerSymbolJson properties:
+```json
+{
+  "angle": {
+    "description": "Numeric value used to rotate the symbol. The symbol is rotated counter-clockwise. For example, The following, angle=-30, in will create a symbol rotated -30 degrees counter-clockwise; that is, 30 degrees clockwise.",
+    "type": "number"
+  },
+  "color": {
+    "description": "Color is represented as a four-element array. The four elements represent values for red, green, blue, and alpha in that order. Values range from 0 through 255. If color is undefined for a symbol, the color value is null.",
+    "items": {
+      "type": "number"
+    },
+    "type": "array"
+  },
+  "outline": {
+    "description": "Sets the outline of the marker symbol."
+  },
+  "size": {
+    "description": "Numeric size of the symbol given in pixels.",
+    "type": "number"
+  },
+  "style": {
+    "description": "The marker style.",
+    "enum": [
+      "esriSMSCircle",
+      "esriSMSCross",
+      "esriSMSDiamond",
+      "esriSMSPath",
+      "esriSMSSquare",
+      "esriSMSTriangle",
+      "esriSMSX"
+    ],
+    "type": "string"
+  },
+  "type": {
+    "const": "esriSMS",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "xoffset": {
+    "description": "Numeric value indicating the offset on the x-axis in pixels.",
+    "type": "number"
+  },
+  "yoffset": {
+    "description": "Numeric value indicating the offset on the y-axis in pixels.",
+    "type": "number"
+  }
+}
+```
+
+esri.rest-api.SymbolJson.TextSymbolJson properties:
+```json
+{
+  "angle": {
+    "description": "A numeric value that defines the number of degrees (0 to 360) that a text symbol is rotated. The rotation is from East in a counter-clockwise direction where East is the 0° axis.",
+    "type": "number"
+  },
+  "backgroundColor": {
+    "description": "Background color of the text.",
+    "items": {
+      "type": "number"
+    },
+    "type": "array"
+  },
+  "borderLineColor": {
+    "description": "Value indicating the the color of the border line.",
+    "items": {
+      "type": "number"
+    },
+    "type": "array"
+  },
+  "borderLineSize": {
+    "description": "Numeric value indicating the the size of the border line in points.",
+    "type": "number"
+  },
+  "color": {
+    "description": "Color is represented as a four-element array. The four elements represent values for red, green, blue, and alpha in that order. Values range from 0 through 255. If color is undefined for a symbol, the color value is null.",
+    "items": {
+      "type": "number"
+    },
+    "type": "array"
+  },
+  "font": {
+    "description": "Font used for text symbols."
+  },
+  "haloColor": {
+    "description": "Color of the halo around the text.",
+    "items": {
+      "type": "number"
+    },
+    "type": "array"
+  },
+  "haloSize": {
+    "description": "Numeric value indicating the point size of a halo around the text symbol.",
+    "type": "number"
+  },
+  "horizontalAlignment": {
+    "description": "The horizontal alignment of the text.",
+    "enum": [
+      "center",
+      "justify",
+      "left",
+      "right"
+    ],
+    "type": "string"
+  },
+  "kerning": {
+    "description": "Boolean value indicating whether to adjust the spacing between characters in the text string.",
+    "type": "boolean"
+  },
+  "rightToLeft": {
+    "description": "Boolean value, set to true if using Hebrew or Arabic fonts.",
+    "type": "boolean"
+  },
+  "rotated": {
+    "description": "Boolean value indicating whether every character in the text string is rotated.",
+    "type": "boolean"
+  },
+  "text": {
+    "description": "Only applicable when specified as a client-side graphic.",
+    "type": "string"
+  },
+  "type": {
+    "const": "esriTS",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "verticalAlignment": {
+    "description": "The vertical alignment of the text.",
+    "enum": [
+      "baseline",
+      "bottom",
+      "middle",
+      "top"
+    ],
+    "type": "string"
+  },
+  "xoffset": {
+    "description": "Numeric value indicating the offset on the x-axis in pixels.",
+    "type": "number"
+  },
+  "yoffset": {
+    "description": "Numeric value indicating the offset on the y-axis in pixels.",
+    "type": "number"
+  }
+}
+```
+
+esri.rest-api.SymbolJson.LineSymbol3DJson properties:
+```json
+{
+  "symbolLayers": {
+    "description": "A Collection of Symbol3DLayer objects used to visualize the graphic or feature.",
+    "items": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/esri.rest-api.SymbolJson.PathSymbol3DLayerJson"
+        },
+        {
+          "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DLayerJson"
+        }
+      ]
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "type": {
+    "const": "LineSymbol3D",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+esri.rest-api.SymbolJson.PointSymbol3DJson properties:
+```json
+{
+  "callout": {
+    "description": "Callout configuration for a symbol."
+  },
+  "styleOrigin": {
+    "description": "The origin of the style from which the symbol was originally referenced. A reference to the style origin can be either by styleName or by styleUrl (but not both). It may be used to understand where a symbol was originally sourced from, but does not affect actual appearance or rendering of the symbol. See {@link https://developers.arcgis.com/web-scene-specification/objects/styleOrigin/}."
+  },
+  "symbolLayers": {
+    "description": "A Collection of Symbol3DLayer objects used to visualize the graphic or feature.",
+    "items": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/esri.rest-api.SymbolJson.IconSymbol3DLayerJson"
+        },
+        {
+          "$ref": "#/definitions/esri.rest-api.SymbolJson.ObjectSymbol3DLayerJson"
+        }
+      ]
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "type": {
+    "const": "PointSymbol3D",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  },
+  "verticalOffset": {
+    "description": "Shifts the symbol along the vertical world axis by a given length."
+  }
+}
+```
+
+esri.rest-api.SymbolJson.PolygonSymbol3DJson properties:
+```json
+{
+  "symbolLayers": {
+    "description": "A Collection of Symbol3DLayer objects used to visualize the graphic or feature.",
+    "items": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/esri.rest-api.SymbolJson.ExtrudeSymbol3DLayerJson"
+        },
+        {
+          "$ref": "#/definitions/esri.rest-api.SymbolJson.FillSymbol3DLayerJson"
+        },
+        {
+          "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DLayerJson"
+        }
+      ]
+    },
+    "type": "array",
+    "isRequired": "true"
+  },
+  "type": {
+    "const": "PolygonSymbol3D",
+    "description": "The type of symbol. See {@link SymbolJsonType}.",
+    "type": "string",
+    "isRequired": "true"
+  }
+}
+```
+
+HasSymbols properties:
+```json
+{
+  "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."
+  }
+}
+```
+
+---
+# command: drawing.set-symbol
+Description: Sets the symbol on a collection of Graphics. The symbol can be configured with an instance of the Esri symbol or with the Esri WebMap JSON. Web only.
+
+Inputs: `object`
+
+---
+# command: drawing.set-sync
+Description: Sets a value that determines whether drawings will be synced automatically across maps.
+
+Inputs: `boolean`
+
+---