@vertigis/viewer-spec 56.10.0 → 56.12.0

package/app-config/common/BrandingColors.d.ts

@@ -82,6 +82,7 @@ export interface BrandingColors {
     inputBorderDisabled: ColorConfig;
     itemHoverBackground: ColorConfig;
     itemSelectedBackground: ColorConfig;
+    loadingBarBackground: ColorConfig;
     none: ColorConfig;
     panelBorder: ColorConfig;
     primaryAccent: ColorConfig;

package/app-config/web/QueryBuilderModelProperties.d.ts

@@ -1,4 +1,5 @@
 import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ItemRef } from "../common/ItemRef.js";
 import type { ComponentModelProperties } from "./ComponentModelProperties.js";
 /**
  * Properties for a query component.
@@ -13,4 +14,9 @@ export interface QueryBuilderModelProperties extends ComponentModelProperties {
      * instance of `QueryArgs` passed in as context.
      */
     onQuery?: Action;
+    /**
+     * A menu of actions used to help create geometries to use as a custom
+     * spatial filter. (MenuModel).
+     */
+    spatialFilterActions?: ItemRef;
 }

package/messaging/registry/map.d.ts

@@ -177,6 +177,9 @@ export interface MarkupArgs extends HasMaps {
      *
      * "vgs-other-snapping-guides": Additional snapping point visualizations.
      *
+     * "vgs-query": Graphics representing the custom spatial filter for the
+     * query builder tool.
+     *
      * "vgs-self-snaps": Used internally by snapping.
      *
      * "vgs-sketching": Temporary graphics used while drawing geometries.

package/messaging/registry/query-builder.d.ts

@@ -3,7 +3,7 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { GeometryLike, LayersLike, ModelRef } from "../common.js";
+import type { GeometryLike, GraphicsLike, LayersLike, ModelRef } from "../common.js";
 /**
  * A query that can be displayed in the query builder, or executed using the
  * `tasks.query` operation.
@@ -25,9 +25,15 @@ export interface Query {
     where?: string;
     /**
      * If specified, limits the results to ones that intersect the given
-     * geometry.
+     * geometry. If both `geometry` and `graphics` are specified, only
+     * `graphics` will be used.
      */
     geometry?: GeometryLike;
+    /**
+     * Alias of `geometry`, to facilitate command chaining. If both `geometry`
+     * and `graphics` are specified, only `graphics` will be used.
+     */
+    graphics?: GraphicsLike;
 }
 /**
  * Base arguments for commands/operations that target query builder components.

package/messaging/registry/ui.d.ts

@@ -164,18 +164,32 @@ export interface SetVisualStateArgs {
  */
 export interface DisplayBusyStateArgs {
     /**
-     * The title to display.
+     * The ID used to link a busy state to its caller. Web only.
+     */
+    id?: string;
+    /**
+     * The title to display. Mobile only.
      */
     title?: string;
     /**
      * The message to display.
      */
     message?: string;
+    /**
+     * The number of milliseconds to wait before displaying the message. Default
+     * is 3000. Web only.
+     */
+    messageDelayMs?: number;
     /**
      * The minimum duration, in milliseconds, that the busy state will be
-     * displayed. Defaults to 500.
+     * displayed. Defaults to 500. Mobile only.
      */
     minimumDisplayDurationMs?: number;
+    /**
+     * The maximum number of milliseconds the busy state will be displayed. Web
+     * only.
+     */
+    maximumDisplayDurationMs?: number;
 }
 /**
  * A component's ID in the layout.
@@ -283,10 +297,8 @@ export declare class UICommands extends CommandRegistry {
      */
     get deactivate(): Command<ComponentId | Model>;
     /**
-     * Displays a spinner and custom message to the user to indicate that the UI
-     * is busy. Mobile only.
-     *
-     * @mobileOnly
+     * Displays a loading indicator and custom message to the user to indicate
+     * that the UI is busy.
      */
     get displayBusyState(): Command<DisplayBusyStateArgs>;
     /**
@@ -313,11 +325,10 @@ export declare class UICommands extends CommandRegistry {
      */
     get focus(): Command<FocusArgs>;
     /**
-     * Hides the busy state if currently shown. Mobile only.
-     *
-     * @mobileOnly
+     * Hides the busy state if currently shown. In Web, requires the ID of the
+     * caller that was used to show the busy state.
      */
