@vertigis/viewer-spec 56.18.0 → 56.19.0

package/messaging/registry/results.d.ts

@@ -17,7 +17,7 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Blob, Features, FeaturesLike, File, GraphicsLike, HasFeatures, HasFiles, MapsLike, ModelRef } from "../common.js";
+import type { Blob, Features, FeaturesLike, File, GraphicsLike, HasFeatures, HasFiles, Layers, MapsLike, ModelRef } from "../common.js";
 import type { VisualElement } from "../mobile.js";
 /**
  * Well known Results Set Ids.
@@ -264,6 +264,36 @@ export interface SetListViewModeArgs {
      */
     results?: ModelRef;
 }
+/**
+ * Arguments for the "results.activate-group" command.
+ */
+export interface ActivateResultGroupArgs {
+    /**
+     * The layer to activate the corresponding group for in the results
+     * component. If more than one layer is included, only the first item in the
+     * array will be used. One of `sources` or `layers` is required. If both are
+     * specified, `sources` will take precedence. Web only.
+     *
+     * @webOnly
+     */
+    layers?: Layers;
+    /**
+     * An array of sources to activate the corresponding group for in the
+     * results component. Only the first item in the array will be used. One of
+     * `sources` or `layers` is required. If both are specified, `sources` will
+     * take precedence. Web only.
+     *
+     * @webOnly
+     */
+    sources?: FeatureSource[];
+    /**
+     * The result component to update, referenced by results model or its ID.
+     * Web only.
+     *
+     * @webOnly
+     */
+    results?: ModelRef;
+}
 /**
  * Arguments for the "results.set-list-card-size" command.
  */
@@ -345,6 +375,13 @@ export declare class ResultsCommands extends CommandRegistry {
      * @webOnly
      */
     get activateDisplayComponents(): Command<void>;
+    /**
+     * Activates the group with the specified layerId in the results component.
+     * Web only.
+     *
+     * @webOnly
+     */
+    get activateGroup(): Command<ActivateResultGroupArgs>;
     /**
      * Presents features to the user within any components that can display
      * features, such as a feature list, feature table, or feature details

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 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 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")}}

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

@@ -802,6 +802,28 @@
             ],
             "description": "A reference to a portal item."
         },
+        "ActivateResultGroupArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"results.activate-group\" command.",
+            "properties": {
+                "layers": {
+                    "$ref": "#/definitions/Layers",
+                    "description": "The layer to activate the corresponding group for in the results component. If more than one layer is included, only the first item in the array will be used. One of `sources` or `layers` is required. If both are specified, `sources` will take precedence. Web only."
+                },
+                "results": {
+                    "$ref": "#/definitions/ModelRef",
+                    "description": "The result component to update, referenced by results model or its ID. Web only."
+                },
+                "sources": {
+                    "description": "An array of sources to activate the corresponding group for in the results component. Only the first item in the array will be used. One of `sources` or `layers` is required. If both are specified, `sources` will take precedence. Web only.",
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "AddAttachmentArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
@@ -20767,6 +20789,15 @@
                 "results.activate-display-components"
             ]
         },
+        "results.activate-group": {
+            "description": "Activates the group with the specified layerId in the results component. Web only.",
+            "enum": [
+                "results.activate-group"
+            ]
+        },
+        "results.activate-group:input": {
+            "$ref": "#/definitions/ActivateResultGroupArgs"
+        },
         "results.add": {
             "description": "Adds features to a currently shown set of features.",
             "enum": [
@@ -24168,6 +24199,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/results.activate-group:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/results.activate-group"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -25228,6 +25275,9 @@
                 {
                     "$ref": "#/definitions/results.activate-display-components"
                 },
+                {
+                    "$ref": "#/definitions/results.activate-group"
+                },
                 {
                     "$ref": "#/definitions/results.add"
                 },

package/package.json

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

package/version.js

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