@vertigis/viewer-spec 50.3.0 → 50.4.0

package/messaging/registry/geolocation.d.ts

@@ -157,14 +157,14 @@ export interface GetTransformationArgs {
      */
     inputSpatialReference?: SpatialReference;
     /**
-     * Gets or sets the desired output spatial reference of the transformations.
-     * For example, the spatial reference of the map. If unspecified, the
-     * spatial reference of the first available map will be used.
+     * The desired output spatial reference of the transformations. For example,
+     * the spatial reference of the map. If unspecified, the spatial reference
+     * of the first available map will be used.
      */
     outputSpatialReference?: SpatialReference;
     /**
-     * Gets or sets the area of interest. If provided, this will be used to
-     * order the list of valid transformations in order of best-fit.
+     * The area of interest. If provided, this will be used to order the list of
+     * valid transformations in order of best-fit.
      */
     area?: Geometry;
 }

package/messaging/registry/geometry.d.ts

@@ -152,13 +152,12 @@ export interface CalculatePointArgs {
      */
     angle?: number;
     /**
-     * Gets or sets a value indicating whether the distance calculations will be
-     * geodetic or planar. Defaults to true.
+     * Whether the distance calculations will be geodetic or planar. Defaults to true.
      */
     geodetic?: boolean;
     /**
-     * Gets or sets the geodetic curve type used when calculating the new point.
-     * Only applies when 'geodetic' is true. Defaults to 'geodesic'.
+     * The geodetic curve type used when calculating the new point. Only applies
+     * when 'geodetic' is true. Defaults to 'geodesic'.
      */
     geodeticCurveType: GeodeticCurveType;
 }

package/messaging/registry/map.d.ts

@@ -595,8 +595,8 @@ export interface StartSketchArgs {
      */
     bufferSize: number;
     /**
-     * A value indicating whether the previous geometry editor settings should
-     * be restored after this sketch is stopped.
+     * Whether the previous geometry editor settings should be restored after
+     * this sketch is stopped.
      */
     retainEditorSettings: boolean;
     /**

package/messaging/registry/offline.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="dotnet-bcl" />
+import type Geometry from "@arcgis/core/geometry/Geometry.js";
 import type FeatureLayer from "@arcgis/core/layers/FeatureLayer";
 import type Layer from "@arcgis/core/layers/Layer";
 import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
@@ -113,11 +114,35 @@ export interface OfflineAreaBase {
 export interface CustomOfflineArea {
 }
 /**
- * Corresponds to
- * `VertiGIS.Mobile.Infrastructure.Offline.CustomOfflineAreaDetails` in the
- * VertiGIS.Mobile SDK.
+ * Defines the details for the creation of a custom offline map area.
  */
 export interface CustomOfflineAreaDetails {
+    /**
+     * The geometry defining this map area.
+     */
+    areaOfInterest: Geometry;
+    /**
+     * The minimum scale for the map.
+     */
+    minScale: number;
+    /**
+     * The maximum scale for the map.
+     */
+    maxScale: number;
+    /**
+     * Whether to include feature attachments when downloading this map area.
+     * Defaults to false.
+     */
+    includeAttachments?: boolean;
+    /**
+     * The name of a tile package to use as a basemap.
+     */
+    basemapTilePackage?: string;
+    /**
+     * Whether feature layer definition expressions are used when taking feature
+     * layers and tables offline. Defaults to false.
+     */
+    isDefinitionExpressionFilterEnabled?: boolean;
 }
 /**
  * Corresponds to `VertiGIS.Mobile.Infrastructure.Offline.OfflineAreaStatus` in
@@ -156,7 +181,7 @@ export interface LayerEdits {
  */
 export interface OfflineOperationResult {
     /**
-     * A value indicating whether or not the operation was successful.
+     * Whether or not the operation was successful.
      */
     success: boolean;
     /**

package/messaging/registry/sketching.d.ts

@@ -533,11 +533,11 @@ export declare type EditorInteractionMode = "centerCrosshairMode" | "pointerMode
  */
 export interface GeometryEditorSettings {
     /**
-     * A value indicating whether snapping should be enabled.
+     * Whether snapping should be enabled.
      */
     snappingEnabled?: boolean;
     /**
-     * A value indicating whether bearing labels should be shown on the map.
+     * Whether bearing labels should be shown on the map.
      */
     showBearings?: boolean;
     /**
@@ -549,16 +549,15 @@ export interface GeometryEditorSettings {
      */
     editorInteractionMode?: EditorInteractionMode;
     /**
-     * A value indicating whether the sketch is using freehand or segment sketching.
+     * Whether the sketch is using freehand or segment sketching.
      */
     freehand?: boolean;
     /**
-     * A value indicating whether the sketch should stop when double clicking.
+     * Whether the sketch should stop when double clicking.
      */
     finishOnDoubleClick?: boolean;
     /**
-     * A value indicating whether the sketch should commit its geometry if
-     * another sketch is activated.
+     * Whether the sketch should commit its geometry if another sketch is activated.
      */
     finishIfInterrupted?: boolean;
 }

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

@@ -1411,23 +1411,23 @@
                     "description": "The editor interaction mode."
                 },
                 "finishIfInterrupted": {
-                    "description": "A value indicating whether the sketch should commit its geometry if another sketch is activated.",
+                    "description": "Whether the sketch should commit its geometry if another sketch is activated.",
                     "type": "boolean"
                 },
                 "finishOnDoubleClick": {
-                    "description": "A value indicating whether the sketch should stop when double clicking.",
+                    "description": "Whether the sketch should stop when double clicking.",
                     "type": "boolean"
                 },
                 "freehand": {
-                    "description": "A value indicating whether the sketch is using freehand or segment sketching.",
+                    "description": "Whether the sketch is using freehand or segment sketching.",
                     "type": "boolean"
                 },
                 "showBearings": {
-                    "description": "A value indicating whether bearing labels should be shown on the map.",
+                    "description": "Whether bearing labels should be shown on the map.",
                     "type": "boolean"
                 },
                 "snappingEnabled": {
-                    "description": "A value indicating whether snapping should be enabled.",
+                    "description": "Whether snapping should be enabled.",
                     "type": "boolean"
                 }
             },

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

