@vertigis/viewer-spec 47.0.0 → 47.3.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.
Files changed (13) hide show
  1. package/app-config/common/BrandingColors.d.ts +2 -0
  2. package/app-config/schema/common-app-config.schema.json +1 -1
  3. package/app-config/schema/mobile-app-config.schema.json +1 -1
  4. package/app-config/schema/web-app-config.schema.json +1 -1
  5. package/layout/schema/layout-common.xsd +33 -3
  6. package/messaging/registry/edit.d.ts +45 -4
  7. package/messaging/registry/edit.js +1 -1
  8. package/messaging/schema/common-action.schema.json +252 -110
  9. package/messaging/schema/mobile-action.schema.json +217 -158
  10. package/messaging/schema/web-action.schema.json +271 -132
  11. package/package.json +13 -13
  12. package/version.d.ts +1 -1
  13. package/version.js +1 -1
package/messaging/schema/mobile-action.schema.json CHANGED
@@ -449,7 +449,7 @@
449
449
  },
450
450
  "AddAttachmentArgs": {
451
451
  "additionalProperties": false,
452
- "description": "Arguments for the \"edit.add-attachment\" command.",
452
+ "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
453
453
  "properties": {
454
454
  "contentType": {
455
455
  "description": "The MIME content type of the attachment.",
@@ -899,6 +899,31 @@
899
899
  ],
900
900
  "type": "object"
901
901
  },
902
+ "DeleteAttachmentArgs": {
903
+ "additionalProperties": false,
904
+ "description": "Arguments for the \"edit.delete-attachment\" command.",
905
+ "properties": {
906
+ "attachments": {
907
+ "description": "The attachment(s) to remove from the feature(s). This property can be populated with the title(s) or ID(s) of the attachments(s). Any and all matching attachments found on the input features will be deleted. Web only.",
908
+ "items": {
909
+ "type": "string"
910
+ },
911
+ "type": "array"
912
+ },
913
+ "features": {
914
+ "$ref": "#/definitions/Features",
915
+ "description": "The feature(s) to remove the attachment(s) from."
916
+ },
917
+ "gcxAttachment": {
918
+ "$ref": "@vertigis.arcgis-extensions.data.Attachment.Attachment",
919
+ "description": "The attachment to remove from the feature(s). Mobile only."
920
+ }
921
+ },
922
+ "required": [
923
+ "features"
924
+ ],
925
+ "type": "object"
926
+ },
902
927
  "DeleteGeometryArgs": {
903
928
  "additionalProperties": false,
904
929
  "description": "Arguments for the \"sketching.delete\" command.",
@@ -3077,6 +3102,35 @@
3077
3102
  ],
3078
3103
  "type": "object"
3079
3104
  },
3105
+ "WebAddAttachmentArgs": {
3106
+ "additionalProperties": false,
3107
+ "description": "VertiGIS Studio Web's arguments for the \"edit.add-attachment\" command. Not supported by Mobile.",
3108
+ "properties": {
3109
+ "blobs": {
3110
+ "anyOf": [
3111
+ {
3112
+ "$ref": "File"
3113
+ },
3114
+ {
3115
+ "items": {
3116
+ "$ref": "File"
3117
+ },
3118
+ "type": "array"
3119
+ }
3120
+ ],
3121
+ "description": "The blob(s) that contains the file attachment(s). If multiple attachments are specified, all attachment will be added to the feature(s)."
3122
+ },
3123
+ "features": {
3124
+ "$ref": "#/definitions/Features",
3125
+ "description": "The feature(s) to add the attachment(s) to. If multiple features are specified, the attachment(s) will be added to all features."
3126
+ }
3127
+ },
3128
+ "required": [
3129
+ "blobs",
3130
+ "features"
3131
+ ],
3132
+ "type": "object"
3133
+ },
3080
3134
  "WebOpenUrlArgs": {
3081
3135
  "additionalProperties": false,
3082
3136
  "description": "VertiGIS Studio Web's arguments for the system.open-url command.",
@@ -3256,18 +3310,12 @@
3256
3310
  "debug-console.close"
3257
3311
  ]
3258
3312
  },
