@vertigis/viewer-spec 43.4.1 → 43.5.0

package/layout/schema/layout-web.xsd

@@ -47,6 +47,49 @@
     </complexType>
   </element>
 
+  <element name="geometry-toolbar" substitutionGroup="base:component">
+    <annotation>
+      <documentation xml:lang="en">
+        A geometry toolbar consisting of a collection of widgets and a
+        configurable toolbar that is displayed while geometry edits are being
+        performed.
+      </documentation>
+    </annotation>
+    <complexType>
+      <complexContent>
+        <extension base="base:Component">
+          <attribute name="orientation">
+            <annotation>
+              <documentation xml:lang="en">
+                Determines the orientation of the widgets and toolbar menu items.
+              </documentation>
+            </annotation>
+            <simpleType>
+              <restriction base="string">
+                <enumeration value="vertical"/>
+                <enumeration value="horizontal"/>
+              </restriction>
+            </simpleType>
+          </attribute>
+          <attribute name="size">
+            <annotation>
+              <documentation xml:lang="en">
+                The size of the geometry toolbar.
+              </documentation>
+            </annotation>
+            <simpleType>
+              <restriction base="string">
+                <enumeration value="small"/>
+                <enumeration value="medium"/>
+                <enumeration value="large"/>
+              </restriction>
+            </simpleType>
+          </attribute>
+        </extension>
+      </complexContent>
+    </complexType>
+  </element>
+
   <element name="inline" substitutionGroup="base:component">
     <annotation>
       <documentation xml:lang="en">

package/messaging/registry/sketching.d.ts

@@ -27,6 +27,7 @@ import { CommandRegistry } from "../CommandRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
 import type { FeaturesLike, GeometryLike, GraphicsLike, HasMaps, MapsLike } from "../common.js";
