@vertigis/viewer-spec 46.0.0 → 46.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 (16) hide show
  1. package/messaging/registry/Operations.d.ts +2 -0
  2. package/messaging/registry/Operations.js +1 -1
  3. package/messaging/registry/app.d.ts +12 -0
  4. package/messaging/registry/app.js +1 -1
  5. package/messaging/registry/edit.d.ts +104 -25
  6. package/messaging/registry/edit.js +1 -1
  7. package/messaging/registry/system.d.ts +30 -9
  8. package/messaging/registry/ui.d.ts +1 -1
  9. package/messaging/schema/common-action.schema.json +484 -1
  10. package/messaging/schema/common-event.schema.json +36 -0
  11. package/messaging/schema/mobile-action.schema.json +307 -12
  12. package/messaging/schema/web-action.schema.json +486 -1
  13. package/messaging/schema/web-event.schema.json +36 -0
  14. package/package.json +3 -3
  15. package/version.d.ts +1 -1
  16. package/version.js +1 -1
package/messaging/schema/common-action.schema.json CHANGED
@@ -351,6 +351,29 @@
351
351
  },
352
352
  "type": "object"
353
353
  },
354
+ "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference": {
355
+ "additionalProperties": false,
356
+ "description": "Matches an existing layer.",
357
+ "properties": {
358
+ "id": {
359
+ "description": "The layer's ID.",
360
+ "type": "string"
361
+ },
362
+ "path": {
363
+ "description": "The path to the geodatabase used by an MMAP layer. Mobile only.",
364
+ "type": "string"
365
+ },
366
+ "subtype": {
367
+ "description": "The Layer's type, used for Layer types with multiple possible layer extension mappings.",
368
+ "type": "string"
369
+ },
370
+ "title": {
371
+ "description": "The layer's title.",
372
+ "type": "string"
373
+ }
374
+ },
375
+ "type": "object"
376
+ },
354
377
  "@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties": {
355
378
  "additionalProperties": false,
356
379
  "description": "Properties that can be passed into the constructor for {@link FormatSettings}.",
@@ -708,6 +731,75 @@
708
731
  },
709
732
  "type": "object"
710
733
  },
734
+ "DisplayAddFeatureArgs": {
735
+ "additionalProperties": false,
736
+ "description": "Arguments for the \"edit.display-add-features\" command. Web only.",
737
+ "properties": {
738
+ "attributes": {
739
+ "description": "Optional layout XML attributes to be used for the transient UI container."
740
+ },
741
+ "editAttachments": {
742
+ "description": "Whether to allow editing of feature attachments.",
743
+ "type": "boolean"
744
+ },
745
+ "editAttributes": {
746
+ "description": "Whether to allow editing of feature attributes.",
747
+ "type": "boolean"
748
+ },
749
+ "editGeometry": {
750
+ "description": "Whether to allow editing of feature geometry.",
751
+ "type": "boolean"
752
+ },
753
+ "editGeometryOptions": {
754
+ "$ref": "#/definitions/EditGeometryOptions",
755
+ "description": "Options for the geometry editing session."
756
+ },
757
+ "featureAttributes": {
758
+ "description": "A collection of attributes to apply to the new feature."
759
+ },
760
+ "geometry": {
761
+ "$ref": "#/definitions/GeometryLike",
762
+ "description": "The geometry to use for the command/operation."
763
+ },
764
+ "icon": {
765
+ "description": "Optional icon that may be used by the transient UI container.",
766
+ "type": "string"
767
+ },
768
+ "layers": {
769
+ "$ref": "#/definitions/LayersLike",
770
+ "description": "Layer(s) to use for the command/operation."
771
+ },
772
+ "maps": {
773
+ "$ref": "MapsLike",
774
+ "description": "Map(s) to use for the command/operation."
775
+ },
776
+ "orientation": {
777
+ "description": "The orientation of the template picker.",
778
+ "enum": [
779
+ "horizontal",
780
+ "vertical"
781
+ ],
782
+ "type": "string"
783
+ },
784
+ "parent": {
785
+ "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.",
786
+ "type": "string"
787
+ },
788
+ "showNotifications": {
789
+ "description": "Whether to show UI notifications.",
790
+ "type": "boolean"
791
+ },
792
+ "showTitles": {
793
+ "description": "Whether to show titles on the template picker.",
794
+ "type": "boolean"
795
+ },
796
+ "templateName": {
797
+ "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.",
798
+ "type": "string"
799
+ }
800
+ },
801
+ "type": "object"
802
+ },
711
803
  "DisplayNotificationArgs": {
712
804
  "additionalProperties": false,
713
805
  "description": "The arguments for the `ui.display-notification` command.",
@@ -730,7 +822,7 @@
730
822
  },
