@vertigis/viewer-spec 50.1.0 → 50.2.0

package/messaging/registry/geolocation.d.ts

@@ -1,4 +1,6 @@
+import type Geometry from "@arcgis/core/geometry/Geometry";
 import type Point from "@arcgis/core/geometry/Point";
+import type { SpatialReference } from "@vertigis/arcgis-extensions/portal/SpatialReference";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { TimeSpan } from "../DotNetTypes.js";
@@ -7,6 +9,7 @@ import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
 import type { HasMaps, Maps } from "../common.js";
+import type { CoordinateTransformation } from "./map.js";
 /**
  * Arguments for the "geolocation.accuracy-changed" event.
  */
@@ -144,6 +147,27 @@ declare enum GnssDeviceType {
     USB = "usb",
     EMULATOR = "emulator"
 }
+/**
+ * Arguments for getting a list of geographic transformations.
+ */
+export interface GetTransformationArgs {
+    /**
+     * The input spatial reference to transform. For example, the spatial
+     * reference of a GNSS receiver. If unspecified, defaults to WGS84.
+     */
+    inputSpatialReference?: SpatialReference;
+    /**
+     * Gets or sets the desired output spatial reference of the transformations.
+     * For example, the spatial reference of the map. If unspecified, the
+     * spatial reference of the first available map will be used.
+     */
+    outputSpatialReference?: SpatialReference;
+    /**
+     * Gets or sets the area of interest. If provided, this will be used to
+     * order the list of valid transformations in order of best-fit.
+     */
+    area?: Geometry;
+}
 /**
  * Event args for the geolocation.gnss-lock-status-changed event.
  */
