@vertigis/viewer-spec 43.4.1 → 45.0.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/Operation.d.ts

@@ -1,4 +1,5 @@
 import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+import type { Event } from "./Event.js";
 import type { Message, MessageExecuteOptions } from "./Message.js";
 /**
  * A named operation. Operations compute a value, but don't generally alter the
@@ -9,6 +10,15 @@ export interface Operation<T = void, TResult = undefined> extends Message {
      * The name of the operation.
      */
     name: string;
+    /**
+     * An event that is published whenever canExecute might return a new value.
+     * Implementations are responsible for calling publish() as appropriate.
+     */
+    readonly canExecuteChanged: Event;
+    /**
+     * Indicates whether the operation has been initialized.
+     */
+    readonly isInitialized: boolean;
     /**
      * Executes the operation and returns its result.
      *
@@ -17,6 +27,18 @@ export interface Operation<T = void, TResult = undefined> extends Message {
      * behavior.
      */
     execute: (argument: T, options?: CancelToken | MessageExecuteOptions) => Promise<TResult>;
+    /**
+     * Determines whether the operation can execute with the given arguments.
+     *
+     * @param argument The operation arguments.
+     */
+    canExecute(argument?: T): boolean;
+    /**
+     * Initializes the operation if it is not already initialized. Attempting to
+     * execute an operation will automatically initialize it, however calling
+     * canExecute() will always return false until the operation is initialized.
+     */
+    initialize(): Promise<void>;
 }
 /**
  * Context that will be passed in to each behavior for an operation.

package/messaging/registry/Operations.d.ts

@@ -1,5 +1,6 @@
 import { OperationRegistry } from "../OperationRegistry.js";
 import { AppOperations } from "./app.js";
+import { ArcadeOperations } from "./arcade.js";
 import { AuthOperations } from "./auth.js";
 import { BasemapOperations } from "./basemap.js";
 import { ChartOperations } from "./charts.js";
@@ -24,6 +25,7 @@ import { TasksOperations } from "./tasks.js";
 import { UIOperations } from "./ui.js";
 import { ViewerOperations } from "./viewer.js";
 export declare class Operations extends OperationRegistry {
+    readonly arcade: ArcadeOperations;
     readonly auth: AuthOperations;
     readonly app: AppOperations;
     readonly basemap: BasemapOperations;

package/messaging/registry/Operations.js

@@ -1 +1 @@
-import{OperationRegistry}from"../OperationRegistry.js";import{AppOperations}from"./app.js";import{AuthOperations}from"./auth.js";import{BasemapOperations}from"./basemap.js";import{ChartOperations}from"./charts.js";import{DebugConsoleOperations}from"./debugConsole.js";import{DrawingOperations}from"./drawing.js";import{FileOperations}from"./file.js";import{GeocodeOperations}from"./geocode.js";import{GeolocationOperations}from"./geolocation.js";import{GeometryOperations}from"./geometry.js";import{HighlightsOperations}from"./highlights.js";import{KpiOperations}from"./kpi.js";import{LogViewerOperations}from"./logViewer.js";import{MapOperations}from"./map.js";import{MeasurementOperations}from"./measurement.js";import{MessagingOperations}from"./messaging.js";import{NetworkOperations}from"./network.js";import{OfflineOperations}from"./offline.js";import{ResultsOperations}from"./results.js";import{SketchingOperations}from"./sketching.js";import{SystemOperations}from"./system.js";import{TasksOperations}from"./tasks.js";import{UIOperations}from"./ui.js";import{ViewerOperations}from"./viewer.js";export class Operations extends OperationRegistry{constructor(){super(...arguments),this.auth=new AuthOperations(this._messages),this.app=new AppOperations(this._messages),this.basemap=new BasemapOperations(this._messages),this.charts=new ChartOperations(this._messages),this.drawing=new DrawingOperations(this._messages),this.file=new FileOperations(this._messages),this.geocode=new GeocodeOperations(this._messages),this.geolocation=new GeolocationOperations(this._messages),this.geometry=new GeometryOperations(this._messages),this.highlights=new HighlightsOperations(this._messages),this.kpi=new KpiOperations(this._messages),this.logViewer=new LogViewerOperations(this._messages),this.map=new MapOperations(this._messages),this.measurement=new MeasurementOperations(this._messages),this.messaging=new MessagingOperations(this._messages),this.network=new NetworkOperations(this._messages),this.offline=new OfflineOperations(this._messages),this.sketching=new SketchingOperations(this._messages),this.system=new SystemOperations(this._messages),this.results=new ResultsOperations(this._messages),this.tasks=new TasksOperations(this._messages),this.ui=new UIOperations(this._messages),this.viewer=new ViewerOperations(this._messages),this.debugConsole=new DebugConsoleOperations(this._messages)}}
+import{OperationRegistry}from"../OperationRegistry.js";import{AppOperations}from"./app.js";import{ArcadeOperations}from"./arcade.js";import{AuthOperations}from"./auth.js";import{BasemapOperations}from"./basemap.js";import{ChartOperations}from"./charts.js";import{DebugConsoleOperations}from"./debugConsole.js";import{DrawingOperations}from"./drawing.js";import{FileOperations}from"./file.js";import{GeocodeOperations}from"./geocode.js";import{GeolocationOperations}from"./geolocation.js";import{GeometryOperations}from"./geometry.js";import{HighlightsOperations}from"./highlights.js";import{KpiOperations}from"./kpi.js";import{LogViewerOperations}from"./logViewer.js";import{MapOperations}from"./map.js";import{MeasurementOperations}from"./measurement.js";import{MessagingOperations}from"./messaging.js";import{NetworkOperations}from"./network.js";import{OfflineOperations}from"./offline.js";import{ResultsOperations}from"./results.js";import{SketchingOperations}from"./sketching.js";import{SystemOperations}from"./system.js";import{TasksOperations}from"./tasks.js";import{UIOperations}from"./ui.js";import{ViewerOperations}from"./viewer.js";export class Operations extends OperationRegistry{constructor(){super(...arguments),this.arcade=new ArcadeOperations(this._messages),this.auth=new AuthOperations(this._messages),this.app=new AppOperations(this._messages),this.basemap=new BasemapOperations(this._messages),this.charts=new ChartOperations(this._messages),this.drawing=new DrawingOperations(this._messages),this.file=new FileOperations(this._messages),this.geocode=new GeocodeOperations(this._messages),this.geolocation=new GeolocationOperations(this._messages),this.geometry=new GeometryOperations(this._messages),this.highlights=new HighlightsOperations(this._messages),this.kpi=new KpiOperations(this._messages),this.logViewer=new LogViewerOperations(this._messages),this.map=new MapOperations(this._messages),this.measurement=new MeasurementOperations(this._messages),this.messaging=new MessagingOperations(this._messages),this.network=new NetworkOperations(this._messages),this.offline=new OfflineOperations(this._messages),this.sketching=new SketchingOperations(this._messages),this.system=new SystemOperations(this._messages),this.results=new ResultsOperations(this._messages),this.tasks=new TasksOperations(this._messages),this.ui=new UIOperations(this._messages),this.viewer=new ViewerOperations(this._messages),this.debugConsole=new DebugConsoleOperations(this._messages)}}

package/messaging/registry/arcade.d.ts

@@ -0,0 +1,100 @@
+import type { ItemRef } from "app-config/common/ItemRef.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Model } from "../common.js";
+/**
+ * The arguments for the arcade.run operation.
+ */
+export interface RunArcadeArgs {
+    /**
+     * The stringified Arcade script to run. If this property is included, the
+     * operation will return the result of the script.
+     */
+    executeScript?: string;
+    /**
+     * The stringified Arcade script used to determine whether or not the
+     * executeScript can/should be run. If no executeScript is provided and the
+     * canExecuteScript returns a truthy value, the operation will return its
+     * input arguments; otherwise, if the canEecuteScript returns a falsey
+     * value, it will throw a {@link Cancellation}.
+     */
+    canExecuteScript?: string;
+    /**
+     * An arguments object that provides named variables and associated values,
+     * which can be referenced from within the executeScript and
+     * canExecuteScript.
+     *
+     * NOTE: All variable keys must consist of only lowercase letters;
+     * camel-cased context variables will break the script when they are
+     * referenced at runtime.
+     */
+    arguments?: Record<string, unknown | ItemPropertyPath>;
+    /**
+     * Properties used to set a series of watch handles and/or event listeners
+     * on an item that will trigger the canExecuteChanged event for the
+     * 'arcade.run' operation.
+     */
+    watchHandles?: WatchEventHandleProperties[];
+}
+/**
+ * An object containing a propertyPath that used to retrieve a property value
+ * from the given item.
+ */
+export interface ItemPropertyPath {
+    /**
+     * The item from which to access a property value.
+     */
+    item: ItemRef | Model;
+    /**
+     * The path to a property on an item.
+     */
+    propertyPath: string;
+}
+export declare class ArcadeOperations extends OperationRegistry {
+    /**
+     * Runs a stringified Arcade script. If only a string is passed in as an
+     * argument, it is interpreted as an executeScript. If an executeSript is
+     * provided, the operation will return its result. If only a canExecute
+     * script is provided and it returns a truthy result, the operation will
+     * return its input arguments. If a canExecuteScript returns a falsey value,
+     * the operation will throw a {@link Cancellation}.
+     *
+     * @webOnly
+     *
+     */
+    get run(): Operation<RunArcadeArgs | string, unknown>;
+}
+/**
+ * Properties used to set a series of watch handles and/or event listeners on
+ * an item.
+ */
+export interface WatchEventHandleProperties {
+    /**
+     * The item whose properties will be watched for changes and/or events.
+     */
+    item: ItemRef | Model;
+    /**
+     * One or more properties on the item that will be watched for changes
+     * and/or events. Any strings will be used as propertyPaths that will be
+     * watched for changes; for this to work, the item and all properties
+     * referenced within the path (except for the last) must implement
+     * {@link Observable}.
+     */
+    watch: string | WatchEventProperty | (string | WatchEventProperty)[];
+}
+/**
+ * Properties on an item to watch, with an optional event name to listen for.
+ */
+export interface WatchEventProperty {
+    /**
+     * The path used to target a property on an item that will be watched for
+     * events. The watched property must implement {@link Evented}; this will
+     * effectively do `item[propertyPath].on(eventName)`.
+     */
+    propertyPath?: string;
+    /**
+     * The name of the event to listen for. If no propertyPath is included, the
+     * listener will go directly on the watched item.
+     */
+    eventName: string;
+}

