@vertigis/viewer-spec 45.1.0 → 46.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -740,7 +740,7 @@
740
740
  },
741
741
  "AddNodeToGeometryArgs": {
742
742
  "additionalProperties": false,
743
- "description": "Arguments for the \"sketching.add-node-to-geometry\" operation.",
743
+ "description": "Deprecated - Mobile users should rather use \"geometry.add-point\"; Web users should use \"sketching.add-point\" with {@link AddPointArgs} or \"sketching.insert-point\" with {@link InsertPointArgs} instead.",
744
744
  "properties": {
745
745
  "geometry": {
746
746
  "$ref": "#/definitions/esri.Geometry",
@@ -770,6 +770,28 @@
770
770
  ],
771
771
  "type": "object"
772
772
  },
773
+ "AddPointArgs": {
774
+ "additionalProperties": false,
775
+ "description": "Arguments for the \"sketching.add-point\" command.",
776
+ "properties": {
777
+ "geometry": {
778
+ "$ref": "#/definitions/esri.Geometry",
779
+ "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile."
780
+ },
781
+ "maps": {
782
+ "$ref": "MapsLike",
783
+ "description": "Map(s) to use for the command/operation."
784
+ },
785
+ "newPoint": {
786
+ "$ref": "#/definitions/esri.Point",
787
+ "description": "The new point to be added."
788
+ }
789
+ },
790
+ "required": [
791
+ "newPoint"
792
+ ],
793
+ "type": "object"
794
+ },
773
795
  "AlertCommandArgs": {
774
796
  "additionalProperties": false,
775
797
  "description": "Arguments for the 'ui.alert' command.",
@@ -1019,6 +1041,10 @@
1019
1041
  "$ref": "MapsLike",
1020
1042
  "description": "The maps to activate drawing on. By default it will be all maps."
1021
1043
  },
1044
+ "maxSegments": {
1045
+ "description": "The maximum number of segments permitted for a polyline or polygon sketch. Default is no limit. Mobile only.",
1046
+ "type": "number"
1047
+ },
1022
1048
  "symbol": {
1023
1049
  "anyOf": [
1024
1050
  {
@@ -1128,6 +1154,48 @@
1128
1154
  ],
1129
1155
  "type": "object"
1130
1156
  },
1157
+ "CreateFeatureArgs": {
1158
+ "additionalProperties": false,
1159
+ "description": "Arguments for the \"edit.create-feature\" operation. Also may be supplied to augment an interactive editing session. A valid feature layer is required. The geometry is required for non-tabular features. Web only.",
1160
+ "properties": {
1161
+ "featureAttributes": {
1162
+ "description": "A collection of attributes to apply to the new feature."
1163
+ },
1164
+ "geometry": {
1165
+ "$ref": "#/definitions/GeometryLike",
1166
+ "description": "The geometry to use for the command/operation."
1167
+ },
1168
+ "layers": {
1169
+ "$ref": "#/definitions/LayersLike",
1170
+ "description": "Layer(s) to use for the command/operation."
1171
+ },
1172
+ "maps": {
1173
+ "$ref": "MapsLike",
1174
+ "description": "Map(s) to use for the command/operation."
1175
+ },
1176
+ "orientation": {
1177
+ "description": "The orientation of the template picker.",
1178
+ "enum": [
1179
+ "horizontal",
1180
+ "vertical"
1181
+ ],
1182
+ "type": "string"
1183
+ },
1184
+ "showNotifications": {
1185
+ "description": "Whether to show UI notifications.",
1186
+ "type": "boolean"
1187
+ },
1188
+ "showTitles": {
1189
+ "description": "Whether to show titles on the template picker.",
1190
+ "type": "boolean"
1191
+ },
1192
+ "templateName": {
1193
+ "description": "The template to use as a starting point for this feature. Requires a layer. The default or first template will be used if not set.",
1194
+ "type": "string"
1195
+ }
1196
+ },
1197
+ "type": "object"
1198
+ },
1131
1199
  "CreateGraphicsResult": {
1132
1200
  "additionalProperties": false,
1133
1201
  "description": "Result of the \"drawing.create-graphics\" and \"measurement.create-graphics\" operations.",
@@ -1303,12 +1371,93 @@
1303
1371
  "description": "Arguments for the \"sketching.delete\" command.",
1304
1372
  "properties": {
1305
1373
  "geometry": {
1374
+ "$ref": "#/definitions/esri.Geometry",
1375
+ "description": "The geometry to remove a point from. If this property is not specified, any active vertices will be deleted."
1376
+ },
1377
+ "maps": {
1378
+ "$ref": "MapsLike",
1379
+ "description": "Map(s) to use for the command/operation."
1380
+ },
1381
+ "partIndex": {
1382
+ "description": "The index of the part of the geometry that the point should be removed from. Required for polyline and polygon geometry types when the geometry and pointIndex properties are defined.",
1383
+ "type": "number"
1384
+ },
1385
+ "point": {
1306
1386
  "$ref": "#/definitions/esri.Point",
1307
- "description": "The point to delete from the active sketch. Not supported in Geocortex Mobile."
1387
+ "description": "The point to remove from the geometry. If this property is defined, the 'pointIndex' and 'partIndex' properties are ignored. If no point nor pointIndex/partIndex are specified, any active points will be deleted. If there are no active points, the entire geometry will be deleted."
1388
+ },
1389
+ "pointIndex": {
1390
+ "description": "The index of the point that should be removed from the geometry. If this property is defined, the geometry property must also be defined.",
1391
+ "type": "number"
1392
+ }
1393
+ },
1394
+ "type": "object"
1395
+ },
1396
+ "DisplayAddFeatureArgs": {
1397
+ "additionalProperties": false,
1398
+ "description": "Arguments for the \"edit.display-add-features\" command. Web only.",
1399
+ "properties": {
1400
+ "attributes": {
1401
+ "description": "Optional layout XML attributes to be used for the transient UI container."
1402
+ },
1403
+ "editAttachments": {
1404
+ "description": "Whether to allow editing of feature attachments.",
1405
+ "type": "boolean"
1406
+ },
1407
+ "editAttributes": {
1408
+ "description": "Whether to allow editing of feature attributes.",
1409
+ "type": "boolean"
1410
+ },
1411
+ "editGeometry": {
1412
+ "description": "Whether to allow editing of feature geometry.",
1413
+ "type": "boolean"
1414
+ },
1415
+ "editGeometryOptions": {
1416
+ "$ref": "#/definitions/EditGeometryOptions",
1417
+ "description": "Options for the geometry editing session."
1418
+ },
1419
+ "featureAttributes": {
1420
+ "description": "A collection of attributes to apply to the new feature."
1421
+ },
1422
+ "geometry": {
1423
+ "$ref": "#/definitions/GeometryLike",
1424
+ "description": "The geometry to use for the command/operation."
1425
+ },
1426
+ "icon": {
1427
+ "description": "Optional icon that may be used by the transient UI container.",
1428
+ "type": "string"
1429
+ },
1430
+ "layers": {
1431
+ "$ref": "#/definitions/LayersLike",
1432
+ "description": "Layer(s) to use for the command/operation."
1308
1433
  },
1309
1434
  "maps": {
1310
1435
  "$ref": "MapsLike",
1311
1436
  "description": "Map(s) to use for the command/operation."
1437
+ },
1438
+ "orientation": {
1439
+ "description": "The orientation of the template picker.",
1440
+ "enum": [
1441
+ "horizontal",
1442
+ "vertical"
1443
+ ],
1444
+ "type": "string"
1445
+ },
1446
+ "parent": {
1447
+ "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.",
1448
+ "type": "string"
1449
+ },
1450
+ "showNotifications": {
1451
+ "description": "Whether to show UI notifications.",
1452
+ "type": "boolean"
1453
+ },
1454
+ "showTitles": {
1455
+ "description": "Whether to show titles on the template picker.",
1456
+ "type": "boolean"
1457
+ },
1458
+ "templateName": {
1459
+ "description": "The template to use as a starting point for this feature. Requires a layer. The default or first template will be used if not set.",
1460
+ "type": "string"
1312
1461
  }
1313
1462
  },
1314
1463
  "type": "object"
@@ -1326,8 +1475,8 @@
1326
1475
  "type": "boolean"
1327
1476
  },
1328
1477
  "message": {
1329
- "description": "The message to be displayed in the notification.",
1330
- "type": "string"
1478
+ "$ref": "#/definitions/TranslatableText",
1479
+ "description": "The message to be displayed in the notification. Mobile only supports a string for this property."
1331
1480
  },
1332
1481
  "notificationGroup": {
1333
1482
  "description": "Notifications in the same notification group are mutually exclusive, and will supersede one another. Mobile only.",
@@ -1351,6 +1500,48 @@
1351
1500
  ],
1352
1501
  "type": "object"
1353
1502
  },
1503
+ "DisplayUpdateFeatureArgs": {
1504
+ "additionalProperties": false,
1505
+ "description": "Arguments for the \"edit.display-update-features\" operation. Web only.",
1506
+ "properties": {
1507
+ "editAttachments": {
1508
+ "description": "Whether to allow editing of feature attachments.",
1509
+ "type": "boolean"
1510
+ },
1511
+ "editAttributes": {
1512
+ "description": "Whether to allow editing of feature attributes.",
1513
+ "type": "boolean"
1514
+ },
1515
+ "editGeometry": {
1516
+ "description": "Whether to allow editing of feature geometry.",
1517
+ "type": "boolean"
1518
+ },
1519
+ "editGeometryOptions": {
1520
+ "$ref": "#/definitions/EditGeometryOptions",
1521
+ "description": "Options for the geometry editing session."
1522
+ },
1523
+ "featureAttributes": {
1524
+ "description": "A collection of attributes to automatically apply to the updated feature."
1525
+ },
1526
+ "features": {
1527
+ "$ref": "#/definitions/FeaturesLike",
1528
+ "description": "Features to use for the command/operation."
1529
+ },
1530
+ "geometry": {
1531
+ "$ref": "#/definitions/GeometryLike",
1532
+ "description": "The geometry to use for the command/operation."
1533
+ },
1534
+ "maps": {
1535
+ "$ref": "MapsLike",
1536
+ "description": "Map(s) to use for the command/operation."
1537
+ },
1538
+ "showNotifications": {
1539
+ "description": "Whether to show UI notifications.",
1540
+ "type": "boolean"
1541
+ }
1542
+ },
1543
+ "type": "object"
1544
+ },
1354
1545
  "DownloadArgs": {
1355
1546
  "additionalProperties": false,
1356
1547
  "description": "Arguments for the system.download-file operation.",
@@ -1432,6 +1623,21 @@
1432
1623
  ],
1433
1624
  "description": "Symbols supported for drawing."
1434
1625
  },
