@vertigis/viewer-spec 56.18.0 → 56.20.0

package/messaging/registry/printing.d.ts

@@ -12,9 +12,37 @@ import type { MapsLike } from "../common.js";
  */
 export type JobParameters = Record<string, unknown>;
 /**
- * The arguments required by the printing.run command.
+ * The export formats allowed for the layout print.
  */
-export interface RunPrintArgs {
+export type LayoutExportFormats = "AIX" | "BMP" | "MF" | "EPS" | "GIF" | "JPG" | "PDF" | "PNG" | "PNG32" | "SVG" | "SVGZ" | "TGA" | "TIFF";
+/**
+ * The arguments required by the printing.run command when printing with ArcGIS
+ * Pro layouts.
+ */
+export interface RunLayoutPrintArgs extends RunPrintArgsBase {
+    /**
+     * The ID of the layout item to be printed.
+     */
+    layoutId: string;
+    /**
+     * The export format of the layout print.
+     */
+    exportFormat?: LayoutExportFormats;
+}
+/**
+ * The arguments required by the printing.run command when printing with
+ * templates.
+ */
+export interface RunPrintArgs extends RunPrintArgsBase {
+    /**
+     * The WKID of the spatial reference used to draw a grid on the map(s).
+     */
+    grid?: SpatialReference;
+}
+/**
+ * The base arguments for the printing.run command.
+ */
+interface RunPrintArgsBase {
     /**
      * The map(s) to print.
      */
@@ -53,10 +81,6 @@ export interface RunPrintArgs {
      * The rotation of the map(s). Defaults to the map's current rotation.
      */
     rotation?: number;
-    /**
-     * The WKID of the spatial reference used to draw a grid on the map(s).
-     */
-    grid?: SpatialReference;
     /**
      * Additional parameters used in the print template, specified as key-value
      * pairs.
@@ -115,9 +139,9 @@ export interface PrintStartedEventArgs extends PrintEventArgsBase {
 export declare class PrintCommands extends CommandRegistry {
     protected readonly _prefix = "printing";
     /**
-     * Run a print job with a given map and template.
+     * Run a print job with a given map and template/layout.
      */
-    get run(): Command<RunPrintArgs>;
+    get run(): Command<RunPrintArgs | RunLayoutPrintArgs>;
 }
 export declare class PrintEvents extends EventRegistry {
     protected readonly _prefix = "printing";
@@ -139,3 +163,4 @@ export declare class PrintEvents extends EventRegistry {
      */
     get printError(): Event<PrintErrorEventArgs>;
 }
+export {};

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/common-action.schema.json

@@ -2349,6 +2349,25 @@
             ],
             "description": "One or more objects that are convertible to layer extensions."
         },
+        "LayoutExportFormats": {
+            "description": "The export formats allowed for the layout print.",
+            "enum": [
+                "AIX",
+                "BMP",
+                "EPS",
+                "GIF",
+                "JPG",
+                "MF",
+                "PDF",
+                "PNG",
+                "PNG32",
+                "SVG",
+                "SVGZ",
+                "TGA",
+                "TIFF"
+            ],
+            "type": "string"
+        },
         "MapRotateArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"map.rotate-by\" and \"map.rotate-to\" commands.",
@@ -2590,9 +2609,72 @@
             ],
             "type": "object"
         },