package/messaging/registry/arcade.js

@@ -0,0 +1 @@
+import{OperationRegistry}from"../OperationRegistry.js";export class ArcadeOperations extends OperationRegistry{get run(){return this._messages.operation("arcade.run")}}

package/messaging/registry/geometry.d.ts

@@ -1,4 +1,7 @@
 import type Geometry from "@arcgis/core/geometry/Geometry";
+import type Point from "@arcgis/core/geometry/Point";
+import type Polygon from "@arcgis/core/geometry/Polygon";
+import type Polyline from "@arcgis/core/geometry/Polyline";
 import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
 import type GeographicTransformation from "@arcgis/core/geometry/support/GeographicTransformation";
 import type { Command } from "../Command.js";
@@ -29,6 +32,10 @@ export interface ProjectArgs {
  * The units for distance buffers supported by ArcGIS.
  */
 export declare type LengthUnits = "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards";
+/**
+ * The units for distance supported by Mobile.
+ */
+export declare type LengthUnitsMobile = LengthUnits | "millimeters" | "centimeters" | "inches" | "mm" | "cm" | "m" | "km" | "in" | "ft" | "yd" | "mi" | "nm";
 /**
  * The result of a geometry.buffer operation.
  */
@@ -42,6 +49,142 @@ export interface BufferResult {
      */
     maps?: MapsLike;
 }
+/**
+ * Arguments for the geometry.add-point operation.
+ */
+export interface AddPointArgs {
+    /**
+     * The starting geometry.
+     */
+    geometry: Polyline | Polygon;
+    /**
+     * The index of the part to which the point will be added.
+     * If null, the last part will be used.
+     */
+    partIndex?: number;
+    /**
+     * The index at which the point will be added.
+     * If null, the point will be added as the last point.
+     */
+    pointIndex?: number;
+    /**
+     * The new point to be added to 'geometry'. The spatial reference must
+     * match 'geometry' or an error will be thrown.
+     */
+    newPoint: Point;
+}
+/**
+ * Arguments for the geometry.add-part operation.
+ */
+export interface AddPartArgs {
+    /**
+     * The starting geometry.
+     */
+    geometry: Polyline | Polygon;
+    /**
+     * The new part to be added to 'geometry'.
+     */
+    part: Point[];
+}
+/**
+ * A reference line used by the geometry.get-point operation.
+ */
+export interface ReferenceLine {
+    /**
+     * The geometry that contains the reference line.
+     */
+    geometry: Polyline | Polygon;
+    /**
+     * The index of the part in 'geometry' that contains the reference line.
+     * If null, the last part will be used.
+     */
+    partIndex?: number;
+    /**
+     * The index of the segment that will be used as the reference line.
+     * If null, the last segment will be used.
+     */
+    segmentIndex?: number;
+}
+/**
+ * The different types of curves that can be used for geodetic distance
+ * calculations.
+ */
+export declare type GeodeticCurveType = "geodesic" | "loxodrome" | "normal-section" | "great-elliptic";
+/**
+ * Arguments for the geometry.calculate-point operation.
+ */
+export interface CalculatePointArgs {
+    /**
+     * The units to be used for 'distance' and 'offset'.
+     * Defaults to the default units of the map.
+     */
+    units: LengthUnitsMobile;
+    /**
+     * The reference line that will be used to calculate the new point.
+     */
+    referenceLine: ReferenceLine;
+    /**
+     * The distance that will be used to calculate the new point.
+     *
+     * If using 'offset', this indicates the distance along
+     * the reference line.
+     *
+     * If using 'angle', this indicates the distance directly
+     * from the new point to the start point of the reference line.
+     *
+     * Cannot be negative.
+     */
+    distance: number;
+    /**
+     * 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.
+     */
+    offset?: number;
+    /**
+     * The angle, relative to the angle of the reference line, that
+     * will be used to calculate the new point. Positive angles are
+     * calculated clockwise from the angle of the reference line,
+     * negative angles are calculated counter-clockwise.
+     *
+     * Exactly one of 'offset' and 'angle' must be set.
+     */
+    angle?: number;
+    /**
+     * Gets or sets a value indicating 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'.
+     */
+    geodeticCurveType: GeodeticCurveType;
+}
+/**
+ * Arguments for the geometry.remove-point operation.
+ */
+export interface RemovePointArgs {
+    /**
+     * The starting geometry.
+     */
+    geometry: Polyline | Polygon;
+    /**
+     * The index of the part from which the point will be removed.
+     * If null, the last part will be used.
+     */
+    partIndex?: number;
+    /**
+     * The index of the point to be removed.
+     * If null, the last point wil be removed.
+     */
+    pointIndex?: number;
+}
 export declare class GeometryOperations extends OperationRegistry {
     /**
      * Projects a set of geometries to a new spatial reference.
@@ -76,8 +219,39 @@ export declare class GeometryOperations extends OperationRegistry {
      * @webOnly
      */
     get getBufferUnits(): Operation<void, LengthUnits>;
+    /**
+     * Adds a point to a given geometry.
+     *
+     * @mobileOnly
+     */
+    get addPoint(): Operation<AddPointArgs, Geometry>;
+    /**
+     * Adds a part to a given geometry.
+     *
+     * @mobileOnly
+     */
+    get addPart(): Operation<AddPartArgs, Geometry>;
+    /**
+     * Calculates a point relative to a given reference line.
+     *
+     * @mobileOnly
+     */
+    get calculatePoint(): Operation<CalculatePointArgs, Point>;
+    /**
+     * Removes a point from a given geometry.
+     *
+     * @mobileOnly
+     */
+    get removePoint(): Operation<RemovePointArgs, Geometry>;
 }
 export declare class GeometryCommands extends CommandRegistry {
+    /**
+     * Display the geometry settings dialog. This allows you to configure buffer
+     * distance and buffer units.
+     *
+     * @webOnly
+     */
+    get displaySettings(): Command<HasUITarget>;
     /**
      * Sets the default buffer distance for the viewer session. The buffer
      * distance must be a number > 0.
@@ -91,11 +265,4 @@ export declare class GeometryCommands extends CommandRegistry {
      * @webOnly
      */
     get setBufferUnits(): Command<LengthUnits>;
-    /**
-     * Show the geometry settings dialog. This allows you to configure buffer
-     * distance and buffer units.
-     *
-     * @webOnly
-     */
-    get showSettings(): Command<HasUITarget>;
 }

package/messaging/registry/geometry.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class GeometryOperations extends OperationRegistry{get project(){return this._messages.operation("geometry.project")}get addPixelTolerance(){return this._messages.operation("geometry.add-pixel-tolerance")}get buffer(){return this._messages.operation("geometry.buffer")}get getBufferDistance(){return this._messages.operation("geometry.get-buffer-distance")}get getBufferUnits(){return this._messages.operation("geometry.get-buffer-units")}}export class GeometryCommands extends CommandRegistry{get setBufferDistance(){return this._messages.command("geometry.set-buffer-distance")}get setBufferUnits(){return this._messages.command("geometry.set-buffer-units")}get showSettings(){return this._messages.command("geometry.show-settings")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class GeometryOperations extends OperationRegistry{get project(){return this._messages.operation("geometry.project")}get addPixelTolerance(){return this._messages.operation("geometry.add-pixel-tolerance")}get buffer(){return this._messages.operation("geometry.buffer")}get getBufferDistance(){return this._messages.operation("geometry.get-buffer-distance")}get getBufferUnits(){return this._messages.operation("geometry.get-buffer-units")}get addPoint(){return this._messages.operation("geometry.add-point")}get addPart(){return this._messages.operation("geometry.add-part")}get calculatePoint(){return this._messages.operation("geometry.calculate-point")}get removePoint(){return this._messages.operation("geometry.remove-point")}}export class GeometryCommands extends CommandRegistry{get displaySettings(){return this._messages.command("geometry.display-settings")}get setBufferDistance(){return this._messages.command("geometry.set-buffer-distance")}get setBufferUnits(){return this._messages.command("geometry.set-buffer-units")}}

package/messaging/registry/measurement.d.ts

@@ -38,6 +38,13 @@ export interface GeometryModeArgs extends MapExtensionArgs {
 export interface CreateMeasurementGraphicsResult extends CreateGraphicsResult {
 }
 export declare class MeasurementCommands extends CommandRegistry {
+    /**
+     * Display the measurements settings dialog. This allows you to configure
+     * measurements system, area and length units.
+     *
+     * @webOnly
+     */
+    get displaySettings(): Command<HasUITarget>;
     /**
      * Sets the value of the default point, line, or polygon symbol. The symbol
      * can be configured with an instance of the Esri symbol or with the Esri
@@ -60,13 +67,6 @@ export declare class MeasurementCommands extends CommandRegistry {
      * @webOnly
      */
     get setLengthUnits(): Command<LengthMeasurementUnits | undefined>;
-    /**
-     * Show the measurements settings dialog. This allows you to configure
-     * measurements system, area and length units.
-     *
-     * @webOnly
-     */
-    get showSettings(): Command<HasUITarget>;
     /**
      * Starts drawing a measurement on the map. If a drawing has previously been
      * started and stopped it will be resumed.

package/messaging/registry/measurement.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";var GeometryMode;!function(e){e.LINE="line",e.AREA="area"}(GeometryMode||(GeometryMode={}));export class MeasurementCommands extends CommandRegistry{get setDefaultSymbol(){return this._messages.command("measurement.set-default-symbol")}get setAreaUnits(){return this._messages.command("measurement.set-area-units")}get setLengthUnits(){return this._messages.command("measurement.set-length-units")}get showSettings(){return this._messages.command("measurement.show-settings")}get start(){return this._messages.command("measurement.start")}get stop(){return this._messages.command("measurement.stop")}get clear(){return this._messages.command("measurement.clear")}get setGeometryMode(){return this._messages.command("measurement.set-geometry-mode")}}export class MeasurementOperations extends OperationRegistry{get createGraphics(){return this._messages.operation("measurement.create-graphics")}get captureGeometry(){return this._messages.operation("measurement.capture-geometry")}get getDefaultSymbol(){return this._messages.operation("measurement.get-default-symbol")}get getDefaultSymbol3D(){return this._messages.operation("measurement.get-default-symbol-3d")}get getAreaUnits(){return this._messages.operation("measurement.get-area-units")}get getLengthUnits(){return this._messages.operation("measurement.get-length-units")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";var GeometryMode;!function(e){e.LINE="line",e.AREA="area"}(GeometryMode||(GeometryMode={}));export class MeasurementCommands extends CommandRegistry{get displaySettings(){return this._messages.command("measurement.display-settings")}get setDefaultSymbol(){return this._messages.command("measurement.set-default-symbol")}get setAreaUnits(){return this._messages.command("measurement.set-area-units")}get setLengthUnits(){return this._messages.command("measurement.set-length-units")}get start(){return this._messages.command("measurement.start")}get stop(){return this._messages.command("measurement.stop")}get clear(){return this._messages.command("measurement.clear")}get setGeometryMode(){return this._messages.command("measurement.set-geometry-mode")}}export class MeasurementOperations extends OperationRegistry{get createGraphics(){return this._messages.operation("measurement.create-graphics")}get captureGeometry(){return this._messages.operation("measurement.capture-geometry")}get getDefaultSymbol(){return this._messages.operation("measurement.get-default-symbol")}get getDefaultSymbol3D(){return this._messages.operation("measurement.get-default-symbol-3d")}get getAreaUnits(){return this._messages.operation("measurement.get-area-units")}get getLengthUnits(){return this._messages.operation("measurement.get-length-units")}}

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,10 +452,12 @@ 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.
+     *
+     * Deprecated in Mobile, use geometry.add-point instead.
      */
     get addNodeToGeometry(): Operation<AddNodeToGeometryArgs, Geometry>;
     /**
@@ -461,6 +474,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 +514,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 +538,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

@@ -11124,7 +11124,7 @@
             ]
         },
         "sketching.add-node-to-geometry": {
-            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry.",
+            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry. Deprecated in Mobile, use geometry.add-point instead.",
             "enum": [
                 "sketching.add-node-to-geometry"
             ]
@@ -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"