@vertigis/viewer-spec 48.3.0 → 48.4.0

package/messaging/registry/panel.d.ts

@@ -2,6 +2,7 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
+import type { Model } from "../common.js";
 /**
  * Arguments for the "panel.anchor-host-panel" command.
  */
@@ -80,6 +81,20 @@ export declare class PanelCommands extends CommandRegistry {
      * @mobileOnly
      */
     get snapHostPanel(): Command<SnapHostPanelArgs>;
+    /**
+     * Closes the popout window for a panel and restores the original
+     * layout.
+     *
+     * @webOnly
+     */
+    get popIn(): Command<Model["id"] | Model>;
+    /**
+     * Removes a panel from the main layout and opens it in a new popout
+     * window.
+     *
+     * @webOnly
+     */
+    get popOut(): Command<Model["id"] | Model>;
 }
 export declare class PanelEvents extends EventRegistry {
     /**

package/messaging/registry/panel.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export var SnapPosition;!function(e){e.HIDDEN="hidden",e.MIDDLE="middle",e.TOP="top"}(SnapPosition||(SnapPosition={}));export class PanelCommands extends CommandRegistry{get openHostPanel(){return this._messages.command("panel.open-host-panel")}get closeHostPanel(){return this._messages.command("panel.close-host-panel")}get anchorHostPanel(){return this._messages.command("panel.anchor-host-panel")}get snapHostPanel(){return this._messages.command("panel.snap-host-panel")}}export class PanelEvents extends EventRegistry{get hostPanelComponentChanged(){return this._messages.event("panel.host-panel-component-changed")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export var SnapPosition;!function(e){e.HIDDEN="hidden",e.MIDDLE="middle",e.TOP="top"}(SnapPosition||(SnapPosition={}));export class PanelCommands extends CommandRegistry{get openHostPanel(){return this._messages.command("panel.open-host-panel")}get closeHostPanel(){return this._messages.command("panel.close-host-panel")}get anchorHostPanel(){return this._messages.command("panel.anchor-host-panel")}get snapHostPanel(){return this._messages.command("panel.snap-host-panel")}get popIn(){return this._messages.command("panel.pop-in")}get popOut(){return this._messages.command("panel.pop-out")}}export class PanelEvents extends EventRegistry{get hostPanelComponentChanged(){return this._messages.event("panel.host-panel-component-changed")}}

package/messaging/registry/ui.d.ts

@@ -187,6 +187,23 @@ export interface FocusArgs {
      */
     timeout?: number;
 }
+/**
+ * Payload for a VisualStateChangeEvent.
+ */
+export interface VisualStateChangeEvent {
+    /**
+     * The ID of the component whose visual state has changed.
+     */
+    component: ComponentId;
+    /**
+     * The visual state of the component before the change.
+     */
+    previous: VisualState;
+    /**
+     * The new visual state of the component.
+     */
+    current: VisualState;
+}
 /**
  * A component's visual state. The values will vary based on the component type.
  */
@@ -414,4 +431,10 @@ export declare class UIEvents extends EventRegistry {
      * @mobileOnly
      */
     get themeChanged(): Event;
+    /**
+     * Raised when a component's visual state is changed.
+     *
+     * @webOnly
+     */
+    get visualStateChanged(): Event<VisualStateChangeEvent>;
 }

package/messaging/registry/ui.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends CommandRegistry{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends OperationRegistry{get confirm(){return this._messages.operation("ui.confirm")}get prompt(){return this._messages.operation("ui.prompt")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}}export class UIEvents extends EventRegistry{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends CommandRegistry{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends OperationRegistry{get confirm(){return this._messages.operation("ui.confirm")}get prompt(){return this._messages.operation("ui.prompt")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}}export class UIEvents extends EventRegistry{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}

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

@@ -16279,6 +16279,38 @@
             "items": {},
             "type": "array"
         },
+        "panel.pop-in": {
+            "description": "Closes the popout window for a panel and restores the original layout.",
+            "enum": [
+                "panel.pop-in"
+            ]
+        },
+        "panel.pop-in:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
+        "panel.pop-out": {
+            "description": "Removes a panel from the main layout and opens it in a new popout window.",
+            "enum": [
+                "panel.pop-out"
+            ]
+        },
+        "panel.pop-out:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
         "printing.run": {
             "description": "Run a print job with a given map and template.",
             "enum": [
@@ -18994,6 +19026,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/panel.pop-in:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/panel.pop-in"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/panel.pop-out:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/panel.pop-out"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -19919,6 +19983,12 @@
                 {
                     "$ref": "#/definitions/messaging.mix-in-args"
                 },
+                {
+                    "$ref": "#/definitions/panel.pop-in"
+                },
+                {
+                    "$ref": "#/definitions/panel.pop-out"
+                },
                 {
                     "$ref": "#/definitions/printing.run"
                 },

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

@@ -373,6 +373,10 @@
             ],
             "type": "string"
         },
+        "ComponentId": {
+            "description": "A component's ID in the layout.",
+            "type": "string"
+        },
         "CreateGraphicsResult": {
             "additionalProperties": false,
             "description": "Result of the \"drawing.create-graphics\" and \"measurement.create-graphics\" operations.",
@@ -1025,6 +1029,34 @@
             },
             "type": "object"
         },
+        "VisualState": {
+            "description": "A component's visual state. The values will vary based on the component type.",
+            "type": "string"
+        },
+        "VisualStateChangeEvent": {
+            "additionalProperties": false,
+            "description": "Payload for a VisualStateChangeEvent.",
+            "properties": {
+                "component": {
+                    "$ref": "#/definitions/ComponentId",
+                    "description": "The ID of the component whose visual state has changed."
+                },
+                "current": {
+                    "$ref": "#/definitions/VisualState",
+                    "description": "The new visual state of the component."
+                },
+                "previous": {
+                    "$ref": "#/definitions/VisualState",
+                    "description": "The visual state of the component before the change."
+                }
+            },
+            "required": [
+                "component",
+                "current",
+                "previous"
+            ],
+            "type": "object"
+        },
         "WorkflowErrorEventArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"workflow.workflow-error\" event.",
@@ -9480,6 +9512,15 @@
         "ui.reordered:input": {
             "type": "string"
         },
+        "ui.visual-state-changed": {
+            "description": "Raised when a component's visual state is changed.",
+            "enum": [
+                "ui.visual-state-changed"
+            ]
+        },
+        "ui.visual-state-changed:input": {
+            "$ref": "#/definitions/VisualStateChangeEvent"
+        },
         "viewer-spec.Event": {
             "anyOf": [
                 {
@@ -9620,6 +9661,9 @@
                 {
                     "$ref": "#/definitions/ui.reordered"
                 },
+                {
+                    "$ref": "#/definitions/ui.visual-state-changed"
+                },
                 {
                     "$ref": "#/definitions/viewer.layout-changed"
                 },

package/package.json

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

package/version.js

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