@vertigis/viewer-spec 50.2.0 → 50.3.0

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

@@ -0,0 +1,12 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { FeatureListProperties } from "./FeatureListProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface ResultsServiceModelProperties extends ComponentModelProperties {
+    /**
+     * The name results list stored in the service. This property is only
+     * serialized into saved projects.
+     */
+    results?: Record<string, FeatureListProperties>;
+}

package/app-config/web/ResultsServiceModelProperties.js

@@ -0,0 +1 @@
+export{};

package/layout/schema/layout-common.xsd

@@ -698,7 +698,17 @@
         </annotation>
         <complexType>
             <complexContent>
-                <extension base="tns:Component" />
+                <extension base="tns:Component">
+                    <attribute name="showStarControls" type="boolean" default="false">
+                        <annotation>
+                            <documentation xml:lang="en">
+                                Whether or not the starred feature icons and
+                                functionality should be included. Defaults to
+                                false. Web only.
+                            </documentation>
+                        </annotation>
+                    </attribute>
+                </extension>
             </complexContent>
         </complexType>
     </element>
@@ -858,7 +868,17 @@
         </annotation>
         <complexType>
             <complexContent>
-                <extension base="tns:Component" />
+                <extension base="tns:Component">
+                    <attribute name="showStarControls" type="boolean" default="false">
+                        <annotation>
+                            <documentation xml:lang="en">
+                                Whether or not the starred feature icons and
+                                functionality should be included. Defaults to
+                                false. Web only
+                            </documentation>
+                        </annotation>
+                    </attribute>
+                </extension>
             </complexContent>
         </complexType>
     </element>

package/layout/schema/layout-web.xsd

@@ -44,7 +44,17 @@
         </annotation>
         <complexType>
             <complexContent>
-                <extension base="base:Component" />
+                <extension base="base:Component">
+                    <attribute name="showStarControls" type="boolean" default="false">
+                        <annotation>
+                            <documentation xml:lang="en">
+                                Whether or not the starred feature icons and
+                                functionality should be included. Defaults to
+                                false.
+                            </documentation>
+                        </annotation>
+                    </attribute>
+                </extension>
             </complexContent>
         </complexType>
     </element>
@@ -197,7 +207,17 @@
         </annotation>
         <complexType>
             <complexContent>
-                <extension base="base:Component" />
+                <extension base="base:Component">
+                    <attribute name="showStarControls" type="boolean" default="false">
+                        <annotation>
+                            <documentation xml:lang="en">
+                                Whether or not the starred feature icons and
+                                functionality should be included. Defaults to
+                                false.
+                            </documentation>
+                        </annotation>
+                    </attribute>
+                </extension>
             </complexContent>
         </complexType>
     </element>

package/messaging/registry/results.d.ts

@@ -18,16 +18,36 @@ import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
 import type { Blob, Features, FeaturesLike, GraphicsLike, HasFeatures, MapsLike, ModelRef } from "../common.js";
 import type { VisualElement } from "../mobile.js";
+/**
+ * Well known Results Set Ids.
+ */
+export declare enum KnownResultSetIds {
+    STARRED = "vgs-starred"
+}
+/**
+ * Arguments for various commands that target a result set of features.
+ */
+export interface TargetsResultsSetArgs {
+    /**
+     * If specified the results will be updated in the named results set only.
+     * Results sets with the prefix 'vgs' are reserved for system use and should
+     * not be used unless you are intentionally targeting a well known results
+     * set such as the 'vgs-starred' results.
+     *
+     * @webOnly
+     */
+    resultsSetId?: KnownResultSetIds | string;
+}
 /**
  * Arguments for various commands that affect a result component's features.
  */