731
823
  "position": {
732
824
  "$ref": "Position",
733
- "description": "The position of the notification on the screen."
825
+ "description": "The position of the notification on the screen. Web only."
734
826
  },
735
827
  "title": {
736
828
  "description": "The notification title - only shown for system notifications. Mobile only.",
@@ -746,6 +838,63 @@
746
838
  ],
747
839
  "type": "object"
748
840
  },
841
+ "DisplayUpdateFeatureArgs": {
842
+ "additionalProperties": false,
843
+ "description": "Arguments for the \"edit.display-update-features\" operation. Web only.",
844
+ "properties": {
845
+ "editAttachments": {
846
+ "description": "Whether to allow editing of feature attachments.",
847
+ "type": "boolean"
848
+ },
849
+ "editAttributes": {
850
+ "description": "Whether to allow editing of feature attributes.",
851
+ "type": "boolean"
852
+ },
853
+ "editGeometry": {
854
+ "description": "Whether to allow editing of feature geometry.",
855
+ "type": "boolean"
856
+ },
857
+ "editGeometryOptions": {
858
+ "$ref": "#/definitions/EditGeometryOptions",
859
+ "description": "Options for the geometry editing session."
860
+ },
861
+ "featureAttributes": {
862
+ "description": "A collection of attributes to automatically apply to the updated feature."
863
+ },
864
+ "features": {
865
+ "$ref": "#/definitions/FeaturesLike",
866
+ "description": "Features to use for the command/operation."
867
+ },
868
+ "geometry": {
869
+ "$ref": "#/definitions/GeometryLike",
870
+ "description": "The geometry to use for the command/operation."
871
+ },
872
+ "maps": {
873
+ "$ref": "MapsLike",
874
+ "description": "Map(s) to use for the command/operation."
875
+ },
876
+ "showNotifications": {
877
+ "description": "Whether to show UI notifications.",
878
+ "type": "boolean"
879
+ }
880
+ },
881
+ "type": "object"
882
+ },
883
+ "EditCommandArgs": {
884
+ "additionalProperties": false,
885
+ "description": "Arguments for the \"edit.add-features\", \"edit.update-features\" and \"edit.delete-features\" commands. Web only.",
886
+ "properties": {
887
+ "features": {
888
+ "$ref": "#/definitions/FeaturesLike",
889
+ "description": "Features to use for the command/operation."
890
+ },
891
+ "showNotifications": {
892
+ "description": "Whether to show UI notifications.",
893
+ "type": "boolean"
894
+ }
895
+ },
896
+ "type": "object"
897
+ },
749
898
  "EditGeometryArgs": {
750
899
  "additionalProperties": false,
751
900
  "description": "Arguments for the \"sketching.edit-geometry\" operation.",
@@ -1301,6 +1450,54 @@
1301
1450
  "description": "A set of parameters used to run a job.",
1302
1451
  "type": "object"
1303
1452
  },
1453
+ "LayersLike": {
1454
+ "anyOf": [
1455
+ {
1456
+ "$ref": "#/definitions/esri.Layer"
1457
+ },
1458
+ {
1459
+ "$ref": "esri.SublayerLike"
1460
+ },
1461
+ {
1462
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
1463
+ },
1464
+ {
1465
+ "$ref": "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension"
1466
+ },
1467
+ {
1468
+ "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
1469
+ },
1470
+ {
1471
+ "items": {
1472
+ "anyOf": [
1473
+ {
1474
+ "$ref": "#/definitions/esri.Layer"
1475
+ },
1476
+ {
1477
+ "$ref": "esri.SublayerLike"
1478
+ },
1479
+ {
1480
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
1481
+ },
1482
+ {
1483
+ "$ref": "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension"
1484
+ },
1485
+ {
1486
+ "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
1487
+ },
1488
+ {
1489
+ "type": "string"
1490
+ }
1491
+ ]
1492
+ },
1493
+ "type": "array"
1494
+ },
1495
+ {
1496
+ "type": "string"
1497
+ }
1498
+ ],
1499
+ "description": "One or more objects that are convertible to layer extensions."
1500
+ },
1304
1501
  "MapRotateArgs": {
1305
1502
  "additionalProperties": false,
1306
1503
  "description": "Arguments for the \"map.rotate-by\" and \"map.rotate-to\" commands.",
@@ -1382,6 +1579,27 @@
1382
1579
  ],
1383
1580
  "type": "string"