+import type { EditSymbolResult } from "./drawing.js";
 import type { LengthUnits } from "./geometry.js";
 /**
  * A representation of a 2D vector or point.
@@ -201,11 +202,15 @@ export interface GeometryOperationBase {
 export interface EditGeometryArgs extends GeometryOperationBase {
     /**
      * The options for this edit operation. Not supported in Mobile.
+     *
+     * @webOnly
      */
     options?: EditGeometryOptions;
 }
 /**
  * Options for the "sketching.edit-geometry operation.
+ *
+ * @webOnly
  */
 export interface EditGeometryOptions {
     /**
@@ -400,6 +405,12 @@ export declare class SketchingOperations extends OperationRegistry {
      * geometry that was drawn, along with the map that it was drawn on.
      */
     get captureGeometry(): Operation<CaptureGeometryArgs, CaptureGeometryResult>;
+    /**
+     * Allows the user to edit the symbology used by the graphics actively being edited.
+     *
+     * @webOnly
+     */
+    get editActiveSymbol(): Operation<void, EditSymbolResult | undefined>;
     /**
      * Allows the user to edit an existing geometry by drawing on a map. Returns
      * the geometry that was edited, or the supplied feature with the altered
@@ -441,7 +452,7 @@ export declare class SketchingOperations extends OperationRegistry {
      * geometry. If validateGeometry parameter is true and geometry is invalid,
      * returns null.
      */
-    get stop(): Operation<StopGeometryEditArgs, CaptureGeometryResult>;
+    get stop(): Operation<StopGeometryEditArgs | void, CaptureGeometryResult>;
     /**
      * Adds a point to a given polyline or polygon geometry. Returns the
      * resulting geometry.
@@ -461,6 +472,12 @@ export declare class SketchingOperations extends OperationRegistry {
     get getActiveNode(): Operation<ItemRef, GetActiveSketchResult>;
 }
 export declare class SketchingCommands extends CommandRegistry {
+    /**
+     * Cancels the current geometry edit or capture operation.
+     *
+     * @webOnly
+     */
+    get cancel(): Command<void>;
     /**
      * Undoes the last edit while editing a geometry.
      */
@@ -495,9 +512,10 @@ export declare class SketchingCommands extends CommandRegistry {
      */
     get setPointAtCurrentLocation(): Command<HasMaps>;
     /**
-     * Deletes a point or the entire geometry, depending on which is selected
-     * while editing a geometry. If a point is specified in the arguments, it
-     * will be deleted (Web only).
+     * If a point is supplied while a sketching or editing operation is active,
+     * the vertex at that point will be deleted from the current geometry. If no
+     * point is supplied and a geometry editing session is active, the entire
+     * geometry will be deleted.
      */
     get delete(): Command<DeleteGeometryArgs>;
     /**
@@ -518,4 +536,28 @@ export declare class SketchingCommands extends CommandRegistry {
      * @mobileOnly
      */
     get setInteractionMode(): Command<SetInteractionModeArgs>;
+    /**
+     * Enables free scaling while editing geometries.
+     *
+     * @webOnly
+     */
+    get enableFreeScaleMode(): Command<void>;
+    /**
+     * Disables free scaling while editing geometries.
+     *
+     * @webOnly
+     */
+    get disableFreeScaleMode(): Command<void>;
+    /**
+     * Enables more precise inputs while editing geometries.
+     *
+     * @webOnly
+     */
+    get enablePrecisionMode(): Command<void>;
+    /**
+     * Disables more precise inputs while editing geometries.
+     *
+     * @webOnly
+     */
+    get disablePrecisionMode(): Command<void>;
 }

package/messaging/registry/sketching.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var SketchTool;!function(e){e.POINT="point",e.MULTIPOINT="multipoint",e.LINE="line",e.POLYLINE="polyline",e.POLYGON="polygon",e.EXTENT="extent",e.SQUARE="square",e.CIRCLE="circle"}(SketchTool||(SketchTool={}));export class SketchingOperations extends OperationRegistry{get captureGeometry(){return this._messages.operation("sketching.capture-geometry")}get editGeometry(){return this._messages.operation("sketching.edit-geometry")}get moveGeometry(){return this._messages.operation("sketching.move-geometry")}get scaleGeometry(){return this._messages.operation("sketching.scale-geometry")}get rotateGeometry(){return this._messages.operation("sketching.rotate-geometry")}get stop(){return this._messages.operation("sketching.stop")}get addNodeToGeometry(){return this._messages.operation("sketching.add-node-to-geometry")}get getActiveSketch(){return this._messages.operation("sketching.get-active-sketch")}get getActiveNode(){return this._messages.operation("sketching.get-active-node")}}export class SketchingCommands extends CommandRegistry{get undo(){return this._messages.command("sketching.undo")}get redo(){return this._messages.command("sketching.redo")}get setGeometryMode(){return this._messages.command("sketching.set-geometry-mode")}get addPointAtCenter(){return this._messages.command("sketching.add-point-at-center")}get addPointAtCurrentLocation(){return this._messages.command("sketching.add-point-at-current-location")}get setPointAtCurrentLocation(){return this._messages.command("sketching.set-point-at-current-location")}get delete(){return this._messages.command("sketching.delete")}get moveNode(){return this._messages.command("sketching.move-node")}get switchActiveNode(){return this._messages.command("sketching.switch-active-node")}get setInteractionMode(){return this._messages.command("sketching.set-interaction-mode")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var SketchTool;!function(e){e.POINT="point",e.MULTIPOINT="multipoint",e.LINE="line",e.POLYLINE="polyline",e.POLYGON="polygon",e.EXTENT="extent",e.SQUARE="square",e.CIRCLE="circle"}(SketchTool||(SketchTool={}));export class SketchingOperations extends OperationRegistry{get captureGeometry(){return this._messages.operation("sketching.capture-geometry")}get editActiveSymbol(){return this._messages.operation("sketching.edit-active-symbol")}get editGeometry(){return this._messages.operation("sketching.edit-geometry")}get moveGeometry(){return this._messages.operation("sketching.move-geometry")}get scaleGeometry(){return this._messages.operation("sketching.scale-geometry")}get rotateGeometry(){return this._messages.operation("sketching.rotate-geometry")}get stop(){return this._messages.operation("sketching.stop")}get addNodeToGeometry(){return this._messages.operation("sketching.add-node-to-geometry")}get getActiveSketch(){return this._messages.operation("sketching.get-active-sketch")}get getActiveNode(){return this._messages.operation("sketching.get-active-node")}}export class SketchingCommands extends CommandRegistry{get cancel(){return this._messages.command("sketching.cancel")}get undo(){return this._messages.command("sketching.undo")}get redo(){return this._messages.command("sketching.redo")}get setGeometryMode(){return this._messages.command("sketching.set-geometry-mode")}get addPointAtCenter(){return this._messages.command("sketching.add-point-at-center")}get addPointAtCurrentLocation(){return this._messages.command("sketching.add-point-at-current-location")}get setPointAtCurrentLocation(){return this._messages.command("sketching.set-point-at-current-location")}get delete(){return this._messages.command("sketching.delete")}get moveNode(){return this._messages.command("sketching.move-node")}get switchActiveNode(){return this._messages.command("sketching.switch-active-node")}get setInteractionMode(){return this._messages.command("sketching.set-interaction-mode")}get enableFreeScaleMode(){return this._messages.command("sketching.enable-free-scale-mode")}get disableFreeScaleMode(){return this._messages.command("sketching.disable-free-scale-mode")}get enablePrecisionMode(){return this._messages.command("sketching.enable-precision-mode")}get disablePrecisionMode(){return this._messages.command("sketching.disable-precision-mode")}}

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

@@ -11148,7 +11148,7 @@
             "$ref": "#/definitions/CaptureGeometryResult"
         },
         "sketching.delete": {
-            "description": "Deletes a point or the entire geometry, depending on which is selected while editing a geometry. If a point is specified in the arguments, it will be deleted (Web only).",
+            "description": "If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied and a geometry editing session is active, the entire geometry will be deleted.",
             "enum": [
                 "sketching.delete"
             ]
@@ -11193,7 +11193,14 @@
             ]
         },
         "sketching.stop:input": {
-            "$ref": "#/definitions/StopGeometryEditArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/StopGeometryEditArgs"
+                },
+                {
+                    "type": "null"
+                }
+            ]
         },
         "sketching.stop:output": {
             "$ref": "#/definitions/CaptureGeometryResult"

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

@@ -12735,7 +12735,7 @@
             "$ref": "#/definitions/CaptureGeometryResult"
         },
         "sketching.delete": {
-            "description": "Deletes a point or the entire geometry, depending on which is selected while editing a geometry. If a point is specified in the arguments, it will be deleted (Web only).",
+            "description": "If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied and a geometry editing session is active, the entire geometry will be deleted.",
             "enum": [
                 "sketching.delete"
             ]
@@ -12798,7 +12798,14 @@
             ]
         },
         "sketching.stop:input": {
-            "$ref": "#/definitions/StopGeometryEditArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/StopGeometryEditArgs"
+                },
+                {
+                    "type": "null"
+                }
+            ]
         },
         "sketching.stop:output": {
             "$ref": "#/definitions/CaptureGeometryResult"

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

@@ -16554,6 +16554,12 @@
         "sketching.add-node-to-geometry:output": {
             "$ref": "#/definitions/esri.Geometry"
         },
+        "sketching.cancel": {
+            "description": "Cancels the current geometry edit or capture operation.",
+            "enum": [
+                "sketching.cancel"
+            ]
+        },
         "sketching.capture-geometry": {
             "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.",
             "enum": [
@@ -16567,7 +16573,7 @@
             "$ref": "#/definitions/CaptureGeometryResult"
         },
         "sketching.delete": {
-            "description": "Deletes a point or the entire geometry, depending on which is selected while editing a geometry. If a point is specified in the arguments, it will be deleted (Web only).",
+            "description": "If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied and a geometry editing session is active, the entire geometry will be deleted.",
             "enum": [
                 "sketching.delete"
             ]
@@ -16575,6 +16581,27 @@
         "sketching.delete:input": {
             "$ref": "#/definitions/DeleteGeometryArgs"
         },
+        "sketching.disable-free-scale-mode": {
+            "description": "Disables free scaling while editing geometries.",
+            "enum": [
+                "sketching.disable-free-scale-mode"
+            ]
+        },
+        "sketching.disable-precision-mode": {
+            "description": "Disables more precise inputs while editing geometries.",
+            "enum": [
+                "sketching.disable-precision-mode"
+            ]
+        },
+        "sketching.edit-active-symbol": {
+            "description": "Allows the user to edit the symbology used by the graphics actively being edited.",
+            "enum": [
+                "sketching.edit-active-symbol"
+            ]
+        },
+        "sketching.edit-active-symbol:output": {
+            "$ref": "#/definitions/EditSymbolResult"
+        },
         "sketching.edit-geometry": {
             "description": "Allows the user to edit an existing geometry by drawing on a map. Returns the geometry that was edited, or the supplied feature with the altered geometry applied, along with the map that it was drawn on.",
             "enum": [
@@ -16587,6 +16614,18 @@
         "sketching.edit-geometry:output": {
             "$ref": "#/definitions/EditGeometryResult"
         },
+        "sketching.enable-free-scale-mode": {
+            "description": "Enables free scaling while editing geometries.",
+            "enum": [
+                "sketching.enable-free-scale-mode"
+            ]
+        },
+        "sketching.enable-precision-mode": {
+            "description": "Enables more precise inputs while editing geometries.",
+            "enum": [
+                "sketching.enable-precision-mode"
+            ]
+        },
         "sketching.get-active-node": {
             "description": "Returns the active point graphic of the active sketch on a map.",
             "enum": [
@@ -16678,7 +16717,14 @@
             ]
         },
         "sketching.stop:input": {
-            "$ref": "#/definitions/StopGeometryEditArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/StopGeometryEditArgs"
+                },
+                {
+                    "type": "null"
+                }
+            ]
         },
         "sketching.stop:output": {
             "$ref": "#/definitions/CaptureGeometryResult"
@@ -19144,9 +19190,24 @@
                 {
                     "$ref": "#/definitions/search.clear"
                 },
+                {
+                    "$ref": "#/definitions/sketching.cancel"
+                },
                 {
                     "$ref": "#/definitions/sketching.delete"
                 },
+                {
+                    "$ref": "#/definitions/sketching.disable-free-scale-mode"
+                },
+                {
+                    "$ref": "#/definitions/sketching.disable-precision-mode"
+                },
+                {
+                    "$ref": "#/definitions/sketching.enable-free-scale-mode"
+                },
+                {
+                    "$ref": "#/definitions/sketching.enable-precision-mode"
+                },
                 {
                     "$ref": "#/definitions/sketching.move-node"
                 },
@@ -20206,6 +20267,9 @@
                 {
                     "$ref": "#/definitions/sketching.capture-geometry"
                 },
+                {
+                    "$ref": "#/definitions/sketching.edit-active-symbol"
+                },
                 {
                     "$ref": "#/definitions/sketching.edit-geometry"
                 },

package/package.json

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

package/version.js

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