@vertigis/viewer-spec 56.21.0 → 56.22.0

package/messaging/registry/results.d.ts

@@ -344,6 +344,23 @@ export interface SetDisplayComponentArgs {
      */
     results?: ModelRef;
 }
+/**
+ * Arguments for the "results.set-active-feature" command.
+ */
+export interface SetActiveFeatureArgs {
+    /**
+     * The feature to set as active in the results component, if it exists. If
+     * multiple features are specified, only the first will be set as active.
+     */
+    features: Features;
+    /**
+     * The result component to update, referenced by results model or its ID.
+     * Web only.
+     *
+     * @webOnly
+     */
+    results?: ModelRef;
+}
 /**
  * Event args for attachment events.
  */
@@ -390,6 +407,16 @@ export declare class ResultsCommands extends CommandRegistry {
      * only).
      */
     get display(): Command<Features | UpdateResultsFeaturesArgs>;
+    /**
+     * Sets the active feature for a particular results component specified by
+     * the `results` arg. Or, if the `results` arg is not defined, sets the
+     * active feature for all results components. Note that each results
+     * component can only have one active feature at a time, but the active
+     * feature can differ between different results components. Web only.
+     *
+     * @webOnly
+     */
+    get setActiveFeature(): Command<SetActiveFeatureArgs>;
     /**
      * Sets the selector, using CSS selector syntax, which queries for results
      * components in the app layout XML, such as the Results List or Results
@@ -584,6 +611,16 @@ export declare class ResultsOperations extends OperationRegistry {
      * @webOnly
      */
     get fromFiles(): Operation<FromConverterArgs | File[], Features>;