1384
1581
  },
1582
+ "OpenUrlArgs": {
1583
+ "additionalProperties": false,
1584
+ "description": "Arguments for the system.open-url command.",
1585
+ "properties": {
1586
+ "context": {
1587
+ "description": "An object containing arguments that this command was originally executed with. This property is populated automatically when using a bound action. The URL will be the configured value, and the context is automatically populated as the argument that was passed into the execute method when the command was executed in context."
1588
+ },
1589
+ "numberFormatterLocale": {
1590
+ "description": "The locale to use for number token substitution. Accepts a valid locale code (example: \"en\", \"fr\" or \"de-AT\"), or \"device\" or \"invariant\" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.",
1591
+ "type": "string"
1592
+ },
1593
+ "url": {
1594
+ "description": "The URL to open.",
1595
+ "type": "string"
1596
+ }
1597
+ },
1598
+ "required": [
1599
+ "url"
1600
+ ],
1601
+ "type": "object"
1602
+ },
1385
1603
  "Results": {
1386
1604
  "additionalProperties": false,
1387
1605
  "description": "Feature results from an operation.",
@@ -1909,6 +2127,40 @@
1909
2127
  ],
1910
2128
  "type": "object"
1911
2129
  },
2130
+ "WebOpenUrlArgs": {
2131
+ "additionalProperties": false,
2132
+ "description": "VertiGIS Studio Web's arguments for the system.open-url command.",
2133
+ "properties": {
2134
+ "features": {
2135
+ "$ref": "#/definitions/FeaturesLike",
2136
+ "description": "Features to use for the command/operation."
2137
+ },
2138
+ "geometry": {
2139
+ "$ref": "#/definitions/GeometryLike",
2140
+ "description": "The geometry to use for the command/operation."
2141
+ },
2142
+ "layers": {
2143
+ "$ref": "#/definitions/LayersLike",
2144
+ "description": "Layer(s) to use for the command/operation."
2145
+ },
2146
+ "maps": {
2147
+ "$ref": "MapsLike",
2148
+ "description": "Map(s) to use for the command/operation."
2149
+ },
2150
+ "numberFormatterLocale": {
2151
+ "description": "The locale to use for number token substitution. Accepts a valid locale code (example: \"en\", \"fr\" or \"de-AT\"), or \"device\" or \"invariant\" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.",
2152
+ "type": "string"
2153
+ },
2154
+ "url": {
2155
+ "description": "The URL to open.",
2156
+ "type": "string"
2157
+ }
2158
+ },
2159
+ "required": [
2160
+ "url"
2161
+ ],
2162
+ "type": "object"
2163
+ },
1912
2164
  "ZoomToViewpointArgs": {
1913
2165
  "additionalProperties": false,
1914
2166
  "description": "Arguments for the map.zoom-to-viewpoint command.",
@@ -2021,6 +2273,104 @@
2021
2273
  "drawing.set-sync:input": {
2022
2274
  "type": "boolean"
2023
2275
  },
2276
+ "edit.add-feature": {
2277
+ "description": "Adds a feature to a particular layer. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
2278
+ "enum": [
2279
+ "edit.add-feature"
2280
+ ]
2281
+ },
2282
+ "edit.add-feature:input": {
2283
+ "anyOf": [
2284
+ {
2285
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
2286
+ },
2287
+ {
2288
+ "$ref": "#/definitions/EditCommandArgs"
2289
+ },
2290
+ {
2291
+ "items": {
2292
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
2293
+ },
2294
+ "type": "array"
2295
+ }
2296
+ ]
2297
+ },
2298
+ "edit.delete-features": {
2299
+ "description": "Deletes the given feature or features from their feature sources. `EditCommandArgs` is not supported on Mobile.",
2300
+ "enum": [
2301
+ "edit.delete-features"
2302
+ ]
2303
+ },
2304
+ "edit.delete-features:input": {
2305
+ "anyOf": [
2306
+ {
2307
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
2308
+ },
2309
+ {
2310
+ "$ref": "#/definitions/EditCommandArgs"
2311
+ },
2312
+ {
2313
+ "items": {
2314
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
2315
+ },
2316
+ "type": "array"
2317
+ }
2318
+ ]
2319
+ },
2320
+ "edit.display-add-feature": {
2321
+ "description": "Display a form for adding a feature. `DisplayAddFeatureArgs` is not supported on Mobile.",
2322
+ "enum": [
2323
+ "edit.display-add-feature"
2324
+ ]
2325
+ },
2326
+ "edit.display-add-feature:input": {
2327
+ "anyOf": [
2328
+ {
2329
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
2330
+ },
2331
+ {
2332
+ "$ref": "#/definitions/DisplayAddFeatureArgs"
2333
+ }
2334
+ ]
2335
+ },
2336
+ "edit.display-update-feature": {
2337
+ "description": "Display a form for updating a feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.",
2338
+ "enum": [
2339
+ "edit.display-update-feature"
2340
+ ]
2341
+ },
2342
+ "edit.display-update-feature:input": {
2343
+ "anyOf": [
2344
+ {
2345
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
2346
+ },
2347
+ {
2348
+ "$ref": "#/definitions/DisplayUpdateFeatureArgs"
2349
+ }
2350
+ ]
2351
+ },
2352
+ "edit.update-feature": {
2353
+ "description": "Updates a feature. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
2354
+ "enum": [
2355
+ "edit.update-feature"
2356
+ ]
2357
+ },
2358
+ "edit.update-feature:input": {
2359
+ "anyOf": [
2360
+ {
2361
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
2362
+ },
2363
+ {
2364
+ "$ref": "#/definitions/EditCommandArgs"
2365
+ },
2366
+ {
2367
+ "items": {
2368
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
2369
+ },
2370
+ "type": "array"
2371
+ }
2372
+ ]
2373
+ },
2024
2374
  "esri.Extent": {
2025
2375
  "$ref": "esri/geometry/Extent"
2026
2376
  },
@@ -11370,6 +11720,25 @@
11370
11720
  "sketching.undo:input": {
11371
11721
  "$ref": "#/definitions/HasMaps"
11372
11722
  },
11723
+ "system.open-url": {
11724
+ "description": "Opens a URL, either in the system browser or whatever app is appropriate for the scheme of the URL. If {@link Features} are included as context, then the URL may contain substitution tokens in the format {FIELD_NAME} where FIELD_NAME is the name of a field in the first feature in the context. In this case, the {FIELD_NAME} is substituted with value of the FIELD_NAME field from the feature feature in the {@link Features}, e.g. https://www.google.com/search?q={NAME}, where the value of the NAME field in the first feature from the context is 'Jasper National Park' would produce the result https://www.google.com/search?q=Jasper National Park. Zero to many substitution tokens may be included. If maps are included as context, {@link LocationToken} can be used to access properties on the first map's view. In Web, if both layers and maps are included as context, then {@link LayerToken} can be used to access properties on the first layer.",
11725
+ "enum": [
11726
+ "system.open-url"
11727
+ ]
11728
+ },
11729
+ "system.open-url:input": {
11730
+ "anyOf": [
11731
+ {
11732
+ "$ref": "#/definitions/WebOpenUrlArgs"
11733
+ },
11734
+ {
11735
+ "$ref": "#/definitions/OpenUrlArgs"
11736
+ },
11737
+ {
11738
+ "type": "string"
11739
+ }
11740
+ ]
11741
+ },
11373
11742
  "tasks.identify": {
11374
11743
  "description": "Returns features that intersect a given geometry.",
11375
11744
  "enum": [
@@ -11554,6 +11923,86 @@
11554
11923
  ],
11555
11924
  "type": "object"
11556
11925
  },
11926
+ {
11927
+ "additionalProperties": false,
11928
+ "properties": {
11929
+ "arguments": {
11930
+ "$ref": "#/definitions/edit.add-feature:input"
11931
+ },
11932
+ "name": {
11933
+ "$ref": "#/definitions/edit.add-feature"
11934
+ }
11935
+ },
11936
+ "required": [
11937
+ "name",
11938
+ "arguments"
11939
+ ],
11940
+ "type": "object"
11941
+ },
11942
+ {
11943
+ "additionalProperties": false,
11944
+ "properties": {
11945
+ "arguments": {
11946
+ "$ref": "#/definitions/edit.delete-features:input"
11947
+ },
11948
+ "name": {
11949
+ "$ref": "#/definitions/edit.delete-features"
11950
+ }
11951
+ },
11952
+ "required": [
11953
+ "name",
11954
+ "arguments"
11955
+ ],
11956
+ "type": "object"
11957
+ },
11958
+ {
11959
+ "additionalProperties": false,
11960
+ "properties": {
11961
+ "arguments": {
11962
+ "$ref": "#/definitions/edit.display-add-feature:input"
11963
+ },
11964
+ "name": {
11965
+ "$ref": "#/definitions/edit.display-add-feature"
11966
+ }
11967
+ },
11968
+ "required": [
11969
+ "name",
11970
+ "arguments"
11971
+ ],
11972
+ "type": "object"
11973
+ },
11974
+ {
11975
+ "additionalProperties": false,
11976
+ "properties": {
11977
+ "arguments": {
11978
+ "$ref": "#/definitions/edit.display-update-feature:input"
11979
+ },
11980
+ "name": {
11981
+ "$ref": "#/definitions/edit.display-update-feature"
11982
+ }
11983
+ },
11984
+ "required": [
11985
+ "name",
11986
+ "arguments"
11987
+ ],
11988
+ "type": "object"
11989
+ },
11990
+ {
11991
+ "additionalProperties": false,
11992
+ "properties": {
11993
+ "arguments": {
11994
+ "$ref": "#/definitions/edit.update-feature:input"
11995
+ },
11996
+ "name": {
11997
+ "$ref": "#/definitions/edit.update-feature"
11998
+ }
11999
+ },
12000
+ "required": [
12001
+ "name",
12002
+ "arguments"
12003
+ ],
12004
+ "type": "object"
12005
+ },
11557
12006
  {
11558
12007
  "additionalProperties": false,
11559
12008
  "properties": {
@@ -12082,6 +12531,22 @@
12082
12531
  ],
12083
12532
  "type": "object"
12084
12533
  },
12534
+ {
12535
+ "additionalProperties": false,
12536
+ "properties": {
12537
+ "arguments": {
12538
+ "$ref": "#/definitions/system.open-url:input"
12539
+ },
12540
+ "name": {
12541
+ "$ref": "#/definitions/system.open-url"
12542
+ }
12543
+ },
12544
+ "required": [
12545
+ "name",
12546
+ "arguments"
12547
+ ],
12548
+ "type": "object"
12549
+ },
12085
12550
  {
12086
12551
  "additionalProperties": false,
12087
12552
  "properties": {
@@ -12190,6 +12655,21 @@
12190
12655
  {
12191
12656
  "$ref": "#/definitions/drawing.set-sync"
12192
12657
  },
12658
+ {
12659
+ "$ref": "#/definitions/edit.add-feature"
12660
+ },
12661
+ {
12662
+ "$ref": "#/definitions/edit.delete-features"
12663
+ },
12664
+ {
12665
+ "$ref": "#/definitions/edit.display-add-feature"
12666
+ },
12667
+ {
12668
+ "$ref": "#/definitions/edit.display-update-feature"
12669
+ },
12670
+ {
12671
+ "$ref": "#/definitions/edit.update-feature"
12672
+ },
12193
12673
  {
12194
12674
  "$ref": "#/definitions/geocode.count"
12195
12675
  },
@@ -12298,6 +12778,9 @@
12298
12778
  {
12299
12779
  "$ref": "#/definitions/sketching.undo"
12300
12780
  },
12781
+ {
12782
+ "$ref": "#/definitions/system.open-url"
12783
+ },
12301
12784
  {
12302
12785
  "$ref": "#/definitions/ui.activate"
12303
12786
  },
package/messaging/schema/common-event.schema.json CHANGED
@@ -302,6 +302,33 @@
302
302
  "auth.token-refreshed:input": {
303
303
  "type": "string"
304
304
  },
305
+ "edit.feature-added": {
306
+ "description": "Raised when a feature is added.",
307
+ "enum": [
308
+ "edit.feature-added"
309
+ ]
310
+ },
311
+ "edit.feature-added:input": {
312
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
313
+ },
314
+ "edit.feature-deleted": {
315
+ "description": "Raised when a feature is deleted.",
316
+ "enum": [
317
+ "edit.feature-deleted"
318
+ ]
319
+ },
320
+ "edit.feature-deleted:input": {
321
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
322
+ },
323
+ "edit.feature-updated": {
324
+ "description": "Raised when a feature is updated.",
325
+ "enum": [
326
+ "edit.feature-updated"
327
+ ]
328
+ },
329
+ "edit.feature-updated:input": {
330
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
331
+ },
305
332
  "esri.Point": {
306
333
  "$ref": "esri/geometry/Point"
307
334
  },
@@ -8844,6 +8871,15 @@
8844
8871
  {
8845
8872
  "$ref": "#/definitions/auth.token-refreshed"
8846
8873
  },
8874
+ {
8875
+ "$ref": "#/definitions/edit.feature-added"
8876
+ },
8877
+ {
8878
+ "$ref": "#/definitions/edit.feature-deleted"
8879
+ },
8880
+ {
8881
+ "$ref": "#/definitions/edit.feature-updated"
8882
+ },
8847
8883
  {
8848
8884
  "$ref": "#/definitions/geolocation.accuracy-changed"
8849
8885
  },