@@ -674,12 +674,12 @@
                     "type": "number"
                 },
                 "geodetic": {
-                    "description": "Gets or sets a value indicating whether the distance calculations will be geodetic or planar. Defaults to true.",
+                    "description": "Whether the distance calculations will be geodetic or planar. Defaults to true.",
                     "type": "boolean"
                 },
                 "geodeticCurveType": {
                     "$ref": "#/definitions/GeodeticCurveType",
-                    "description": "Gets or sets the geodetic curve type used when calculating the new point. Only applies when 'geodetic' is true. Defaults to 'geodesic'."
+                    "description": "The geodetic curve type used when calculating the new point. Only applies when 'geodetic' is true. Defaults to 'geodesic'."
                 },
                 "offset": {
                     "description": "The offset that will be used to calculate the new point. The 'offset' corresponds to the distance perpendicularly away from the reference line. Positive values will result in a point to the right of the reference line, negative values will be to the left. Exactly one of 'offset' and 'angle' must be set.",
@@ -945,6 +945,42 @@
             ],
             "type": "object"
         },
+        "CustomOfflineAreaDetails": {
+            "additionalProperties": false,
+            "description": "Defines the details for the creation of a custom offline map area.",
+            "properties": {
+                "areaOfInterest": {
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "The geometry defining this map area."
+                },
+                "basemapTilePackage": {
+                    "description": "The name of a tile package to use as a basemap.",
+                    "type": "string"
+                },
+                "includeAttachments": {
+                    "description": "Whether to include feature attachments when downloading this map area. Defaults to false.",
+                    "type": "boolean"
+                },
+                "isDefinitionExpressionFilterEnabled": {
+                    "description": "Whether feature layer definition expressions are used when taking feature layers and tables offline. Defaults to false.",
+                    "type": "boolean"
+                },
+                "maxScale": {
+                    "description": "The maximum scale for the map.",
+                    "type": "number"
+                },
+                "minScale": {
+                    "description": "The minimum scale for the map.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "areaOfInterest",
+                "maxScale",
+                "minScale"
+            ],
+            "type": "object"
+        },
         "DeleteAttachmentArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"edit.delete-attachment\" command.",
@@ -1686,23 +1722,23 @@
                     "description": "The editor interaction mode."
                 },
                 "finishIfInterrupted": {
-                    "description": "A value indicating whether the sketch should commit its geometry if another sketch is activated.",
+                    "description": "Whether the sketch should commit its geometry if another sketch is activated.",
                     "type": "boolean"
                 },
                 "finishOnDoubleClick": {
-                    "description": "A value indicating whether the sketch should stop when double clicking.",
+                    "description": "Whether the sketch should stop when double clicking.",
                     "type": "boolean"
                 },
                 "freehand": {
-                    "description": "A value indicating whether the sketch is using freehand or segment sketching.",
+                    "description": "Whether the sketch is using freehand or segment sketching.",
                     "type": "boolean"
                 },
                 "showBearings": {
-                    "description": "A value indicating whether bearing labels should be shown on the map.",
+                    "description": "Whether bearing labels should be shown on the map.",
                     "type": "boolean"
                 },
                 "snappingEnabled": {
-                    "description": "A value indicating whether snapping should be enabled.",
+                    "description": "Whether snapping should be enabled.",
                     "type": "boolean"
                 }
             },
