@vertigis/viewer-spec 49.8.0 → 50.0.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 (67) hide show
  1. package/README.md +1 -1
  2. package/analytics/MobileAction.d.ts +54 -0
  3. package/analytics/MobileAction.js +1 -0
  4. package/app-config/mobile/BasemapModelProperties.d.ts +1 -1
  5. package/app-config/mobile/VertigisMobileModelProperties.d.ts +2 -2
  6. package/app-config/schema/common-app-config.schema.json +1 -1
  7. package/app-config/schema/mobile-app-config.schema.json +1 -1
  8. package/app-config/schema/web-app-config.schema.json +1 -1
  9. package/app-config/web/ResultsModelProperties.d.ts +1 -1
  10. package/app-config/web/VertigisWebModelProperties.d.ts +2 -3
  11. package/docs/presentation.md +30 -23
  12. package/messaging/DotNetTypes.d.ts +4 -0
  13. package/messaging/DotNetTypes.js +1 -0
  14. package/messaging/common.d.ts +53 -2
  15. package/messaging/common.js +1 -1
  16. package/messaging/mobile.d.ts +1 -8
  17. package/messaging/registry/Events.d.ts +6 -0
  18. package/messaging/registry/Events.js +1 -1
  19. package/messaging/registry/app.d.ts +32 -32
  20. package/messaging/registry/app.js +1 -1
  21. package/messaging/registry/auth.d.ts +44 -11
  22. package/messaging/registry/auth.js +1 -1
  23. package/messaging/registry/basemap.d.ts +19 -1
  24. package/messaging/registry/basemap.js +1 -1
  25. package/messaging/registry/bookmark.d.ts +41 -0
  26. package/messaging/registry/bookmark.js +1 -0
  27. package/messaging/registry/device.d.ts +12 -0
  28. package/messaging/registry/device.js +1 -1
  29. package/messaging/registry/file.d.ts +10 -0
  30. package/messaging/registry/file.js +1 -1
  31. package/messaging/registry/geolocation.d.ts +163 -7
  32. package/messaging/registry/geolocation.js +1 -1
  33. package/messaging/registry/geometry-toolbar.d.ts +5 -5
  34. package/messaging/registry/highlights.d.ts +6 -7
  35. package/messaging/registry/map.d.ts +85 -14
  36. package/messaging/registry/map.js +1 -1
  37. package/messaging/registry/measurement.d.ts +36 -4
  38. package/messaging/registry/measurement.js +1 -1
  39. package/messaging/registry/offline.d.ts +6 -0
  40. package/messaging/registry/offline.js +1 -1
  41. package/messaging/registry/panel.d.ts +8 -1
  42. package/messaging/registry/panel.js +1 -1
  43. package/messaging/registry/photos.js +1 -1
  44. package/messaging/registry/results.d.ts +40 -0
  45. package/messaging/registry/results.js +1 -1
  46. package/messaging/registry/search.d.ts +31 -7
  47. package/messaging/registry/search.js +1 -1
  48. package/messaging/registry/settings.d.ts +40 -0
  49. package/messaging/registry/settings.js +1 -0
  50. package/messaging/registry/shortcut.d.ts +40 -0
  51. package/messaging/registry/shortcut.js +1 -0
  52. package/messaging/registry/sketching.d.ts +4 -4
  53. package/messaging/registry/system.d.ts +21 -0
  54. package/messaging/registry/system.js +1 -1
  55. package/messaging/registry/tasks.d.ts +26 -16
  56. package/messaging/registry/tasks.js +1 -1
  57. package/messaging/registry/ui.d.ts +4 -4
  58. package/messaging/registry/workflow.d.ts +6 -9
  59. package/messaging/schema/common-action.schema.json +578 -38
  60. package/messaging/schema/common-event.schema.json +728 -11
  61. package/messaging/schema/mobile-action.schema.json +626 -79
  62. package/messaging/schema/mobile-event.schema.json +1740 -237
  63. package/messaging/schema/web-action.schema.json +611 -62
  64. package/messaging/schema/web-event.schema.json +665 -20
  65. package/package.json +4 -4
  66. package/version.d.ts +1 -1
  67. package/version.js +1 -1
@@ -60,6 +60,9 @@
60
60
  },
61
61
  "geometry": {
62
62
  "anyOf": [
63
+ {
64
+ "$ref": "#/definitions/esri.Geometry"
65
+ },
63
66
  {
64
67
  "$ref": "#/definitions/esri.rest-api.Point.Point"
65
68
  },
@@ -74,9 +77,6 @@
74
77
  },
75
78
  {
76
79
  "$ref": "#/definitions/esri.rest-api.Extent.Extent"
77
- },
78
- {
79
- "$ref": "#/definitions/esri.Geometry"
80
80
  }
81
81
  ],
82
82
  "description": "The feature's geometry."
@@ -363,6 +363,10 @@
363
363
  },
364
364
  "type": "object"
365
365
  },
