@vertigis/viewer-spec 61.16.0 → 61.17.0

package/app-config/web/PrintFormModelProperties.d.ts

@@ -1,3 +1,4 @@
+import type { ColorJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
 import type { WebMapLike } from "@vertigis/arcgis-extensions/mapping/MapExtension.js";
 import type { ItemRef } from "../common/ItemRef.js";
 import type { ComponentModelProperties } from "./ComponentModelProperties.js";
@@ -24,6 +25,54 @@ export interface SpatialReferenceGrid {
      */
     wkt?: string;
 }
+/**
+ * The print extent indicator style. The extent indicator is exported as map
+ * overlay on overview maps for series prints.
+ */
+export interface ExtentIndicatorStyle {
+    /**
+     * The fill color. Defaults to half transparent yellow ([255, 204, 0, 50]).
+     */
+    fillColor?: ColorJson;
+    /**
+     * The overlap color. Defaults to full transparent green ([0, 255, 0, 0]).
+     */
+    overlapColor?: ColorJson;
+    /**
+     * The outline color. Defaults to solid yellow ([255, 204, 0, 255]).
+     */
+    outlineColor?: ColorJson;
+    /**
+     * The outline width in pixels. Defaults to 2.
+     */
+    outlineWidth?: number;
+    /**
+     * The label color. Defaults to solid yellow ([255, 204, 0, 255]).
+     */
+    labelColor?: ColorJson;
+    /**
+     * The label font size in points. Defaults to 20.
+     */
+    labelFontSize?: number;
+    /**
+     * The label halo fill color. Defaults to half transparent white ([255, 255,
+     * 255, 100]).
+     */
+    labelHaloFillColor?: ColorJson;
+    /**
+     * The label halo outline color. Defaults to half transparent black ([0, 0,
+     * 0, 100]).
+     */
+    labelHaloOutlineColor?: ColorJson;
+    /**
+     * The label halo outline width in pixels. Defaults to 1.
+     */
+    labelHaloOutlineWidth?: number;
+    /**
+     * The label halo size in pixels. Defaults to 2.
+     */
+    labelHaloSize?: number;
+}
 /**
  * Legend items visibility.
  */
@@ -85,13 +134,18 @@ export interface PrintFormModelProperties extends ComponentModelProperties {
      */
     strictModeEnabled?: boolean;
     /**
-     * Web map used as overview map in the print layout; defaults to application
+     * Web map used as overview map in the print layout. Defaults to application
      * map if not set.
      */
     additionalMapOverview?: WebMapLike;
     /**
-     * Web map used as overview page map in the print layout; defaults to
+     * Web map used as overview page map in the print layout. Defaults to
      * application map if not set.
      */
     additionalMapOverviewPage?: WebMapLike;
+    /**
+     * The print extent indicator style. Defaults to printing engine defaults if
+     * not set.
+     */
+    extentIndicatorStyle?: ExtentIndicatorStyle;
 }

package/messaging/registry/printing.d.ts

@@ -5,6 +5,7 @@ import type SpatialReference from "@arcgis/core/geometry/SpatialReference.js";
 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 { ColorJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
 import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal.js";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
@@ -601,7 +602,7 @@ export interface PageSeamless {
  */
 export interface PageCover {
     /**
-     * Whether the cover page is visible.
+     * Whether the cover page is visible. Defaults to false.
      */
     visible?: boolean;
     /**
@@ -618,7 +619,7 @@ export interface PageCover {
  */
 export interface PageOverview {
     /**
-     * Whether the overview page is visible.
+     * Whether the overview page is visible. Defaults to false.
      */
     visible?: boolean;
     /**
@@ -634,54 +635,82 @@ export interface PageOverview {
      */
     pageGraphics?: {
         /**
-         * Whether the page graphics are visible.
+         * Whether the page graphics are visible. Defaults to false.
          */
         visible?: boolean;
         /**
-         * Page stroke RGB color according to the ESRI RGB color specification.
+         * Page stroke width in pixels. Defaults to 2.
          */
-        colorStroke: number[];
+        widthStroke?: number;
         /**
-         * Page fill RGB color according to the ESRI RGB color specification.
+         * Page stroke color. Defaults to solid yellow ([255, 204, 0, 255]).
          */
-        colorFill: number[];
+        colorStroke?: ColorJson;
+        /**
+         * Page fill color. Defaults to half transparent yellow ([255, 204, 0,
+         * 50]).
+         */
+        colorFill?: ColorJson;
     };
     /**
      * Page overlap graphics settings.
      */
     pageGraphicsOverlap?: {
         /**
-         * Whether the page overlap fill graphics are visible.
+         * Whether the page overlap fill graphics are visible. Defaults to
+         * false.
          */
         visibleFill?: boolean;
         /**
-         * Page overlap fill RGB Color according to the ESRI RGB color
-         * specification.
+         * Page overlap fill color. Defaults to full transparent green ([0, 255,
+         * 0, 0]).
          */
-        colorFill?: number[];
+        colorFill?: ColorJson;
     };
     /**
      * Page graphics index settings.
      */
     pageGraphicsIndex?: {
         /**
-         * Whether the index line graphics is visible.
+         * Whether the index line graphics is visible. Defaults to false.
          */
         visibleStroke?: boolean;
         /**
-         * Whether the page number annotations are visible.
+         * Index line stroke color. Defaults to half transparent blue ([0, 0,
+         * 255, 50]).
+         */
+        colorStroke?: ColorJson;
+        /**
+         * Whether the page number annotations are visible. Defaults to true.
          */
         visibleAnnotation?: boolean;
         /**
-         * Index line stroke RGB color according to the ESRI RGB color
-         * specification.
+         * Page number annotations font size in points. Defaults to 20.
+         */
+        fontSizeAnnotation?: number;
+        /**
+         * Page number annotations color. Defaults to solid yellow ([255, 204,
+         * 0, 255]).
+         */
+        colorAnnotation?: ColorJson;
+        /**
+         * Page number annotations halo outline color. Defaults to half
+         * transparent black ([0, 0, 0, 100]).
+         */
+        haloOutlineColorAnnotation?: ColorJson;
+        /**
+         * Page number annotations halo fill color. Defaults to half transparent
+         * white ([255, 255, 255, 100]).
+         */
+        haloFillColorAnnotation?: ColorJson;
+        /**
+         * Page number annotations halo outline width in pixels. Defaults to 1.
          */
-        colorStroke?: number[];
+        haloOutlineWidthAnnotation?: number;
         /**
-         * Page number annotations RGB color according to the ESRI RGB color
-         * specification.
+         * Page number annotations halo size in pixels. Defaults to 2.
          */
-        colorAnnotation?: number[];
+        haloSizeAnnotation?: number;
     };
 }
 /**
@@ -689,7 +718,7 @@ export interface PageOverview {
  */
 export interface PageLegend {
     /**
-     * Whether the legend page is visible.
+     * Whether the legend page is visible. Defaults to false.
      */
     visible?: boolean;
     /**

package/package.json

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

package/version.js

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