1626
+ "EditCommandArgs": {
1627
+ "additionalProperties": false,
1628
+ "description": "Arguments for the \"edit.add-features\", \"edit.update-features\" and \"edit.delete-features\" commands. Web only.",
1629
+ "properties": {
1630
+ "features": {
1631
+ "$ref": "#/definitions/FeaturesLike",
1632
+ "description": "Features to use for the command/operation."
1633
+ },
1634
+ "showNotifications": {
1635
+ "description": "Whether to show UI notifications.",
1636
+ "type": "boolean"
1637
+ }
1638
+ },
1639
+ "type": "object"
1640
+ },
1435
1641
  "EditGeometryArgs": {
1436
1642
  "additionalProperties": false,
1437
1643
  "description": "Arguments for the \"sketching.edit-geometry\" operation.",
@@ -1517,6 +1723,10 @@
1517
1723
  "description": "Whether to allow scaling of the edited geometry. Defaults to true.",
1518
1724
  "type": "boolean"
1519
1725
  },
1726
+ "enableVertexEditing": {
1727
+ "description": "Whether to allow the user to add, move, and remove vertices from a geometry. Defaults to true.",
1728
+ "type": "boolean"
1729
+ },
1520
1730
  "scaleMode": {
1521
1731
  "description": "Setting \"free\" allows independent scaling on the x and y axis, \"preserve-aspect-ratio\" constrains scaling to the original aspect ratio. Defaults to \"preserve-aspect-ratio\".",
1522
1732
  "enum": [
@@ -1524,6 +1734,10 @@
1524
1734
  "preserve-aspect-ratio"
1525
1735
  ],
1526
1736
  "type": "string"
1737
+ },
1738
+ "validateGeometry": {
1739
+ "description": "Whether the resulting geometry is validated before it's returned from the operation. If the geometry is invalid upon completion, an error is thrown. Defaults to true.",
1740
+ "type": "boolean"
1527
1741
  }