366
+ "ArcGISPortalIdentity": {
367
+ "additionalProperties": false,
368
+ "type": "object"
369
+ },
366
370
  "AuthenticationType": {
367
371
  "description": "A type of authentication.",
368
372
  "enum": [
@@ -446,6 +450,15 @@
446
450
  "GeolocationStatusChangedEventArgs": {
447
451
  "additionalProperties": false,
448
452
  "description": "Arguments for the \"geolocation.status-changed\" event.",
453
+ "properties": {
454
+ "isEnabled": {
455
+ "description": "Indicates whether the geolocation is now enabled.",
456
+ "type": "boolean"
457
+ }
458
+ },
459
+ "required": [
460
+ "isEnabled"
461
+ ],
449
462
  "type": "object"
450
463
  },
451
464
  "GeometryLike": {
@@ -481,6 +494,9 @@
481
494
  },
482
495
  "type": "array"
483
496
  },
497
+ {
498
+ "$ref": "#/definitions/esri.Geometry"
499
+ },
484
500
  {
485
501
  "$ref": "#/definitions/esri.rest-api.Feature.Feature"
486
502
  },
@@ -515,12 +531,12 @@
515
531
  {
516
532
  "$ref": "#/definitions/esri.rest-api.Extent.Extent"
517
533
  },
518
- {
519
- "$ref": "#/definitions/esri.Geometry"
520
- },
521
534
  {
522
535
  "items": {
523
536
  "anyOf": [
537
+ {
538
+ "$ref": "#/definitions/esri.Geometry"
539
+ },
524
540
  {
525
541
  "$ref": "#/definitions/esri.rest-api.Point.Point"
526
542
  },
@@ -535,9 +551,6 @@
535
551
  },
536
552
  {
537
553
  "$ref": "#/definitions/esri.rest-api.Extent.Extent"
538
- },
539
- {
540
- "$ref": "#/definitions/esri.Geometry"
541
554
  }
542
555
  ]
543
556
  },
@@ -550,6 +563,10 @@
550
563
  "additionalProperties": false,
551
564
  "description": "A geolocation source.",
552
565
  "properties": {
566
+ "deviceFullName": {
567
+ "description": "Full name of the GNSS device.",
568
+ "type": "string"
569
+ },
553
570
  "deviceName": {
554
571
  "description": "Name of the GNSS device.",
555
572
  "type": "string"
@@ -564,6 +581,7 @@
564
581
  }
565
582
  },
566
583
  "required": [
584
+ "deviceFullName",
567
585
  "deviceName",
568
586
  "deviceType",
569
587
  "settings"
@@ -690,11 +708,41 @@
690
708
  "additionalProperties": false,
691
709
  "description": "Arguments for the various map events.",
692
710
  "properties": {
711
+ "mapExtension": {
712
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
713
+ "description": "The map extension for which the event was generated."
714
+ },
715
+ "maps": {
716
+ "$ref": "MapsLike",
717
+ "description": "The map from which the event was generated."
718
+ }
719
+ },
720
+ "required": [
721
+ "mapExtension"
722
+ ],
723
+ "type": "object"
724
+ },
725
+ "MapInitializedEvent": {
726
+ "additionalProperties": false,
727
+ "description": "Event args for the map.initialized event.",
728
+ "properties": {
729
+ "loadTime": {
730
+ "$ref": "#/definitions/TimeSpan",
731
+ "description": "The amount of time that the map took to load. Mobile only."
732
+ },
733
+ "mapExtension": {
734
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
735
+ "description": "The map extension for which the event was generated."
736
+ },
693
737
  "maps": {
694
738
  "$ref": "MapsLike",
695
739
  "description": "The map from which the event was generated."
696
740
  }
697
741
  },
742
+ "required": [
743
+ "loadTime",
744
+ "mapExtension"
745
+ ],
698
746
  "type": "object"
699
747
  },
700
748
  "MapsLike": {
@@ -755,6 +803,9 @@
755
803
  {
756
804
  "$ref": "#/definitions/esri.rest-api.StreamLayer.StreamLayer"
757
805
  },
806
+ {
807
+ "$ref": "#/definitions/esri.rest-api.SubtypeGroupLayer.SubtypeGroupLayer"
808
+ },
758
809
  {
759
810
  "$ref": "#/definitions/esri.rest-api.TiledImageServiceLayer.TiledImageServiceLayer"
760
811
  },
@@ -773,6 +824,14 @@
773
824
  ],
774
825
  "description": "An operational layer in a web map/scene."
775
826
  },
827
+ "PortalType": {
828
+ "description": "The type of Portal.",
829
+ "enum": [
830
+ "AGOL",
831
+ "ArcGISEnterprise"
832
+ ],
833
+ "type": "string"
834
+ },
776
835
  "PrintErrorEventArgs": {
777
836
  "additionalProperties": false,
778
837
  "description": "Arguments for the printing.print-error event.",
@@ -953,20 +1012,44 @@
953
1012
  ],
954
1013
  "type": "object"
955
1014
  },