+    /**
+     * Returns the current active feature from a specific results component if
+     * model ID or model is specified, otherwise returns all active features
+     * from all results components. Note that each results component can only
+     * have one active feature at a time, but the active feature can differ
+     * between different results components. Web only.
+     *
+     * @webOnly
+     */
+    get getActiveFeatures(): Operation<ModelRef | void, Features | undefined>;
     /**
      * Convert the specified csv, xlsx or shapefile files to args that can be
      * used to create Features. Web only.

package/messaging/registry/results.js

@@ -1 +1 @@
-import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export var KnownResultSetIds;!function(t){t.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends t{constructor(){super(...arguments),this._prefix="results"}get activateDisplayComponents(){return this._get("activate-display-components")}get activateGroup(){return this._get("activate-group")}get display(){return this._get("display")}get setDisplayComponents(){return this._get("set-display-components")}get displayDetails(){return this._get("display-details")}get displaySummary(){return this._get("display-summary")}get displayNewDetails(){return this._get("display-new-details")}get add(){return this._get("add")}get intersect(){return this._get("intersect")}get remove(){return this._get("remove")}get replace(){return this._get("replace")}get clear(){return this._get("clear")}get clearDetails(){return this._get("clear-details")}get hideDetails(){return this._get("hide-details")}get openAttachment(){return this._get("open-attachment")}get refresh(){return this._get("refresh")}get setListViewMode(){return this._get("set-list-view-mode")}get setListCardSize(){return this._get("set-list-card-size")}}export class ResultsEvents extends e{constructor(){super(...arguments),this._prefix="results"}get changed(){return this._get("changed")}get displayed(){return this._get("displayed")}get attachmentOpened(){return this._get("attachment-opened")}get detailsShown(){return this._get("details-shown")}get relatedDetailsShown(){return this._get("related-details-shown")}}export class ResultsOperations extends r{constructor(){super(...arguments),this._prefix="results"}get configureUploadData(){return this._get("configure-upload-data")}get contains(){return this._get("contains")}get convertToCsv(){return this._get("convert-to-csv")}get convertToXlsx(){return this._get("convert-to-xlsx")}get convertToShapefile(){return this._get("convert-to-shapefile")}get convertToLayers(){return this._get("convert-to-layers")}get fromCsv(){return this._get("from-csv")}get fromFiles(){return this._get("from-files")}get uploadDataFromFiles(){return this._get("upload-data-from-files")}get uploadDataToFeatures(){return this._get("upload-data-to-features")}get fromShapefile(){return this._get("from-shapefile")}get fromXlsx(){return this._get("from-xlsx")}get fromGraphics(){return this._get("from-graphics")}get toGraphics(){return this._get("to-graphics")}get getFeatures(){return this._get("get-features")}get filter(){return this._get("filter")}}
+import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export var KnownResultSetIds;!function(t){t.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends t{constructor(){super(...arguments),this._prefix="results"}get activateDisplayComponents(){return this._get("activate-display-components")}get activateGroup(){return this._get("activate-group")}get display(){return this._get("display")}get setActiveFeature(){return this._get("set-active-feature")}get setDisplayComponents(){return this._get("set-display-components")}get displayDetails(){return this._get("display-details")}get displaySummary(){return this._get("display-summary")}get displayNewDetails(){return this._get("display-new-details")}get add(){return this._get("add")}get intersect(){return this._get("intersect")}get remove(){return this._get("remove")}get replace(){return this._get("replace")}get clear(){return this._get("clear")}get clearDetails(){return this._get("clear-details")}get hideDetails(){return this._get("hide-details")}get openAttachment(){return this._get("open-attachment")}get refresh(){return this._get("refresh")}get setListViewMode(){return this._get("set-list-view-mode")}get setListCardSize(){return this._get("set-list-card-size")}}export class ResultsEvents extends e{constructor(){super(...arguments),this._prefix="results"}get changed(){return this._get("changed")}get displayed(){return this._get("displayed")}get attachmentOpened(){return this._get("attachment-opened")}get detailsShown(){return this._get("details-shown")}get relatedDetailsShown(){return this._get("related-details-shown")}}export class ResultsOperations extends r{constructor(){super(...arguments),this._prefix="results"}get configureUploadData(){return this._get("configure-upload-data")}get contains(){return this._get("contains")}get convertToCsv(){return this._get("convert-to-csv")}get convertToXlsx(){return this._get("convert-to-xlsx")}get convertToShapefile(){return this._get("convert-to-shapefile")}get convertToLayers(){return this._get("convert-to-layers")}get fromCsv(){return this._get("from-csv")}get fromFiles(){return this._get("from-files")}get getActiveFeatures(){return this._get("get-active-features")}get uploadDataFromFiles(){return this._get("upload-data-from-files")}get uploadDataToFeatures(){return this._get("upload-data-to-features")}get fromShapefile(){return this._get("from-shapefile")}get fromXlsx(){return this._get("from-xlsx")}get fromGraphics(){return this._get("from-graphics")}get toGraphics(){return this._get("to-graphics")}get getFeatures(){return this._get("get-features")}get filter(){return this._get("filter")}}

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

@@ -6101,6 +6101,24 @@
             ],
             "type": "object"
         },
+        "SetActiveFeatureArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"results.set-active-feature\" command.",
+            "properties": {
+                "features": {
+                    "$ref": "#/definitions/Features",
+                    "description": "The feature to set as active in the results component, if it exists. If multiple features are specified, only the first will be set as active."
+                },
+                "results": {
+                    "$ref": "#/definitions/ModelRef",
+                    "description": "The result component to update, referenced by results model or its ID. Web only."
+                }
+            },
+            "required": [
+                "features"
+            ],
+            "type": "object"
+        },
         "SetActivePointsArgs": {
             "additionalProperties": false,
             "description": "The arguments for the \"sketching.set-active-points\" command.",
@@ -21432,6 +21450,28 @@
         "results.from-xlsx:output": {
             "$ref": "#/definitions/Features"
         },
+        "results.get-active-features": {
+            "description": "Returns the current active feature from a specific results component if model ID or model is specified, otherwise returns all active features from all results components. Note that each results component can only have one active feature at a time, but the active feature can differ between different results components. Web only.",
+            "enum": [
+                "results.get-active-features"
+            ]
+        },
+        "results.get-active-features:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "type": [
+                        "string",
+                        "null"
+                    ]
+                }
+            ]
+        },
+        "results.get-active-features:output": {
+            "$ref": "#/definitions/Features"
+        },
         "results.get-features": {
             "description": "Returns the current set of features from a specific results component if a model or model ID is specified, otherwise from all results components. Web only.",
             "enum": [
@@ -21484,6 +21524,15 @@
         "results.replace:input": {
             "$ref": "#/definitions/ShowResultsArgs"
         },
+        "results.set-active-feature": {
+            "description": "Sets the active feature for a particular results component specified by the `results` arg. Or, if the `results` arg is not defined, sets the active feature for all results components. Note that each results component can only have one active feature at a time, but the active feature can differ between different results components. Web only.",
+            "enum": [
+                "results.set-active-feature"
+            ]
+        },
+        "results.set-active-feature:input": {
+            "$ref": "#/definitions/SetActiveFeatureArgs"
+        },
         "results.set-display-components": {
             "description": "Sets the selector, using CSS selector syntax, which queries for results components in the app layout XML, such as the Results List or Results Table components. The selector is used to determine which components will be activated when displaying results using `results.display`. All other components that do not match the selector are deactivated after running this command. Web only.",
             "enum": [
@@ -24448,6 +24497,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/results.set-active-feature:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/results.set-active-feature"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -25394,6 +25459,9 @@
                 {
                     "$ref": "#/definitions/results.replace"
                 },
+                {
+                    "$ref": "#/definitions/results.set-active-feature"
+                },
                 {
                     "$ref": "#/definitions/results.set-display-components"
                 },
@@ -26320,6 +26388,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/results.get-active-features:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/results.get-active-features"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -26967,6 +27051,9 @@
                 {
                     "$ref": "#/definitions/results.from-xlsx"
                 },
+                {
+                    "$ref": "#/definitions/results.get-active-features"
+                },
                 {
                     "$ref": "#/definitions/results.get-features"
                 },

package/package.json

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

package/version.js

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