@vertigis/viewer-spec 59.31.0 → 60.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 (44) hide show
  1. package/messaging/DotNetTypes.d.ts +11 -0
  2. package/messaging/registry/Operations.d.ts +0 -7
  3. package/messaging/registry/Operations.js +1 -1
  4. package/messaging/registry/app.d.ts +1 -20
  5. package/messaging/registry/app.js +1 -1
  6. package/messaging/registry/arcade.d.ts +2 -2
  7. package/messaging/registry/auth.d.ts +3 -3
  8. package/messaging/registry/basemap.d.ts +4 -3
  9. package/messaging/registry/bulk-editing.d.ts +2 -7
  10. package/messaging/registry/charts.d.ts +1 -1
  11. package/messaging/registry/display.d.ts +2 -2
  12. package/messaging/registry/drawing.d.ts +2 -2
  13. package/messaging/registry/edit.d.ts +25 -27
  14. package/messaging/registry/file.d.ts +3 -3
  15. package/messaging/registry/geolocation.d.ts +80 -9
  16. package/messaging/registry/highlights.d.ts +0 -19
  17. package/messaging/registry/highlights.js +1 -1
  18. package/messaging/registry/layers.d.ts +1 -1
  19. package/messaging/registry/layout.d.ts +1 -5
  20. package/messaging/registry/licensing.d.ts +2 -2
  21. package/messaging/registry/location-marker.d.ts +1 -2
  22. package/messaging/registry/map.d.ts +5 -5
  23. package/messaging/registry/measurement.d.ts +1 -1
  24. package/messaging/registry/network.d.ts +2 -2
  25. package/messaging/registry/printing.d.ts +10 -10
  26. package/messaging/registry/reports.d.ts +1 -1
  27. package/messaging/registry/results.d.ts +6 -5
  28. package/messaging/registry/sketching.d.ts +9 -96
  29. package/messaging/registry/sketching.js +1 -1
  30. package/messaging/registry/system.d.ts +1 -1
  31. package/messaging/registry/tasks.d.ts +2 -1
  32. package/messaging/registry/tracing.d.ts +1 -1
  33. package/messaging/registry/ui.d.ts +1 -1
  34. package/messaging/schema/common-action.schema.json +23 -98
  35. package/messaging/schema/common-event.schema.json +5 -4
  36. package/messaging/schema/mobile-action.schema.json +29 -121
  37. package/messaging/schema/mobile-event.schema.json +41 -43
  38. package/messaging/schema/web-action.schema.json +56 -392
  39. package/messaging/schema/web-event.schema.json +17 -16
  40. package/package.json +1 -1
  41. package/version.d.ts +1 -1
  42. package/version.js +1 -1
  43. package/messaging/registry/debugConsole.d.ts +0 -26
  44. package/messaging/registry/debugConsole.js +0 -1
@@ -787,7 +787,7 @@
787
787
  },