1015
+ "SignInCompletedEventArgs": {
1016
+ "additionalProperties": false,
1017
+ "description": "Arguments for the auth.sign-in-completed and auth.portal-sign-in-completed events. Only available in VertiGIS Studio Mobile.",
1018
+ "properties": {
1019
+ "credential": {
1020
+ "$ref": "esriRuntimeSdk.Credential",
1021
+ "description": "The credential resulting from the sign in."
1022
+ },
1023
+ "identity": {
1024
+ "$ref": "#/definitions/ArcGISPortalIdentity",
1025
+ "description": "The identity that was obtained from the sign in."
1026
+ }
1027
+ },
1028
+ "required": [
1029
+ "credential",
1030
+ "identity"
1031
+ ],
1032
+ "type": "object"
1033
+ },
956
1034
  "SignInEventArgs": {
957
1035
  "additionalProperties": false,
958
- "description": "Arguments for the auth.sign-in events. Only available in the Geocortex Mobile Viewer.",
1036
+ "description": "Arguments for the auth.sign-in events. Only available in VertiGIS Studio Mobile.",
959
1037
  "properties": {
960
1038
  "authenticationType": {
961
1039
  "$ref": "#/definitions/AuthenticationType",
962
- "description": "The authentication method used for the sign in process. Not available in Geocortex Web Viewer."
1040
+ "description": "The authentication method used for the sign in process. Not available in VertiGIS Studio Web."
1041
+ },
1042
+ "portalType": {
1043
+ "$ref": "#/definitions/PortalType",
1044
+ "description": "The type of Portal: AGOL or Enterprise."
963
1045
  },
964
1046
  "requestInfo": {
965
- "description": "Information about the resource that is required to sign in. Not available in Geocortex Web Viewer. Will be an instance of esri.security.CredentialRequestInfo for the Geocortex Mobile Viewer."
1047
+ "description": "Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile."
966
1048
  }
967
1049
  },
968
1050
  "required": [
969
1051
  "authenticationType",
1052
+ "portalType",
970
1053
  "requestInfo"
971
1054
  ],
972
1055
  "type": "object"
@@ -977,22 +1060,31 @@
977
1060
  "properties": {
978
1061
  "authenticationType": {
979
1062
  "$ref": "#/definitions/AuthenticationType",
980
- "description": "The authentication method used for the sign in process. Not available in Geocortex Web Viewer."
1063
+ "description": "The authentication method used for the sign in process. Not available in VertiGIS Studio Web."
981
1064
  },
982
1065
  "exception": {
983
- "description": "The exception that occurred during the sign in. Not available in Geocortex Web Viewer."
1066
+ "description": "The exception that occurred during the sign in. Not available in VertiGIS Studio Web."
1067
+ },
1068
+ "portalType": {
1069
+ "$ref": "#/definitions/PortalType",
1070
+ "description": "The type of Portal: AGOL or Enterprise."
984
1071
  },
985
1072
  "requestInfo": {
986
- "description": "Information about the resource that is required to sign in. Not available in Geocortex Web Viewer. Will be an instance of esri.security.CredentialRequestInfo for the Geocortex Mobile Viewer."
1073
+ "description": "Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile."
987
1074
  }
988
1075
  },
989
1076
  "required": [
990
1077
  "authenticationType",
991
1078
  "exception",
1079
+ "portalType",
992
1080
  "requestInfo"
993
1081
  ],
994
1082
  "type": "object"
995
1083
  },
1084
+ "TimeSpan": {
1085
+ "additionalProperties": false,
1086
+ "type": "object"
1087
+ },
996
1088
  "UpdateSessionArgs": {
997
1089
  "additionalProperties": false,
998
1090
  "description": "Used to update an in-progress interactive feature editing session with new attributes, attachments or geometry. Web only.",
@@ -1018,6 +1110,10 @@
1018
1110
  "additionalProperties": false,
1019
1111
  "description": "Arguments for the ViewModeChanged event.",
1020
1112
  "properties": {
1113
+ "mapExtension": {
1114
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
1115
+ "description": "The map extension for which the event was generated."
1116
+ },
1021
1117
  "maps": {
1022
1118
  "$ref": "MapsLike",
1023
1119
  "description": "The map from which the event was generated."
@@ -1027,6 +1123,9 @@
1027
1123
  "description": "The new ViewMode."
1028
1124
  }
1029
1125
  },
1126
+ "required": [
1127
+ "mapExtension"
1128
+ ],
1030
1129
  "type": "object"
1031
1130
  },
1032
1131
  "VisualState": {
@@ -1108,13 +1207,20 @@
1108
1207
  "type": "object"
1109
1208
  },
1110
1209
  "auth.sign-in-completed": {
1111
- "description": "Raised when successfully signed in.",
1210
+ "description": "Raised when successfully signed in. Principal event type used in Web, SignInCompletedEventArgs used in Mobile.",
1112
1211
  "enum": [
1113
1212
  "auth.sign-in-completed"
1114
1213
  ]
1115
1214
  },
1116
1215
  "auth.sign-in-completed:input": {
1117
- "$ref": "Principal"
1216
+ "anyOf": [
1217
+ {
1218
+ "$ref": "Principal"
1219
+ },
1220
+ {
1221
+ "$ref": "#/definitions/SignInCompletedEventArgs"
1222
+ }
1223
+ ]
1118
1224
  },
1119
1225
  "auth.sign-in-failed": {
1120
1226
  "description": "Raised when a sign-in attempt fails.",
@@ -1161,7 +1267,7 @@
1161
1267
  ]
1162
1268
  },
1163
1269
  "auth.token-refreshed": {
1164
- "description": "Raised when the user's token is refreshed. Will be the new token in the Geocortex Web Viewer, and a TokenCredential object in the Geocortex Mobile Viewer.",
1270
+ "description": "Raised when the user's token is refreshed. Will be the new token in the VertiGIS Studio Web, and a TokenCredential object in VertiGIS Studio Mobile.",
1165
1271
  "enum": [
1166
1272
  "auth.token-refreshed"
1167
1273
  ]
@@ -1285,6 +1391,10 @@
1285
1391
  "$ref": "#/definitions/esri.rest-api._LayerBase.BlendMode",
1286
1392
  "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer."
1287
1393
  },
1394
+ "effect": {
1395
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
1396
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
1397
+ },
1288
1398
  "filters": {
1289
1399
  "description": "A list of filters available for this layer. Overrides filters defined on the service.",
1290
1400
  "items": {
@@ -1571,6 +1681,10 @@
1571
1681
  "description": "Indicates whether to allow a client to ignore popups defined by the service item.",
1572
1682
  "type": "boolean"
1573
1683
  },
1684
+ "effect": {
1685
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
1686
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
1687
+ },
1574
1688
  "id": {
1575
1689
  "description": "A unique identifying string for the layer.",
1576
1690
  "type": "string"
@@ -2323,6 +2437,369 @@
2323
2437
  ],
2324
2438
  "type": "object"
2325
2439
  },
