@vertigis/viewer-spec 61.14.1 → 61.15.0

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

@@ -3,27 +3,11 @@ Description: Display the measurements settings dialog. This allows you to config
 
 Inputs: `HasUITarget`
 
-HasUITarget properties:
-```json
-{
-  "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"
-  },
-  "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."
-  }
-}
-```
-
 ---
 # command: measurement.set-area-units
 Description: Sets the area units used for measurements. Set as undefined for units to be intelligently selected based on dimensions. Web only.
 
-Inputs: `( AreaMeasurementUnits )`
+Inputs: `( "acres" | "ares" | "hectares" | "square-feet" | "square-kilometers" | "square-meters" | "square-miles" | "square-yards" )`
 
 ---
 # command: measurement.set-default-symbol
@@ -35,6 +19,17 @@ esri.rest-api.SymbolJson.CIMSymbolReferenceJson properties:
 ```json
 {
   "symbol": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/@arcgis.core.symbols.cim.types.CIMLineSymbol"
+      },
+      {
+        "$ref": "#/definitions/@arcgis.core.symbols.cim.types.CIMPointSymbol"
+      },
+      {
+        "$ref": "#/definitions/@arcgis.core.symbols.cim.types.CIMPolygonSymbol"
+      }
+    ],
     "description": "The symbol. Supported values are CIMPointSymbol, CIMLineSymbol, and CIMPolygonSymbol."
   },
   "type": {
@@ -51,21 +46,41 @@ esri.rest-api.SymbolJson.PictureFillSymbolJson properties:
 {
   "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"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "contentType": {
     "description": "String value indicating the content type for the image.",
-    "type": "string"
+    "type": [
+      "null",
+      "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"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "imageData": {
     "description": "String value indicating the base64 encoded data.",
-    "type": "string"
+    "type": [
+      "null",
+      "string"
+    ]
   },
   "outline": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Sets the outline of the symbol."
   },
   "type": {
@@ -76,27 +91,45 @@ esri.rest-api.SymbolJson.PictureFillSymbolJson properties:
   },
   "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"
+    "type": [
+      "null",
+      "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"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "xoffset": {
     "description": "Numeric value indicating the offset on the x-axis in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "xscale": {
     "description": "Numeric value indicating the scale factor in x direction.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "yoffset": {
     "description": "Numeric value indicating the offset on the y-axis in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "yscale": {
     "description": "Numeric value indicating the scale factor in y direction.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   }
 }
 ```