3259
- "debug-console.close:output": {
3260
- "type": "undefined"
3261
- },
3262
3313
  "debug-console.display": {
3263
3314
  "description": "Displays the Debug Console. Deprecated; use log-viewer.display instead.",
3264
3315
  "enum": [
3265
3316
  "debug-console.display"
3266
3317
  ]
3267
3318
  },
3268
- "debug-console.display:output": {
3269
- "type": "undefined"
3270
- },
3271
3319
  "drawing.set-sync": {
3272
3320
  "description": "Sets a value that determines whether drawings will be synced automatically across maps.",
3273
3321
  "enum": [
@@ -3284,7 +3332,14 @@
3284
3332
  ]
3285
3333
  },
3286
3334
  "edit.add-attachment:input": {
3287
- "$ref": "#/definitions/AddAttachmentArgs"
3335
+ "anyOf": [
3336
+ {
3337
+ "$ref": "#/definitions/AddAttachmentArgs"
3338
+ },
3339
+ {
3340
+ "$ref": "#/definitions/WebAddAttachmentArgs"
3341
+ }
3342
+ ]
3288
3343
  },
3289
3344
  "edit.add-feature": {
3290
3345
  "description": "Adds a feature to a particular layer. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
@@ -3308,6 +3363,15 @@
3308
3363
  }
3309
3364
  ]
3310
3365
  },