@@ -299,6 +323,13 @@ export declare class GeolocationOperations extends OperationRegistry {
      * not to perform this during startup.
      */
     get getPosition(): Operation<void, Point>;
+    /**
+     * Returns a list of valid coordinate transformations for given input and
+     * output spatial references.
+     *
+     * @mobileOnly
+     */
+    get getCoordinateTransformations(): Operation<GetTransformationArgs, CoordinateTransformation[]>;
 }
 export declare class GeolocationEvents extends EventRegistry {
     /**

package/messaging/registry/geolocation.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var GeolocateState;var GnssDeviceType;!function(e){e.DISABLED="Disabled",e.ENABLED="Enabled",e.RECENTERING="Recentering",e.RECENTERING_AND_REORIENTING="RecenteringAndReorienting"}(GeolocateState||(GeolocateState={})),function(e){e.INTEGRATED="integrated",e.BLUETOOTH="bluetooth",e.USB="usb",e.EMULATOR="emulator"}(GnssDeviceType||(GnssDeviceType={}));export var FixQuality;!function(e){e.INVALID="Invalid",e.GPS_FIX="GpsFix",e.DGPS_FIX="DgpsFix",e.PPS_FIX="PpsFix",e.RTK="Rtk",e.FLOAT_RTK="FloatRtk",e.ESTIMATED="Estimated",e.MANUAL_INPUT="ManualInput",e.SIMULATION="Simulation"}(FixQuality||(FixQuality={}));export var GpgsaFixMode;!function(e){e.NOT_AVAILABLE="NotAvailable",e.FIX_2D="Fix2D",e.FIX_3D="Fix3D"}(GpgsaFixMode||(GpgsaFixMode={}));export var GnssLockStatus;!function(e){e[e.Good=0]="Good",e[e.UncorrectedPosition=1]="UncorrectedPosition",e[e.EstimatedAccuracy=2]="EstimatedAccuracy",e[e.LostConnection=4]="LostConnection",e[e.NoLocation=16]="NoLocation",e[e.Integrated=32]="Integrated"}(GnssLockStatus||(GnssLockStatus={}));export class GeolocationCommands extends CommandRegistry{get autoRecenter(){return this._messages.command("geolocation.auto-recenter")}get autoRecenterAndReorient(){return this._messages.command("geolocation.auto-recenter-and-reorient")}get displayLocation(){return this._messages.command("geolocation.display-location")}get turnOffGeolocation(){return this._messages.command("geolocation.turn-off-geolocation")}get displayDeviceSettings(){return this._messages.command("geolocation.display-device-settings")}get displayDeviceMetadata(){return this._messages.command("geolocation.display-device-metadata")}get displayDeviceSelection(){return this._messages.command("geolocation.display-device-selection")}}export class GeolocationOperations extends OperationRegistry{get changeSource(){return this._messages.operation("geolocation.change-source")}get getActiveSource(){return this._messages.operation("geolocation.get-active-source")}get getAllSources(){return this._messages.operation("geolocation.get-all-sources")}get getCurrentState(){return this._messages.operation("geolocation.get-current-state")}get getLocationPermissionsEnabled(){return this._messages.operation("geolocation.get-location-permissions-enabled")}get getPosition(){return this._messages.operation("geolocation.get-position")}}export class GeolocationEvents extends EventRegistry{get accuracyChanged(){return this._messages.event("geolocation.accuracy-changed")}get metadataChanged(){return this._messages.event("geolocation.metadata-changed")}get autoRecenterStarted(){return this._messages.event("geolocation.auto-recenter-started")}get autoRecenterAndReorientStarted(){return this._messages.event("geolocation.auto-recenter-and-reorient-started")}get autoRecenterStopped(){return this._messages.event("geolocation.auto-recenter-stopped")}get autoRecenterAndReorientStopped(){return this._messages.event("geolocation.auto-recenter-and-reorient-stopped")}get gnssDeviceDetectionStarted(){return this._messages.event("geolocation.gnss-device-detection-started")}get gnssDeviceDetectionStopped(){return this._messages.event("geolocation.gnss-device-detection-stopped")}get gnssLockStatusChanged(){return this._messages.event("geolocation.gnss-lock-status-changed")}get headingChanged(){return this._messages.event("geolocation.heading-changed")}get positionAcquired(){return this._messages.event("geolocation.position-acquired")}get positionChanged(){return this._messages.event("geolocation.position-changed")}get positionLost(){return this._messages.event("geolocation.position-lost")}get sourceChanged(){return this._messages.event("geolocation.source-changed")}get statusChanged(){return this._messages.event("geolocation.status-changed")}get displayLocationStarted(){return this._messages.event("geolocation.display-location-started")}get displayLocationStopped(){return this._messages.event("geolocation.display-location-stopped")}get transformationChanged(){return this._messages.event("geolocation.gnss-transformation-changed")}get antennaHeightChanged(){return this._messages.event("geolocation.gnss-antenna-height-changed")}get locationDisplayModeChanged(){return this._messages.event("geolocation.display-mode-changed")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var GeolocateState;var GnssDeviceType;!function(e){e.DISABLED="Disabled",e.ENABLED="Enabled",e.RECENTERING="Recentering",e.RECENTERING_AND_REORIENTING="RecenteringAndReorienting"}(GeolocateState||(GeolocateState={})),function(e){e.INTEGRATED="integrated",e.BLUETOOTH="bluetooth",e.USB="usb",e.EMULATOR="emulator"}(GnssDeviceType||(GnssDeviceType={}));export var FixQuality;!function(e){e.INVALID="Invalid",e.GPS_FIX="GpsFix",e.DGPS_FIX="DgpsFix",e.PPS_FIX="PpsFix",e.RTK="Rtk",e.FLOAT_RTK="FloatRtk",e.ESTIMATED="Estimated",e.MANUAL_INPUT="ManualInput",e.SIMULATION="Simulation"}(FixQuality||(FixQuality={}));export var GpgsaFixMode;!function(e){e.NOT_AVAILABLE="NotAvailable",e.FIX_2D="Fix2D",e.FIX_3D="Fix3D"}(GpgsaFixMode||(GpgsaFixMode={}));export var GnssLockStatus;!function(e){e[e.Good=0]="Good",e[e.UncorrectedPosition=1]="UncorrectedPosition",e[e.EstimatedAccuracy=2]="EstimatedAccuracy",e[e.LostConnection=4]="LostConnection",e[e.NoLocation=16]="NoLocation",e[e.Integrated=32]="Integrated"}(GnssLockStatus||(GnssLockStatus={}));export class GeolocationCommands extends CommandRegistry{get autoRecenter(){return this._messages.command("geolocation.auto-recenter")}get autoRecenterAndReorient(){return this._messages.command("geolocation.auto-recenter-and-reorient")}get displayLocation(){return this._messages.command("geolocation.display-location")}get turnOffGeolocation(){return this._messages.command("geolocation.turn-off-geolocation")}get displayDeviceSettings(){return this._messages.command("geolocation.display-device-settings")}get displayDeviceMetadata(){return this._messages.command("geolocation.display-device-metadata")}get displayDeviceSelection(){return this._messages.command("geolocation.display-device-selection")}}export class GeolocationOperations extends OperationRegistry{get changeSource(){return this._messages.operation("geolocation.change-source")}get getActiveSource(){return this._messages.operation("geolocation.get-active-source")}get getAllSources(){return this._messages.operation("geolocation.get-all-sources")}get getCurrentState(){return this._messages.operation("geolocation.get-current-state")}get getLocationPermissionsEnabled(){return this._messages.operation("geolocation.get-location-permissions-enabled")}get getPosition(){return this._messages.operation("geolocation.get-position")}get getCoordinateTransformations(){return this._messages.operation("geolocation.get-coordinate-transformations")}}export class GeolocationEvents extends EventRegistry{get accuracyChanged(){return this._messages.event("geolocation.accuracy-changed")}get metadataChanged(){return this._messages.event("geolocation.metadata-changed")}get autoRecenterStarted(){return this._messages.event("geolocation.auto-recenter-started")}get autoRecenterAndReorientStarted(){return this._messages.event("geolocation.auto-recenter-and-reorient-started")}get autoRecenterStopped(){return this._messages.event("geolocation.auto-recenter-stopped")}get autoRecenterAndReorientStopped(){return this._messages.event("geolocation.auto-recenter-and-reorient-stopped")}get gnssDeviceDetectionStarted(){return this._messages.event("geolocation.gnss-device-detection-started")}get gnssDeviceDetectionStopped(){return this._messages.event("geolocation.gnss-device-detection-stopped")}get gnssLockStatusChanged(){return this._messages.event("geolocation.gnss-lock-status-changed")}get headingChanged(){return this._messages.event("geolocation.heading-changed")}get positionAcquired(){return this._messages.event("geolocation.position-acquired")}get positionChanged(){return this._messages.event("geolocation.position-changed")}get positionLost(){return this._messages.event("geolocation.position-lost")}get sourceChanged(){return this._messages.event("geolocation.source-changed")}get statusChanged(){return this._messages.event("geolocation.status-changed")}get displayLocationStarted(){return this._messages.event("geolocation.display-location-started")}get displayLocationStopped(){return this._messages.event("geolocation.display-location-stopped")}get transformationChanged(){return this._messages.event("geolocation.gnss-transformation-changed")}get antennaHeightChanged(){return this._messages.event("geolocation.gnss-antenna-height-changed")}get locationDisplayModeChanged(){return this._messages.event("geolocation.display-mode-changed")}}

package/messaging/schema/mobile-action.schema.json

@@ -1842,6 +1842,25 @@
             ],
             "type": "object"
         },
+        "GetTransformationArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for getting a list of geographic transformations.",
+            "properties": {
+                "area": {
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "Gets or sets the area of interest. If provided, this will be used to order the list of valid transformations in order of best-fit."
+                },
+                "inputSpatialReference": {
+                    "$ref": "#/definitions/esri.rest-api.SpatialReference.SpatialReference",
+                    "description": "The input spatial reference to transform. For example, the spatial reference of a GNSS receiver. If unspecified, defaults to WGS84."
+                },
+                "outputSpatialReference": {
+                    "$ref": "#/definitions/esri.rest-api.SpatialReference.SpatialReference",
+                    "description": "Gets or sets the desired output spatial reference of the transformations. For example, the spatial reference of the map. If unspecified, the spatial reference of the first available map will be used."
+                }
+            },
+            "type": "object"
+        },
         "GetViewInsetsArgs": {
             "additionalProperties": false,
             "description": "Result of the \"map.get-view-insets\" operation.",
@@ -12864,6 +12883,21 @@
             },
             "type": "array"
         },
+        "geolocation.get-coordinate-transformations": {
+            "description": "Returns a list of valid coordinate transformations for given input and output spatial references.",
+            "enum": [
+                "geolocation.get-coordinate-transformations"
+            ]
+        },
+        "geolocation.get-coordinate-transformations:input": {
+            "$ref": "#/definitions/GetTransformationArgs"
+        },
+        "geolocation.get-coordinate-transformations:output": {
+            "items": {
+                "$ref": "#/definitions/CoordinateTransformation"
+            },
+            "type": "array"
+        },
         "geolocation.get-current-state": {
             "description": "Gets the current geolocate state.",
             "enum": [
@@ -16948,6 +16982,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geolocation.get-coordinate-transformations:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geolocation.get-coordinate-transformations"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -17529,6 +17579,9 @@
                 {
                     "$ref": "#/definitions/geolocation.get-all-sources"
                 },
+                {
+                    "$ref": "#/definitions/geolocation.get-coordinate-transformations"
+                },
                 {
                     "$ref": "#/definitions/geolocation.get-current-state"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "50.1.0",
+  "version": "50.2.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export declare const version = "50.1.0";
+export declare const version = "50.2.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export const version = "50.1.0";
+export const version = "50.2.0";