@vertigis/viewer-spec 51.7.0 → 51.8.0

package/messaging/registry/geolocation.d.ts

@@ -1,6 +1,9 @@
+import type Color from "@arcgis/core/Color";
 import type Geometry from "@arcgis/core/geometry/Geometry";
 import type Point from "@arcgis/core/geometry/Point";
+import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol.js";
 import type { SpatialReference } from "@vertigis/arcgis-extensions/portal/SpatialReference";
+import type { Color as ColorJson } from "@vertigis/arcgis-extensions/portal/Symbol";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { TimeSpan } from "../DotNetTypes.js";
@@ -143,6 +146,34 @@ export interface GnssDeviceConnectionInfo {
      */
     settings: GnssDeviceSettings;
 }
+/**
+ * Arguments for the geolocation.set-location-symbol command.
+ */
+export interface SetLocationSymbolArgs {
+    /**
+     * The color to use for the location marker's fill and the accuracy circle's
+     * outline.
+     */
+    color?: Color | ColorJson | string;
+    /**
+     * The symbol to use for the outline of the location marker.
+     */
+    outline?: SimpleLineSymbol;
+    /**
+     * The size to use for the location marker.
+     */
+    size?: number;
+    /**
+     * The style to use for the location marker. Valid values are: circle,
+     * cross, diamond, square, triangle and X.
+     */
+    style?: string;
+    /**
+     * If true, all other properties will be ignored and the location symbol
+     * will be reset to the default symbol.
+     */
+    default?: boolean;
+}
 declare enum GnssDeviceType {
     INTEGRATED = "integrated",
     BLUETOOTH = "bluetooth",
@@ -295,6 +326,12 @@ export declare class GeolocationCommands extends CommandRegistry {
      * @mobileOnly
      */
     get applyDatumTransformation(): Command<CoordinateTransformation | string | number | number[]>;
+    /**
+     * Modifies the location display symbol.
+     *
+     * @mobileOnly
+     */
+    get setLocationSymbol(): Command<SetLocationSymbolArgs>;
 }
 export declare class GeolocationOperations extends OperationRegistry {
     /**

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")}get applyDatumTransformation(){return this._messages.command("geolocation.apply-datum-transformation")}}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")}}
+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")}get applyDatumTransformation(){return this._messages.command("geolocation.apply-datum-transformation")}get setLocationSymbol(){return this._messages.command("geolocation.set-location-symbol")}}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

@@ -3213,6 +3213,44 @@
             ],
             "type": "object"
         },
+        "SetLocationSymbolArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the geolocation.set-location-symbol command.",
+            "properties": {
+                "color": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/esri.Color"
+                        },
+                        {
+                            "$ref": "#/definitions/esri.rest-api.Symbol.Color",
+                            "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/}."
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "The color to use for the location marker's fill and the accuracy circle's outline."
+                },
+                "default": {
+                    "description": "If true, all other properties will be ignored and the location symbol will be reset to the default symbol.",
+                    "type": "boolean"
+                },
+                "outline": {
+                    "$ref": "#/definitions/esri.SimpleLineSymbol",
+                    "description": "The symbol to use for the outline of the location marker."
+                },
+                "size": {
+                    "description": "The size to use for the location marker.",
+                    "type": "number"
+                },
+                "style": {
+                    "description": "The style to use for the location marker. Valid values are: circle, cross, diamond, square, triangle and X.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "SetSnappingConfigurationArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.set-snapping-configuration\" command.",
@@ -13398,6 +13436,15 @@
         "geolocation.get-position:output": {
             "$ref": "#/definitions/esri.Point"
         },
+        "geolocation.set-location-symbol": {
+            "description": "Modifies the location display symbol.",
+            "enum": [
+                "geolocation.set-location-symbol"
+            ]
+        },
+        "geolocation.set-location-symbol:input": {
+            "$ref": "#/definitions/SetLocationSymbolArgs"
+        },
         "geolocation.turn-off-geolocation": {
             "description": "Turns off geolocation.",
             "enum": [
@@ -15471,6 +15518,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geolocation.set-location-symbol:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geolocation.set-location-symbol"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -17023,6 +17086,9 @@
                 {
                     "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
                 },
+                {
+                    "$ref": "#/definitions/geolocation.set-location-symbol"
+                },
                 {
                     "$ref": "#/definitions/geolocation.turn-off-geolocation"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "51.7.0",
+  "version": "51.8.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 VertiGIS Studio Viewer Specification.
  */
-export declare const version = "51.7.0";
+export declare const version = "51.8.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "51.7.0";
+export const version = "51.8.0";