@vertigis/viewer-spec 59.17.0 → 59.18.0

package/messaging/registry/printing.d.ts

@@ -42,6 +42,19 @@ export interface PrintSpatialReference {
      */
     wkt?: string;
 }
+/**
+ * Represents the print output dimensions for a MAP ONLY print.
+ */
+export interface PrintOutputDimensions {
+    /**
+     * The height of the map image in pixels.
+     */
+    height: number;
+    /**
+     * The height of the map image in pixels.
+     */
+    width: number;
+}
 /**
  * Represents the print extent.
  */
@@ -752,17 +765,46 @@ export interface PreparedPrintJobArgs {
 }
 /**
  * The arguments required by the printing.run command when printing with
- * VertiGIS Studio ArcGIS Pro layouts, -layout packages or map only (printing
+ * VertiGIS Studio ArcGIS Pro layouts, -layout packages or MAP ONLY (printing
  * gen2).
  */
 export interface RunLayoutPrintArgs extends RunPrintArgsBase {
     /**
      * The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.:
-     * vglaypk_xxx) item to print with or "MAP_ONLY" for map only prints.
+     * vglaypk_xxx) item to print with. Deprecated; use portalItem instead.
+     *
+     * @deprecated
+     */
+    layoutId?: string;
+    /**
+     * The portal item where the print layout or layout package is located. If
+     * not defined, a MAP ONLY print is performed.
+     */
+    portalItem?: PortalItemLike;
+    /**
+     * The print scale.
+     */
+    scale: number;
+    /**
+     * The map extent. Defaults to the map's current extent. The actual print
+     * extent is calculated from the center point of the map extent, the print
+     * scale and the layout frame- or the output dimensions.
      */
-    layoutId: string;
+    extent?: Extent;
+    /**
+     * The print output dimensions for a MAP ONLY print.
+     */
+    outputDimensions?: PrintOutputDimensions;
+    /**
+     * Custom layout field parameters, specified as key-value pairs. The key is
+     * related to the layout field key. If a field for a specified key has an
+     * auto-filled value, this value is overwritten by the value provided here.
+     * NOTE: See VGS Printing documentation to learn more about layout fields.
+     */
+    parameters?: JobParameters;
     /**
-     * The print output format or PDF as default.
+     * The print output format. Defaults to PDF if undefined or if layout
+     * package print is performed.
      */
     outputFormat?: PrintOutputFormat;
 }
