@vertigis/viewer-spec 61.0.0 → 61.1.1

package/messaging/registry/printing.d.ts

@@ -2,6 +2,7 @@ import type Viewpoint from "@arcgis/core/Viewpoint";
 import type Extent from "@arcgis/core/geometry/Extent";
 import type Point from "@arcgis/core/geometry/Point.js";
 import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
+import type { Feature } from "@vertigis/arcgis-extensions/data/Feature.js";
 import type { BasemapJson } from "@vertigis/arcgis-extensions/json/BasemapJson.js";
 import type { OperationalLayerJson } from "@vertigis/arcgis-extensions/json/OperationalLayerJson.js";
 import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
@@ -11,7 +12,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 { MapsLike } from "../common.js";
+import type { FeaturesLike, MapsLike } from "../common.js";
 /**
  * A set of parameters used to run a job.
  */
@@ -548,10 +549,10 @@ export interface Page {
      */
     dynamicElements?: DynamicElement[];
     /**
-     * Layer objects selections of the default Page additionally to the Layer
+     * Layer objects selections of the default Page. Overwrites the Layer
      * objects selections in additionalSettings.
      */
-    selection?: Selection;
+    selection?: Selection[];
 }
 /**
  * Represents the seamless page settings.
@@ -745,7 +746,7 @@ export interface AdditionalSettings {
     /**
      * Layer objects selections.
      */
-    selection?: Selection;
+    selection?: Selection[];
     /**
      * Series time settings for time-aware layers.
      */
@@ -777,6 +778,15 @@ export interface AdditionalSettings {
      */
     dynamicElements?: DynamicElement[];
 }
+/**
+ * Arguments for the printing.print-features command.
+ */
+export interface PrintFeaturesArgs {
+    /**
+     * The feature(s) to print.
+     */
+    features: FeaturesLike;
+}
 /**
  * Print job arguments (printing gen2).
  */