2440
+ "esri.rest-api.Effect.BloomEffectFunction": {
2441
+ "additionalProperties": false,
2442
+ "description": "An Effect Function for the bloom effect.",
2443
+ "properties": {
2444
+ "radius": {
2445
+ "description": "Determines the radius of the blur. Negative values are not allowed. Leaves the pixels inside the radius untouched.",
2446
+ "type": "number"
2447
+ },
2448
+ "strength": {
2449
+ "description": "The intensity of the bloom effect. The higher the value, the brighter the glow. Negative values are not allowed.",
2450
+ "type": "number"
2451
+ },
2452
+ "threshold": {
2453
+ "description": "The minimum color luminosity for a pixel to bloom, where at 0 all pixels bloom and 1 only the pixels with 100% luminosity colors bloom.",
2454
+ "type": "number"
2455
+ },
2456
+ "type": {
2457
+ "description": "Effect type.",
2458
+ "enum": [
2459
+ "bloom"
2460
+ ],
2461
+ "type": "string"
2462
+ }
2463
+ },
2464
+ "required": [
2465
+ "type"
2466
+ ],
2467
+ "type": "object"
2468
+ },
2469
+ "esri.rest-api.Effect.BlurEffectFunction": {
2470
+ "additionalProperties": false,
2471
+ "description": "An Effect Function for the blur effect.",
2472
+ "properties": {
2473
+ "radius": {
2474
+ "description": "The radius of the blur in points. It defines the value of the standard deviation to the Gaussian function. Negative values are not allowed.",
2475
+ "type": "number"
2476
+ },
2477
+ "type": {
2478
+ "description": "Effect type.",
2479
+ "enum": [
2480
+ "blur"
2481
+ ],
2482
+ "type": "string"
2483
+ }
2484
+ },
2485
+ "required": [
2486
+ "type"
2487
+ ],
2488
+ "type": "object"
2489
+ },
2490
+ "esri.rest-api.Effect.BrightnessEffectFunction": {
2491
+ "additionalProperties": false,
2492
+ "description": "An Effect Function for the brightness effect.",
2493
+ "properties": {
2494
+ "amount": {
2495
+ "description": "Amount of effect. A value of 0 leaves the input unchanged. Grayscale, invert, sepia, and opacity effects accept a maximum amount of 1 which applies the effect at 100%. Brightness, contrast, and saturate can accept amount above 1. Negative values are not allowed.",
2496
+ "type": "number"
2497
+ },
2498
+ "type": {
2499
+ "description": "Effect type.",
2500
+ "enum": [
2501
+ "brightness"
2502
+ ],
2503
+ "type": "string"
2504
+ }
2505
+ },
2506
+ "required": [
2507
+ "type"
2508
+ ],
2509
+ "type": "object"
2510
+ },
2511
+ "esri.rest-api.Effect.ContrastEffectFunction": {
2512
+ "additionalProperties": false,
2513
+ "description": "An Effect Function for the contrast effect.",
2514
+ "properties": {
2515
+ "amount": {
2516
+ "description": "Amount of effect. A value of 0 leaves the input unchanged. Grayscale, invert, sepia, and opacity effects accept a maximum amount of 1 which applies the effect at 100%. Brightness, contrast, and saturate can accept amount above 1. Negative values are not allowed.",
2517
+ "type": "number"
2518
+ },
2519
+ "type": {
2520
+ "description": "Effect type.",
2521
+ "enum": [
2522
+ "contrast"
2523
+ ],
2524
+ "type": "string"
2525
+ }
2526
+ },
2527
+ "required": [
2528
+ "type"
2529
+ ],
2530
+ "type": "object"
2531
+ },
2532
+ "esri.rest-api.Effect.DropShadowEffectFunction": {
2533
+ "additionalProperties": false,
2534
+ "description": "An Effect Function for the drop-shadow effect.",
2535
+ "properties": {
2536
+ "blurRadius": {
2537
+ "description": "The radius of the blur in points. It defines the value of the standard deviation to the Gaussian function.",
2538
+ "type": "number"
2539
+ },
2540
+ "color": {
2541
+ "description": "Color is represented as a four-element array. The four elements represent values for red, green, blue, and alpha in that order. Values range from 0 through 255.",
2542
+ "items": {
2543
+ "type": "number"
2544
+ },
2545
+ "type": "array"
2546
+ },
2547
+ "type": {
2548
+ "description": "Effect type.",
2549
+ "enum": [
2550
+ "drop-shadow"
2551
+ ],
2552
+ "type": "string"
2553
+ },
2554
+ "xoffset": {
2555
+ "description": "The distance of the shadow on the x-axis in points.",
2556
+ "type": "number"
2557
+ },
2558
+ "yoffset": {
2559
+ "description": "The distance of the shadow on the y-axis in points.",
2560
+ "type": "number"
2561
+ }
2562
+ },
2563
+ "required": [
2564
+ "type"
2565
+ ],
2566
+ "type": "object"
2567
+ },
2568
+ "esri.rest-api.Effect.Effect": {
2569
+ "anyOf": [
2570
+ {
2571
+ "items": {
2572
+ "$ref": "#/definitions/esri.rest-api.Effect.ScaleDependentEffect"
2573
+ },
2574
+ "type": "array"
2575
+ },
2576
+ {
2577
+ "items": {
2578
+ "anyOf": [
2579
+ {
2580
+ "$ref": "#/definitions/esri.rest-api.Effect.HueRotateEffectFunction"
2581
+ },
2582
+ {
2583
+ "$ref": "#/definitions/esri.rest-api.Effect.BlurEffectFunction"
2584
+ },
2585
+ {
2586
+ "$ref": "#/definitions/esri.rest-api.Effect.DropShadowEffectFunction"
2587
+ },
2588
+ {
2589
+ "$ref": "#/definitions/esri.rest-api.Effect.BloomEffectFunction"
2590
+ },
2591
+ {
2592
+ "$ref": "#/definitions/esri.rest-api.Effect.BrightnessEffectFunction"
2593
+ },
2594
+ {
2595
+ "$ref": "#/definitions/esri.rest-api.Effect.ContrastEffectFunction"
2596
+ },
2597
+ {
2598
+ "$ref": "#/definitions/esri.rest-api.Effect.GrayscaleEffectFunction"
2599
+ },
2600
+ {
2601
+ "$ref": "#/definitions/esri.rest-api.Effect.InvertEffectFunction"
2602
+ },
2603
+ {
2604
+ "$ref": "#/definitions/esri.rest-api.Effect.OpacityEffectFunction"
2605
+ },
2606
+ {
2607
+ "$ref": "#/definitions/esri.rest-api.Effect.SaturateEffectFunction"
2608
+ },
2609
+ {
2610
+ "$ref": "#/definitions/esri.rest-api.Effect.SepiaEffectFunction"
2611
+ }
2612
+ ],
2613
+ "description": "Effect functions that can be combined to build a layer effect."
2614
+ },
2615
+ "type": "array"
2616
+ }
2617
+ ],
2618
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
2619
+ },
2620
+ "esri.rest-api.Effect.GrayscaleEffectFunction": {
2621
+ "additionalProperties": false,
2622
+ "description": "An Effect Function for the grayscale effect.",
2623
+ "properties": {
2624
+ "amount": {
2625
+ "description": "Amount of effect. A value of 0 leaves the input unchanged. Grayscale, invert, sepia, and opacity effects accept a maximum amount of 1 which applies the effect at 100%. Brightness, contrast, and saturate can accept amount above 1. Negative values are not allowed.",
2626
+ "type": "number"
2627
+ },
2628
+ "type": {
2629
+ "description": "Effect type.",
2630
+ "enum": [
2631
+ "grayscale"
2632
+ ],
2633
+ "type": "string"
2634
+ }
2635
+ },
2636
+ "required": [
2637
+ "type"
2638
+ ],
2639
+ "type": "object"
2640
+ },
2641
+ "esri.rest-api.Effect.HueRotateEffectFunction": {
2642
+ "additionalProperties": false,
2643
+ "description": "An Effect Function for the hue-rotate effect.",
2644
+ "properties": {
2645
+ "angle": {
2646
+ "description": "The relative change in hue as an angle in degree. A value of 0 leaves the input unchanged. A positive hue rotation increases the hue value, while a negative one decreases the hue value.",
2647
+ "type": "number"
2648
+ },
2649
+ "type": {
2650
+ "description": "Effect type.",
2651
+ "enum": [
2652
+ "hue-rotate"
2653
+ ],
2654
+ "type": "string"
2655
+ }
2656
+ },
2657
+ "required": [
2658
+ "type"
2659
+ ],
2660
+ "type": "object"
2661
+ },
2662
+ "esri.rest-api.Effect.InvertEffectFunction": {
2663
+ "additionalProperties": false,
2664
+ "description": "An Effect Function for the invert effect.",
2665
+ "properties": {
2666
+ "amount": {
2667
+ "description": "Amount of effect. A value of 0 leaves the input unchanged. Grayscale, invert, sepia, and opacity effects accept a maximum amount of 1 which applies the effect at 100%. Brightness, contrast, and saturate can accept amount above 1. Negative values are not allowed.",
2668
+ "type": "number"
2669
+ },
2670
+ "type": {
2671
+ "description": "Effect type.",
2672
+ "enum": [
2673
+ "invert"
2674
+ ],
2675
+ "type": "string"
2676
+ }
2677
+ },
2678
+ "required": [
2679
+ "type"
2680
+ ],
2681
+ "type": "object"
2682
+ },
2683
+ "esri.rest-api.Effect.OpacityEffectFunction": {
2684
+ "additionalProperties": false,
2685
+ "description": "An Effect Function for the opacity effect.",
2686
+ "properties": {
2687
+ "amount": {
2688
+ "description": "Amount of effect. A value of 0 leaves the input unchanged. Grayscale, invert, sepia, and opacity effects accept a maximum amount of 1 which applies the effect at 100%. Brightness, contrast, and saturate can accept amount above 1. Negative values are not allowed.",
2689
+ "type": "number"
2690
+ },
2691
+ "type": {
2692
+ "description": "Effect type.",
2693
+ "enum": [
2694
+ "opacity"
2695
+ ],
2696
+ "type": "string"
2697
+ }
2698
+ },
2699
+ "required": [
2700
+ "type"
2701
+ ],
2702
+ "type": "object"
2703
+ },
2704
+ "esri.rest-api.Effect.SaturateEffectFunction": {
2705
+ "additionalProperties": false,
2706
+ "description": "An Effect Function for the saturate effect.",
2707
+ "properties": {
2708
+ "amount": {
2709
+ "description": "Amount of effect. A value of 0 leaves the input unchanged. Grayscale, invert, sepia, and opacity effects accept a maximum amount of 1 which applies the effect at 100%. Brightness, contrast, and saturate can accept amount above 1. Negative values are not allowed.",
2710
+ "type": "number"
2711
+ },
2712
+ "type": {
2713
+ "description": "Effect type.",
2714
+ "enum": [
2715
+ "saturate"
2716
+ ],
2717
+ "type": "string"
2718
+ }
2719
+ },
2720
+ "required": [
2721
+ "type"
2722
+ ],
2723
+ "type": "object"
2724
+ },
2725
+ "esri.rest-api.Effect.ScaleDependentEffect": {
2726
+ "additionalProperties": false,
2727
+ "description": "An object describing the effect to apply at a scale stop.",
2728
+ "properties": {
2729
+ "scale": {
2730
+ "description": "The scale of the view for the effect to take place.",
2731
+ "type": "number"
2732
+ },
2733
+ "value": {
2734
+ "description": "The effect to be applied at the corresponding scale.",
2735
+ "items": {
2736
+ "anyOf": [
2737
+ {
2738
+ "$ref": "#/definitions/esri.rest-api.Effect.HueRotateEffectFunction"
2739
+ },
2740
+ {
2741
+ "$ref": "#/definitions/esri.rest-api.Effect.BlurEffectFunction"
2742
+ },
2743
+ {
2744
+ "$ref": "#/definitions/esri.rest-api.Effect.DropShadowEffectFunction"
2745
+ },
2746
+ {
2747
+ "$ref": "#/definitions/esri.rest-api.Effect.BloomEffectFunction"
2748
+ },
2749
+ {
2750
+ "$ref": "#/definitions/esri.rest-api.Effect.BrightnessEffectFunction"
2751
+ },
2752
+ {
2753
+ "$ref": "#/definitions/esri.rest-api.Effect.ContrastEffectFunction"
2754
+ },
2755
+ {
2756
+ "$ref": "#/definitions/esri.rest-api.Effect.GrayscaleEffectFunction"
2757
+ },
2758
+ {
2759
+ "$ref": "#/definitions/esri.rest-api.Effect.InvertEffectFunction"
2760
+ },
2761
+ {
2762
+ "$ref": "#/definitions/esri.rest-api.Effect.OpacityEffectFunction"
2763
+ },
2764
+ {
2765
+ "$ref": "#/definitions/esri.rest-api.Effect.SaturateEffectFunction"
2766
+ },
2767
+ {
2768
+ "$ref": "#/definitions/esri.rest-api.Effect.SepiaEffectFunction"
2769
+ }
2770
+ ],
2771
+ "description": "Effect functions that can be combined to build a layer effect."
2772
+ },
2773
+ "type": "array"
2774
+ }
2775
+ },
2776
+ "required": [
2777
+ "scale",
2778
+ "value"
2779
+ ],
2780
+ "type": "object"
2781
+ },
2782
+ "esri.rest-api.Effect.SepiaEffectFunction": {
2783
+ "additionalProperties": false,
2784
+ "description": "An Effect Function for the sepia effect.",
2785
+ "properties": {
2786
+ "amount": {
2787
+ "description": "Amount of effect. A value of 0 leaves the input unchanged. Grayscale, invert, sepia, and opacity effects accept a maximum amount of 1 which applies the effect at 100%. Brightness, contrast, and saturate can accept amount above 1. Negative values are not allowed.",
2788
+ "type": "number"
2789
+ },
2790
+ "type": {
2791
+ "description": "Effect type.",
2792
+ "enum": [
2793
+ "sepia"
2794
+ ],
2795
+ "type": "string"
2796
+ }
2797
+ },
2798
+ "required": [
2799
+ "type"
2800
+ ],
2801
+ "type": "object"
2802
+ },
2326
2803
  "esri.rest-api.ElevationInfo.ElevationInfo": {
2327
2804
  "additionalProperties": false,
2328
2805
  "description": "Specifies how graphics are placed on the vertical axis (z). This property may only be used in a SceneView.{@linkhttps://developers.arcgis.com/web-scene-specification/objects/elevationInfo/}.",
@@ -2382,6 +2859,10 @@
2382
2859
  "$ref": "#/definitions/esri.rest-api._LayerBase.BlendMode",
2383
2860
  "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer."
2384
2861
  },