@@ -771,35 +813,14 @@ export interface RunLayoutPrintArgs extends RunPrintArgsBase {
  * templates (printing gen1).
  */
 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.
-     */
-    maps: MapsLike;
     /**
      * The ID of the report item.
      */
     id?: string;
     /**
-     * The title of the report.
-     */
-    title?: string;
-    /**
-     * The portal item where the report is located.
+     * The portal item where the print template is located.
      */
     portalItem?: PortalItemLike;
-    /**
-     * The DPI with which to print.
-     */
-    dpi?: number;
     /**
      * The scale of the map(s). Defaults to the map's current scale.
      */
@@ -809,6 +830,10 @@ interface RunPrintArgsBase {
      * extent. If scale is provided, only the center point is used.
      */
     extent?: Extent;
+    /**
+     * The WKID of the spatial reference used to draw a grid on the map(s).
+     */
+    grid?: SpatialReference;
     /**
      * The initial viewpoint of the 3D map(s). Defaults to the scene's current
      * viewpoint.
@@ -818,6 +843,23 @@ interface RunPrintArgsBase {
      * The rotation of the map(s). Defaults to the map's current rotation.
      */
     rotation?: number;
+}
+/**
+ * The base arguments for the printing.run command.
+ */
+interface RunPrintArgsBase {
+    /**
+     * The map(s) to print.
+     */
+    maps: MapsLike;
+    /**
+     * The title of the print.
+     */
+    title?: string;
+    /**
+     * The DPI with which to print.
+     */
+    dpi?: number;
     /**
      * Additional parameters used in the print template, specified as key-value
      * pairs.

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

@@ -3060,6 +3060,25 @@
             ],
             "description": "Filters applied to the pointCloud which will hide a point.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/pointCloudFilter/}."
         },
+        "PrintOutputDimensions": {
+            "additionalProperties": false,
+            "description": "Represents the print output dimensions for a MAP ONLY print.",
+            "properties": {
+                "height": {
+                    "description": "The height of the map image in pixels.",
+                    "type": "number"
+                },
+                "width": {
+                    "description": "The height of the map image in pixels.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "height",
+                "width"
+            ],
+            "type": "object"
+        },
         "PrintOutputFormat": {
             "description": "Represents the print output format type (printing gen2). Note: Output format is ignored and PDF is used automatically if more than one page is exported.",
             "enum": [
@@ -3156,7 +3175,7 @@
         },
         "RunLayoutPrintArgs": {
             "additionalProperties": false,
-            "description": "The arguments required by the printing.run command when printing with VertiGIS Studio ArcGIS Pro layouts, -layout packages or map only (printing gen2).",
+            "description": "The arguments required by the printing.run command when printing with VertiGIS Studio ArcGIS Pro layouts, -layout packages or MAP ONLY (printing gen2).",
             "properties": {
                 "dpi": {
                     "description": "The DPI with which to print.",
@@ -3164,56 +3183,48 @@
                 },
                 "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"
+                    "description": "The map extent. Defaults to the map's current extent. The actual print extent is calculated from the center point of the map extent, the print scale and the layout frame- or the output dimensions."
                 },
                 "instanceId": {
                     "description": "A unique ID used to track a print job.",
                     "type": "string"
                 },
                 "layoutId": {
-                    "description": "The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with or \"MAP_ONLY\" for map only prints.",
+                    "description": "The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with. Deprecated; use portalItem instead.",
                     "type": "string"
                 },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "The map(s) to print."
                 },
+                "outputDimensions": {
+                    "$ref": "#/definitions/PrintOutputDimensions",
+                    "description": "The print output dimensions for a MAP ONLY print."
+                },
                 "outputFormat": {
                     "$ref": "#/definitions/PrintOutputFormat",
-                    "description": "The print output format or PDF as default."
+                    "description": "The print output format. Defaults to PDF if undefined or if layout package print is performed."
                 },
                 "parameters": {
                     "$ref": "#/definitions/JobParameters",
-                    "description": "Additional parameters used in the print template, specified as key-value pairs."
+                    "description": "Custom layout field parameters, specified as key-value pairs. The key is related to the layout field key. If a field for a specified key has an auto-filled value, this value is overwritten by the value provided here. NOTE: See VGS Printing documentation to learn more about layout fields."
                 },
                 "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"
+                    "description": "The portal item where the print layout or layout package is located. If not defined, a MAP ONLY print is performed."
                 },
                 "scale": {
-                    "description": "The scale of the map(s). Defaults to the map's current scale.",
+                    "description": "The print scale.",
                     "type": "number"
                 },
                 "title": {
-                    "description": "The title of the report.",
+                    "description": "The title of the print.",
                     "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"
+                "maps",
+                "scale"
             ],
             "type": "object"
         },
@@ -3251,7 +3262,7 @@
                 },
                 "portalItem": {
                     "$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
-                    "description": "The portal item where the report is located."
+                    "description": "The portal item where the print template is located."
                 },
                 "rotation": {
                     "description": "The rotation of the map(s). Defaults to the map's current rotation.",
@@ -3262,7 +3273,7 @@
                     "type": "number"
                 },
                 "title": {
-                    "description": "The title of the report.",
+                    "description": "The title of the print.",
                     "type": "string"
                 },
                 "viewpoint": {

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

@@ -3899,6 +3899,25 @@
             ],
             "description": "Filters applied to the pointCloud which will hide a point.\n\nSee {@link https://developers.arcgis.com/web-scene-specification/objects/pointCloudFilter/}."
         },
+        "PrintOutputDimensions": {
+            "additionalProperties": false,
+            "description": "Represents the print output dimensions for a MAP ONLY print.",
+            "properties": {
+                "height": {
+                    "description": "The height of the map image in pixels.",
+                    "type": "number"
+                },
+                "width": {
+                    "description": "The height of the map image in pixels.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "height",
+                "width"
+            ],
+            "type": "object"
+        },
         "PrintOutputFormat": {
             "description": "Represents the print output format type (printing gen2). Note: Output format is ignored and PDF is used automatically if more than one page is exported.",
             "enum": [
@@ -4091,7 +4110,7 @@
         },
         "RunLayoutPrintArgs": {
             "additionalProperties": false,
-            "description": "The arguments required by the printing.run command when printing with VertiGIS Studio ArcGIS Pro layouts, -layout packages or map only (printing gen2).",
+            "description": "The arguments required by the printing.run command when printing with VertiGIS Studio ArcGIS Pro layouts, -layout packages or MAP ONLY (printing gen2).",
             "properties": {
                 "dpi": {
                     "description": "The DPI with which to print.",
@@ -4099,56 +4118,48 @@
                 },
                 "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"
+                    "description": "The map extent. Defaults to the map's current extent. The actual print extent is calculated from the center point of the map extent, the print scale and the layout frame- or the output dimensions."
                 },
                 "instanceId": {
                     "description": "A unique ID used to track a print job.",
                     "type": "string"
                 },
                 "layoutId": {
-                    "description": "The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with or \"MAP_ONLY\" for map only prints.",
+                    "description": "The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with. Deprecated; use portalItem instead.",
                     "type": "string"
                 },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "The map(s) to print."
                 },
+                "outputDimensions": {
+                    "$ref": "#/definitions/PrintOutputDimensions",
+                    "description": "The print output dimensions for a MAP ONLY print."
+                },
                 "outputFormat": {
                     "$ref": "#/definitions/PrintOutputFormat",
-                    "description": "The print output format or PDF as default."
+                    "description": "The print output format. Defaults to PDF if undefined or if layout package print is performed."
                 },
                 "parameters": {
                     "$ref": "#/definitions/JobParameters",
-                    "description": "Additional parameters used in the print template, specified as key-value pairs."
+                    "description": "Custom layout field parameters, specified as key-value pairs. The key is related to the layout field key. If a field for a specified key has an auto-filled value, this value is overwritten by the value provided here. NOTE: See VGS Printing documentation to learn more about layout fields."
                 },
                 "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"
+                    "description": "The portal item where the print layout or layout package is located. If not defined, a MAP ONLY print is performed."
                 },
                 "scale": {
-                    "description": "The scale of the map(s). Defaults to the map's current scale.",
+                    "description": "The print scale.",
                     "type": "number"
                 },
                 "title": {
-                    "description": "The title of the report.",
+                    "description": "The title of the print.",
                     "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"
+                "maps",
+                "scale"
             ],
             "type": "object"
         },
@@ -4186,7 +4197,7 @@
                 },
                 "portalItem": {
                     "$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
-                    "description": "The portal item where the report is located."
+                    "description": "The portal item where the print template is located."
                 },
                 "rotation": {
                     "description": "The rotation of the map(s). Defaults to the map's current rotation.",
@@ -4197,7 +4208,7 @@
                     "type": "number"
                 },
                 "title": {
-                    "description": "The title of the report.",
+                    "description": "The title of the print.",
                     "type": "string"
                 },
                 "viewpoint": {

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

@@ -6088,6 +6088,25 @@
             "description": "A username for a particular ArcGIS Portal User.",
             "type": "string"
         },
+        "PrintOutputDimensions": {
+            "additionalProperties": false,
+            "description": "Represents the print output dimensions for a MAP ONLY print.",
+            "properties": {
+                "height": {
+                    "description": "The height of the map image in pixels.",
+                    "type": "number"
+                },
+                "width": {
+                    "description": "The height of the map image in pixels.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "height",
+                "width"
+            ],
+            "type": "object"
+        },
         "PrintOutputFormat": {
             "description": "Represents the print output format type (printing gen2). Note: Output format is ignored and PDF is used automatically if more than one page is exported.",
             "enum": [
@@ -6560,7 +6579,7 @@
         },
         "RunLayoutPrintArgs": {
             "additionalProperties": false,
-            "description": "The arguments required by the printing.run command when printing with VertiGIS Studio ArcGIS Pro layouts, -layout packages or map only (printing gen2).",
+            "description": "The arguments required by the printing.run command when printing with VertiGIS Studio ArcGIS Pro layouts, -layout packages or MAP ONLY (printing gen2).",
             "properties": {
                 "dpi": {
                     "description": "The DPI with which to print.",
@@ -6568,56 +6587,48 @@
                 },
                 "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"
+                    "description": "The map extent. Defaults to the map's current extent. The actual print extent is calculated from the center point of the map extent, the print scale and the layout frame- or the output dimensions."
                 },
                 "instanceId": {
                     "description": "A unique ID used to track a print job.",
                     "type": "string"
                 },
                 "layoutId": {
-                    "description": "The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with or \"MAP_ONLY\" for map only prints.",
+                    "description": "The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with. Deprecated; use portalItem instead.",
                     "type": "string"
                 },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "The map(s) to print."
                 },
+                "outputDimensions": {
+                    "$ref": "#/definitions/PrintOutputDimensions",
+                    "description": "The print output dimensions for a MAP ONLY print."
+                },
                 "outputFormat": {
                     "$ref": "#/definitions/PrintOutputFormat",
-                    "description": "The print output format or PDF as default."
+                    "description": "The print output format. Defaults to PDF if undefined or if layout package print is performed."
                 },
                 "parameters": {
                     "$ref": "#/definitions/JobParameters",
-                    "description": "Additional parameters used in the print template, specified as key-value pairs."
+                    "description": "Custom layout field parameters, specified as key-value pairs. The key is related to the layout field key. If a field for a specified key has an auto-filled value, this value is overwritten by the value provided here. NOTE: See VGS Printing documentation to learn more about layout fields."
                 },
                 "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"
+                    "description": "The portal item where the print layout or layout package is located. If not defined, a MAP ONLY print is performed."
                 },
                 "scale": {
-                    "description": "The scale of the map(s). Defaults to the map's current scale.",
+                    "description": "The print scale.",
                     "type": "number"
                 },
                 "title": {
-                    "description": "The title of the report.",
+                    "description": "The title of the print.",
                     "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"
+                "maps",
+                "scale"
             ],
             "type": "object"
         },
@@ -6655,7 +6666,7 @@
                 },
                 "portalItem": {
                     "$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
-                    "description": "The portal item where the report is located."
+                    "description": "The portal item where the print template is located."
                 },
                 "rotation": {
                     "description": "The rotation of the map(s). Defaults to the map's current rotation.",
@@ -6666,7 +6677,7 @@
                     "type": "number"
                 },
                 "title": {
-                    "description": "The title of the report.",
+                    "description": "The title of the print.",
                     "type": "string"
                 },
                 "viewpoint": {

package/package.json

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

package/version.js

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