-export interface UpdateResultsFeaturesArgs extends HasFeatures {
+export interface UpdateResultsFeaturesArgs extends TargetsResultsSetArgs, HasFeatures {
     /**
      * The result component to update, referenced by results model or its ID.
      *
      * @webOnly
      */
-    results: ModelRef;
+    results?: ModelRef;
 }
 /**
  * Arguments for the "results.convert-to-csv" operation.
@@ -295,6 +315,13 @@ export interface FeatureDetailsEvent {
     feature: Feature;
 }
 export declare class ResultsCommands extends CommandRegistry {
+    /**
+     * Activates the current set of results component(s), which is set via
+     * results.set-display-components.
+     *
+     * @webOnly
+     */
+    get activateDisplayComponents(): Command<void>;
     /**
      * Presents features to the user within any components that can display
      * features, such as a feature list, feature table, or feature details
@@ -352,7 +379,7 @@ export declare class ResultsCommands extends CommandRegistry {
      * a component model or model ID is given, then only the specified component
      * is cleared (Web only).
      */
-    get clear(): Command<ModelRef | void>;
+    get clear(): Command<ModelRef | TargetsResultsSetArgs | void>;
     /**
      * Clears the feature details so that no feature data is shown.
      *
@@ -393,6 +420,12 @@ export declare class ResultsCommands extends CommandRegistry {
     get setListCardSize(): Command<CardSize | SetListCardSizeArgs>;
 }
 export declare class ResultsEvents extends EventRegistry {
+    /**
+     * Raised when results are added or removed to a named results set.
+     *
+     * @webOnly
+     */
+    get changed(): Event<TargetsResultsSetArgs>;
     /**
      * Raised when results are displayed.
      *
@@ -419,6 +452,12 @@ export declare class ResultsEvents extends EventRegistry {
     get relatedDetailsShown(): Event<FeatureDetailsEvent>;
 }
 export declare class ResultsOperations extends OperationRegistry {
+    /**
+     * Check if features are contained in the specified results.
+     *
+     * @webOnly
+     */
+    get contains(): Operation<TargetsResultsSetArgs & HasFeatures, boolean[]>;
     /**
      * Converts the provided Feature(s) to a CSV file grouped by feature source.
      * If there are multiple sources the CSV(s) will be bundled in a zip file.
@@ -479,7 +518,7 @@ export declare class ResultsOperations extends OperationRegistry {
      *
      * @webOnly
      */
-    get getFeatures(): Operation<ModelRef | void, Features>;
+    get getFeatures(): Operation<ModelRef | TargetsResultsSetArgs | void, Features>;
     /**
      * Filters down a set of results using an SQL 'where' clause and/or an
      * intersecting geometry.

package/messaging/registry/results.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class ResultsCommands extends CommandRegistry{get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends EventRegistry{get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends OperationRegistry{get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var KnownResultSetIds;!function(e){e.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends CommandRegistry{get activateDisplayComponents(){return this._messages.command("results.activate-display-components")}get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends EventRegistry{get changed(){return this._messages.event("results.changed")}get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends OperationRegistry{get contains(){return this._messages.operation("results.contains")}get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}

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

@@ -2364,6 +2364,17 @@
             },
             "type": "object"
         },
+        "TargetsResultsSetArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for various commands that target a result set of features.",
+            "properties": {
+                "resultsSetId": {
+                    "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "TrackCustomEventArgs": {
             "additionalProperties": false,
             "description": "Arguments for the 'studio-analytics.track-custom-event' command.",
@@ -2447,11 +2458,12 @@
                 "results": {
                     "$ref": "#/definitions/ModelRef",
                     "description": "The result component to update, referenced by results model or its ID."
+                },
+                "resultsSetId": {
+                    "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
+                    "type": "string"
                 }
             },
-            "required": [
-                "results"
-            ],
             "type": "object"
         },
         "WebAddAttachmentArgs": {
@@ -12135,6 +12147,9 @@
                 {
                     "$ref": "#/definitions/Model"
                 },
+                {
+                    "$ref": "#/definitions/TargetsResultsSetArgs"
+                },
                 {
                     "type": [
                         "string",

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

@@ -3257,6 +3257,17 @@
             },
             "type": "object"
         },
+        "TargetsResultsSetArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for various commands that target a result set of features.",
+            "properties": {
+                "resultsSetId": {
+                    "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "TrackCustomEventArgs": {
             "additionalProperties": false,
             "description": "Arguments for the 'studio-analytics.track-custom-event' command.",
@@ -3340,11 +3351,12 @@
                 "results": {
                     "$ref": "#/definitions/ModelRef",
                     "description": "The result component to update, referenced by results model or its ID."
+                },
+                "resultsSetId": {
+                    "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
+                    "type": "string"
                 }
             },
-            "required": [
-                "results"
-            ],
             "type": "object"
         },
         "WebAddAttachmentArgs": {
@@ -13941,6 +13953,9 @@
                 {
                     "$ref": "#/definitions/Model"
                 },
+                {
+                    "$ref": "#/definitions/TargetsResultsSetArgs"
+                },
                 {
                     "type": [
                         "string",

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

@@ -4979,6 +4979,17 @@
             },
             "type": "object"
         },
+        "TargetsResultsSetArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for various commands that target a result set of features.",
+            "properties": {
+                "resultsSetId": {
+                    "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "TimeExtent": {
             "additionalProperties": false,
             "description": "A time extent for a filter effect.",
@@ -5377,11 +5388,12 @@
                 "results": {
                     "$ref": "#/definitions/ModelRef",
                     "description": "The result component to update, referenced by results model or its ID."
+                },
+                "resultsSetId": {
+                    "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
+                    "type": "string"
                 }
             },
-            "required": [
-                "results"
-            ],
             "type": "object"
         },
         "UpdateSessionArgs": {
@@ -17349,6 +17361,12 @@
         "reports.run:input": {
             "$ref": "#/definitions/RunReportArgs"
         },
+        "results.activate-display-components": {
+            "description": "Activates the current set of results component(s), which is set via results.set-display-components.",
+            "enum": [
+                "results.activate-display-components"
+            ]
+        },
         "results.add": {
             "description": "Adds features to a currently shown set of features.",
             "enum": [
@@ -17369,6 +17387,9 @@
                 {
                     "$ref": "#/definitions/Model"
                 },
+                {
+                    "$ref": "#/definitions/TargetsResultsSetArgs"
+                },
                 {
                     "type": [
                         "string",
@@ -17377,6 +17398,27 @@
                 }
             ]
         },
+        "results.contains": {
+            "description": "Check if features are contained in the specified results.",
+            "enum": [
+                "results.contains"
+            ]
+        },
+        "results.contains:input": {
+            "additionalProperties": false,
+            "properties": {
+                "resultsSetId": {
+                    "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
+                    "type": "string"
+                }
+            }
+        },
+        "results.contains:output": {
+            "items": {
+                "type": "boolean"
+            },
+            "type": "array"
+        },
         "results.convert-to-csv": {
             "description": "Converts the provided Feature(s) to a CSV file grouped by feature source. If there are multiple sources the CSV(s) will be bundled in a zip file.",
             "enum": [
@@ -17830,6 +17872,9 @@
                 {
                     "$ref": "#/definitions/Model"
                 },
+                {
+                    "$ref": "#/definitions/TargetsResultsSetArgs"
+                },
                 {
                     "type": [
                         "string",
@@ -21140,6 +21185,9 @@
                 {
                     "$ref": "#/definitions/reports.run"
                 },
+                {
+                    "$ref": "#/definitions/results.activate-display-components"
+                },
                 {
                     "$ref": "#/definitions/results.add"
                 },
@@ -21717,6 +21765,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/results.contains:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/results.contains"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -22308,6 +22372,9 @@
                 {
                     "$ref": "#/definitions/measurement.get-length-units"
                 },
+                {
+                    "$ref": "#/definitions/results.contains"
+                },
                 {
                     "$ref": "#/definitions/results.convert-to-csv"
                 },

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

@@ -1081,6 +1081,17 @@
             ],
             "type": "object"
         },
+        "TargetsResultsSetArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for various commands that target a result set of features.",
+            "properties": {
+                "resultsSetId": {
+                    "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "TimeSpan": {
             "additionalProperties": false,
             "type": "object"
@@ -10050,6 +10061,15 @@
         "reports.report-started:input": {
             "$ref": "#/definitions/ReportStartedEventArgs"
         },
+        "results.changed": {
+            "description": "Raised when results are added or removed to a named results set.",
+            "enum": [
+                "results.changed"
+            ]
+        },
+        "results.changed:input": {
+            "$ref": "#/definitions/TargetsResultsSetArgs"
+        },
         "ui.activated": {
             "description": "Raised when a component is activated. The argument is the component ID.",
             "enum": [
@@ -10270,6 +10290,9 @@
                 {
                     "$ref": "#/definitions/reports.report-started"
                 },
+                {
+                    "$ref": "#/definitions/results.changed"
+                },
                 {
                     "$ref": "#/definitions/ui.activated"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "50.2.0",
+  "version": "50.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 Geocortex Viewer Specification.
  */
-export declare const version = "50.2.0";
+export declare const version = "50.3.0";

package/version.js

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