+        "RunLayoutPrintArgs": {
+            "additionalProperties": false,
+            "description": "The arguments required by the printing.run command when printing with ArcGIS Pro layouts.",
+            "properties": {
+                "dpi": {
+                    "description": "The DPI with which to print.",
+                    "type": "number"
+                },
+                "exportFormat": {
+                    "$ref": "#/definitions/LayoutExportFormats",
+                    "description": "The export format of the layout print."
+                },
+                "extent": {
+                    "$ref": "#/definitions/esri.Extent",
+                    "description": "The initial extent of the 2D map(s). Defaults to the map's current extent. If scale is provided, only the center point is used."
+                },
+                "id": {
+                    "description": "The ID of the report item.",
+                    "type": "string"
+                },
+                "instanceId": {
+                    "description": "A unique ID used to track a print job.",
+                    "type": "string"
+                },
+                "layoutId": {
+                    "description": "The ID of the layout item to be printed.",
+                    "type": "string"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map(s) to print."
+                },
+                "parameters": {
+                    "$ref": "#/definitions/JobParameters",
+                    "description": "Additional parameters used in the print template, specified as key-value pairs."
+                },
+                "portalItem": {
+                    "$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
+                    "description": "The portal item where the report is located."
+                },
+                "rotation": {
+                    "description": "The rotation of the map(s). Defaults to the map's current rotation.",
+                    "type": "number"
+                },
+                "scale": {
+                    "description": "The scale of the map(s). Defaults to the map's current scale.",
+                    "type": "number"
+                },
+                "title": {
+                    "description": "The title of the report.",
+                    "type": "string"
+                },
+                "viewpoint": {
+                    "$ref": "#/definitions/esri.Viewpoint",
+                    "description": "The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint."
+                }
+            },
+            "required": [
+                "layoutId",
+                "maps"
+            ],
+            "type": "object"
+        },
         "RunPrintArgs": {
             "additionalProperties": false,
-            "description": "The arguments required by the printing.run command.",
+            "description": "The arguments required by the printing.run command when printing with templates.",
             "properties": {
                 "dpi": {
                     "description": "The DPI with which to print.",
@@ -13710,13 +13792,20 @@
             ]
         },
         "printing.run": {
-            "description": "Run a print job with a given map and template.",
+            "description": "Run a print job with a given map and template/layout.",
             "enum": [
                 "printing.run"
             ]
         },
         "printing.run:input": {
-            "$ref": "#/definitions/RunPrintArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/RunLayoutPrintArgs"
+                },
+                {
+                    "$ref": "#/definitions/RunPrintArgs"
+                }
+            ]
         },
         "results.add": {
             "description": "Adds features to a currently shown set of features.",

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

@@ -2861,6 +2861,25 @@
             ],
             "description": "One or more objects that are convertible to layer extensions."
         },
+        "LayoutExportFormats": {
+            "description": "The export formats allowed for the layout print.",
+            "enum": [
+                "AIX",
+                "BMP",
+                "EPS",
+                "GIF",
+                "JPG",
+                "MF",
+                "PDF",
+                "PNG",
+                "PNG32",
+                "SVG",
+                "SVGZ",
+                "TGA",
+                "TIFF"
+            ],
+            "type": "string"
+        },
         "LengthUnitsMobile": {
             "description": "The units for distance supported by Mobile.",
             "enum": [
@@ -3395,9 +3414,72 @@
             ],
             "type": "object"
         },
+        "RunLayoutPrintArgs": {
+            "additionalProperties": false,
+            "description": "The arguments required by the printing.run command when printing with ArcGIS Pro layouts.",
+            "properties": {
+                "dpi": {
+                    "description": "The DPI with which to print.",
+                    "type": "number"
+                },
+                "exportFormat": {
+                    "$ref": "#/definitions/LayoutExportFormats",
+                    "description": "The export format of the layout print."
+                },
+                "extent": {
+                    "$ref": "#/definitions/esri.Extent",
+                    "description": "The initial extent of the 2D map(s). Defaults to the map's current extent. If scale is provided, only the center point is used."
+                },
+                "id": {
+                    "description": "The ID of the report item.",
+                    "type": "string"
+                },
+                "instanceId": {
+                    "description": "A unique ID used to track a print job.",
+                    "type": "string"
+                },
+                "layoutId": {
+                    "description": "The ID of the layout item to be printed.",
+                    "type": "string"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map(s) to print."
+                },
+                "parameters": {
+                    "$ref": "#/definitions/JobParameters",
+                    "description": "Additional parameters used in the print template, specified as key-value pairs."
+                },
+                "portalItem": {
+                    "$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
+                    "description": "The portal item where the report is located."
+                },
+                "rotation": {
+                    "description": "The rotation of the map(s). Defaults to the map's current rotation.",
+                    "type": "number"
+                },
+                "scale": {
+                    "description": "The scale of the map(s). Defaults to the map's current scale.",
+                    "type": "number"
+                },
+                "title": {
+                    "description": "The title of the report.",
+                    "type": "string"
+                },
+                "viewpoint": {
+                    "$ref": "#/definitions/esri.Viewpoint",
+                    "description": "The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint."
+                }
+            },
+            "required": [
+                "layoutId",
+                "maps"
+            ],
+            "type": "object"
+        },
         "RunPrintArgs": {
             "additionalProperties": false,
-            "description": "The arguments required by the printing.run command.",
+            "description": "The arguments required by the printing.run command when printing with templates.",
             "properties": {
                 "dpi": {
                     "description": "The DPI with which to print.",
@@ -15676,13 +15758,20 @@
             ]
         },
         "printing.run": {
-            "description": "Run a print job with a given map and template.",
+            "description": "Run a print job with a given map and template/layout.",
             "enum": [
                 "printing.run"
             ]
         },
         "printing.run:input": {
-            "$ref": "#/definitions/RunPrintArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/RunLayoutPrintArgs"
+                },
+                {
+                    "$ref": "#/definitions/RunPrintArgs"
+                }
+            ]
         },
         "results.add": {
             "description": "Adds features to a currently shown set of features.",

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.",
@@ -4662,6 +4684,25 @@
             ],
             "description": "One or more objects that are convertible to layer extensions."
         },