788
788
  "AddAttachmentArgs": {
789
789
  "additionalProperties": false,
790
- "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
790
+ "description": "Arguments for the \"edit.add-attachment\" command. \"Features\" is the feature(s) the attachment is being added to.",
791
791
  "properties": {
792
792
  "contentType": {
793
793
  "description": "The MIME content type of the attachment.",
@@ -801,11 +801,8 @@
801
801
  "type": "array"
802
802
  },
803
803
  "features": {
804
- "description": "The feature(s) to add the attachment to.",
805
- "items": {
806
- "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
807
- },
808
- "type": "array"
804
+ "$ref": "#/definitions/FeaturesLike",
805
+ "description": "Features to use for the command/operation."
809
806
  },
810
807
  "maps": {
811
808
  "$ref": "MapsLike",
@@ -819,7 +816,6 @@
819
816
  "required": [
820
817
  "contentType",
821
818
  "data",
822
- "features",
823
819
  "maps",
824
820
  "name"
825
821
  ],
@@ -880,46 +876,6 @@
880
876
  },
881
877
  "type": "object"
882
878
  },
883
- "AddNodeOrder": {
884
- "description": "Indicates whether a new point should be added before or after the active point in a sketch.",
885
- "enum": [
886
- "add-after-active",
887
- "add-before-active"
888
- ],
889
- "type": "string"
890
- },
891
- "AddNodeToGeometryArgs": {
892
- "additionalProperties": false,
893
- "description": "Deprecated - Mobile users should rather use \"geometry.add-point\"; Web users should use \"sketching.add-point\" with {@link AddPointArgs} or \"sketching.insert-point\" with {@link InsertPointArgs} instead.",
894
- "properties": {
895
- "geometry": {
896
- "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion",
897
- "description": "The initial geometry to add the point to. Can be null."
898
- },
899
- "geometryType": {
900
- "description": "The type of geometry to create if the initial geometry is null. In VertiGIS Studio Mobile, this value must be 'polygon' or 'polyline'. In VertiGIS Studio Web, this value may also be null if the point being added is intended to be added to the active sketch.",
901
- "type": "string"
902
- },
903
- "maps": {
904
- "$ref": "MapsLike",
905
- "description": "Map(s) to use for the command/operation."
906
- },
907
- "node": {
908
- "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion",
909
- "description": "A point geometry to add to the initial geometry. In VertiGIS Studio Web, this value may be null if the intention is to add a point at the position of the active point of an active sketch."
910
- },
911
- "nodeOrder": {
912
- "$ref": "#/definitions/AddNodeOrder",
913
- "description": "Indicates whether the new point should be added before or after the active point in the sketch. Not supported by VertiGIS Studio Mobile."
914
- }
915
- },
916
- "required": [
917
- "geometry",
918
- "geometryType",
919
- "node"
920
- ],
921
- "type": "object"
922
- },
923
879
  "AddPartArgs": {
924
880
  "additionalProperties": false,
925
881
  "description": "Arguments for the geometry.add-part operation.",
@@ -993,7 +949,7 @@
993
949
  },
994
950
  "initialPosition": {
995
951
  "$ref": "MessageBoxPosition",
996
- "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
952
+ "description": "Where the dialog appears in the app when it is created. Defaults to \"center\" position. Web only."
997
953
  },
998
954
  "isDraggable": {
999
955
  "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
@@ -1131,7 +1087,7 @@
1131
1087
  "type": "number"
1132
1088
  },
1133
1089
  "pluginSettings": {
1134
- "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
1090
+ "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings. Web only."
1135
1091
  },
1136
1092
  "symbol": {
1137
1093
  "anyOf": [
@@ -1279,7 +1235,7 @@
1279
1235
  },
1280
1236
  "initialPosition": {
1281
1237
  "$ref": "MessageBoxPosition",
1282
- "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
1238
+ "description": "Where the dialog appears in the app when it is created. Defaults to \"center\" position. Web only."
1283
1239
  },
1284
1240
  "isDraggable": {
1285
1241
  "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
@@ -1812,7 +1768,7 @@
1812
1768
  "type": "string"
1813
1769
  },
1814
1770
  "pluginSettings": {
1815
- "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
1771
+ "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
1816
1772
  },
1817
1773
  "showNotifications": {
1818
1774
  "description": "Whether to show UI notifications. Defaults to `true`.",
@@ -1892,7 +1848,7 @@
1892
1848
  "type": "string"
1893
1849
  },
1894
1850
  "pluginSettings": {
1895
- "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
1851
+ "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
1896
1852
  },
1897
1853
  "relatedFeatureSource": {
1898
1854
  "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource",
@@ -2123,7 +2079,7 @@
2123
2079
  "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."
2124
2080
  },
2125
2081
  "pluginSettings": {
2126
- "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
2082
+ "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
2127
2083
  },
2128
2084
  "showNotifications": {
2129
2085
  "description": "Whether to show UI notifications. Will default to `true`.",
@@ -3013,7 +2969,7 @@
3013
2969
  },
3014
2970
  "GetViewInsetsArgs": {
3015
2971
  "additionalProperties": false,
3016
- "description": "Result of the \"map.get-view-insets\" operation.",
2972
+ "description": "Result of the \"map.get-view-insets\" operation {@link Thickness}.",
3017
2973
  "properties": {
3018
2974
  "bottom": {
3019
2975
  "description": "The width covering the map from below.",
@@ -3280,7 +3236,7 @@
3280
3236
  "type": "boolean"
3281
3237
  },
3282
3238
  "sources": {
3283
- "description": "The feature sources to identify. Can be used instead of or in addition to \"maps\". Not supported in VertiGIS Studio Mobile (use \"maps\").",
3239
+ "description": "The feature sources to identify. Can be used instead of or in addition to \"maps\". Not supported in VertiGIS Studio Mobile (use \"maps\"). Source will be used in addition to the maps.",
3284
3240
  "items": {
3285
3241
  "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
3286
3242
  },
@@ -3302,7 +3258,7 @@
3302
3258
  "properties": {
3303
3259
  "geometry": {
3304
3260
  "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion",
3305
- "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile."
3261
+ "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by VertiGIS Studio Mobile."
3306
3262
  },
3307
3263
  "maps": {
3308
3264
  "$ref": "MapsLike",
@@ -3441,7 +3397,7 @@
3441
3397
  "additionalProperties": false,
3442
3398
  "properties": {
3443
3399
  "accountId": {
3444
- "description": "The accountId (orgId) that we want to check licensing.",
3400
+ "description": "The accountId (orgId) that we want to check licensing for.",
3445
3401
  "type": "string"
3446
3402
  },
3447
3403
  "applicationName": {
@@ -3449,7 +3405,7 @@
3449
3405
  "type": "string"
3450
3406
  },
3451
3407
  "sku": {
3452
- "description": "Overwrite the SKU for license check.",
3408
+ "description": "Overwrite the default SKU (if any) for license checking.",
3453
3409
  "type": "string"
3454
3410
  }
3455
3411
  },
@@ -3901,7 +3857,7 @@
3901
3857
  "description": "Arguments to pick a file.",
3902
3858
  "properties": {
3903
3859
  "allowedFileTypes": {
3904
- "description": "Allowed types of file used to pick a file. Mobile only.",
3860
+ "description": "Allowed file types used to pick a file. Mobile only.",
3905
3861
  "items": {
3906
3862
  "type": "string"
3907
3863
  },
@@ -4416,7 +4372,7 @@
4416
4372
  "type": "string"
4417
4373
  }
4418
4374
  ],
4419
- "description": "Argument used in case when we have only 1 map in the app or when the first active map should be used. Basemap extension ID or the basemap self. If more than one basemap is specified, only the first one is used."
4375
+ "description": "Argument used in case when we have only 1 map in the app or when the first active map should be used. Basemap extension ID or the basemap itself. If more than one basemap is specified, only the first one is used."
4420
4376
  },
4421
4377
  "SetBasemapArgs": {
4422
4378
  "anyOf": [
@@ -4440,7 +4396,7 @@
4440
4396
  },
4441
4397
  "SetBasemapWithTargetMapArg": {
4442
4398
  "additionalProperties": false,
4443
- "description": "Argument used in case when we have more than 1 map in the app, and we need to pass the target map from outside (eg basemap picker in VertiGIS Studio Web).",
4399
+ "description": "Argument used in case when we have more than 1 map in the app, and we need to pass the target map from outside (e.g. basemap picker in VertiGIS Studio Web).",
4444
4400
  "properties": {
4445
4401
  "basemap": {
4446
4402
  "$ref": "#/definitions/SetBasemapArg",
@@ -4571,7 +4527,7 @@
4571
4527
  "description": "The symbol to use for the outline of the location marker."
4572
4528
  },
4573
4529
  "size": {
4574
- "description": "The size to use for the location marker.",
4530
+ "description": "The size to use for the location marker, in device independent pixels (DIPs).",
4575
4531
  "type": "number"
4576
4532
  },
4577
4533
  "style": {
@@ -5119,6 +5075,7 @@
5119
5075
  },
5120
5076
  "TimeSpan": {
5121
5077
  "additionalProperties": false,
5078
+ "description": "{@link https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-9.0}.",
5122
5079
  "type": "object"
5123
5080
  },
5124
5081
  "TraceCompletedArgs": {
@@ -5392,7 +5349,7 @@
5392
5349
  "type": "array"
5393
5350
  }
5394
5351
  ],
5395
- "description": "The blob(s) that contains the file attachment(s). If multiple attachments are specified, all attachment will be added to the feature(s)."
5352
+ "description": "The blob(s) that contains the file attachment(s). If multiple attachments are specified, all attachments will be added to the feature(s)."
5396
5353
  },
5397
5354
  "features": {
5398
5355
  "$ref": "#/definitions/Features",
@@ -5582,7 +5539,7 @@
5582
5539
  "$ref": "esriRuntimeSdk.Credential"
5583
5540
  },
5584
5541
  "auth.sign-in": {
5585
- "description": "Initiates user sign-in if they aren't already signed in. The argument indicates whether or not the map should be reloaded when the sign-in is complete. This argument is optional and only supported by VertiGIS Studio Mobile.",
5542
+ "description": "Initiates user sign-in if they aren't already signed in. The argument indicates whether or not the map should be reloaded when the sign-in is complete. This argument is optional and only supported by VertiGIS Studio Mobile. Default is true.",
5586
5543
  "enum": [
5587
5544
  "auth.sign-in"
5588
5545
  ]
@@ -5594,7 +5551,7 @@
5594
5551
  ]
5595
5552
  },
5596
5553
  "auth.sign-out": {
5597
- "description": "Signs the user out. The argument indicates whether or not the map should be reloaded when the sign-out is complete. This argument is optional and only supported by VertiGIS Studio Mobile.",
5554
+ "description": "Signs the user out. The argument indicates whether or not the map should be reloaded when the sign-out is complete. This argument is optional and only supported by VertiGIS Studio Mobile. Default is true.",
5598
5555
  "enum": [
5599
5556
  "auth.sign-out"
5600
5557
  ]
@@ -5641,18 +5598,6 @@
5641
5598
  "basemap.set:input": {
5642
5599
  "$ref": "#/definitions/SetBasemapArgs"
5643
5600
  },
5644
- "debug-console.close": {
5645
- "description": "Closes the Debug Console. Deprecated; use log-viewer.close instead. Mobile only.",
5646
- "enum": [
5647
- "debug-console.close"
5648
- ]
5649
- },
5650
- "debug-console.display": {
5651
- "description": "Displays the Debug Console. Deprecated; use log-viewer.display instead. Mobile only.",
5652
- "enum": [
5653
- "debug-console.display"
5654
- ]
5655
- },
5656
5601
  "drawing.create-graphics": {
5657
5602
  "description": "Creates graphics.\n\nIn Web, creates graphics out of GeometryLike or CreateGraphicsArgs, with the current symbols that are set on the DrawManager.\n\nIn 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.",
5658
5603
  "enum": [
@@ -5874,7 +5819,7 @@
5874
5819
  ]
5875
5820
  },
5876
5821
  "edit.clear-gnss-metadata": {
5877
- "description": "Clears a feature's GNSS metadata. This command will clear the well known GNSS attributes, such as \"esrignss_longitude\" and \"esrignss_latitude\".",
5822
+ "description": "Clears a feature's GNSS metadata. This command will clear the well known GNSS attributes, such as \"esrignss_longitude\" and \"esrignss_latitude\". Mobile only.",
5878
5823
  "enum": [
5879
5824
  "edit.clear-gnss-metadata"
5880
5825
  ]
@@ -5933,7 +5878,7 @@
5933
5878
  ]
5934
5879
  },
5935
5880
  "edit.display-add-feature": {
5936
- "description": "Begin an interactive feature editing session with a new feature. `DisplayAddFeatureArgs` is not supported on Mobile.\n\n**Example:** Create and allow the user to edit a new feature with an initial attributes collection. If no geometry is provided in context they will be asked to select one.\n\n_Note:_ $map1.map.extension is the output of a 'Get Map' activity run in Web by Workflow. When the map and/or layer are provided in the context of a command chain these parameters can be omitted.\n\n```\n{\n \"editAttributes\": true,\n \"editGeometry\": true,\n \"featureAttributes\": {\n \"ASSET_ID\": \"WFH001234\"\n },\n \"layers\": \"Victoria_Fire_Hydrants_8780\",\n \"maps\": $map1.map.extension\n}\n```",
5881
+ "description": "Begin an interactive feature editing session with a new feature. `DisplayAddFeatureArgs` is not supported on Mobile.\n\n**Example:** Create and allow the user to edit a new feature with an initial attributes collection. If no geometry is provided in context they will be asked to select one.\n\n_Note:_ \"maps\" argument can be the output of a 'Get Map' activity run in Web by Workflow or coming from a previous operation in the action chain. When the map and/or layer are provided in the context of a command chain these parameters can be omitted.\n\n```\n{\n \"editAttributes\": true,\n \"editGeometry\": true,\n \"featureAttributes\": {\n \"ASSET_ID\": \"WFH001234\"\n },\n \"layers\": \"Victoria_Fire_Hydrants_8780\"\n}\n```",
5937
5882
  "enum": [
5938
5883
  "edit.display-add-feature"
5939
5884
  ]
@@ -5949,7 +5894,7 @@
5949
5894
  ]
5950
5895
  },
5951
5896
  "edit.display-add-related-feature": {
5952
- "description": "Begin an interactive feature editing session for a new related feature. The specified feature will be the original feature that the new related feature will be added to in the relationship.\n\n**Example:** Create and edit a new record on a related table, with the option to add attachments. Make sure the 'COMMENTS' field is included in the editable attributes and make it required.\n\n_Notes:_.\n\n1. The feature used here must come from the running viewer, and cannot be an ad-hoc feature created from a JSON object. For example, you can use the output of `results.get-active-features`, or the feature provided in a command chain context.\n2. `editableExpression` and `requiredExpression` both take an arcade expression, and here the string \"true\" is just a simple arcade expression that always returns true. You can also use a more complex expression, or reference one from your webmap.\n\n```\n{\n \"editAttributes\": true,\n \"editAttachments\": true,\n \"features\": $runOperation1.result,\n \"relationshipId\": \"1\",\n \"fieldElements\": [\n {\n \"fieldName\": \"COMMENTS\",\n \"editableExpression\": \"true\",\n \"requiredExpression\": \"true\"\n }\n ]\n}\n```",
5897
+ "description": "Begin an interactive feature editing session for a new related feature. The specified feature will be the original feature that the new related feature will be added to in the relationship.\n\n**Example:** Create and edit a new record on a related table, with the option to add attachments. Make sure the 'COMMENTS' field is included in the editable attributes and make it required.\n\n_Notes:_.\n\n1. The feature used here must come from the running viewer, and cannot be an ad-hoc feature created from a JSON object. For example, you can use the output of `results.get-active-features`, or the feature provided in a command chain context.\n2. `editableExpression` and `requiredExpression` both take an Arcade expression, and here the string \"true\" is just a simple Arcade expression that always returns true. You can also use a more complex expression, or reference one from your webmap.\n\n```\n{\n \"editAttributes\": true,\n \"editAttachments\": true,\n \"relationshipId\": \"1\",\n \"fieldElements\": [\n {\n \"fieldName\": \"COMMENTS\",\n \"editableExpression\": \"true\",\n \"requiredExpression\": \"true\"\n }\n ]\n}\n```",
5953
5898
  "enum": [
5954
5899
  "edit.display-add-related-feature"
5955
5900
  ]
@@ -6015,7 +5960,7 @@
6015
5960
  ]
6016
5961
  },
6017
5962
  "edit.update-gnss-metadata": {
6018
- "description": "Automatically populates the well known GNSS attributes from the current location data. Examples of well known GNSS attributes are \"esrignss_longitude\" and \"esrignss_latitude\". The input feature argument may be null, in which case a new feature will be created. Returns the input feature, or a new feature if one was created.",
5963
+ "description": "Automatically populates the well known GNSS attributes from the current location data. Examples of well known GNSS attributes are \"esrignss_longitude\" and \"esrignss_latitude\". The input feature argument may be null, in which case a new feature will be created. Returns the input feature, or a new feature if one was created. Mobile only.",
6019
5964
  "enum": [
6020
5965
  "edit.update-gnss-metadata"
6021
5966
  ]
@@ -16853,7 +16798,7 @@
16853
16798
  ]
16854
16799
  },
16855
16800
  "network.are-web-requests-disabled": {
16856
- "description": "Determines if Disconnected Mode is enabled and web requests can be sent by the app.",
16801
+ "description": "Determines if Disconnected Mode is enabled and web requests cannot be sent by the app.",
16857
16802
  "enum": [
16858
16803
  "network.are-web-requests-disabled"
16859
16804
  ]
@@ -17182,13 +17127,13 @@
17182
17127
  ]
17183
17128
  },
17184
17129
  "results.display": {
17185
- "description": "Presents features to the user within any components that can display features, such as a feature list, feature table, or feature details component. The argument is the features to display, or an object specifying both features and the target results component to update (Web only).",
17130
+ "description": "Presents features to the user within any components that can display features, such as a feature list, feature table, or feature details component. The argument is the features to display, or an object specifying both features and the target results component to update (Web only). If features are specified, they will overwrite any incoming features from previous operations up the action chain.",
17186
17131
  "enum": [
17187
17132
  "results.display"
17188
17133
  ]
17189
17134
  },
17190
17135
  "results.display-details": {
17191
- "description": "Presents feature details to the user within the feature-details component. The argument is the feature(s) to display, or an object specifying both features and the target results component to update (Web only).",
17136
+ "description": "Presents feature details to the user within the feature-details component. The argument is the feature(s) to display, or an object specifying both features and the target results component to update (this object, UpdateResultsFeaturesArgs, is Web only).",
17192
17137
  "enum": [
17193
17138
  "results.display-details"
17194
17139
  ]
@@ -17419,18 +17364,6 @@
17419
17364
  "search.set-source:input": {
17420
17365
  "$ref": "#/definitions/SearchSource"
17421
17366
  },
17422
- "sketching.add-node-to-geometry": {
17423
- "description": "Deprecated - Mobile users should rather use \"geometry.add-point\"; Web users should use \"sketching.add-point\" or \"sketching.insert-point\" instead.",
17424
- "enum": [
17425
- "sketching.add-node-to-geometry"
17426
- ]
17427
- },
17428
- "sketching.add-node-to-geometry:input": {
17429
- "$ref": "#/definitions/AddNodeToGeometryArgs"
17430
- },
17431
- "sketching.add-node-to-geometry:output": {
17432
- "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion"
17433
- },
17434
17367
  "sketching.add-point": {
17435
17368
  "description": "Adds a point to polygon, polyline, or multipoint using the selected index as the point to insert after.",
17436
17369
  "enum": [
@@ -19901,12 +19834,6 @@
19901
19834
  {
19902
19835
  "$ref": "#/definitions/basemap.set"
19903
19836
  },
19904
- {
19905
- "$ref": "#/definitions/debug-console.close"
19906
- },
19907
- {
19908
- "$ref": "#/definitions/debug-console.display"
19909
- },
19910
19837
  {
19911
19838
  "$ref": "#/definitions/drawing.draw"
19912
19839
  },
@@ -21011,22 +20938,6 @@
21011
20938
  ],
21012
20939
  "type": "object"
21013
20940
  },
21014
- {
21015
- "additionalProperties": false,
21016
- "properties": {
21017
- "arguments": {
21018
- "$ref": "#/definitions/sketching.add-node-to-geometry:input"
21019
- },
21020
- "name": {
21021
- "$ref": "#/definitions/sketching.add-node-to-geometry"
21022
- }
21023
- },
21024
- "required": [
21025
- "name",
21026
- "arguments"
21027
- ],
21028
- "type": "object"
21029
- },
21030
20941
  {
21031
20942
  "additionalProperties": false,
21032
20943
  "properties": {
@@ -21372,9 +21283,6 @@
21372
21283
  {
21373
21284
  "$ref": "#/definitions/results.upload-data-to-features"
21374
21285
  },
21375
- {
21376
- "$ref": "#/definitions/sketching.add-node-to-geometry"
21377
- },
21378
21286
  {
21379
21287
  "$ref": "#/definitions/sketching.capture-geometry"
21380
21288
  },
@@ -961,21 +961,6 @@
961
961
  ],
962
962
  "description": "Filter mode represents the way elements draw when participating in a filter block."
963
963
  },
964
- "FixQuality": {
965
- "description": "The quality of the GNSS fix.",
966
- "enum": [
967
- "DgpsFix",
968
- "Estimated",
969
- "FloatRtk",
970
- "GpsFix",
971
- "Invalid",
972
- "ManualInput",
973
- "PpsFix",
974
- "Rtk",
975
- "Simulation"
976
- ],
977
- "type": "string"
978
- },
979
964
  "GenericAppsListedArgs": {
980
965
  "additionalProperties": false,
981
966
  "description": "Arguments for the app.generic.apps-listed event. Only available in VertiGIS Studio Mobile.",
@@ -1064,7 +1049,7 @@
1064
1049
  "description": "Arguments for the \"geolocation.status-changed\" event.",
1065
1050
  "properties": {
1066
1051
  "isEnabled": {
1067
- "description": "Indicates whether the geolocation is now enabled.",
1052
+ "description": "Indicates whether the geolocation is enabled.",
1068
1053
  "type": "boolean"
1069
1054
  }
1070
1055
  },
@@ -1098,7 +1083,7 @@
1098
1083
  "description": "Event args for the geolocation.gnss-antenna-height-changed event.",
1099
1084
  "properties": {
1100
1085
  "height": {
1101
- "description": "The antenna height.",
1086
+ "description": "The antenna height. May be either feet or meters depending on user setting.",
1102
1087
  "type": "number"
1103
1088
  }
1104
1089
  },
@@ -1239,7 +1224,7 @@
1239
1224
  },
1240
1225
  "layers": {
1241
1226
  "$ref": "#/definitions/LayersLike",
1242
- "description": "The layer whose visibility was changed. Web only."
1227
+ "description": "The layer(s) whose visibility was changed. Web only."
1243
1228
  }
1244
1229
  },
1245
1230
  "type": "object"
@@ -1497,77 +1482,89 @@
1497
1482
  },
1498
1483
  "NmeaProperties": {
1499
1484
  "additionalProperties": false,
1485
+ "description": "Properties describing a GNSS data point.",
1500
1486
  "properties": {
1501
1487
  "altitude": {
1488
+ "description": "The altitude (z-value).",
1502
1489
  "type": "number"
1503
1490
  },
1504
1491
  "correctionAge": {
1505
- "$ref": "#/definitions/TimeSpan"
1492
+ "$ref": "#/definitions/TimeSpan",
1493
+ "description": "The age of differential GPS data record; TimeSpan.Zero when DGPS is not used."
1506
1494
  },
1507
1495
  "course": {
1496
+ "description": "The course of the device, in degrees.",
1508
1497
  "type": "number"
1509
1498
  },
1510
- "estimatedHorizontalAccuracy": {
1511
- "type": "number"
1512
- },
1513
- "estimatedVerticalAccuracy": {
1514
- "type": "number"
1515
- },
1516
- "fixMethod": {
1517
- "type": "string"
1518
- },
1519
1499
  "fixMode": {
1520
- "$ref": "#/definitions/GnssFixMode"
1521
- },
1522
- "fixQuality": {
1523
- "$ref": "#/definitions/FixQuality"
1500
+ "$ref": "#/definitions/GnssFixMode",
1501
+ "description": "Whether this is a 2D or 3D fix."
1524
1502
  },
1525
1503
  "fixTimeUtc": {
1526
- "$ref": "Date"
1504
+ "$ref": "Date",
1505
+ "description": "A timestamp of when the location was recorded."
1506
+ },
1507
+ "fixType": {
1508
+ "description": "Gets the NMEA type of signal or technique being used by the GPS receiver to determine its location.",
1509
+ "type": "string"
1527
1510
  },
1528
1511
  "heightOfGeoid": {
1512
+ "description": "The geoidal separation, the height difference between ellipsoidal surface and the geoid model's surface in meters.",
1513
+ "type": "number"
1514
+ },
1515
+ "horizontalAccuracy": {
1516
+ "description": "Estimated horizontal accuracy of this location in meters.",
1529
1517
  "type": "number"
1530
1518
  },
1531
1519
  "horizontalDilutionOfPrecision": {
1520
+ "description": "Horizontal Dilution of Precision (measure of accuracy in 2-D position; for example, Latitude and Longitude), 0.5 through 99.9 in percents.",
1532
1521
  "type": "number"
1533
1522
  },
1534
1523
  "latitude": {
1524
+ "description": "The latitude (y-value).",
1535
1525
  "type": "number"
1536
1526
  },
1537
1527
  "longitude": {
1528
+ "description": "The longitude (x-value).",
1538
1529
  "type": "number"
1539
1530
  },
1540
1531
  "magneticVariation": {
1532
+ "description": "The magnetic variation, in degrees.\n\nPositive values (easterly variation) subtract from the true course and negative values (westerly variation) add to the true course.",
1541
1533
  "type": "number"
1542
1534
  },
1543
1535
  "positionDilutionOfPrecision": {
1544
- "type": "number"
1545
- },
1546
- "preciseHorizontalAccuracy": {
1547
- "type": "number"
1548
- },
1549
- "preciseVerticalAccuracy": {
1536
+ "description": "Gets the Position Dilution of Precision (measure of accuracy in 3-d position), 0.5 through 99.9 in percents.",
1550
1537
  "type": "number"
1551
1538
  },
1552
1539
  "satelliteIds": {
1540
+ "description": "The ids of the satellites in view.",
1553
1541
  "items": {
1554
1542
  "type": "number"
1555
1543
  },
1556
1544
  "type": "array"
1557
1545
  },
1558
1546
  "satellitesInUse": {
1547
+ "description": "The number of satellites used in the calculation of the location.",
1559
1548
  "type": "number"
1560
1549
  },
1561
1550
  "satellitesInView": {
1551
+ "description": "The number of satellites in view.",
1562
1552
  "type": "number"
1563
1553
  },
1564
1554
  "speed": {
1555
+ "description": "The velocity of the device, in meters per second.",
1565
1556
  "type": "number"
1566
1557
  },
1567
1558
  "stationId": {
1559
+ "description": "The reference station ID, range from 0000-4095.",
1560
+ "type": "number"
1561
+ },
1562
+ "verticalAccuracy": {
1563
+ "description": "Estimated vertical accuracy of this location in meters.",
1568
1564
  "type": "number"
1569
1565
  },
1570
1566
  "verticalDilutionOfPrecision": {
1567
+ "description": "Vertical Dilution of Precision (measure of accuracy in 1-D position), 0.5 through 99.9 in percents.",
1571
1568
  "type": "number"
1572
1569
  }
1573
1570
  },
@@ -1987,7 +1984,7 @@
1987
1984
  },
1988
1985
  "portalType": {
1989
1986
  "$ref": "#/definitions/PortalType",
1990
- "description": "The type of Portal: AGOL or Enterprise."
1987
+ "description": "The type of Portal: AGOL or ArcGISEnterprise."
1991
1988
  },
1992
1989
  "requestInfo": {
1993
1990
  "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."
@@ -2013,7 +2010,7 @@
2013
2010
  },
2014
2011
  "portalType": {
2015
2012
  "$ref": "#/definitions/PortalType",
2016
- "description": "The type of Portal: AGOL or Enterprise."
2013
+ "description": "The type of Portal: AGOL or ArcGISEnterprise."
2017
2014
  },
2018
2015
  "requestInfo": {
2019
2016
  "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."
@@ -2118,6 +2115,7 @@
2118
2115
  },
2119
2116
  "TimeSpan": {
2120
2117
  "additionalProperties": false,
2118
+ "description": "{@link https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-9.0}.",
2121
2119
  "type": "object"
2122
2120
  },
2123
2121
  "UserWentOnlineEventArgs": {
@@ -2277,7 +2275,7 @@
2277
2275
  ]
2278
2276
  },
2279
2277
  "app.interrupted": {
2280
- "description": "Raised when the app is interrupted temporarily (eg. Pull down notifications, control center, or OS level prompt or alert). Mobile only.",
2278
+ "description": "Raised when the app is interrupted temporarily (e.g. Pull down notifications, control center, or OS level prompt or alert). Mobile only.",
2281
2279
  "enum": [
2282
2280
  "app.interrupted"
2283
2281
  ]
@@ -2451,7 +2449,7 @@
2451
2449
  "$ref": "#/definitions/DeviceOrientationChangedEventArgs"
2452
2450
  },
2453
2451
  "display.overlap-element-translate-started": {
2454
- "description": "Raised when one UI element is being moved overtop of another, such that the element underneath is partially or fully obscured. Mobile only.",
2452
+ "description": "Raised when one UI element is being moved overtop another, such that the element underneath is partially or fully obscured. Mobile only.",
2455
2453
  "enum": [
2456
2454
  "display.overlap-element-translate-started"
2457
2455
  ]