@vertigis/viewer-spec 47.2.0 → 47.4.1

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.
Files changed (16) hide show
  1. package/app-config/common/BrandingColors.d.ts +2 -0
  2. package/app-config/schema/web-app-config.schema.json +1 -1
  3. package/app-config/web/FeatureInfoModelProperties.d.ts +15 -0
  4. package/messaging/registry/edit.d.ts +87 -23
  5. package/messaging/registry/edit.js +1 -1
  6. package/messaging/registry/results.d.ts +10 -6
  7. package/messaging/registry/ui.d.ts +0 -2
  8. package/messaging/schema/common-action.schema.json +118 -26
  9. package/messaging/schema/common-event.schema.json +3 -3
  10. package/messaging/schema/mobile-action.schema.json +109 -26
  11. package/messaging/schema/mobile-event.schema.json +3 -3
  12. package/messaging/schema/web-action.schema.json +213 -30
  13. package/messaging/schema/web-event.schema.json +551 -11
  14. package/package.json +13 -13
  15. package/version.d.ts +1 -1
  16. package/version.js +1 -1
package/messaging/schema/mobile-action.schema.json CHANGED
@@ -955,13 +955,6 @@
955
955
  "additionalProperties": false,
956
956
  "description": "Arguments for the \"edit.display-add-features\" command. Web only.",
957
957
  "properties": {
958
- "attributes": {
959
- "description": "Optional layout XML attributes to be used for the transient UI container."
960
- },
961
- "editAttachments": {
962
- "description": "Whether to allow editing of feature attachments.",
963
- "type": "boolean"
964
- },
965
958
  "editAttributes": {
966
959
  "description": "Whether to allow editing of feature attributes.",
967
960
  "type": "boolean"
@@ -977,14 +970,14 @@
977
970
  "featureAttributes": {
978
971
  "description": "A collection of attributes to apply to the new feature."
979
972
  },
973
+ "formUITarget": {
974
+ "$ref": "#/definitions/HasUITarget",
975
+ "description": "Arguments for the display of the attribute editing form."
976
+ },
980
977
  "geometry": {
981
978
  "$ref": "#/definitions/GeometryLike",
982
979
  "description": "The geometry to use for the command/operation."
983
980
  },
984
- "icon": {
985
- "description": "Optional icon that may be used by the transient UI container.",
986
- "type": "string"
987
- },
988
981
  "layers": {
989
982
  "$ref": "#/definitions/LayersLike",
990
983
  "description": "Layer(s) to use for the command/operation."
@@ -1001,10 +994,6 @@
1001
994
  ],
1002
995
  "type": "string"
1003
996
  },
1004
- "parent": {
1005
- "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.",
1006
- "type": "string"
1007
- },
1008
997
  "showNotifications": {
1009
998
  "description": "Whether to show UI notifications.",
1010
999
  "type": "boolean"
@@ -1016,6 +1005,14 @@
1016
1005
  "templateName": {
1017
1006
  "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.",
1018
1007
  "type": "string"
1008
+ },
1009
+ "templateUITarget": {
1010
+ "$ref": "#/definitions/HasUITarget",
1011
+ "description": "Arguments for the display of the template picker."
1012
+ },
1013
+ "typeId": {
1014
+ "description": "A type id to use as a starting point for this feature. This may return one or more templates and requires a layer with types defined.",
1015
+ "type": "string"
1019
1016
  }
1020
1017
  },
1021
1018
  "type": "object"
@@ -1132,8 +1129,11 @@
1132
1129
  "additionalProperties": false,
1133
1130
  "description": "Arguments for the \"edit.display-update-features\" operation. Web only.",
1134
1131
  "properties": {
1132
+ "attributes": {
1133
+ "description": "Optional layout XML attributes to be used for the transient UI container."
1134
+ },
1135
1135
  "editAttachments": {
1136
- "description": "Whether to allow editing of feature attachments.",
1136
+ "description": "Whether to allow editing of feature attachments. Web only.",
1137
1137
  "type": "boolean"
1138
1138
  },
1139
1139
  "editAttributes": {
@@ -1159,10 +1159,18 @@
1159
1159
  "$ref": "#/definitions/GeometryLike",
1160
1160
  "description": "The geometry to use for the command/operation."
1161
1161
  },
1162
+ "icon": {
1163
+ "description": "Optional icon that may be used by the transient UI container.",
1164
+ "type": "string"
1165
+ },
1162
1166
  "maps": {
1163
1167
  "$ref": "MapsLike",
1164
1168
  "description": "Map(s) to use for the command/operation."
1165
1169
  },
1170
+ "parent": {
1171
+ "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.",
1172
+ "type": "string"
1173
+ },
1166
1174
  "showNotifications": {
1167
1175
  "description": "Whether to show UI notifications.",
1168
1176
  "type": "boolean"
@@ -1833,6 +1841,24 @@
1833
1841
  },
1834
1842
  "type": "object"
1835
1843
  },
1844
+ "HasUITarget": {
1845
+ "additionalProperties": false,
1846
+ "description": "An object with arguments for a command or operation that can display temporary UI.",
1847
+ "properties": {
1848
+ "attributes": {
1849
+ "description": "Optional layout XML attributes to be used for the transient UI container."
1850
+ },
1851
+ "icon": {
1852
+ "description": "Optional icon that may be used by the transient UI container.",
1853
+ "type": "string"
1854
+ },
1855
+ "parent": {
1856
+ "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.",
1857
+ "type": "string"
1858
+ }
1859
+ },
1860
+ "type": "object"
1861
+ },
1836
1862
  "HideMapArgs": {
1837
1863
  "additionalProperties": false,
1838
1864
  "description": "Arguments for the \"map.hide\" operation.",
@@ -3342,24 +3368,43 @@
3342
3368
  ]
3343
3369
  },