1528
1742
  },
1529
1743
  "type": "object"
@@ -2487,9 +2701,31 @@
2487
2701
  },
2488
2702
  "type": "object"
2489
2703
  },
2704
+ "GetActivePointsResult": {
2705
+ "additionalProperties": false,
2706
+ "description": "Result returned from the 'sketching.get-active-points' operation.",
2707
+ "properties": {
2708
+ "graphics": {
2709
+ "description": "The active graphic(s).",
2710
+ "items": {
2711
+ "$ref": "#/definitions/esri.Graphic"
2712
+ },
2713
+ "type": "array"
2714
+ },
2715
+ "maps": {
2716
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
2717
+ "description": "The map associated with the graphics."
2718
+ }
2719
+ },
2720
+ "required": [
2721
+ "graphics",
2722
+ "maps"
2723
+ ],
2724
+ "type": "object"
2725
+ },
2490
2726
  "GetActiveSketchResult": {
2491
2727
  "additionalProperties": false,
2492
- "description": "Result returned from the 'sketching.get-active-sketch' and 'sketching.get-active-node' operations.",
2728
+ "description": "Result returned from the 'sketching.get-active-sketch' operation.",
2493
2729
  "properties": {
2494
2730
  "graphics": {
2495
2731
  "description": "The active graphic(s).",
@@ -2509,6 +2745,28 @@
2509
2745
  ],
2510
2746
  "type": "object"
2511
2747
  },
2748
+ "GetAdjacentPointArgs": {
2749
+ "additionalProperties": false,
2750
+ "description": "Arguments for the 'sketching.get-adjacent-point' operation.",
2751
+ "properties": {
2752
+ "maps": {
2753
+ "$ref": "MapsLike",
2754
+ "description": "Map(s) to use for the command/operation."
2755
+ },
2756
+ "referencePoint": {
2757
+ "$ref": "#/definitions/esri.Point",
2758
+ "description": "A point geometry that represents a vertex within an active editing graphic."
2759
+ },
2760
+ "relativeOffset": {
2761
+ "$ref": "#/definitions/PointOffset",
2762
+ "description": "Specifies if the desired point comes before or after the referencePoint. Defaults to 'after'."
2763
+ }
2764
+ },
2765
+ "required": [
2766
+ "referencePoint"
2767
+ ],
2768
+ "type": "object"
2769
+ },
2512
2770
  "GetCoordinateArgs": {
2513
2771
  "additionalProperties": false,
2514
2772
  "description": "Arguments for the map.get-user-coordinates-input operation.",
@@ -2840,6 +3098,36 @@
2840
3098
  ],
2841
3099
  "type": "object"
2842
3100
  },
3101
+ "InsertPointArgs": {
3102
+ "additionalProperties": false,
3103
+ "description": "Arguments for the \"sketching.insert-point\" command.",
3104
+ "properties": {
3105
+ "geometry": {
3106
+ "$ref": "#/definitions/esri.Geometry",
3107
+ "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile."
3108
+ },
3109
+ "maps": {
3110
+ "$ref": "MapsLike",
3111
+ "description": "Map(s) to use for the command/operation."
3112
+ },
3113
+ "newPoint": {
3114
+ "$ref": "#/definitions/esri.Point",
3115
+ "description": "The new point to be added."
3116
+ },
3117
+ "partIndex": {
3118
+ "description": "The index of the part to which the point will be added. If null, the last part will be used.",
3119
+ "type": "number"
3120
+ },
3121
+ "pointIndex": {
3122
+ "description": "The index at which the point will be added. If null, the point will be added as the last point.",
3123
+ "type": "number"
3124
+ }
3125
+ },
3126
+ "required": [
3127
+ "newPoint"
3128
+ ],
3129
+ "type": "object"
3130
+ },
2843
3131
  "ItemConfig": {
2844
3132
  "additionalProperties": {
2845
3133
  },
@@ -3006,6 +3294,23 @@
3006
3294
  ],
3007
3295
  "type": "string"
3008
3296
  },