+        "LayoutExportFormats": {
+            "description": "The export formats allowed for the layout print.",
+            "enum": [
+                "AIX",
+                "BMP",
+                "EPS",
+                "GIF",
+                "JPG",
+                "MF",
+                "PDF",
+                "PNG",
+                "PNG32",
+                "SVG",
+                "SVGZ",
+                "TGA",
+                "TIFF"
+            ],
+            "type": "string"
+        },
         "LengthMeasurementUnits": {
             "description": "The units for length measurements supported by ArcGIS.",
             "enum": [
@@ -5673,9 +5714,72 @@
             },
             "type": "object"
         },
+        "RunLayoutPrintArgs": {
+            "additionalProperties": false,
+            "description": "The arguments required by the printing.run command when printing with ArcGIS Pro layouts.",
+            "properties": {
+                "dpi": {
+                    "description": "The DPI with which to print.",
+                    "type": "number"
+                },
+                "exportFormat": {
+                    "$ref": "#/definitions/LayoutExportFormats",
+                    "description": "The export format of the layout print."
+                },
+                "extent": {
+                    "$ref": "#/definitions/esri.Extent",
+                    "description": "The initial extent of the 2D map(s). Defaults to the map's current extent. If scale is provided, only the center point is used."
+                },
+                "id": {
+                    "description": "The ID of the report item.",
+                    "type": "string"
+                },
+                "instanceId": {
+                    "description": "A unique ID used to track a print job.",
+                    "type": "string"
+                },
+                "layoutId": {
+                    "description": "The ID of the layout item to be printed.",
+                    "type": "string"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map(s) to print."
+                },
+                "parameters": {
+                    "$ref": "#/definitions/JobParameters",
+                    "description": "Additional parameters used in the print template, specified as key-value pairs."
+                },
+                "portalItem": {
+                    "$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
+                    "description": "The portal item where the report is located."
+                },
+                "rotation": {
+                    "description": "The rotation of the map(s). Defaults to the map's current rotation.",
+                    "type": "number"
+                },
+                "scale": {
+                    "description": "The scale of the map(s). Defaults to the map's current scale.",
+                    "type": "number"
+                },
+                "title": {
+                    "description": "The title of the report.",
+                    "type": "string"
+                },
+                "viewpoint": {
+                    "$ref": "#/definitions/esri.Viewpoint",
+                    "description": "The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint."
+                }
+            },
+            "required": [
+                "layoutId",
+                "maps"
+            ],
+            "type": "object"
+        },
         "RunPrintArgs": {
             "additionalProperties": false,
-            "description": "The arguments required by the printing.run command.",
+            "description": "The arguments required by the printing.run command when printing with templates.",
             "properties": {
                 "dpi": {
                     "description": "The DPI with which to print.",
@@ -20580,13 +20684,20 @@
             ]
         },
         "printing.run": {
-            "description": "Run a print job with a given map and template.",
+            "description": "Run a print job with a given map and template/layout.",
             "enum": [
                 "printing.run"
             ]
         },
         "printing.run:input": {
-            "$ref": "#/definitions/RunPrintArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/RunLayoutPrintArgs"
+                },
+                {
+                    "$ref": "#/definitions/RunPrintArgs"
+                }
+            ]
         },
         "project.create": {
             "description": "Creates app config for a project, based on the current state of the application. Web only.",
@@ -20767,6 +20878,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 +24288,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 +25364,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.20.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.20.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.20.0";