-    get hideBusyState(): Command;
+    get hideBusyState(): Command<string | void>;
     /**
      * Hides a notification previously shown to the user.
      */

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

@@ -709,7 +709,7 @@
             "description": "Arguments for the \"map.add-markup\" command.",
             "properties": {
                 "collection": {
-                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
+                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-query\": Graphics representing the custom spatial filter for the query builder tool. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
                     "type": "string"
                 },
                 "graphics": {
@@ -976,7 +976,7 @@
             "description": "Arguments for the \"map.clear-markup\" command.",
             "properties": {
                 "collection": {
-                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
+                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-query\": Graphics representing the custom spatial filter for the query builder tool. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
                     "type": "string"
                 },
                 "graphics": {
@@ -1298,6 +1298,37 @@
             },
             "type": "object"
         },
+        "DisplayBusyStateArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"ui.display-busy-state\" args.",
+            "properties": {
+                "id": {
+                    "description": "The ID used to link a busy state to its caller. Web only.",
+                    "type": "string"
+                },
+                "maximumDisplayDurationMs": {
+                    "description": "The maximum number of milliseconds the busy state will be displayed. Web only.",
+                    "type": "number"
+                },
+                "message": {
+                    "description": "The message to display.",
+                    "type": "string"
+                },
+                "messageDelayMs": {
+                    "description": "The number of milliseconds to wait before displaying the message. Default is 3000. Web only.",
+                    "type": "number"
+                },
+                "minimumDisplayDurationMs": {
+                    "description": "The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500. Mobile only.",
+                    "type": "number"
+                },
+                "title": {
+                    "description": "The title to display. Mobile only.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "DisplayNotificationArgs": {
             "additionalProperties": false,
             "description": "The arguments for the `ui.display-notification` command.",
@@ -14029,6 +14060,15 @@
                 }
             ]
         },
+        "ui.display-busy-state": {
+            "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
+            "enum": [
+                "ui.display-busy-state"
+            ]
+        },
+        "ui.display-busy-state:input": {
+            "$ref": "#/definitions/DisplayBusyStateArgs"
+        },
         "ui.display-notification": {
             "description": "Shows a notification to the user.",
             "enum": [
@@ -14038,6 +14078,18 @@
         "ui.display-notification:input": {
             "$ref": "#/definitions/DisplayNotificationArgs"
         },
+        "ui.hide-busy-state": {
+            "description": "Hides the busy state if currently shown. In Web, requires the ID of the caller that was used to show the busy state.",
+            "enum": [
+                "ui.hide-busy-state"
+            ]
+        },
+        "ui.hide-busy-state:input": {
+            "type": [
+                "string",
+                "null"
+            ]
+        },
         "ui.hide-notification": {
             "description": "Hides a notification previously shown to the user.",
             "enum": [
@@ -14862,6 +14914,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/ui.display-busy-state:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/ui.display-busy-state"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -14878,6 +14946,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/ui.hide-busy-state:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/ui.hide-busy-state"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15082,9 +15166,15 @@
                 {
                     "$ref": "#/definitions/ui.deactivate"
                 },
+                {
+                    "$ref": "#/definitions/ui.display-busy-state"
+                },
                 {
                     "$ref": "#/definitions/ui.display-notification"
                 },
+                {
+                    "$ref": "#/definitions/ui.hide-busy-state"
+                },
                 {
                     "$ref": "#/definitions/ui.hide-notification"
                 },

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

@@ -693,7 +693,7 @@
             "description": "Arguments for the \"map.add-markup\" command.",
             "properties": {
                 "collection": {
-                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
+                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-query\": Graphics representing the custom spatial filter for the query builder tool. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
                     "type": "string"
                 },
                 "graphics": {
@@ -1096,7 +1096,7 @@
             "description": "Arguments for the \"map.clear-markup\" command.",
             "properties": {
                 "collection": {
-                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
+                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-query\": Graphics representing the custom spatial filter for the query builder tool. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
                     "type": "string"
                 },
                 "graphics": {
@@ -1506,16 +1506,28 @@
             "additionalProperties": false,
             "description": "Arguments for the \"ui.display-busy-state\" args.",
             "properties": {
+                "id": {
+                    "description": "The ID used to link a busy state to its caller. Web only.",
+                    "type": "string"
+                },
+                "maximumDisplayDurationMs": {
+                    "description": "The maximum number of milliseconds the busy state will be displayed. Web only.",
+                    "type": "number"
+                },
                 "message": {
                     "description": "The message to display.",
                     "type": "string"
                 },
+                "messageDelayMs": {
+                    "description": "The number of milliseconds to wait before displaying the message. Default is 3000. Web only.",
+                    "type": "number"
+                },
                 "minimumDisplayDurationMs": {
-                    "description": "The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500.",
+                    "description": "The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500. Mobile only.",
                     "type": "number"
                 },
                 "title": {
-                    "description": "The title to display.",
+                    "description": "The title to display. Mobile only.",
                     "type": "string"
                 }
             },
@@ -16184,7 +16196,7 @@
             ]
         },
         "ui.display-busy-state": {
-            "description": "Displays a spinner and custom message to the user to indicate that the UI is busy. Mobile only.",
+            "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
             "enum": [
                 "ui.display-busy-state"
             ]
@@ -16202,11 +16214,17 @@
             "$ref": "#/definitions/DisplayNotificationArgs"
         },
         "ui.hide-busy-state": {
-            "description": "Hides the busy state if currently shown. Mobile only.",
+            "description": "Hides the busy state if currently shown. In Web, requires the ID of the caller that was used to show the busy state.",
             "enum": [
                 "ui.hide-busy-state"
             ]
         },
+        "ui.hide-busy-state:input": {
+            "type": [
+                "string",
+                "null"
+            ]
+        },
         "ui.hide-notification": {
             "description": "Hides a notification previously shown to the user.",
             "enum": [
@@ -18051,6 +18069,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/ui.hide-busy-state:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/ui.hide-busy-state"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {

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

@@ -952,7 +952,7 @@
             "description": "Arguments for the \"map.add-markup\" command.",
             "properties": {
                 "collection": {
-                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
+                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-query\": Graphics representing the custom spatial filter for the query builder tool. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
                     "type": "string"
                 },
                 "graphics": {
@@ -1426,7 +1426,7 @@
             "description": "Arguments for the \"map.clear-markup\" command.",
             "properties": {
                 "collection": {
-                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
+                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-query\": Graphics representing the custom spatial filter for the query builder tool. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
                     "type": "string"
                 },
                 "graphics": {
@@ -1995,6 +1995,37 @@
             },
             "type": "object"
         },
+        "DisplayBusyStateArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"ui.display-busy-state\" args.",
+            "properties": {
+                "id": {
+                    "description": "The ID used to link a busy state to its caller. Web only.",
+                    "type": "string"
+                },
+                "maximumDisplayDurationMs": {
+                    "description": "The maximum number of milliseconds the busy state will be displayed. Web only.",
+                    "type": "number"
+                },
+                "message": {
+                    "description": "The message to display.",
+                    "type": "string"
+                },
+                "messageDelayMs": {
+                    "description": "The number of milliseconds to wait before displaying the message. Default is 3000. Web only.",
+                    "type": "number"
+                },
+                "minimumDisplayDurationMs": {
+                    "description": "The minimum duration, in milliseconds, that the busy state will be displayed. Defaults to 500. Mobile only.",
+                    "type": "number"
+                },
+                "title": {
+                    "description": "The title to display. Mobile only.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "DisplayNotificationArgs": {
             "additionalProperties": false,
             "description": "The arguments for the `ui.display-notification` command.",
@@ -3789,7 +3820,7 @@
             "description": "Arguments for the \"map.get-markup\" operation.",
             "properties": {
                 "collection": {
-                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
+                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-query\": Graphics representing the custom spatial filter for the query builder tool. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
                     "type": "string"
                 },
                 "geometry": {
@@ -4500,7 +4531,7 @@
             "description": "Base arguments for markup commands and operations.",
             "properties": {
                 "collection": {
-                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
+                    "description": "The named collection of markup to operate on. If not specified the default markup collection will be used. Some markup collection names are used internally by Web: \"default\": The default markup layer. \"vgs-active-snapping-guides\": The active snap point when snapping. \"vgs-buffer\": Buffer graphics from out of the box buffer tools. \"vgs-context-marker\": Right click context marker on map. \"vgs-dirty-indicator\": Invalid geometry indicators used when editing. \"vgs-editing-control\": Edit frame and vertices while editing geometries. \"vgs-location-accuracy\": Location accuracy circle when geolocating. \"vgs-location-marker-*\": Location markers have this prefix followed by the marker id. \"vgs-map-notes\": Map Notes. \"vgs-measurement-labels\": Labels on measured graphics. \"vgs-other-snapping-guides\": Additional snapping point visualizations. \"vgs-query\": Graphics representing the custom spatial filter for the query builder tool. \"vgs-self-snaps\": Used internally by snapping. \"vgs-sketching\": Temporary graphics used while drawing geometries. \"vgs-snapping-radius\": Snapping radius when snapping is active. \"vgs-transient-measurement-labels\": Measurement labels used while drawing. Web only.",
                     "type": "string"
                 },
                 "maps": {
@@ -5085,7 +5116,11 @@
             "properties": {
                 "geometry": {
                     "$ref": "#/definitions/GeometryLike",
-                    "description": "If specified, limits the results to ones that intersect the given geometry."
+                    "description": "If specified, limits the results to ones that intersect the given geometry. If both `geometry` and `graphics` are specified, only `graphics` will be used."
+                },
+                "graphics": {
+                    "$ref": "#/definitions/GraphicsLike",
+                    "description": "Alias of `geometry`, to facilitate command chaining. If both `geometry` and `graphics` are specified, only `graphics` will be used."
                 },
                 "layers": {
                     "$ref": "#/definitions/LayersLike",
@@ -5972,7 +6007,11 @@
             "properties": {
                 "geometry": {
                     "$ref": "#/definitions/GeometryLike",
-                    "description": "If specified, limits the results to ones that intersect the given geometry."
+                    "description": "If specified, limits the results to ones that intersect the given geometry. If both `geometry` and `graphics` are specified, only `graphics` will be used."
+                },
+                "graphics": {
+                    "$ref": "#/definitions/GraphicsLike",
+                    "description": "Alias of `geometry`, to facilitate command chaining. If both `geometry` and `graphics` are specified, only `graphics` will be used."
                 },
                 "layers": {
                     "$ref": "#/definitions/LayersLike",
@@ -21585,6 +21624,15 @@
                 }
             ]
         },
+        "ui.display-busy-state": {
+            "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",
+            "enum": [
+                "ui.display-busy-state"
+            ]
+        },
+        "ui.display-busy-state:input": {
+            "$ref": "#/definitions/DisplayBusyStateArgs"
+        },
         "ui.display-notification": {
             "description": "Shows a notification to the user.",
             "enum": [
@@ -21657,6 +21705,18 @@
         "ui.get-visual-state:output": {
             "type": "string"
         },
+        "ui.hide-busy-state": {
+            "description": "Hides the busy state if currently shown. In Web, requires the ID of the caller that was used to show the busy state.",
+            "enum": [
+                "ui.hide-busy-state"
+            ]
+        },
+        "ui.hide-busy-state:input": {
+            "type": [
+                "string",
+                "null"
+            ]
+        },
         "ui.hide-notification": {
             "description": "Hides a notification previously shown to the user.",
             "enum": [
@@ -24129,6 +24189,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/ui.display-busy-state:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/ui.display-busy-state"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -24161,6 +24237,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/ui.hide-busy-state:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/ui.hide-busy-state"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -24785,12 +24877,18 @@
                 {
                     "$ref": "#/definitions/ui.deactivate"
                 },
+                {
+                    "$ref": "#/definitions/ui.display-busy-state"
+                },
                 {
                     "$ref": "#/definitions/ui.display-notification"
                 },
                 {
                     "$ref": "#/definitions/ui.focus"
                 },
+                {
+                    "$ref": "#/definitions/ui.hide-busy-state"
+                },
                 {
                     "$ref": "#/definitions/ui.hide-notification"
                 },

package/package.json

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

package/version.js

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