3297
+ "Maps": {
3298
+ "anyOf": [
3299
+ {
3300
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension"
3301
+ },
3302
+ {
3303
+ "$ref": "#/definitions/HasMaps"
3304
+ },
3305
+ {
3306
+ "items": {
3307
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension"
3308
+ },
3309
+ "type": "array"
3310
+ }
3311
+ ],
3312
+ "description": "One or more map extensions, or an object that has map extensions."
3313
+ },
3009
3314
  "MapsLike": {
3010
3315
  "anyOf": [
3011
3316
  {
@@ -3149,7 +3454,7 @@
3149
3454
  },
3150
3455
  "MoveNodeArgs": {
3151
3456
  "additionalProperties": false,
3152
- "description": "The arguments for the \"sketching.move-node\" command.",
3457
+ "description": "Deprecated - use \"sketching.move-point\" with {@link MovePointArgs}.",
3153
3458
  "properties": {
3154
3459
  "maps": {
3155
3460
  "$ref": "MapsLike",
@@ -3169,6 +3474,45 @@
3169
3474
  ],
3170
3475
  "type": "object"
3171
3476
  },
3477
+ "MovePointArgs": {
3478
+ "additionalProperties": false,
3479
+ "description": "The arguments for the \"sketching.move-point\" command.",
3480
+ "properties": {
3481
+ "distance": {
3482
+ "$ref": "#/definitions/Vector2D",
3483
+ "description": "An amount to move the point(s) on the X and Y axes. If the newPoint property is defined, this property will be ignored."
3484
+ },
3485
+ "geometry": {
3486
+ "$ref": "#/definitions/esri.Geometry",
3487
+ "description": "The geometry where the point exists, if multiple are present in an active editing session. This property is required if pointIndex and/or partIndex are defined."
3488
+ },
3489
+ "maps": {
3490
+ "$ref": "MapsLike",
3491
+ "description": "Map(s) to use for the command/operation."
3492
+ },
3493
+ "newPoint": {
3494
+ "$ref": "#/definitions/esri.Point",
3495
+ "description": "The new point that will replace the target point within an active sketch or edit geometry. If this property is defined, the distance property will be ignored."
3496
+ },
3497
+ "partIndex": {
3498
+ "description": "The part of the geometry where the point exists. Required for polyline and polygon geometry types when the geometry and pointIndex properties are defined.",
3499
+ "type": "number"
3500
+ },
3501
+ "point": {
3502
+ "$ref": "#/definitions/esri.Point",
3503
+ "description": "The point to move, which must already exist within the active sketch. If this property is undefined and no geometry and pointIndex are specified, the active point(s) will be moved."
3504
+ },
3505
+ "pointIndex": {
3506
+ "description": "The index of the point. If this property is defined, the 'geometry' property must also be defined.",
3507
+ "type": "number"
3508
+ },
3509
+ "units": {
3510
+ "$ref": "#/definitions/LengthUnits",
3511
+ "description": "The units of the above distance. Optional, will default to the units used by the measurement service associated with the map."
3512
+ }
3513
+ },
3514
+ "type": "object"
3515
+ },
3172
3516
  "NarrateArgs": {
3173
3517
  "anyOf": [
3174
3518
  {
@@ -3255,6 +3599,14 @@
3255
3599
  ],
3256
3600
  "type": "string"
3257
3601
  },
3602
+ "PointOffset": {
3603
+ "description": "Specifies if a desired point comes before or after a given reference point.",
3604
+ "enum": [
3605
+ "after",
3606
+ "before"
3607
+ ],
3608
+ "type": "string"
3609
+ },
3258
3610
  "ProjectArgs": {
3259
3611
  "additionalProperties": false,
3260
3612
  "description": "Arguments for the geometry.project operation.",
@@ -3758,6 +4110,43 @@
3758
4110
  ],
3759
4111
  "type": "object"
3760
4112
  },
4113
+ "SetActivePointsArgs": {
4114
+ "additionalProperties": false,
4115
+ "description": "The arguments for the \"sketching.set-active-points\" command.",
4116
+ "properties": {
4117
+ "geometry": {
4118
+ "$ref": "#/definitions/esri.Geometry",
4119
+ "description": "The geometry where the new active point exists, if multiple are present in an active editing session. This property is required if pointIndex and/or partIndex are defined."
4120
+ },
4121
+ "maps": {
4122
+ "$ref": "MapsLike",
4123
+ "description": "Map(s) to use for the command/operation."
4124
+ },
4125
+ "partIndex": {
4126
+ "description": "The part of the geometry where the new active point exists. Required for polyline and polygon geometry types when the geometry and pointIndex properties are defined.",
4127
+ "type": "number"
4128
+ },
4129
+ "pointIndex": {
4130
+ "description": "The index of the new active point. If this property is defined, the geometry property must be defined.",
4131
+ "type": "number"
4132
+ },
4133
+ "points": {
4134
+ "anyOf": [
4135
+ {
4136
+ "$ref": "#/definitions/esri.Point"
4137
+ },
4138
+ {
4139
+ "items": {
4140
+ "$ref": "#/definitions/esri.Point"
4141
+ },
4142
+ "type": "array"
4143
+ }
4144
+ ],
4145
+ "description": "The new point(s) that will become active in the sketch or editing session. Sketching only supports one active point; if multiple are specified, then only the first will be set as active."
4146
+ }
4147
+ },
4148
+ "type": "object"
4149
+ },
3761
4150
  "SetBasemapArg": {
3762
4151
  "anyOf": [
3763
4152
  {
@@ -4102,7 +4491,7 @@
4102
4491
  },
4103
4492
  "SwitchActiveNodeArgs": {
4104
4493
  "additionalProperties": false,
4105
- "description": "The arguments for the \"sketching.switch-active-node\" command.",
4494
+ "description": "Deprecated - use \"sketching.set-active-points\" with {@link SetActivePointsArgs}.",
4106
4495
  "properties": {
4107
4496
  "maps": {
4108
4497
  "$ref": "MapsLike",
@@ -4509,6 +4898,61 @@
4509
4898
  ],
4510
4899
  "type": "object"
4511
4900
  },
4901
+ "TranslatableText": {
4902
+ "anyOf": [
4903
+ {
4904
+ "$ref": "#/definitions/TranslateOptions"
4905
+ },
4906
+ {
4907
+ "type": "string"
4908
+ }
4909
+ ],
4910
+ "description": "A translatable string, either a language string or a language string with arguments to pass into it."
4911
+ },
4912
+ "TranslateOptions": {
4913
+ "additionalProperties": false,
4914
+ "description": "The available options for the Locale Service translate function.",
4915
+ "properties": {
4916
+ "args": {
4917
+ "description": "The values to substitute into the format string if it contains substitution placeholders (see utilities/string/format in Geocortex API).",
4918
+ "items": {
4919
+ },
4920
+ "type": "array"
4921
+ },
4922
+ "currency": {
4923
+ "description": "The default unit of currency to use when formatting currency. See {@link NumberSettings.currency}.",
4924
+ "type": "string"
4925
+ },
4926
+ "dateFormat": {
4927
+ "description": "The default format to use when formatting dates. See {@link DateFormatter.format}.",
4928
+ "type": "string"
4929
+ },
4930
+ "fractionalDigits": {
4931
+ "description": "The default number of digits to show after the decimal point when formatting numbers. See {@link NumberSettings.fractionalDigits}.",
4932
+ "type": "number"
4933
+ },
4934
+ "locale": {
4935
+ "description": "The locale to use for translation. If not specified, the current locale will be used.",
4936
+ "type": "string"
4937
+ },
4938
+ "numberFormat": {
4939
+ "description": "The default format to use when formatting numbers. See {@link NumberFormatter.format}.",
4940
+ "type": "string"
4941
+ },
4942
+ "text": {
4943
+ "description": "The string to translate. If the text is a language resource key, then a localized version of that resource will be used if one exists, otherwise the original text is returned.",
4944
+ "type": "string"
4945
+ },
4946
+ "timeZone": {
4947
+ "description": "The time zone of a date being formatted.",
4948
+ "type": "string"
4949
+ }
4950
+ },
4951
+ "required": [
4952
+ "text"
4953
+ ],
4954
+ "type": "object"
4955
+ },
4512
4956
  "UpdateChartDefinitionArgs": {
4513
4957
  "additionalProperties": false,
4514
4958
  "description": "Arguments for the charts.update-definition command.",
@@ -5407,21 +5851,131 @@
5407
5851
  "$ref": "#/definitions/GraphicsLike",
5408
5852
  "description": "Graphics to use for the command/operation."
5409
5853
  },
5410
- "symbol": {
5411
- "$ref": "#/definitions/SymbolLike",
5412
- "description": "The symbol to use for the command/operation."
5854
+ "symbol": {
5855
+ "$ref": "#/definitions/SymbolLike",
5856
+ "description": "The symbol to use for the command/operation."
5857
+ }
5858
+ },
5859
+ "type": "object"
5860
+ },
5861
+ "drawing.set-sync": {
5862
+ "description": "Sets a value that determines whether drawings will be synced automatically across maps.",
5863
+ "enum": [
5864
+ "drawing.set-sync"
5865
+ ]
5866
+ },
5867
+ "drawing.set-sync:input": {
5868
+ "type": "boolean"
5869
+ },
5870
+ "edit.add-feature": {
5871
+ "description": "Adds a feature to a particular layer. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
5872
+ "enum": [
5873
+ "edit.add-feature"
5874
+ ]
5875
+ },
5876
+ "edit.add-feature:input": {
5877
+ "anyOf": [
5878
+ {
5879
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
5880
+ },
5881
+ {
5882
+ "$ref": "#/definitions/EditCommandArgs"
5883
+ },
5884
+ {
5885
+ "items": {
5886
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
5887
+ },
5888
+ "type": "array"
5889
+ }
5890
+ ]
5891
+ },
5892
+ "edit.create-feature": {
5893
+ "description": "Creates a new `Feature` for the supplied layer from the supplied data.",
5894
+ "enum": [
5895
+ "edit.create-feature"
5896
+ ]
5897
+ },
5898
+ "edit.create-feature:input": {
5899
+ "$ref": "#/definitions/CreateFeatureArgs"
5900
+ },
5901
+ "edit.create-feature:output": {
5902
+ "$ref": "#/definitions/HasFeatures"
5903
+ },
5904
+ "edit.delete-features": {
5905
+ "description": "Deletes the given feature or features from their feature sources. `EditCommandArgs` is not supported on Mobile.",
5906
+ "enum": [
5907
+ "edit.delete-features"
5908
+ ]
5909
+ },
5910
+ "edit.delete-features:input": {
5911
+ "anyOf": [
5912
+ {
5913
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
5914
+ },
5915
+ {
5916
+ "$ref": "#/definitions/EditCommandArgs"
5917
+ },
5918
+ {
5919
+ "items": {
5920
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
5921
+ },
5922
+ "type": "array"
5923
+ }
5924
+ ]
5925
+ },
5926
+ "edit.display-add-feature": {
5927
+ "description": "Display a form for adding a feature. `DisplayAddFeatureArgs` is not supported on Mobile.",
5928
+ "enum": [
5929
+ "edit.display-add-feature"
5930
+ ]
5931
+ },
5932
+ "edit.display-add-feature:input": {
5933
+ "anyOf": [
5934
+ {
5935
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
5936
+ },
5937
+ {
5938
+ "$ref": "#/definitions/DisplayAddFeatureArgs"
5939
+ }
5940
+ ]
5941
+ },
5942
+ "edit.display-update-feature": {
5943
+ "description": "Display a form for updating a feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.",
5944
+ "enum": [
5945
+ "edit.display-update-feature"
5946
+ ]
5947
+ },
5948
+ "edit.display-update-feature:input": {
5949
+ "anyOf": [
5950
+ {
5951
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
5952
+ },
5953
+ {
5954
+ "$ref": "#/definitions/DisplayUpdateFeatureArgs"
5413
5955
  }
5414
- },
5415
- "type": "object"
5956
+ ]
5416
5957
  },
5417
- "drawing.set-sync": {
5418
- "description": "Sets a value that determines whether drawings will be synced automatically across maps.",
5958
+ "edit.update-feature": {
5959
+ "description": "Updates a feature. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
5419
5960
  "enum": [
5420
- "drawing.set-sync"
5961
+ "edit.update-feature"
5421
5962
  ]
5422
5963
  },
5423
- "drawing.set-sync:input": {
5424
- "type": "boolean"
5964
+ "edit.update-feature:input": {
5965
+ "anyOf": [
5966
+ {
5967
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
5968
+ },
5969
+ {
5970
+ "$ref": "#/definitions/EditCommandArgs"
5971
+ },
5972
+ {
5973
+ "items": {
5974
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
5975
+ },
5976
+ "type": "array"
5977
+ }
5978
+ ]
5425
5979
  },
5426
5980
  "esri.Color": {
5427
5981
  "$ref": "esri/Color"
@@ -16648,7 +17202,7 @@
16648
17202
  ]
16649
17203
  },
16650
17204
  "sketching.add-node-to-geometry": {
16651
- "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry. Deprecated in Mobile, use geometry.add-point instead.",
17205
+ "description": "Deprecated - Mobile users should rather use \"geometry.add-point\"; Web users should use \"sketching.add-point\" or \"sketching.insert-point\" instead.",
16652
17206
  "enum": [
16653
17207
  "sketching.add-node-to-geometry"
16654
17208
  ]
@@ -16659,6 +17213,15 @@
16659
17213
  "sketching.add-node-to-geometry:output": {
16660
17214
  "$ref": "#/definitions/esri.Geometry"
16661
17215
  },
17216
+ "sketching.add-point": {
17217
+ "description": "Adds a point to polygon, polyline, or multipoint using the selected index as the point to insert after.",
17218
+ "enum": [
17219
+ "sketching.add-point"
17220
+ ]
17221
+ },
17222
+ "sketching.add-point:input": {
17223
+ "$ref": "#/definitions/AddPointArgs"
17224
+ },
16662
17225
  "sketching.cancel": {
16663
17226
  "description": "Cancels the current geometry edit or capture operation.",
16664
17227
  "enum": [
@@ -16678,13 +17241,20 @@
16678
17241
  "$ref": "#/definitions/CaptureGeometryResult"
16679
17242
  },
16680
17243
  "sketching.delete": {
16681
- "description": "If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied and a geometry editing session is active, the entire geometry will be deleted.",
17244
+ "description": "If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied, any active points in the session will be deleted. If there are no active points in the session, the entire geometry will be deleted.",
16682
17245
  "enum": [
16683
17246
  "sketching.delete"
16684
17247
  ]
16685
17248
  },
16686
17249
  "sketching.delete:input": {
16687
- "$ref": "#/definitions/DeleteGeometryArgs"
17250
+ "anyOf": [
17251
+ {
17252
+ "$ref": "#/definitions/DeleteGeometryArgs"
17253
+ },
17254
+ {
17255
+ "type": "null"
17256
+ }
17257
+ ]
16688
17258
  },
16689
17259
  "sketching.disable-free-scale-mode": {
16690
17260
  "description": "Disables free scaling while editing geometries.",
@@ -16732,16 +17302,28 @@
16732
17302
  ]
16733
17303
  },
16734
17304
  "sketching.get-active-node": {
16735
- "description": "Returns the active point graphic of the active sketch on a map.",
17305
+ "description": "Deprecated - use 'sketching.get-active-points' instead.",
16736
17306
  "enum": [
16737
17307
  "sketching.get-active-node"
16738
17308
  ]
16739
17309
  },
16740
17310
  "sketching.get-active-node:input": {
16741
- "type": "string"
17311
+ "$ref": "Maps"
16742
17312
  },
16743
17313
  "sketching.get-active-node:output": {
16744
- "$ref": "#/definitions/GetActiveSketchResult"
17314
+ "$ref": "#/definitions/GetActivePointsResult"
17315
+ },
17316
+ "sketching.get-active-points": {
17317
+ "description": "Returns the active point graphics of the active sketch or edit session on a map.",
17318
+ "enum": [
17319
+ "sketching.get-active-points"
17320
+ ]
17321
+ },
17322
+ "sketching.get-active-points:input": {
17323
+ "$ref": "Maps"
17324
+ },
17325
+ "sketching.get-active-points:output": {
17326
+ "$ref": "#/definitions/GetActivePointsResult"
16745
17327
  },
16746
17328
  "sketching.get-active-sketch": {
16747
17329
  "description": "Returns the active sketch graphic from a map.",
@@ -16752,6 +17334,27 @@
16752
17334
  "sketching.get-active-sketch:output": {
16753
17335
  "$ref": "#/definitions/GetActiveSketchResult"
16754
17336
  },
17337
+ "sketching.get-adjacent-point": {
17338
+ "description": "Return the adjacent point graphic(s), relative to a given vertex that's a part of an active editing or sketching session. This operation is only supported for Polyline and Polygon geometries.",
17339
+ "enum": [
17340
+ "sketching.get-adjacent-point"
17341
+ ]
17342
+ },
17343
+ "sketching.get-adjacent-point:input": {
17344
+ "$ref": "#/definitions/GetAdjacentPointArgs"
17345
+ },
17346
+ "sketching.get-adjacent-point:output": {
17347
+ "$ref": "#/definitions/GetActiveSketchResult"
17348
+ },
17349
+ "sketching.insert-point": {
17350
+ "description": "Inserts a point into a polygon, polyline, or multipoint at the specified index. If the partIndex is null, then the last part is used. If the pointIndex is null, then the new point is inserted at the end.",
17351
+ "enum": [
17352
+ "sketching.insert-point"
17353
+ ]
17354
+ },
17355
+ "sketching.insert-point:input": {
17356
+ "$ref": "#/definitions/InsertPointArgs"
17357
+ },
16755
17358
  "sketching.move-geometry": {
16756
17359
  "description": "Allows the user to move an existing geometry by a specified amount. Returns the altered geometry or the supplied feature with altered geometry applied. Will also pass through any map or symbol associated with the command chain, but only the map is required for this operation.",
16757
17360
  "enum": [
@@ -16765,7 +17368,7 @@
16765
17368
  "$ref": "#/definitions/GeometryOperationBase"
16766
17369
  },
16767
17370
  "sketching.move-node": {
16768
- "description": "Moves a point within an active sketch to a new location.",
17371
+ "description": "Deprecated - use 'sketching.move-point' instead.",
16769
17372
  "enum": [
16770
17373
  "sketching.move-node"
16771
17374
  ]
@@ -16773,6 +17376,15 @@
16773
17376
  "sketching.move-node:input": {
16774
17377
  "$ref": "#/definitions/MoveNodeArgs"
16775
17378
  },
17379
+ "sketching.move-point": {
17380
+ "description": "Moves a point within an active sketch to a new location.",
17381
+ "enum": [
17382
+ "sketching.move-point"
17383
+ ]
17384
+ },
17385
+ "sketching.move-point:input": {
17386
+ "$ref": "#/definitions/MovePointArgs"
17387
+ },
16776
17388
  "sketching.redo": {
16777
17389
  "description": "Redoes the last undone edit while editing a geometry.",
16778
17390
  "enum": [
@@ -16806,6 +17418,15 @@
16806
17418
  "sketching.scale-geometry:output": {
16807
17419
  "$ref": "#/definitions/GeometryOperationBase"
16808
17420
  },
17421
+ "sketching.set-active-points": {
17422
+ "description": "Switches the active point of an active sketch.",
17423
+ "enum": [
17424
+ "sketching.set-active-points"
17425
+ ]
17426
+ },
17427
+ "sketching.set-active-points:input": {
17428
+ "$ref": "#/definitions/SetActivePointsArgs"
17429
+ },
16809
17430
  "sketching.set-geometry-mode": {
16810
17431
  "description": "Sets the geometry mode of the geometry editor.",
16811
17432
  "enum": [
@@ -16816,7 +17437,7 @@
16816
17437
  "$ref": "#/definitions/SetGeometryModeArgs"
16817
17438
  },
16818
17439
  "sketching.stop": {
16819
- "description": "Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, returns null.",
17440
+ "description": "Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, the operation will return null.",
16820
17441
  "enum": [
16821
17442
  "sketching.stop"
16822
17443
  ]
@@ -16835,7 +17456,7 @@
16835
17456
  "$ref": "#/definitions/CaptureGeometryResult"
16836
17457
  },
16837
17458
  "sketching.switch-active-node": {
16838
- "description": "Switches the active point of an active sketch.",
17459
+ "description": "Deprecated - use 'sketching.set-active-points' instead.",
16839
17460
  "enum": [
16840
17461
  "sketching.switch-active-node"
16841
17462
  ]
@@ -17372,6 +17993,86 @@
17372
17993
  ],
17373
17994
  "type": "object"
17374
17995
  },
17996
+ {
17997
+ "additionalProperties": false,
17998
+ "properties": {
17999
+ "arguments": {
18000
+ "$ref": "#/definitions/edit.add-feature:input"
18001
+ },
18002
+ "name": {
18003
+ "$ref": "#/definitions/edit.add-feature"
18004
+ }
18005
+ },
18006
+ "required": [
18007
+ "name",
18008
+ "arguments"
18009
+ ],
18010
+ "type": "object"
18011
+ },
18012
+ {
18013
+ "additionalProperties": false,
18014
+ "properties": {
18015
+ "arguments": {
18016
+ "$ref": "#/definitions/edit.delete-features:input"
18017
+ },
18018
+ "name": {
18019
+ "$ref": "#/definitions/edit.delete-features"
18020
+ }
18021
+ },
18022
+ "required": [
18023
+ "name",
18024
+ "arguments"
18025
+ ],
18026
+ "type": "object"
18027
+ },
18028
+ {
18029
+ "additionalProperties": false,
18030
+ "properties": {
18031
+ "arguments": {
18032
+ "$ref": "#/definitions/edit.display-add-feature:input"
18033
+ },
18034
+ "name": {
18035
+ "$ref": "#/definitions/edit.display-add-feature"
18036
+ }
18037
+ },
18038
+ "required": [
18039
+ "name",
18040
+ "arguments"
18041
+ ],
18042
+ "type": "object"
18043
+ },
18044
+ {
18045
+ "additionalProperties": false,
18046
+ "properties": {
18047
+ "arguments": {
18048
+ "$ref": "#/definitions/edit.display-update-feature:input"
18049
+ },
18050
+ "name": {
18051
+ "$ref": "#/definitions/edit.display-update-feature"
18052
+ }
18053
+ },
18054
+ "required": [
18055
+ "name",
18056
+ "arguments"
18057
+ ],
18058
+ "type": "object"
18059
+ },
18060
+ {
18061
+ "additionalProperties": false,
18062
+ "properties": {
18063
+ "arguments": {
18064
+ "$ref": "#/definitions/edit.update-feature:input"
18065
+ },
18066
+ "name": {
18067
+ "$ref": "#/definitions/edit.update-feature"
18068
+ }
18069
+ },
18070
+ "required": [
18071
+ "name",
18072
+ "arguments"
18073
+ ],
18074
+ "type": "object"
18075
+ },
17375
18076
  {
17376
18077
  "additionalProperties": false,
17377
18078
  "properties": {
@@ -18684,6 +19385,22 @@
18684
19385
  ],
18685
19386
  "type": "object"
18686
19387
  },
19388
+ {
19389
+ "additionalProperties": false,
19390
+ "properties": {
19391
+ "arguments": {
19392
+ "$ref": "#/definitions/sketching.add-point:input"
19393
+ },
19394
+ "name": {
19395
+ "$ref": "#/definitions/sketching.add-point"
19396
+ }
19397
+ },
19398
+ "required": [
19399
+ "name",
19400
+ "arguments"
19401
+ ],
19402
+ "type": "object"
19403
+ },
18687
19404
  {
18688
19405
  "additionalProperties": false,
18689
19406
  "properties": {
@@ -18700,6 +19417,22 @@
18700
19417
  ],
18701
19418
  "type": "object"
18702
19419
  },
19420
+ {
19421
+ "additionalProperties": false,
19422
+ "properties": {
19423
+ "arguments": {
19424
+ "$ref": "#/definitions/sketching.insert-point:input"
19425
+ },
19426
+ "name": {
19427
+ "$ref": "#/definitions/sketching.insert-point"
19428
+ }
19429
+ },
19430
+ "required": [
19431
+ "name",
19432
+ "arguments"
19433
+ ],
19434
+ "type": "object"
19435
+ },
18703
19436
  {
18704
19437
  "additionalProperties": false,
18705
19438
  "properties": {
@@ -18716,6 +19449,22 @@
18716
19449
  ],
18717
19450
  "type": "object"
18718
19451
  },
19452
+ {
19453
+ "additionalProperties": false,
19454
+ "properties": {
19455
+ "arguments": {
19456
+ "$ref": "#/definitions/sketching.move-point:input"
19457
+ },
19458
+ "name": {
19459
+ "$ref": "#/definitions/sketching.move-point"
19460
+ }
19461
+ },
19462
+ "required": [
19463
+ "name",
19464
+ "arguments"
19465
+ ],
19466
+ "type": "object"
19467
+ },
18719
19468
  {
18720
19469
  "additionalProperties": false,
18721
19470
  "properties": {
@@ -18732,6 +19481,22 @@
18732
19481
  ],
18733
19482
  "type": "object"
18734
19483
  },
19484
+ {
19485
+ "additionalProperties": false,
19486
+ "properties": {
19487
+ "arguments": {
19488
+ "$ref": "#/definitions/sketching.set-active-points:input"
19489
+ },
19490
+ "name": {
19491
+ "$ref": "#/definitions/sketching.set-active-points"
19492
+ }
19493
+ },
19494
+ "required": [
19495
+ "name",
19496
+ "arguments"
19497
+ ],
19498
+ "type": "object"
19499
+ },
18735
19500
  {
18736
19501
  "additionalProperties": false,
18737
19502
  "properties": {
@@ -19059,6 +19824,21 @@
19059
19824
  {
19060
19825
  "$ref": "#/definitions/drawing.set-sync"
19061
19826
  },
19827
+ {
19828
+ "$ref": "#/definitions/edit.add-feature"
19829
+ },
19830
+ {
19831
+ "$ref": "#/definitions/edit.delete-features"
19832
+ },
19833
+ {
19834
+ "$ref": "#/definitions/edit.display-add-feature"
19835
+ },
19836
+ {
19837
+ "$ref": "#/definitions/edit.display-update-feature"
19838
+ },
19839
+ {
19840
+ "$ref": "#/definitions/edit.update-feature"
19841
+ },
19062
19842
  {
19063
19843
  "$ref": "#/definitions/geocode.batch-geocode"
19064
19844
  },
@@ -19314,6 +20094,9 @@
19314
20094
  {
19315
20095
  "$ref": "#/definitions/search.clear"
19316
20096
  },
20097
+ {
20098
+ "$ref": "#/definitions/sketching.add-point"
20099
+ },
19317
20100
  {
19318
20101
  "$ref": "#/definitions/sketching.cancel"
19319
20102
  },
@@ -19332,12 +20115,21 @@
19332
20115
  {
19333
20116
  "$ref": "#/definitions/sketching.enable-precision-mode"
19334
20117
  },
20118
+ {
20119
+ "$ref": "#/definitions/sketching.insert-point"
20120
+ },
19335
20121
  {
19336
20122
  "$ref": "#/definitions/sketching.move-node"
19337
20123
  },
20124
+ {
20125
+ "$ref": "#/definitions/sketching.move-point"
20126
+ },
19338
20127
  {
19339
20128
  "$ref": "#/definitions/sketching.redo"
19340
20129
  },
20130
+ {
20131
+ "$ref": "#/definitions/sketching.set-active-points"
20132
+ },
19341
20133
  {
19342
20134
  "$ref": "#/definitions/sketching.set-geometry-mode"
19343
20135
  },
@@ -19527,6 +20319,22 @@
19527
20319
  ],
19528
20320
  "type": "object"
19529
20321
  },
20322
+ {
20323
+ "additionalProperties": false,
20324
+ "properties": {
20325
+ "arguments": {
20326
+ "$ref": "#/definitions/edit.create-feature:input"
20327
+ },
20328
+ "name": {
20329
+ "$ref": "#/definitions/edit.create-feature"
20330
+ }
20331
+ },
20332
+ "required": [
20333
+ "name",
20334
+ "arguments"
20335
+ ],
20336
+ "type": "object"
20337
+ },
19530
20338
  {
19531
20339
  "additionalProperties": false,
19532
20340
  "properties": {
@@ -20039,6 +20847,38 @@
20039
20847
  ],
20040
20848
  "type": "object"
20041
20849
  },
20850
+ {
20851
+ "additionalProperties": false,
20852
+ "properties": {
20853
+ "arguments": {
20854
+ "$ref": "#/definitions/sketching.get-active-points:input"
20855
+ },
20856
+ "name": {
20857
+ "$ref": "#/definitions/sketching.get-active-points"
20858
+ }
20859
+ },
20860
+ "required": [
20861
+ "name",
20862
+ "arguments"
20863
+ ],
20864
+ "type": "object"
20865
+ },
20866
+ {
20867
+ "additionalProperties": false,
20868
+ "properties": {
20869
+ "arguments": {
20870
+ "$ref": "#/definitions/sketching.get-adjacent-point:input"
20871
+ },
20872
+ "name": {
20873
+ "$ref": "#/definitions/sketching.get-adjacent-point"
20874
+ }
20875
+ },
20876
+ "required": [
20877
+ "name",
20878
+ "arguments"
20879
+ ],
20880
+ "type": "object"
20881
+ },
20042
20882
  {
20043
20883
  "additionalProperties": false,
20044
20884
  "properties": {
@@ -20283,6 +21123,9 @@
20283
21123
  {
20284
21124
  "$ref": "#/definitions/drawing.get-default-symbol3-d"
20285
21125
  },
21126
+ {
21127
+ "$ref": "#/definitions/edit.create-feature"
21128
+ },
20286
21129
  {
20287
21130
  "$ref": "#/definitions/geolocation.get-current-state"
20288
21131
  },
@@ -20400,9 +21243,15 @@
20400
21243
  {
20401
21244
  "$ref": "#/definitions/sketching.get-active-node"
20402
21245
  },
21246
+ {
21247
+ "$ref": "#/definitions/sketching.get-active-points"
21248
+ },
20403
21249
  {
20404
21250
  "$ref": "#/definitions/sketching.get-active-sketch"
20405
21251
  },
21252
+ {
21253
+ "$ref": "#/definitions/sketching.get-adjacent-point"
21254
+ },
20406
21255
  {
20407
21256
  "$ref": "#/definitions/sketching.move-geometry"
20408
21257
  },