@vertigis/viewer-spec 60.5.1 → 60.6.0

package/messaging/registry/settings.d.ts

@@ -7,12 +7,30 @@ export declare class SettingsEvents extends EventRegistry {
      *
      * @mobileOnly
      */
-    get updated(): Event;
+    get updated(): Event<SettingsInfo>;
+    /**
+     * Raised when application settings have been loaded, e.g. on app launch.
+     * Mobile only.
+     *
+     * @mobileOnly
+     */
+    get loaded(): Event<SettingsInfo>;
+    /**
+     * Raised when application settings have been unloaded, e.g. when returning
+     * to the app selector in Go.
+     *
+     * @mobileOnly
+     */
+    get unloaded(): Event;
 }
 /**
  * The current settings.
  */
 export interface SettingsInfo {
+    /**
+     * The configured measurement system to use within the app.
+     */
+    configuredMeasurementSystem: ConfiguredMeasurementSystem;
     /**
      * Indicates if layer visibilities are remembered and restored upon app
      * startup.
@@ -36,3 +54,8 @@ export interface SettingsInfo {
  * The approximate size / resolution that photos should be resized to.
  */
 export type PhotoResizeOption = "Original" | "Large" | "Medium" | "Small";
+/**
+ * The measurement system units configured for an app. Default uses the device's
+ * default units.
+ */
+export type ConfiguredMeasurementSystem = "Default" | "Metric" | "USCustomary";

package/messaging/registry/settings.js

@@ -1 +1 @@
-import{EventRegistry as t}from"../EventRegistry.js";export class SettingsEvents extends t{_prefix="settings";get updated(){return this._get("updated")}}
+import{EventRegistry as e}from"../EventRegistry.js";export class SettingsEvents extends e{_prefix="settings";get updated(){return this._get("updated")}get loaded(){return this._get("loaded")}get unloaded(){return this._get("unloaded")}}

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

@@ -716,6 +716,15 @@
             ],
             "type": "object"
         },
+        "ConfiguredMeasurementSystem": {
+            "description": "The measurement system units configured for an app. Default uses the device's default units.",
+            "enum": [
+                "Default",
+                "Metric",
+                "USCustomary"
+            ],
+            "type": "string"
+        },
         "DataSourceJson": {
             "anyOf": [
                 {
@@ -1644,6 +1653,16 @@
             ],
             "description": "An operational layer in a web map/scene."
         },
+        "PhotoResizeOption": {
+            "description": "The approximate size / resolution that photos should be resized to.",
+            "enum": [
+                "Large",
+                "Medium",
+                "Original",
+                "Small"
+            ],
+            "type": "string"
+        },
         "PointCloudFilterJson": {
             "anyOf": [
                 {
@@ -1946,6 +1965,40 @@
             ],
             "type": "object"
         },
+        "SettingsInfo": {
+            "additionalProperties": false,
+            "description": "The current settings.",
+            "properties": {
+                "activeTheme": {
+                    "description": "The user selected theme id.",
+                    "type": "string"
+                },
+                "configuredMeasurementSystem": {
+                    "$ref": "#/definitions/ConfiguredMeasurementSystem",
+                    "description": "The configured measurement system to use within the app."
+                },
+                "photoResize": {
+                    "$ref": "#/definitions/PhotoResizeOption",
+                    "description": "The size that photos will be resized to when adding as a feature attachment."
+                },
+                "rememberLayerVisibilities": {
+                    "description": "Indicates if layer visibilities are remembered and restored upon app startup.",
+                    "type": "boolean"
+                },
+                "rememberMapExtent": {
+                    "description": "Indicates if the map extent is remembered and restored upon app startup.",
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "activeTheme",
+                "configuredMeasurementSystem",
+                "photoResize",
+                "rememberLayerVisibilities",
+                "rememberMapExtent"
+            ],
+            "type": "object"
+        },
         "ShortcutArgs": {
             "additionalProperties": false,
             "description": "The arguments for keyboard shortcut events.",
@@ -12644,12 +12697,30 @@
         "search.started:input": {
             "$ref": "#/definitions/SearchArgs"
         },
+        "settings.loaded": {
+            "description": "Raised when application settings have been loaded, e.g. on app launch. Mobile only.",
+            "enum": [
+                "settings.loaded"
+            ]
+        },
+        "settings.loaded:input": {
+            "$ref": "#/definitions/SettingsInfo"
+        },
+        "settings.unloaded": {
+            "description": "Raised when application settings have been unloaded, e.g. when returning to the app selector in Go.",
+            "enum": [
+                "settings.unloaded"
+            ]
+        },
         "settings.updated": {
             "description": "Raised when application settings have been updated. Mobile only.",
             "enum": [
                 "settings.updated"
             ]
         },
+        "settings.updated:input": {
+            "$ref": "#/definitions/SettingsInfo"
+        },
         "shortcuts.shortcut-added": {
             "description": "Raised when a shortcut was added. Mobile only.",
             "enum": [
@@ -13036,6 +13107,12 @@
                 {
                     "$ref": "#/definitions/search.started"
                 },
+                {
+                    "$ref": "#/definitions/settings.loaded"
+                },
+                {
+                    "$ref": "#/definitions/settings.unloaded"
+                },
                 {
                     "$ref": "#/definitions/settings.updated"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "60.5.1",
+  "version": "60.6.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 = "60.5.1";
+export declare const version = "60.6.0";

package/version.js

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