@vertigis/viewer-spec 48.7.0 → 48.9.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.
@@ -487,6 +487,23 @@
487
487
  ],
488
488
  "type": "object"
489
489
  },
490
+ "AddMarkupArgs": {
491
+ "additionalProperties": false,
492
+ "description": "Arguments for the \"map.add-markup\" operation. Only available in Mobile.",
493
+ "properties": {
494
+ "graphics": {
495
+ "description": "The graphics to add to the map.",
496
+ "items": {
497
+ "$ref": "#/definitions/esri.Graphic"
498
+ },
499
+ "type": "array"
500
+ }
501
+ },
502
+ "required": [
503
+ "graphics"
504
+ ],
505
+ "type": "object"
506
+ },
490
507
  "AddNodeOrder": {
491
508
  "description": "Indicates whether a new point should be added before or after the active point in a sketch.",
492
509
  "enum": [
@@ -689,6 +706,10 @@
689
706
  "additionalProperties": false,
690
707
  "description": "Arguments for the \"sketching.capture-geometry\" operation.",
691
708
  "properties": {
709
+ "editorSettings": {
710
+ "$ref": "#/definitions/GeometryEditorSettings",
711
+ "description": "The settings to be applied to the sketch. Mobile only."
712
+ },
692
713
  "geometryType": {
693
714
  "anyOf": [
694
715
  {
@@ -856,6 +877,24 @@
856
877
  ],
857
878
  "type": "object"
858
879
  },
880
+ "CreateGraphicsArgs": {
881
+ "additionalProperties": false,
882
+ "description": "Arguments for the \"drawing.create-graphics\" operation. Only available in Mobile.",
883
+ "properties": {
884
+ "geometry": {
885
+ "$ref": "#/definitions/esri.Geometry",
886
+ "description": "The geometry that was captured."
887
+ },
888
+ "symbol": {
889
+ "$ref": "#/definitions/esri.Symbol",
890
+ "description": "The symbol that should be used to create the graphic. If null, a default is provided."
891
+ }
892
+ },
893
+ "required": [
894
+ "geometry"
895
+ ],
896
+ "type": "object"
897
+ },
859
898
  "CreateGraphicsResult": {
860
899
  "additionalProperties": false,
861
900
  "description": "Result of the \"drawing.create-graphics\" and \"measurement.create-graphics\" operations.",
@@ -869,7 +908,7 @@
869
908
  },
870
909
  "maps": {
871
910
  "$ref": "MapsLike",
872
- "description": "The map that the graphics were created on."
911
+ "description": "The map that the graphics were created on. Only available in Web."
873
912
  }
874
913
  },
875
914
  "required": [
@@ -1590,7 +1629,7 @@
1590
1629
  },
1591
1630
  "GeometryEditorSettings": {
1592
1631
  "additionalProperties": false,
1593
- "description": "Settings for the geometry editor.",
1632
+ "description": "Settings for a sketch.",
1594
1633
  "properties": {
1595
1634
  "editorGeometryMode": {
1596
1635
  "$ref": "#/definitions/EditorGeometryMode",
@@ -1600,6 +1639,18 @@
1600
1639
  "$ref": "#/definitions/EditorInteractionMode",
1601
1640
  "description": "The editor interaction mode."
1602
1641
  },
1642
+ "finishIfInterrupted": {
1643
+ "description": "A value indicating whether the sketch should commit its geometry if another sketch is activated.",
1644
+ "type": "boolean"
1645
+ },
1646
+ "finishOnDoubleClick": {
1647
+ "description": "A value indicating whether the sketch should stop when double clicking.",
1648
+ "type": "boolean"
1649
+ },
1650
+ "freehand": {
1651
+ "description": "A value indicating whether the sketch is using freehand or segment sketching.",
1652
+ "type": "boolean"
1653
+ },
1603
1654
  "showBearings": {
1604
1655
  "description": "A value indicating whether bearing labels should be shown on the map.",
1605
1656
  "type": "boolean"
@@ -2888,7 +2939,7 @@
2888
2939
  },
2889
2940
  "editorSettings": {
2890
2941
  "$ref": "#/definitions/GeometryEditorSettings",
2891
- "description": "The settings to be applied to the geometry editor."
2942
+ "description": "The settings to be applied to the sketch."
2892
2943
  },
2893
2944
  "geometry": {
2894
2945
  "$ref": "#/definitions/esri.Geometry",
@@ -2913,6 +2964,10 @@
2913
2964
  "retainEditorSettings": {
2914
2965
  "description": "A value indicating whether the previous geometry editor settings should be restored after this sketch is stopped.",
2915
2966
  "type": "boolean"
2967
+ },
2968
+ "symbol": {
2969
+ "$ref": "#/definitions/esri.rest-api.Symbol.Symbol",
2970
+ "description": "An optional symbol to use."
2916
2971
  }
2917
2972
  },
2918
2973
  "required": [
@@ -3349,6 +3404,130 @@
3349
3404
  "debug-console.display"
3350
3405
  ]
3351
3406
  },
3407
+ "drawing.create-graphics": {
3408
+ "description": "Creates graphics. In Web, creates graphics out of GeometryLike args, with the current symbols that are set on the DrawManager. In Mobile, creates graphics from the given CreateGraphicsArgs or CreateGraphicsArgs[] (or some GeometryLike args). Any provided symbol parameter is used, otherwise a default symbol is used.",
3409
+ "enum": [
3410
+ "drawing.create-graphics"
3411
+ ]
3412
+ },
3413
+ "drawing.create-graphics:input": {
3414
+ "anyOf": [
3415
+ {
3416
+ "$ref": "#/definitions/esri.Geometry"
3417
+ },
3418
+ {
3419
+ "$ref": "#/definitions/esri.Graphic"
3420
+ },
3421
+ {
3422
+ "$ref": "#/definitions/esri.FeatureSet"
3423
+ },
3424
+ {
3425
+ "$ref": "#/definitions/esri.rest-api.Extent.Extent"
3426
+ },
3427
+ {
3428
+ "$ref": "#/definitions/esri.rest-api.Multipoint.Multipoint"
3429
+ },
3430
+ {
3431
+ "$ref": "#/definitions/esri.rest-api.Polygon.Polygon"
3432
+ },
3433
+ {
3434
+ "$ref": "#/definitions/esri.rest-api.Polyline.Polyline"
3435
+ },
3436
+ {
3437
+ "$ref": "#/definitions/esri.rest-api.Point.Point"
3438
+ },
3439
+ {
3440
+ "$ref": "#/definitions/esri.rest-api.Feature.Feature"
3441
+ },
3442
+ {
3443
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
3444
+ },
3445
+ {
3446
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3447
+ },
3448
+ {
3449
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
3450
+ },
3451
+ {
3452
+ "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
3453
+ },
3454
+ {
3455
+ "$ref": "#/definitions/CreateGraphicsResult"
3456
+ },
3457
+ {
3458
+ "items": {
3459
+ "anyOf": [
3460
+ {
3461
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
3462
+ },
3463
+ {
3464
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
3465
+ }
3466
+ ]
3467
+ },
3468
+ "type": "array"
3469
+ },
3470
+ {
3471
+ "items": {
3472
+ "anyOf": [
3473
+ {
3474
+ "$ref": "#/definitions/esri.Graphic"
3475
+ },
3476
+ {
3477
+ "$ref": "#/definitions/esri.rest-api.Feature.Feature"
3478
+ }
3479
+ ]
3480
+ },
3481
+ "type": "array"
3482
+ },
3483
+ {
3484
+ "items": {
3485
+ "anyOf": [
3486
+ {
3487
+ "$ref": "#/definitions/esri.Geometry"
3488
+ },
3489
+ {
3490
+ "$ref": "#/definitions/esri.rest-api.Extent.Extent"
3491
+ },
3492
+ {
3493
+ "$ref": "#/definitions/esri.rest-api.Multipoint.Multipoint"
3494
+ },
3495
+ {
3496
+ "$ref": "#/definitions/esri.rest-api.Polygon.Polygon"
3497
+ },
3498
+ {
3499
+ "$ref": "#/definitions/esri.rest-api.Polyline.Polyline"
3500
+ },
3501
+ {
3502
+ "$ref": "#/definitions/esri.rest-api.Point.Point"
3503
+ }
3504
+ ]
3505
+ },
3506
+ "type": "array"
3507
+ },
3508
+ {
3509
+ "$ref": "#/definitions/CreateGraphicsArgs"
3510
+ },
3511
+ {
3512
+ "items": {
3513
+ "$ref": "#/definitions/CreateGraphicsArgs"
3514
+ },
3515
+ "type": "array"
3516
+ }
3517
+ ]
3518
+ },
3519
+ "drawing.create-graphics:output": {
3520
+ "$ref": "#/definitions/CreateGraphicsResult"
3521
+ },
3522
+ "drawing.draw": {
3523
+ "description": "Allows the user to draw on the map by capturing geometry, creating a graphic, and persisting the graphic on the map. This is a shortcut for the command chain [\"sketching.capture-geometry\", \"drawing.create-graphics\", \"map.add-markup\"]. Some default geometryEditorSettings are also applied.",
3524
+ "enum": [
3525
+ "drawing.draw"
3526
+ ]
3527
+ },
3528
+ "drawing.draw:input": {
3529
+ "$ref": "#/definitions/CaptureGeometryArgs"
3530
+ },
3352
3531
  "drawing.set-sync": {
3353
3532
  "description": "Sets a value that determines whether drawings will be synced automatically across maps.",
3354
3533
  "enum": [
@@ -12271,6 +12450,44 @@
12271
12450
  "log-viewer.display"
12272
12451
  ]
12273
12452
  },
12453
+ "map.add-markup": {
12454
+ "description": "Adds markup to the map(s). In Web, uses GraphicsLike args. In Mobile, uses AddMarkupArgs or some GraphicsLike args.",
12455
+ "enum": [
12456
+ "map.add-markup"
12457
+ ]
12458
+ },
12459
+ "map.add-markup:input": {
12460
+ "anyOf": [
12461
+ {
12462
+ "$ref": "#/definitions/esri.Graphic"
12463
+ },
12464
+ {
12465
+ "$ref": "#/definitions/esri.FeatureSet"
12466
+ },
12467
+ {
12468
+ "$ref": "#/definitions/esri.rest-api.Feature.Feature"
12469
+ },
12470
+ {
12471
+ "$ref": "#/definitions/CreateGraphicsResult"
12472
+ },
12473
+ {
12474
+ "items": {
12475
+ "anyOf": [
12476
+ {
12477
+ "$ref": "#/definitions/esri.Graphic"
12478
+ },
12479
+ {
12480
+ "$ref": "#/definitions/esri.rest-api.Feature.Feature"
12481
+ }
12482
+ ]
12483
+ },
12484
+ "type": "array"
12485
+ },
12486
+ {
12487
+ "$ref": "#/definitions/AddMarkupArgs"
12488
+ }
12489
+ ]
12490
+ },
12274
12491
  "map.disable-map-click": {
12275
12492
  "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.",
12276
12493
  "enum": [
@@ -13666,6 +13883,22 @@
13666
13883
  ],
13667
13884
  "type": "object"
13668
13885
  },
13886
+ {
13887
+ "additionalProperties": false,
13888
+ "properties": {
13889
+ "arguments": {
13890
+ "$ref": "#/definitions/drawing.draw:input"
13891
+ },
13892
+ "name": {
13893
+ "$ref": "#/definitions/drawing.draw"
13894
+ }
13895
+ },
13896
+ "required": [
13897
+ "name",
13898
+ "arguments"
13899
+ ],
13900
+ "type": "object"
13901
+ },
13669
13902
  {
13670
13903
  "additionalProperties": false,
13671
13904
  "properties": {
@@ -14226,6 +14459,22 @@
14226
14459
  ],
14227
14460
  "type": "object"
14228
14461
  },
14462
+ {
14463
+ "additionalProperties": false,
14464
+ "properties": {
14465
+ "arguments": {
14466
+ "$ref": "#/definitions/map.add-markup:input"
14467
+ },
14468
+ "name": {
14469
+ "$ref": "#/definitions/map.add-markup"
14470
+ }
14471
+ },
14472
+ "required": [
14473
+ "name",
14474
+ "arguments"
14475
+ ],
14476
+ "type": "object"
14477
+ },
14229
14478
  {
14230
14479
  "additionalProperties": false,
14231
14480
  "properties": {
@@ -15357,6 +15606,9 @@
15357
15606
  {
15358
15607
  "$ref": "#/definitions/debug-console.display"
15359
15608
  },
15609
+ {
15610
+ "$ref": "#/definitions/drawing.draw"
15611
+ },
15360
15612
  {
15361
15613
  "$ref": "#/definitions/drawing.set-sync"
15362
15614
  },
@@ -15480,6 +15732,9 @@
15480
15732
  {
15481
15733
  "$ref": "#/definitions/log-viewer.display"
15482
15734
  },
15735
+ {
15736
+ "$ref": "#/definitions/map.add-markup"
15737
+ },
15483
15738
  {
15484
15739
  "$ref": "#/definitions/map.disable-map-click"
15485
15740
  },
@@ -15763,6 +16018,22 @@
15763
16018
  ],
15764
16019
  "type": "object"
15765
16020
  },
16021
+ {
16022
+ "additionalProperties": false,
16023
+ "properties": {
16024
+ "arguments": {
16025
+ "$ref": "#/definitions/drawing.create-graphics:input"
16026
+ },
16027
+ "name": {
16028
+ "$ref": "#/definitions/drawing.create-graphics"
16029
+ }
16030
+ },
16031
+ "required": [
16032
+ "name",
16033
+ "arguments"
16034
+ ],
16035
+ "type": "object"
16036
+ },
15766
16037
  {
15767
16038
  "additionalProperties": false,
15768
16039
  "properties": {
@@ -16367,6 +16638,9 @@
16367
16638
  {
16368
16639
  "$ref": "#/definitions/basemap.get-current"
16369
16640
  },
16641
+ {
16642
+ "$ref": "#/definitions/drawing.create-graphics"
16643
+ },
16370
16644
  {
16371
16645
  "$ref": "#/definitions/file.pick-file"
16372
16646
  },
@@ -928,6 +928,15 @@
928
928
  "app.backgrounded"
929
929
  ]
930
930
  },
931
+ "app.custom-started": {
932
+ "description": "Raised when a custom app is started.",
933
+ "enum": [
934
+ "app.custom-started"
935
+ ]
936
+ },
937
+ "app.custom-started:input": {
938
+ "$ref": "#/definitions/SpecificAppArgs"
939
+ },
931
940
  "app.custom.started": {
932
941
  "description": "Raised when a custom app is started.",
933
942
  "enum": [
@@ -937,6 +946,21 @@
937
946
  "app.custom.started:input": {
938
947
  "$ref": "#/definitions/SpecificAppArgs"
939
948
  },
949
+ "app.favorited": {
950
+ "description": "Raised when an app is favorited.",
951
+ "enum": [
952
+ "app.favorited"
953
+ ]
954
+ },
955
+ "app.favorited:input": {
956
+ "$ref": "GcxAppInfo"
957
+ },
958
+ "app.generic-app-started": {
959
+ "description": "Raised when a generic app is started.",
960
+ "enum": [
961
+ "app.generic-app-started"
962
+ ]
963
+ },
940
964
  "app.generic.apps-listed": {
941
965
  "description": "Raised when apps are listed within the generic app.",
942
966
  "enum": [
@@ -952,12 +976,33 @@
952
976
  "app.generic.started"
953
977
  ]
954
978
  },
979
+ "app.going-to-app-selector": {
980
+ "description": "Raised when returning to the app selector screen from a specific app in Go.",
981
+ "enum": [
982
+ "app.going-to-app-selector"
983
+ ]
984
+ },
955
985
  "app.interrupted": {
956
986
  "description": "Raised when the app is interrupted temporarily (eg. Pull down notifications, control center, or OS level prompt or alert).",
957
987
  "enum": [
958
988
  "app.interrupted"
959
989
  ]
960
990
  },
991
+ "app.refreshed": {
992
+ "description": "Raised when an app has been refreshed.",
993
+ "enum": [
994
+ "app.refreshed"
995
+ ]
996
+ },
997
+ "app.refreshed:input": {
998
+ "$ref": "#/definitions/SpecificAppArgs"
999
+ },
1000
+ "app.refreshing": {
1001
+ "description": "Raised when an app refresh is beginning.",
1002
+ "enum": [
1003
+ "app.refreshing"
1004
+ ]
1005
+ },
961
1006
  "app.specific-app-started": {
962
1007
  "description": "Raised when a specific app is started within the generic app.",
963
1008
  "enum": [
@@ -967,6 +1012,15 @@
967
1012
  "app.specific-app-started:input": {
968
1013
  "$ref": "#/definitions/SpecificAppArgs"
969
1014
  },
1015
+ "app.unfavorited": {
1016
+ "description": "Raised when an app is unfavorited.",
1017
+ "enum": [
1018
+ "app.unfavorited"
1019
+ ]
1020
+ },
1021
+ "app.unfavorited:input": {
1022
+ "$ref": "GcxAppInfo"
1023
+ },
970
1024
  "auth.sign-in-cancelled": {
971
1025
  "description": "Raised when the user cancels a sign-in challenge.",
972
1026
  "enum": [
@@ -9559,21 +9613,42 @@
9559
9613
  {
9560
9614
  "$ref": "#/definitions/app.backgrounded"
9561
9615
  },
9616
+ {
9617
+ "$ref": "#/definitions/app.custom-started"
9618
+ },
9562
9619
  {
9563
9620
  "$ref": "#/definitions/app.custom.started"
9564
9621
  },
9622
+ {
9623
+ "$ref": "#/definitions/app.favorited"
9624
+ },
9625
+ {
9626
+ "$ref": "#/definitions/app.generic-app-started"
9627
+ },
9565
9628
  {
9566
9629
  "$ref": "#/definitions/app.generic.apps-listed"
9567
9630
  },
9568
9631
  {
9569
9632
  "$ref": "#/definitions/app.generic.started"
9570
9633
  },
9634
+ {
9635
+ "$ref": "#/definitions/app.going-to-app-selector"
9636
+ },
9571
9637
  {
9572
9638
  "$ref": "#/definitions/app.interrupted"
9573
9639
  },
9640
+ {
9641
+ "$ref": "#/definitions/app.refreshed"
9642
+ },
9643
+ {
9644
+ "$ref": "#/definitions/app.refreshing"
9645
+ },
9574
9646
  {
9575
9647
  "$ref": "#/definitions/app.specific-app-started"
9576
9648
  },
9649
+ {
9650
+ "$ref": "#/definitions/app.unfavorited"
9651
+ },
9577
9652
  {
9578
9653
  "$ref": "#/definitions/auth.sign-in-cancelled"
9579
9654
  },