3366
+ "edit.delete-attachment": {
3367
+ "description": "Deletes attachments from feature(s).",
3368
+ "enum": [
3369
+ "edit.delete-attachment"
3370
+ ]
3371
+ },
3372
+ "edit.delete-attachment:input": {
3373
+ "$ref": "#/definitions/DeleteAttachmentArgs"
3374
+ },
3311
3375
  "edit.delete-features": {
3312
3376
  "description": "Deletes the given feature or features from their feature sources. `EditCommandArgs` is not supported on Mobile.",
3313
3377
  "enum": [
@@ -11657,9 +11721,6 @@
11657
11721
  "geocode.count:input": {
11658
11722
  "$ref": "#/definitions/GeocodeArgs"
11659
11723
  },
11660
- "geocode.count:output": {
11661
- "type": "undefined"
11662
- },
11663
11724
  "geocode.geocode": {
11664
11725
  "description": "Finds one or more locations corresponding to an address.",
11665
11726
  "enum": [
@@ -11669,9 +11730,6 @@
11669
11730
  "geocode.geocode:input": {
11670
11731
  "$ref": "#/definitions/GeocodeArgs"
11671
11732
  },
11672
- "geocode.geocode:output": {
11673
- "type": "undefined"
11674
- },
11675
11733
  "geocode.reverse-geocode": {
11676
11734
  "description": "Finds the address at a particular location. The geocoder must have the supportsReverseGeocoding capability.",
11677
11735
  "enum": [
@@ -11681,9 +11739,6 @@
11681
11739
  "geocode.reverse-geocode:input": {
11682
11740
  "$ref": "#/definitions/ReverseGeocodeArgs"
11683
11741
  },
11684
- "geocode.reverse-geocode:output": {
11685
- "type": "undefined"
11686
- },
11687
11742
  "geocode.suggest": {
11688
11743
  "description": "Suggests matching addresses to search for based on some input text. The geocoder must have the supportsSuggest capability.",
11689
11744
  "enum": [
@@ -11693,9 +11748,6 @@
11693
11748
  "geocode.suggest:input": {
11694
11749
  "$ref": "#/definitions/SuggestArgs"
11695
11750
  },
11696
- "geocode.suggest:output": {
11697
- "type": "undefined"
11698
- },
11699
11751
  "geolocation.auto-recenter": {
11700
11752
  "description": "Centers the map on the user's current location and keeps the location centered as it moves around. The maps parameter is only supported in Geocortex Mobile Viewer. In Geocortex Web Viewer, all maps are affected.",
11701
11753
  "enum": [
@@ -11775,9 +11827,6 @@
11775
11827
  "geolocation.get-active-source:input": {
11776
11828
  "$ref": "#/definitions/GnssDeviceConnectionInfo"
11777
11829
  },
11778
- "geolocation.get-active-source:output": {
11779
- "type": "undefined"
11780
- },
11781
11830
  "geolocation.get-all-sources": {
11782
11831
  "description": "Gets the list of currently available geolocation sources. Includes integrated receivers, GNSS devices, and emulators.",
11783
11832
  "enum": [
@@ -11811,9 +11860,6 @@
11811
11860
  "geolocation.get-location-permissions-enabled:input": {
11812
11861
  "type": "boolean"
11813
11862
  },
11814
- "geolocation.get-location-permissions-enabled:output": {
11815
- "type": "undefined"
11816
- },
11817
11863
  "geolocation.get-position": {
11818
11864
  "description": "Returns the current user position. This Operation can block while the user is prompted for permission, as such it is considered best practice not to perform this during startup.",
11819
11865
  "enum": [
@@ -12073,18 +12119,12 @@
12073
12119
  "log-viewer.close"
12074
12120
  ]
12075
12121
  },
12076
- "log-viewer.close:output": {
12077
- "type": "undefined"
12078
- },
12079
12122
  "log-viewer.display": {
12080
12123
  "description": "Displays the Log Viewer.",
12081
12124
  "enum": [
12082
12125
  "log-viewer.display"
12083
12126
  ]
12084
12127
  },
12085
- "log-viewer.display:output": {
12086
- "type": "undefined"
12087
- },
12088
12128
  "map.disable-map-click": {
12089
12129
  "description": "Disables the click event handler on the map, so that if the user clicks on the map, the configured handler will not be invoked.",
12090
12130
  "enum": [
@@ -13528,6 +13568,22 @@
13528
13568
  ],
13529
13569
  "type": "object"
13530
13570
  },
13571
+ {
13572
+ "additionalProperties": false,
13573
+ "properties": {
13574
+ "arguments": {
13575
+ "$ref": "#/definitions/edit.delete-attachment:input"
13576
+ },
13577
+ "name": {
13578
+ "$ref": "#/definitions/edit.delete-attachment"
13579
+ }
13580
+ },
13581
+ "required": [
13582
+ "name",
13583
+ "arguments"
13584
+ ],
13585
+ "type": "object"
13586
+ },
13531
13587
  {
13532
13588
  "additionalProperties": false,
13533
13589
  "properties": {
@@ -13608,6 +13664,70 @@
13608
13664
  ],
13609
13665
  "type": "object"
13610
13666
  },
13667
+ {
13668
+ "additionalProperties": false,
13669
+ "properties": {
13670
+ "arguments": {
13671
+ "$ref": "#/definitions/geocode.count:input"
13672
+ },
13673
+ "name": {
13674
+ "$ref": "#/definitions/geocode.count"
13675
+ }
13676
+ },
13677
+ "required": [
13678
+ "name",
13679
+ "arguments"
13680
+ ],
13681
+ "type": "object"
13682
+ },
13683
+ {
13684
+ "additionalProperties": false,
13685
+ "properties": {
13686
+ "arguments": {
13687
+ "$ref": "#/definitions/geocode.geocode:input"
13688
+ },
13689
+ "name": {
13690
+ "$ref": "#/definitions/geocode.geocode"
13691
+ }
13692
+ },
13693
+ "required": [
13694
+ "name",
13695
+ "arguments"
13696
+ ],
13697
+ "type": "object"
13698
+ },
13699
+ {
13700
+ "additionalProperties": false,
13701
+ "properties": {
13702
+ "arguments": {
13703
+ "$ref": "#/definitions/geocode.reverse-geocode:input"
13704
+ },
13705
+ "name": {
13706
+ "$ref": "#/definitions/geocode.reverse-geocode"
13707
+ }
13708
+ },
13709
+ "required": [
13710
+ "name",
13711
+ "arguments"
13712
+ ],
13713
+ "type": "object"
13714
+ },
13715
+ {
13716
+ "additionalProperties": false,
13717
+ "properties": {
13718
+ "arguments": {
13719
+ "$ref": "#/definitions/geocode.suggest:input"
13720
+ },
13721
+ "name": {
13722
+ "$ref": "#/definitions/geocode.suggest"
13723
+ }
13724
+ },
13725
+ "required": [
13726
+ "name",
13727
+ "arguments"
13728
+ ],
13729
+ "type": "object"
13730
+ },
13611
13731
  {
13612
13732
  "additionalProperties": false,
13613
13733
  "properties": {
@@ -13672,6 +13792,38 @@
13672
13792
  ],
13673
13793
  "type": "object"
13674
13794
  },
13795
+ {
13796
+ "additionalProperties": false,
13797
+ "properties": {
13798
+ "arguments": {
13799
+ "$ref": "#/definitions/geolocation.get-active-source:input"
13800
+ },
13801
+ "name": {
13802
+ "$ref": "#/definitions/geolocation.get-active-source"
13803
+ }
13804
+ },
13805
+ "required": [
13806
+ "name",
13807
+ "arguments"
13808
+ ],
13809
+ "type": "object"
13810
+ },
13811
+ {
13812
+ "additionalProperties": false,
13813
+ "properties": {
13814
+ "arguments": {
13815
+ "$ref": "#/definitions/geolocation.get-location-permissions-enabled:input"
13816
+ },
13817
+ "name": {
13818
+ "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
13819
+ }
13820
+ },
13821
+ "required": [
13822
+ "name",
13823
+ "arguments"
13824
+ ],
13825
+ "type": "object"
13826
+ },
13675
13827
  {
13676
13828
  "additionalProperties": false,
13677
13829
  "properties": {
@@ -15053,6 +15205,12 @@
15053
15205
  {
15054
15206
  "$ref": "#/definitions/basemap.set"
15055
15207
  },
15208
+ {
15209
+ "$ref": "#/definitions/debug-console.close"
15210
+ },
15211
+ {
15212
+ "$ref": "#/definitions/debug-console.display"
15213
+ },
15056
15214
  {
15057
15215
  "$ref": "#/definitions/drawing.set-sync"
15058
15216
  },
@@ -15062,6 +15220,9 @@
15062
15220
  {
15063
15221
  "$ref": "#/definitions/edit.add-feature"
15064
15222
  },
15223
+ {
15224
+ "$ref": "#/definitions/edit.delete-attachment"
15225
+ },
15065
15226
  {
15066
15227
  "$ref": "#/definitions/edit.delete-features"
15067
15228
  },
@@ -15077,6 +15238,18 @@
15077
15238
  {
15078
15239
  "$ref": "#/definitions/file.open-file"
15079
15240
  },
15241
+ {
15242
+ "$ref": "#/definitions/geocode.count"
15243
+ },
15244
+ {
15245
+ "$ref": "#/definitions/geocode.geocode"
15246
+ },
15247
+ {
15248
+ "$ref": "#/definitions/geocode.reverse-geocode"
15249
+ },
15250
+ {
15251
+ "$ref": "#/definitions/geocode.suggest"
15252
+ },
15080
15253
  {
15081
15254
  "$ref": "#/definitions/geolocation.auto-recenter"
15082
15255
  },
@@ -15098,6 +15271,12 @@
15098
15271
  {
15099
15272
  "$ref": "#/definitions/geolocation.display-location"
15100
15273
  },
15274
+ {
15275
+ "$ref": "#/definitions/geolocation.get-active-source"
15276
+ },
15277
+ {
15278
+ "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
15279
+ },
15101
15280
  {
15102
15281
  "$ref": "#/definitions/geolocation.turn-off-geolocation"
15103
15282
  },
@@ -15149,6 +15328,12 @@
15149
15328
  {
15150
15329
  "$ref": "#/definitions/layer-presets.apply"
15151
15330
  },
15331
+ {
15332
+ "$ref": "#/definitions/log-viewer.close"
15333
+ },
15334
+ {
15335
+ "$ref": "#/definitions/log-viewer.display"
15336
+ },
15152
15337
  {
15153
15338
  "$ref": "#/definitions/map.disable-map-click"
15154
15339
  },
@@ -15448,86 +15633,6 @@
15448
15633
  ],
15449
15634
  "type": "object"
15450
15635
  },
15451
- {
15452
- "additionalProperties": false,
15453
- "properties": {
15454
- "arguments": {
15455
- "$ref": "#/definitions/geocode.count:input"
15456
- },
15457
- "name": {
15458
- "$ref": "#/definitions/geocode.count"
15459
- }
15460
- },
15461
- "required": [
15462
- "name",
15463
- "arguments"
15464
- ],
15465
- "type": "object"
15466
- },
15467
- {
15468
- "additionalProperties": false,
15469
- "properties": {
15470
- "arguments": {
15471
- "$ref": "#/definitions/geocode.geocode:input"
15472
- },
15473
- "name": {
15474
- "$ref": "#/definitions/geocode.geocode"
15475
- }
15476
- },
15477
- "required": [
15478
- "name",
15479
- "arguments"
15480
- ],
15481
- "type": "object"
15482
- },
15483
- {
15484
- "additionalProperties": false,
15485
- "properties": {
15486
- "arguments": {
15487
- "$ref": "#/definitions/geocode.reverse-geocode:input"
15488
- },
15489
- "name": {
15490
- "$ref": "#/definitions/geocode.reverse-geocode"
15491
- }
15492
- },
15493
- "required": [
15494
- "name",
15495
- "arguments"
15496
- ],
15497
- "type": "object"
15498
- },
15499
- {
15500
- "additionalProperties": false,
15501
- "properties": {
15502
- "arguments": {
15503
- "$ref": "#/definitions/geocode.suggest:input"
15504
- },
15505
- "name": {
15506
- "$ref": "#/definitions/geocode.suggest"
15507
- }
15508
- },
15509
- "required": [
15510
- "name",
15511
- "arguments"
15512
- ],
15513
- "type": "object"
15514
- },
15515
- {
15516
- "additionalProperties": false,
15517
- "properties": {
15518
- "arguments": {
15519
- "$ref": "#/definitions/geolocation.get-active-source:input"
15520
- },
15521
- "name": {
15522
- "$ref": "#/definitions/geolocation.get-active-source"
15523
- }
15524
- },
15525
- "required": [
15526
- "name",
15527
- "arguments"
15528
- ],
15529
- "type": "object"
15530
- },
15531
15636
  {
15532
15637
  "additionalProperties": false,
15533
15638
  "properties": {
@@ -15544,22 +15649,6 @@
15544
15649
  ],
15545
15650
  "type": "object"
15546
15651
  },
15547
- {
15548
- "additionalProperties": false,
15549
- "properties": {
15550
- "arguments": {
15551
- "$ref": "#/definitions/geolocation.get-location-permissions-enabled:input"
15552
- },
15553
- "name": {
15554
- "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
15555
- }
15556
- },
15557
- "required": [
15558
- "name",
15559
- "arguments"
15560
- ],
15561
- "type": "object"
15562
- },
15563
15652
  {
15564
15653
  "additionalProperties": false,
15565
15654
  "properties": {
@@ -16132,39 +16221,15 @@
16132
16221
  {
16133
16222
  "$ref": "#/definitions/basemap.get-current"
16134
16223
  },
16135
- {
16136
- "$ref": "#/definitions/debug-console.close"
16137
- },
16138
- {
16139
- "$ref": "#/definitions/debug-console.display"
16140
- },
16141
16224
  {
16142
16225
  "$ref": "#/definitions/file.pick-file"
16143
16226
  },
16144
- {
16145
- "$ref": "#/definitions/geocode.count"
16146
- },
16147
- {
16148
- "$ref": "#/definitions/geocode.geocode"
16149
- },
16150
- {
16151
- "$ref": "#/definitions/geocode.reverse-geocode"
16152
- },
16153
- {
16154
- "$ref": "#/definitions/geocode.suggest"
16155
- },
16156
- {
16157
- "$ref": "#/definitions/geolocation.get-active-source"
16158
- },
16159
16227
  {
16160
16228
  "$ref": "#/definitions/geolocation.get-all-sources"
16161
16229
  },
16162
16230
  {
16163
16231
  "$ref": "#/definitions/geolocation.get-current-state"
16164
16232
  },
16165
- {
16166
- "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
16167
- },
16168
16233
  {
16169
16234
  "$ref": "#/definitions/geolocation.get-position"
16170
16235
  },
@@ -16180,12 +16245,6 @@
16180
16245
  {
16181
16246
  "$ref": "#/definitions/geometry.remove-point"
16182
16247
  },
16183
- {
16184
- "$ref": "#/definitions/log-viewer.close"
16185
- },
16186
- {
16187
- "$ref": "#/definitions/log-viewer.display"
16188
- },
16189
16248
  {
16190
16249
  "$ref": "#/definitions/map.export-image"
16191
16250
  },