@@ -106,19 +139,31 @@ esri.rest-api.SymbolJson.PictureMarkerSymbolJson properties:
 {
   "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"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "contentType": {
     "description": "String value indicating the content type for the image.",
-    "type": "string"
+    "type": [
+      "null",
+      "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"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "imageData": {
     "description": "String value indicating the base64 encoded data.",
-    "type": "string"
+    "type": [
+      "null",
+      "string"
+    ]
   },
   "type": {
     "const": "esriPMS",
@@ -128,19 +173,31 @@ esri.rest-api.SymbolJson.PictureMarkerSymbolJson properties:
   },
   "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"
+    "type": [
+      "null",
+      "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"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "xoffset": {
     "description": "Numeric value indicating the offset on the x-axis in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "yoffset": {
     "description": "Numeric value indicating the offset on the y-axis in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   }
 }
 ```
@@ -149,24 +206,79 @@ esri.rest-api.SymbolJson.SimpleFillSymbolJson properties:
 ```json
 {
   "color": {
+    "anyOf": [
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 4,
+        "minItems": 4,
+        "type": "array"
+      },
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 3,
+        "minItems": 3,
+        "type": "array"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "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."
   },
   "outline": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Sets the outline of the fill symbol."
   },
   "style": {
-    "description": "The fill style.",
-    "enum": [
-      "esriSFSBackwardDiagonal",
-      "esriSFSCross",
-      "esriSFSDiagonalCross",
-      "esriSFSForwardDiagonal",
-      "esriSFSHorizontal",
-      "esriSFSNull",
-      "esriSFSSolid",
-      "esriSFSVertical"
+    "anyOf": [
+      {
+        "enum": [
+          "esriSFSBackwardDiagonal",
+          "esriSFSCross",
+          "esriSFSDiagonalCross",
+          "esriSFSForwardDiagonal",
+          "esriSFSHorizontal",
+          "esriSFSNull",
+          "esriSFSSolid",
+          "esriSFSVertical"
+        ],
+        "type": "string"
+      },
+      {
+        "type": "null"
+      }
     ],
-    "type": "string"
+    "description": "The fill style."
   },
   "type": {
     "const": "esriSFS",
@@ -181,19 +293,66 @@ esri.rest-api.SymbolJson.SimpleLineSymbolJson properties:
 ```json
 {
   "color": {
+    "anyOf": [
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 4,
+        "minItems": 4,
+        "type": "array"
+      },
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 3,
+        "minItems": 3,
+        "type": "array"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "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."
   },
   "style": {
-    "description": "The line style.",
-    "enum": [
-      "esriSLSDash",
-      "esriSLSDashDot",
-      "esriSLSDashDotDot",
-      "esriSLSDot",
-      "esriSLSNull",
-      "esriSLSSolid"
+    "anyOf": [
+      {
+        "enum": [
+          "esriSLSDash",
+          "esriSLSDashDot",
+          "esriSLSDashDotDot",
+          "esriSLSDot",
+          "esriSLSNull",
+          "esriSLSSolid"
+        ],
+        "type": "string"
+      },
+      {
+        "type": "null"
+      }
     ],
-    "type": "string"
+    "description": "The line style."
   },
   "type": {
     "const": "esriSLS",
@@ -203,7 +362,10 @@ esri.rest-api.SymbolJson.SimpleLineSymbolJson properties:
   },
   "width": {
     "description": "Numeric value indicating the width of the line in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   }
 }
 ```
@@ -213,30 +375,91 @@ esri.rest-api.SymbolJson.SimpleMarkerSymbolJson properties:
 {
   "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"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "color": {
+    "anyOf": [
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 4,
+        "minItems": 4,
+        "type": "array"
+      },
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 3,
+        "minItems": 3,
+        "type": "array"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "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."
   },
   "outline": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Sets the outline of the marker symbol."
   },
   "size": {
     "description": "Numeric size of the symbol given in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "style": {
-    "description": "The marker style.",
-    "enum": [
-      "esriSMSCircle",
-      "esriSMSCross",
-      "esriSMSDiamond",
-      "esriSMSPath",
-      "esriSMSSquare",
-      "esriSMSTriangle",
-      "esriSMSX"
+    "anyOf": [
+      {
+        "enum": [
+          "esriSMSCircle",
+          "esriSMSCross",
+          "esriSMSDiamond",
+          "esriSMSPath",
+          "esriSMSSquare",
+          "esriSMSTriangle",
+          "esriSMSX"
+        ],
+        "type": "string"
+      },
+      {
+        "type": "null"
+      }
     ],
-    "type": "string"
+    "description": "The marker style."
   },
   "type": {
     "const": "esriSMS",
@@ -246,11 +469,17 @@ esri.rest-api.SymbolJson.SimpleMarkerSymbolJson properties:
   },
   "xoffset": {
     "description": "Numeric value indicating the offset on the x-axis in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "yoffset": {
     "description": "Numeric value indicating the offset on the y-axis in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   }
 }
 ```
@@ -260,56 +489,252 @@ esri.rest-api.SymbolJson.TextSymbolJson properties:
 {
   "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"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "backgroundColor": {
+    "anyOf": [
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 4,
+        "minItems": 4,
+        "type": "array"
+      },
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 3,
+        "minItems": 3,
+        "type": "array"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Background color of the text."
   },
   "borderLineColor": {
+    "anyOf": [
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 4,
+        "minItems": 4,
+        "type": "array"
+      },
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 3,
+        "minItems": 3,
+        "type": "array"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Value indicating the the color of the border line."
   },
   "borderLineSize": {
     "description": "Numeric value indicating the the size of the border line in points.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "color": {
+    "anyOf": [
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 4,
+        "minItems": 4,
+        "type": "array"
+      },
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 3,
+        "minItems": 3,
+        "type": "array"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "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."
   },
   "font": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.FontJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Font used for text symbols."
   },
   "haloColor": {
+    "anyOf": [
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 4,
+        "minItems": 4,
+        "type": "array"
+      },
+      {
+        "items": [
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "number"
+          }
+        ],
+        "maxItems": 3,
+        "minItems": 3,
+        "type": "array"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Color of the halo around the text."
   },
   "haloSize": {
     "description": "Numeric value indicating the point size of a halo around the text symbol.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "horizontalAlignment": {
-    "description": "The horizontal alignment of the text.",
-    "enum": [
-      "center",
-      "justify",
-      "left",
-      "right"
+    "anyOf": [
+      {
+        "enum": [
+          "center",
+          "justify",
+          "left",
+          "right"
+        ],
+        "type": "string"
+      },
+      {
+        "type": "null"
+      }
     ],
-    "type": "string"
+    "description": "The horizontal alignment of the text."
   },
   "kerning": {
     "description": "Boolean value indicating whether to adjust the spacing between characters in the text string.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "rightToLeft": {
     "description": "Boolean value, set to true if using Hebrew or Arabic fonts.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "rotated": {
     "description": "Boolean value indicating whether every character in the text string is rotated.",
-    "type": "boolean"
+    "type": [
+      "null",
+      "boolean"
+    ]
   },
   "text": {
     "description": "Only applicable when specified as a client-side graphic.",
-    "type": "string"
+    "type": [
+      "null",
+      "string"
+    ]
   },
   "type": {
     "const": "esriTS",
@@ -318,22 +743,35 @@ esri.rest-api.SymbolJson.TextSymbolJson properties:
     "isRequired": "true"
   },
   "verticalAlignment": {
-    "description": "The vertical alignment of the text.",
-    "enum": [
-      "baseline",
-      "bottom",
-      "middle",
-      "top"
+    "anyOf": [
+      {
+        "enum": [
+          "baseline",
+          "bottom",
+          "middle",
+          "top"
+        ],
+        "type": "string"
+      },
+      {
+        "type": "null"
+      }
     ],
-    "type": "string"
+    "description": "The vertical alignment of the text."
   },
   "xoffset": {
     "description": "Numeric value indicating the offset on the x-axis in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   },
   "yoffset": {
     "description": "Numeric value indicating the offset on the y-axis in pixels.",
-    "type": "number"
+    "type": [
+      "null",
+      "number"
+    ]
   }
 }
 ```
@@ -369,9 +807,25 @@ esri.rest-api.SymbolJson.PointSymbol3DJson properties:
 ```json
 {
   "callout": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.CalloutJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Callout configuration for a symbol."
   },
   "styleOrigin": {
+    "anyOf": [
+      {
+        "$ref": "__type"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "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": {
@@ -396,6 +850,14 @@ esri.rest-api.SymbolJson.PointSymbol3DJson properties:
     "isRequired": "true"
   },
   "verticalOffset": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/esri.rest-api.SymbolJson.VerticalOffsetJson"
+      },
+      {
+        "type": "null"
+      }
+    ],
     "description": "Shifts the symbol along the vertical world axis by a given length."
   }
 }
@@ -512,6 +974,6 @@ HasSymbols properties:
 # command: measurement.set-length-units
 Description: Sets the length units used for measurements. Set as undefined for units to be intelligently selected based on dimensions. Web only.
 
-Inputs: `( LengthMeasurementUnits )`
+Inputs: `( "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" )`
 
 ---