@@ -960,6 +970,15 @@ export interface PrintFinishedEventArgs extends PrintEventArgsBase {
  */
 export interface PrintProgressEventArgs extends PrintEventArgsBase {
 }
+/**
+ * Arguments for the printing.print-features-prepared event.
+ */
+export interface PrintFeaturesPreparedEventArgs {
+    /**
+     * Features containing geometries to print. Web only.
+     */
+    features: Feature[];
+}
 /**
  * Arguments for the printing.print-preparing event.
  */
@@ -1002,6 +1021,13 @@ export declare class PrintCommands extends CommandRegistry {
      * Run a print job with a given map and template/layout.
      */
     get run(): Command<RunPrintArgs | RunLayoutPrintArgs>;
+    /**
+     * Opens the print component with the option to print specified features.
+     * Web only.
+     *
+     * @webOnly
+     */
+    get printFeatures(): Command<PrintFeaturesArgs>;
 }
 export declare class PrintOperations extends OperationRegistry {
     protected readonly _prefix = "printing";
@@ -1015,6 +1041,12 @@ export declare class PrintOperations extends OperationRegistry {
 }
 export declare class PrintEvents extends EventRegistry {
     protected readonly _prefix = "printing";
+    /**
+     * Raised when features are prepared for prints.
+     *
+     * @webOnly
+     */
+    get printFeaturesPrepared(): Event<PrintFeaturesPreparedEventArgs>;
     /**
      * Raised before a print gets prepared.
      *

package/messaging/registry/printing.js

@@ -1 +1 @@
-import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as e}from"../OperationRegistry.js";export const printOutputFormats=["AIX","BMP","EMF","EPS","GIF","JPG","PDF","PNG","PNG32","SVG","SVGZ","TGA","TIFF"];export class PrintCommands extends r{_prefix="printing";get run(){return this._get("run")}}export class PrintOperations extends e{_prefix="printing";get updateArgs(){return this._get("update-args")}}export class PrintEvents extends t{_prefix="printing";get printPreparing(){return this._get("print-preparing")}get printPrepared(){return this._get("print-prepared")}get printStarted(){return this._get("print-started")}get printProgress(){return this._get("print-progress")}get printFinished(){return this._get("print-finished")}get printError(){return this._get("print-error")}}
+import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as e}from"../OperationRegistry.js";export const printOutputFormats=["AIX","BMP","EMF","EPS","GIF","JPG","PDF","PNG","PNG32","SVG","SVGZ","TGA","TIFF"];export class PrintCommands extends r{_prefix="printing";get run(){return this._get("run")}get printFeatures(){return this._get("print-features")}}export class PrintOperations extends e{_prefix="printing";get updateArgs(){return this._get("update-args")}}export class PrintEvents extends t{_prefix="printing";get printFeaturesPrepared(){return this._get("print-features-prepared")}get printPreparing(){return this._get("print-preparing")}get printPrepared(){return this._get("print-prepared")}get printStarted(){return this._get("print-started")}get printProgress(){return this._get("print-progress")}get printFinished(){return this._get("print-finished")}get printError(){return this._get("print-error")}}

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

@@ -2511,8 +2511,11 @@
                     "description": "Security settings."
                 },
                 "selection": {
-                    "$ref": "#/definitions/Selection",
-                    "description": "Layer objects selections."
+                    "description": "Layer objects selections.",
+                    "items": {
+                        "$ref": "#/definitions/Selection"
+                    },
+                    "type": "array"
                 },
                 "timeSeries": {
                     "$ref": "TimeSeries",
@@ -8389,6 +8392,20 @@
             ],
             "type": "object"
         },
+        "PrintFeaturesArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the printing.print-features command.",
+            "properties": {
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "The feature(s) to print."
+                }
+            },
+            "required": [
+                "features"
+            ],
+            "type": "object"
+        },
         "PrintJobArgs": {
             "additionalProperties": false,
             "description": "Print job arguments (printing gen2).",
@@ -26755,6 +26772,15 @@
         "portal.create-or-update-item:output": {
             "$ref": "#/definitions/@arcgis.core.portal.PortalItem.PortalItem"
         },
+        "printing.print-features": {
+            "description": "Opens the print component with the option to print specified features. Web only.",
+            "enum": [
+                "printing.print-features"
+            ]
+        },
+        "printing.print-features:input": {
+            "$ref": "#/definitions/PrintFeaturesArgs"
+        },
         "printing.run": {
             "description": "Run a print job with a given map and template/layout.",
             "enum": [
@@ -30357,6 +30383,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/printing.print-features:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/printing.print-features"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -31633,6 +31675,9 @@
                 {
                     "$ref": "#/definitions/panel.pop-out"
                 },
+                {
+                    "$ref": "#/definitions/printing.print-features"
+                },
                 {
                     "$ref": "#/definitions/printing.run"
                 },

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

@@ -1996,8 +1996,11 @@
                     "description": "Security settings."
                 },
                 "selection": {
-                    "$ref": "#/definitions/Selection",
-                    "description": "Layer objects selections."
+                    "description": "Layer objects selections.",
+                    "items": {
+                        "$ref": "#/definitions/Selection"
+                    },
+                    "type": "array"
                 },
                 "timeSeries": {
                     "$ref": "TimeSeries",
@@ -3702,6 +3705,23 @@
             ],
             "type": "object"
         },
+        "PrintFeaturesPreparedEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the printing.print-features-prepared event.",
+            "properties": {
+                "features": {
+                    "description": "Features containing geometries to print. Web only.",
+                    "items": {
+                        "$ref": "T_13"
+                    },
+                    "type": "array"
+                }
+            },
+            "required": [
+                "features"
+            ],
+            "type": "object"
+        },
         "PrintFinishedEventArgs": {
             "additionalProperties": false,
             "description": "Arguments for the printing.print-finished event.",
@@ -16070,6 +16090,15 @@
         "printing.print-error:input": {
             "$ref": "#/definitions/PrintErrorEventArgs"
         },
+        "printing.print-features-prepared": {
+            "description": "Raised when features are prepared for prints.",
+            "enum": [
+                "printing.print-features-prepared"
+            ]
+        },
+        "printing.print-features-prepared:input": {
+            "$ref": "#/definitions/PrintFeaturesPreparedEventArgs"
+        },
         "printing.print-finished": {
             "description": "Raised when a print has finished running. Event arguments include the print download URL.",
             "enum": [
@@ -16429,6 +16458,9 @@
                 {
                     "$ref": "#/definitions/printing.print-error"
                 },
+                {
+                    "$ref": "#/definitions/printing.print-features-prepared"
+                },
                 {
                     "$ref": "#/definitions/printing.print-finished"
                 },

package/messaging/schema/web-printing-command-definitions.md

@@ -1,3 +1,19 @@
+# command: printing.print-features
+Description: Opens the print component with the option to print specified features. Web only.
+
+Inputs: `PrintFeaturesArgs`
+
+PrintFeaturesArgs properties:
+```json
+{
+  "features": {
+    "description": "The feature(s) to print.",
+    "isRequired": "true"
+  }
+}
+```
+
+---
 # command: printing.run
 Description: Run a print job with a given map and template/layout.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "61.0.0",
+  "version": "61.1.1",
   "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 = "61.0.0";
+export declare const version = "61.1.1";

package/version.js

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