@vertigis/viewer-spec 58.2.0 → 58.3.0

package/messaging/registry/ui.d.ts

@@ -239,6 +239,16 @@ export interface VisualStateChangeEvent {
  * A component's visual state. The values will vary based on the component type.
  */
 export type VisualState = string;
+/**
+ * Represents the state of a layout node.
+ */
+export declare enum State {
+    UNLOADED = 0,
+    SUSPENDED = 1,
+    ACTIVATED = 2,
+    DEACTIVATED = 3,
+    FAILED = 4
+}
 /**
  * A position for a display notification.
  */
@@ -428,6 +438,12 @@ export declare class UIOperations extends OperationRegistry {
      * @webOnly
      */
     get getVisualState(): Operation<ComponentId, VisualState | undefined>;
+    /**
+     * Gets the state of a component. Web only.
+     *
+     * @webOnly
+     */
+    get getComponentState(): Operation<ComponentId, State | undefined>;
     /**
      * Prompts the user to enter a value in a popup box. Web only.
      *

package/messaging/registry/ui.js

@@ -1 +1 @@
-import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as i}from"../OperationRegistry.js";export var NotificationCategory;!function(t){t.ERROR="error",t.INFO="info",t.SUCCESS="success",t.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(t){t.AUTO="auto",t.APP="app",t.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(t){t.BOTTOM="bottom",t.LEFT="left",t.RIGHT="right",t.TOP="top"}(Position||(Position={}));export class UICommands extends t{_prefix="ui";get activate(){return this._get("activate")}get activeToggle(){return this._get("active-toggle")}get alert(){return this._get("alert")}get await(){return this._get("await")}get deactivate(){return this._get("deactivate")}get displayBusyState(){return this._get("display-busy-state")}get displayNotification(){return this._get("display-notification")}get pauseNotifications(){return this._get("pause-notifications")}get resumeNotifications(){return this._get("resume-notifications")}get focus(){return this._get("focus")}get hideBusyState(){return this._get("hide-busy-state")}get hideNotification(){return this._get("hide-notification")}get makeAvailable(){return this._get("make-available")}get makeUnavailable(){return this._get("make-unavailable")}get narrate(){return this._get("narrate")}get setDensity(){return this._get("set-density")}get setLocale(){return this._get("set-locale")}get setTheme(){return this._get("set-theme")}get setVisualState(){return this._get("set-visual-state")}}export class UIOperations extends i{_prefix="ui";get confirm(){return this._get("confirm")}get getComponentIds(){return this._get("get-component-ids")}get getLocale(){return this._get("get-locale")}get getTheme(){return this._get("get-theme")}get getThemes(){return this._get("get-themes")}get getVisualState(){return this._get("get-visual-state")}get prompt(){return this._get("prompt")}}export class UIEvents extends e{_prefix="ui";get activated(){return this._get("activated")}get added(){return this._get("added")}get ancestorActivated(){return this._get("ancestor-activated")}get ancestorDeactivated(){return this._get("ancestor-deactivated")}get deactivated(){return this._get("deactivated")}get densityChanged(){return this._get("density-changed")}get localeChanged(){return this._get("locale-changed")}get initializing(){return this._get("initializing")}get initialized(){return this._get("initialized")}get removed(){return this._get("removed")}get reordered(){return this._get("reordered")}get themeChanged(){return this._get("theme-changed")}get visualStateChanged(){return this._get("visual-state-changed")}}
+import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as i}from"../OperationRegistry.js";export var NotificationCategory;!function(t){t.ERROR="error",t.INFO="info",t.SUCCESS="success",t.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(t){t.AUTO="auto",t.APP="app",t.SYSTEM="system"}(NotificationType||(NotificationType={}));export var State;!function(t){t[t.UNLOADED=0]="UNLOADED",t[t.SUSPENDED=1]="SUSPENDED",t[t.ACTIVATED=2]="ACTIVATED",t[t.DEACTIVATED=3]="DEACTIVATED",t[t.FAILED=4]="FAILED"}(State||(State={}));export var Position;!function(t){t.BOTTOM="bottom",t.LEFT="left",t.RIGHT="right",t.TOP="top"}(Position||(Position={}));export class UICommands extends t{_prefix="ui";get activate(){return this._get("activate")}get activeToggle(){return this._get("active-toggle")}get alert(){return this._get("alert")}get await(){return this._get("await")}get deactivate(){return this._get("deactivate")}get displayBusyState(){return this._get("display-busy-state")}get displayNotification(){return this._get("display-notification")}get pauseNotifications(){return this._get("pause-notifications")}get resumeNotifications(){return this._get("resume-notifications")}get focus(){return this._get("focus")}get hideBusyState(){return this._get("hide-busy-state")}get hideNotification(){return this._get("hide-notification")}get makeAvailable(){return this._get("make-available")}get makeUnavailable(){return this._get("make-unavailable")}get narrate(){return this._get("narrate")}get setDensity(){return this._get("set-density")}get setLocale(){return this._get("set-locale")}get setTheme(){return this._get("set-theme")}get setVisualState(){return this._get("set-visual-state")}}export class UIOperations extends i{_prefix="ui";get confirm(){return this._get("confirm")}get getComponentIds(){return this._get("get-component-ids")}get getLocale(){return this._get("get-locale")}get getTheme(){return this._get("get-theme")}get getThemes(){return this._get("get-themes")}get getVisualState(){return this._get("get-visual-state")}get getComponentState(){return this._get("get-component-state")}get prompt(){return this._get("prompt")}}export class UIEvents extends e{_prefix="ui";get activated(){return this._get("activated")}get added(){return this._get("added")}get ancestorActivated(){return this._get("ancestor-activated")}get ancestorDeactivated(){return this._get("ancestor-deactivated")}get deactivated(){return this._get("deactivated")}get densityChanged(){return this._get("density-changed")}get localeChanged(){return this._get("locale-changed")}get initializing(){return this._get("initializing")}get initialized(){return this._get("initialized")}get removed(){return this._get("removed")}get reordered(){return this._get("reordered")}get themeChanged(){return this._get("theme-changed")}get visualStateChanged(){return this._get("visual-state-changed")}}

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

@@ -7058,6 +7058,17 @@
             ],
             "type": "string"
         },
+        "State": {
+            "description": "Represents the state of a layout node.",
+            "enum": [
+                0,
+                1,
+                2,
+                3,
+                4
+            ],
+            "type": "number"
+        },
         "StopGeometryEditArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.stop\" operation.",
@@ -22557,6 +22568,18 @@
         "ui.get-component-ids:output": {
             "type": "string"
         },
+        "ui.get-component-state": {
+            "description": "Gets the state of a component. Web only.",
+            "enum": [
+                "ui.get-component-state"
+            ]
+        },
+        "ui.get-component-state:input": {
+            "type": "string"
+        },
+        "ui.get-component-state:output": {
+            "$ref": "#/definitions/State"
+        },
         "ui.get-locale": {
             "description": "Gets the current locale code for the application. (example: \"en\", \"fr\" or \"de-AT\"). Web only.",
             "enum": [
@@ -27189,6 +27212,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/ui.get-component-state:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/ui.get-component-state"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -27547,6 +27586,9 @@
                 {
                     "$ref": "#/definitions/ui.get-component-ids"
                 },
+                {
+                    "$ref": "#/definitions/ui.get-component-state"
+                },
                 {
                     "$ref": "#/definitions/ui.get-locale"
                 },

package/package.json

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

package/version.js

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