@@ -1848,7 +1884,7 @@
             "properties": {
                 "area": {
                     "$ref": "#/definitions/esri.Geometry",
-                    "description": "Gets or sets the area of interest. If provided, this will be used to order the list of valid transformations in order of best-fit."
+                    "description": "The area of interest. If provided, this will be used to order the list of valid transformations in order of best-fit."
                 },
                 "inputSpatialReference": {
                     "$ref": "#/definitions/esri.rest-api.SpatialReference.SpatialReference",
@@ -1856,7 +1892,7 @@
                 },
                 "outputSpatialReference": {
                     "$ref": "#/definitions/esri.rest-api.SpatialReference.SpatialReference",
-                    "description": "Gets or sets the desired output spatial reference of the transformations. For example, the spatial reference of the map. If unspecified, the spatial reference of the first available map will be used."
+                    "description": "The desired output spatial reference of the transformations. For example, the spatial reference of the map. If unspecified, the spatial reference of the first available map will be used."
                 }
             },
             "type": "object"
@@ -2351,7 +2387,7 @@
                     "type": "string"
                 },
                 "success": {
-                    "description": "A value indicating whether or not the operation was successful.",
+                    "description": "Whether or not the operation was successful.",
                     "type": "boolean"
                 },
                 "syncLayerErrors": {
@@ -3075,7 +3111,7 @@
                     "type": "string"
                 },
                 "retainEditorSettings": {
-                    "description": "A value indicating whether the previous geometry editor settings should be restored after this sketch is stopped.",
+                    "description": "Whether the previous geometry editor settings should be restored after this sketch is stopped.",
                     "type": "boolean"
                 },
                 "symbol": {

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

@@ -2674,23 +2674,23 @@
                     "description": "The editor interaction mode."
                 },
                 "finishIfInterrupted": {
-                    "description": "A value indicating whether the sketch should commit its geometry if another sketch is activated.",
+                    "description": "Whether the sketch should commit its geometry if another sketch is activated.",
                     "type": "boolean"
                 },
                 "finishOnDoubleClick": {
-                    "description": "A value indicating whether the sketch should stop when double clicking.",
+                    "description": "Whether the sketch should stop when double clicking.",
                     "type": "boolean"
                 },
                 "freehand": {
-                    "description": "A value indicating whether the sketch is using freehand or segment sketching.",
+                    "description": "Whether the sketch is using freehand or segment sketching.",
                     "type": "boolean"
                 },
                 "showBearings": {
-                    "description": "A value indicating whether bearing labels should be shown on the map.",
+                    "description": "Whether bearing labels should be shown on the map.",
                     "type": "boolean"
                 },
                 "snappingEnabled": {
-                    "description": "A value indicating whether snapping should be enabled.",
+                    "description": "Whether snapping should be enabled.",
                     "type": "boolean"
                 }
             },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "50.3.0",
+  "version": "50.4.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 Geocortex Viewer Specification.
  */
-export declare const version = "50.3.0";
+export declare const version = "50.4.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export const version = "50.3.0";
+export const version = "50.4.0";