2862
+ "effect": {
2863
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
2864
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
2865
+ },
2385
2866
  "id": {
2386
2867
  "description": "A unique identifying string for the layer.",
2387
2868
  "type": "string"
@@ -2628,6 +3109,10 @@
2628
3109
  "description": "Indicates whether to allow a client to ignore popups defined by the service item.",
2629
3110
  "type": "boolean"
2630
3111
  },
3112
+ "effect": {
3113
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
3114
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
3115
+ },
2631
3116
  "featureCollection": {
2632
3117
  "$ref": "#/definitions/esri.rest-api.FeatureCollection.FeatureCollection",
2633
3118
  "description": "A featureCollection object defining a layer of features whose geometry and attributes will be stored directly within the web map. This is only used when no url property is supplied."
@@ -3497,6 +3982,10 @@
3497
3982
  "$ref": "#/definitions/esri.rest-api._LayerBase.BlendMode",
3498
3983
  "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer."
3499
3984
  },
3985
+ "effect": {
3986
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
3987
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
3988
+ },
3500
3989
  "id": {
3501
3990
  "description": "A unique identifying string for the layer.",
3502
3991
  "type": "string"
@@ -3604,6 +4093,10 @@
3604
4093
  "$ref": "#/definitions/esri.rest-api._LayerBase.BlendMode",
3605
4094
  "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer."
3606
4095
  },
