@vertigis/viewer-spec 56.11.0 → 56.12.0

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/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": {

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": {

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": {
@@ -3820,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": {
@@ -4531,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": {
@@ -5116,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",
@@ -6003,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",

package/package.json

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