3344
3370
  "edit.add-feature": {
3345
- "description": "Adds a feature to a particular layer. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
3371
+ "description": "Adds a feature to a particular layer. `Features` and `EditCommandArgs` are not supported on Mobile.",
3346
3372
  "enum": [
3347
3373
  "edit.add-feature"
3348
3374
  ]
3349
3375
  },
3350
3376
  "edit.add-feature:input": {
3351
3377
  "anyOf": [
3378
+ {
3379
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
3380
+ },
3352
3381
  {
3353
3382
  "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3354
3383
  },
3355
3384
  {
3356
- "$ref": "#/definitions/EditCommandArgs"
3385
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
3386
+ },
3387
+ {
3388
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
3357
3389
  },
3358
3390
  {
3359
3391
  "items": {
3360
- "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3392
+ "anyOf": [
3393
+ {
3394
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3395
+ },
3396
+ {
3397
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
3398
+ }
3399
+ ]
3361
3400
  },
3362
3401
  "type": "array"
3402
+ },
3403
+ {
3404
+ "$ref": "#/definitions/Results"
3405
+ },
3406
+ {
3407
+ "$ref": "#/definitions/EditCommandArgs"
3363
3408
  }
3364
3409
  ]
3365
3410
  },
@@ -3380,22 +3425,41 @@
3380
3425
  },
3381
3426
  "edit.delete-features:input": {
3382
3427
  "anyOf": [
3428
+ {
3429
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
3430
+ },
3383
3431
  {
3384
3432
  "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3385
3433
  },
3386
3434
  {
3387
- "$ref": "#/definitions/EditCommandArgs"
3435
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
3436
+ },
3437
+ {
3438
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
3388
3439
  },
3389
3440
  {
3390
3441
  "items": {
3391
- "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3442
+ "anyOf": [
3443
+ {
3444
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3445
+ },
3446
+ {
3447
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
3448
+ }
3449
+ ]
3392
3450
  },
3393
3451
  "type": "array"
3452
+ },
3453
+ {
3454
+ "$ref": "#/definitions/Results"
3455
+ },
3456
+ {
3457
+ "$ref": "#/definitions/EditCommandArgs"
3394
3458
  }
3395
3459
  ]
3396
3460
  },
3397
3461
  "edit.display-add-feature": {
3398
- "description": "Display a form for adding a feature. `DisplayAddFeatureArgs` is not supported on Mobile.",
3462
+ "description": "Begin an interactive feature editing session with a new feature. `DisplayAddFeatureArgs` is not supported on Mobile.",
3399
3463
  "enum": [
3400
3464
  "edit.display-add-feature"
3401
3465
  ]
@@ -3411,7 +3475,7 @@
3411
3475
  ]
3412
3476
  },
3413
3477
  "edit.display-update-feature": {
3414
- "description": "Display a form for updating a feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.",
3478
+ "description": "Begin an interactive feature editing session with an existing feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.",
3415
3479
  "enum": [
3416
3480
  "edit.display-update-feature"
3417
3481
  ]
@@ -3427,24 +3491,43 @@
3427
3491
  ]
3428
3492
  },
3429
3493
  "edit.update-feature": {
3430
- "description": "Updates a feature. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
3494
+ "description": "Updates a layer feature or features. Edits to the geometry and attributes of the supplied features will be committed to their respective feature sources. `Features` and `EditCommandArgs` are not supported on Mobile.",
3431
3495
  "enum": [
3432
3496
  "edit.update-feature"
3433
3497
  ]
3434
3498
  },
3435
3499
  "edit.update-feature:input": {
3436
3500
  "anyOf": [
3501
+ {
3502
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
3503
+ },
3437
3504
  {
3438
3505
  "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3439
3506
  },
3440
3507
  {
3441
- "$ref": "#/definitions/EditCommandArgs"
3508
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
3509
+ },
3510
+ {
3511
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
3442
3512
  },
3443
3513
  {
3444
3514
  "items": {
3445
- "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3515
+ "anyOf": [
3516
+ {
3517
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3518
+ },
3519
+ {
3520
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
3521
+ }
3522
+ ]
3446
3523
  },
3447
3524
  "type": "array"
3525
+ },
3526
+ {
3527
+ "$ref": "#/definitions/Results"
3528
+ },
3529
+ {
3530
+ "$ref": "#/definitions/EditCommandArgs"
3448
3531
  }
3449
3532
  ]
3450
3533
  },
package/messaging/schema/mobile-event.schema.json CHANGED
@@ -1084,7 +1084,7 @@
1084
1084
  "$ref": "#/definitions/AttachmentEventArgs"
1085
1085
  },
1086
1086
  "edit.feature-added": {
1087
- "description": "Raised when a feature is added.",
1087
+ "description": "Raised when a new feature is added to a feature source.",
1088
1088
  "enum": [
1089
1089
  "edit.feature-added"
1090
1090
  ]
@@ -1093,7 +1093,7 @@
1093
1093
  "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
1094
1094
  },
1095
1095
  "edit.feature-deleted": {
1096
- "description": "Raised when a feature is deleted.",
1096
+ "description": "Raised when a feature is deleted from a feature source.",
1097
1097
  "enum": [
1098
1098
  "edit.feature-deleted"
1099
1099
  ]
@@ -1102,7 +1102,7 @@
1102
1102
  "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
1103
1103
  },
1104
1104
  "edit.feature-updated": {
1105
- "description": "Raised when a feature is updated.",
1105
+ "description": "Raised when the attributes or geometry of a feature from a feature source are updated.",
1106
1106
  "enum": [
1107
1107
  "edit.feature-updated"
1108
1108
  ]