4096
+ "effect": {
4097
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
4098
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
4099
+ },
3607
4100
  "id": {
3608
4101
  "description": "A unique identifying string for the layer.",
3609
4102
  "type": "string"
@@ -3848,6 +4341,10 @@
3848
4341
  "$ref": "#/definitions/esri.rest-api.DefinitionEditor.DefinitionEditor",
3849
4342
  "description": "Stores interactive filters."
3850
4343
  },
4344
+ "effect": {
4345
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
4346
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
4347
+ },
3851
4348
  "format": {
3852
4349
  "description": "The output image type.",
3853
4350
  "enum": [
@@ -3998,6 +4495,10 @@
3998
4495
  "description": "Boolean property indicating whether to ignore popups defined by the service item.",
3999
4496
  "type": "boolean"
4000
4497
  },
4498
+ "effect": {
4499
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
4500
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
4501
+ },
4001
4502
  "id": {
4002
4503
  "description": "A unique identifying string for the layer.",
4003
4504
  "type": "string"
@@ -4112,6 +4613,10 @@
4112
4613
  "$ref": "#/definitions/esri.rest-api._LayerBase.BlendMode",
4113
4614
  "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer."
4114
4615
  },
4616
+ "effect": {
4617
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
4618
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
4619
+ },
4115
4620
  "id": {
4116
4621
  "description": "A unique identifying string for the layer.",
4117
4622
  "type": "string"
@@ -4254,6 +4759,10 @@
4254
4759
  "$ref": "#/definitions/esri.rest-api._LayerBase.BlendMode",
4255
4760
  "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer."
4256
4761
  },
4762
+ "effect": {
4763
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
4764
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
4765
+ },
4257
4766
  "id": {
4258
4767
  "description": "A unique identifying string for the layer.",
4259
4768
  "type": "string"
@@ -4985,6 +5494,10 @@
4985
5494
  "customParameters": {
4986
5495
  "description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
4987
5496
  },
5497
+ "effect": {
5498
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
5499
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
5500
+ },
4988
5501
  "id": {
4989
5502
  "description": "A unique identifying string for the layer.",
4990
5503
  "type": "string"
@@ -5634,6 +6147,10 @@
5634
6147
  "description": "Indicates whether to allow a client to ignore popups defined by the service item.",
5635
6148
  "type": "boolean"
5636
6149
  },
6150
+ "effect": {
6151
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
6152
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
6153
+ },
5637
6154
  "id": {
5638
6155
  "description": "A unique identifying string for the layer.",
5639
6156
  "type": "string"
@@ -6765,6 +7282,10 @@
6765
7282
  "description": "Indicates whether to allow a client to ignore popups defined by the service item.",
6766
7283
  "type": "boolean"
6767
7284
  },
7285
+ "effect": {
7286
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
7287
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
7288
+ },
6768
7289
  "id": {
6769
7290
  "description": "A unique identifying string for the layer.",
6770
7291
  "type": "string"
@@ -7134,6 +7655,10 @@
7134
7655
  "description": "Indicates whether to allow a client to ignore popups defined by the service item.",
7135
7656
  "type": "boolean"
7136
7657
  },
7658
+ "effect": {
7659
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
7660
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
7661
+ },
7137
7662
  "featureCollection": {
7138
7663
  "$ref": "#/definitions/esri.rest-api.FeatureCollection.FeatureCollection",
7139
7664
  "description": "A featureCollection object defining a layer of features whose geometry and attributes will be stored directly within the web map. This is only used when no url property is supplied."
@@ -7272,6 +7797,99 @@
7272
7797
  ],
7273
7798
  "type": "object"
7274
7799
  },
7800
+ "esri.rest-api.SubtypeGroupLayer.SubtypeGroupLayer": {
7801
+ "additionalProperties": false,
7802
+ "description": "SubtypeGroupLayer provides the ability to organize several sublayers into one common layer. Suppose there are several FeatureLayers that all represent water features in different dimensions. For example, wells (points), streams (lines), and lakes (polygons). The SubtypeGroupLayer provides the functionality to treat them as one layer called Water Features even though they are stored as separate feature layers.{@linkhttps://developers.arcgis.com/web-scene-specification/objects/subtypeGroupLayer/}.",
7803
+ "properties": {
7804
+ "blendMode": {
7805
+ "$ref": "#/definitions/esri.rest-api._LayerBase.BlendMode",
7806
+ "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer."
7807
+ },
7808
+ "customParameters": {
7809
+ "description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
7810
+ },
7811
+ "effect": {
7812
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
7813
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
7814
+ },
7815
+ "id": {
7816
+ "description": "A unique identifying string for the layer.",
7817
+ "type": "string"
7818
+ },
7819
+ "layerDefinition": {
7820
+ "$ref": "#/definitions/esri.rest-api.LayerDefinition.LayerDefinition",
7821
+ "description": "A layerDefinition object defining the attribute schema and drawing information for the layer."
7822
+ },
7823
+ "layerType": {
7824
+ "description": "String indicating the layer type. Value of this property must be SubtypeGroupLayer.",
7825
+ "enum": [
7826
+ "ArcGISSubtypeGroupLayer"
7827
+ ],
7828
+ "type": "string"
7829
+ },
7830
+ "layers": {
7831
+ "description": "An array of feature layers, each describing the properties for a subtype in the feature service layer.",
7832
+ "items": {
7833
+ "$ref": "#/definitions/esri.rest-api.FeatureLayer.FeatureLayer"
7834
+ },
7835
+ "type": "array"
7836
+ },
7837
+ "listMode": {
7838
+ "$ref": "esri.ListMode",
7839
+ "description": "Indicates how the layer should display in the table of contents. The known values are listed below. See{@linkListMode}."
7840
+ },
7841
+ "maxScale": {
7842
+ "description": "A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.",
7843
+ "type": "number"
7844
+ },
7845
+ "minScale": {
7846
+ "description": "A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.",
7847
+ "type": "number"
7848
+ },
7849
+ "opacity": {
7850
+ "description": "The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.",
7851
+ "type": "number"
7852
+ },
7853
+ "refreshInterval": {
7854
+ "description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page.{@linkhttps://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
7855
+ "type": "number"
7856
+ },
7857
+ "showLegend": {
7858
+ "description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
7859
+ "type": "boolean"
7860
+ },
7861
+ "title": {
7862
+ "description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
7863
+ "type": "string"
7864
+ },
7865
+ "type": {
7866
+ "description": "(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type. See{@linkOperationalLayerType}and{@linkBaseMapLayerType}.",
7867
+ "enum": [
7868
+ "BingMapsAerial",
7869
+ "BingMapsHybrid",
7870
+ "BingMapsRoad",
7871
+ "CSV",
7872
+ "KML",
7873
+ "OpenStreetMap",
7874
+ "WMS",
7875
+ "WebTiledLayer"
7876
+ ],
7877
+ "type": "string"
7878
+ },
7879
+ "url": {
7880
+ "description": "The URL to the layer. If the layer is not from a web service but rather a feature collection, then the url property is omitted.",
7881
+ "type": "string"
7882
+ },
7883
+ "visibility": {
7884
+ "description": "Determines whether the layer is initially visible in the web map.",
7885
+ "type": "boolean"
7886
+ }
7887
+ },
7888
+ "required": [
7889
+ "layerType"
7890
+ ],
7891
+ "type": "object"
7892
+ },
7275
7893
  "esri.rest-api.Symbol.Color": {
7276
7894
  "description": "Color is represented as a four-element array. The four elements represent values for red, green, blue, and alpha in that order. Values range from 0 through 255. If color is undefined for a symbol, the color value is null.{@linkhttps://developers.arcgis.com/web-map-specification/objects/color/}{@linkhttps://developers.arcgis.com/web-scene-specification/objects/color/}.",
7277
7895
  "items": {
@@ -7774,6 +8392,10 @@
7774
8392
  "customParameters": {
7775
8393
  "description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
7776
8394
  },
8395
+ "effect": {
8396
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
8397
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
8398
+ },
7777
8399
  "id": {
7778
8400
  "description": "A unique identifying string for the layer.",
7779
8401
  "type": "string"
@@ -7868,6 +8490,10 @@
7868
8490
  },
7869
8491
  "type": "array"
7870
8492
  },
8493
+ "effect": {
8494
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
8495
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
8496
+ },
7871
8497
  "exclusionAreas": {
7872
8498
  "$ref": "__type",
7873
8499
  "description": "Exclusion areas define extent areas where no data will be fetched for a layer. NOTE: Applicable if used as a baseMapLayer. An array of exclusionArea objects defining the layer exclusions.{@linkhttps://developers.arcgis.com/web-map-specification/objects/exclusionArea/}."
@@ -8362,6 +8988,10 @@
8362
8988
  "customParameters": {
8363
8989
  "description": "A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types."
8364
8990
  },
8991
+ "effect": {
8992
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
8993
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
8994
+ },
8365
8995
  "id": {
8366
8996
  "description": "A unique identifying string for the layer.",
8367
8997
  "type": "string"
@@ -8834,6 +9464,10 @@
8834
9464
  "customParameters": {
8835
9465
  "description": "A sequence of custom parameters to all WMS requests. These parameters are applied to GetCapabilities, GetMap, and GetFeatureInfo requests. If used with the customLayerParameters property, customParameters will not take precedence."
8836
9466
  },
9467
+ "effect": {
9468
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
9469
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
9470
+ },
8837
9471
  "extent": {
8838
9472
  "description": "The rectangular map extent that should be requested from the service.",
8839
9473
  "items": {
@@ -9036,6 +9670,10 @@
9036
9670
  "description": "Attribution to the Web Tile Layer provider. It is displayed in the attribution on the web map. Input required by the user when the layer is added to the web map.",
9037
9671
  "type": "string"
9038
9672
  },
9673
+ "effect": {
9674
+ "$ref": "#/definitions/esri.rest-api.Effect.Effect",
9675
+ "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
9676
+ },
9039
9677
  "fullExtent": {
9040
9678
  "$ref": "#/definitions/esri.rest-api.Extent.Extent",
9041
9679
  "description": "An extent object representing the full extent envelope for the layer."
@@ -9293,13 +9931,20 @@
9293
9931
  "$ref": "#/definitions/LocationMarkerEvent"
9294
9932
  },
9295
9933
  "map.initialized": {
9296
- "description": "Raised when a map has completed initialization.",
9934
+ "description": "Raised when a map has completed initialization. MapEvent used in Web, MapInitializedEvent used in Mobile.",
9297
9935
  "enum": [
9298
9936
  "map.initialized"
9299
9937
  ]
9300
9938
  },
9301
9939
  "map.initialized:input": {
9302
- "$ref": "MapEvent"
9940
+ "anyOf": [
9941
+ {
9942
+ "$ref": "MapEvent"
9943
+ },
9944
+ {
9945
+ "$ref": "MapInitializedEvent"
9946
+ }
9947
+ ]
9303
9948
  },
9304
9949
  "map.view-mode-changed": {
9305
9950
  "description": "Raised when a map's {@link ViewMode} is changed. This happens when the map view is changed between a WebMap and a WebScene.",