@vertigis/viewer-spec 45.1.0 → 46.1.0

package/messaging/registry/sketching.d.ts

@@ -21,16 +21,15 @@ import type { SimpleFillSymbol as SimpleFillSymbolProperties } from "@vertigis/a
 import type { SimpleLineSymbol as SimpleLineSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleLineSymbol";
 import type { SimpleMarkerSymbol as SimpleMarkerSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleMarkerSymbol";
 import type { Symbol as SymbolJson } from "@vertigis/arcgis-extensions/portal/Symbol";
-import type { ItemRef } from "../../app-config/common/ItemRef.js";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { FeaturesLike, GeometryLike, GraphicsLike, HasMaps, MapsLike } from "../common.js";
+import type { FeaturesLike, GeometryLike, GraphicsLike, HasMaps, Maps, MapsLike } from "../common.js";
 import type { EditSymbolResult } from "./drawing.js";
-import type { LengthUnits } from "./geometry.js";
+import type { GeodeticCurveType, LengthUnits, LengthUnitsMobile, ReferenceLine } from "./geometry.js";
 /**
  * A representation of a 2D vector or point.
  */
@@ -101,7 +100,9 @@ export declare enum SketchTool {
  */
 export declare type AddNodeOrder = "add-after-active" | "add-before-active";
 /**
- * The arguments for the "sketching.move-node" command.
+ * Deprecated - use "sketching.move-point" with {@link MovePointArgs}.
+ *
+ * @deprecated
  */
 export interface MoveNodeArgs extends HasMaps {
     /**
@@ -115,7 +116,53 @@ export interface MoveNodeArgs extends HasMaps {
     position: Geometry;
 }
 /**
- * The arguments for the "sketching.switch-active-node" command.
+ * The arguments for the "sketching.move-point" command.
+ */
+export interface MovePointArgs extends HasMaps {
+    /**
+     * The point to move, which must already exist within the active sketch. If
+     * this property is undefined and no geometry and pointIndex are specified,
+     * the active point(s) will be moved.
+     */
+    point?: Point;
+    /**
+     * The geometry where the point exists, if multiple are present in an active
+     * editing session. This property is required if pointIndex and/or partIndex
+     * are defined.
+     */
+    geometry?: Geometry;
+    /**
+     * The index of the point. If this property is defined, the 'geometry'
+     * property must also be defined.
+     */
+    pointIndex?: number;
+    /**
+     * The part of the geometry where the point exists. Required for polyline
+     * and polygon geometry types when the geometry and pointIndex properties
+     * are defined.
+     */
+    partIndex?: number;
+    /**
+     * The new point that will replace the target point within an active sketch
+     * or edit geometry. If this property is defined, the distance property
+     * will be ignored.
+     */
+    newPoint?: Point;
+    /**
+     * An amount to move the point(s) on the X and Y axes. If the newPoint
+     * property is defined, this property will be ignored.
+     */
+    distance?: Vector2D;
+    /**
+     * The units of the above distance. Optional, will default to the units used
+     * by the measurement service associated with the map.
+     */
+    units?: LengthUnits;
+}
+/**
+ * Deprecated - use "sketching.set-active-points" with {@link SetActivePointsArgs}.
+ *
+ * @deprecated
  */
 export interface SwitchActiveNodeArgs extends HasMaps {
     /**
@@ -123,6 +170,34 @@ export interface SwitchActiveNodeArgs extends HasMaps {
      */
     node: Point;
 }
+/**
+ * The arguments for the "sketching.set-active-points" command.
+ */
+export interface SetActivePointsArgs extends HasMaps {
+    /**
+     * The new point(s) that will become active in the sketch or editing
+     * session. Sketching only supports one active point; if multiple are
+     * specified, then only the first will be set as active.
+     */
+    points?: Point | Point[];
+    /**
+     * The geometry where the new active point exists, if multiple are present
+     * in an active editing session. This property is required if pointIndex
+     * and/or partIndex are defined.
+     */
+    geometry?: Geometry;
+    /**
+     * The index of the new active point. If this property is defined, the
+     * geometry property must be defined.
+     */
+    pointIndex?: number;
+    /**
+     * The part of the geometry where the new active point exists. Required for
+     * polyline and polygon geometry types when the geometry and pointIndex
+     * properties are defined.
+     */
+    partIndex?: number;
+}
 /**
  * Arguments for the "sketching.capture-geometry" operation.
  */
@@ -147,6 +222,11 @@ export interface CaptureGeometryArgs {
      * Mobile.
      */
     symbol?: SymbolJson | SymbolSet;
+    /**
+     * The maximum number of segments permitted for a polyline or polygon
+     * sketch. Default is no limit. Mobile only.
+     */
+    maxSegments?: number;
 }
 /**
  * Result of the "sketching.capture-geometry" operation.
@@ -232,12 +312,23 @@ export interface EditGeometryOptions {
      * Defaults to true.
      */
     enableScaleModeToggle?: boolean;
+    /**
+     * Whether to allow the user to add, move, and remove vertices from a
+     * geometry. Defaults to true.
+     */
+    enableVertexEditing?: boolean;
     /**
      * Setting "free" allows independent scaling on the x and y axis,
      * "preserve-aspect-ratio" constrains scaling to the original aspect ratio.
      * Defaults to "preserve-aspect-ratio".
      */
     scaleMode?: "free" | "preserve-aspect-ratio";
+    /**
+     * Whether the resulting geometry is validated before it's returned from the
+     * operation. If the geometry is invalid upon completion, an error is
+     * thrown. Defaults to true.
+     */
+    validateGeometry?: boolean;
     /**
      * Where to anchor the geometry when performing a free scale operation.
      * Defaults to "center".
@@ -302,7 +393,49 @@ export interface StopGeometryEditArgs {
     validateGeometry?: boolean;
 }
 /**
- * Arguments for the "sketching.add-node-to-geometry" operation.
+ * Arguments for the "sketching.add-point" command.
+ */
+export interface AddPointArgs extends HasMaps {
+    /**
+     * The new point to be added.
+     */
+    newPoint: Point;
+    /**
+     * The geometry to add the point to, if multiple are present in an active
+     * editing session. Not supported by Mobile.
+     */
+    geometry?: Geometry;
+}
+/**
+ * Arguments for the "sketching.insert-point" command.
+ */
+export interface InsertPointArgs extends HasMaps {
+    /**
+     * 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.
+     */
+    newPoint: Point;
+    /**
+     * The geometry to add the point to, if multiple are present in an active
+     * editing session. Not supported by Mobile.
+     */
+    geometry?: Geometry;
+}
+/**
+ * Deprecated - Mobile users should rather use "geometry.add-point"; Web users
+ * should use "sketching.add-point" with {@link AddPointArgs} or
+ * "sketching.insert-point" with {@link InsertPointArgs} instead.
+ *
+ * @deprecated
  */
 export interface AddNodeToGeometryArgs extends HasMaps {
     /**
@@ -333,10 +466,28 @@ export interface AddNodeToGeometryArgs extends HasMaps {
  */
 export interface DeleteGeometryArgs extends HasMaps {
     /**
-     * The point to delete from the active sketch. Not supported in Geocortex
-     * Mobile.
+     * The point to remove from the geometry. If this property is defined, the
+     * 'pointIndex' and 'partIndex' properties are ignored. If no point nor
+     * pointIndex/partIndex are specified, any active points will be deleted. If
+     * there are no active points, the entire geometry will be deleted.
+     */
+    point?: Point;
+    /**
+     * The geometry to remove a point from. If this property is not specified,
+     * any active vertices will be deleted.
+     */
+    geometry?: Geometry;
+    /**
+     * The index of the point that should be removed from the geometry. If this
+     * property is defined, the geometry property must also be defined.
+     */
+    pointIndex?: number;
+    /**
+     * The index of the part of the geometry that the point should be removed
+     * from. Required for polyline and polygon geometry types when the geometry
+     * and pointIndex properties are defined.
      */
-    geometry?: Point;
+    partIndex?: number;
 }
 /**
  * Arguments for the "sketching.set-geometry-mode" command.
@@ -397,8 +548,12 @@ export interface GeometryEditorSettings {
     editorInteractionMode?: EditorInteractionMode;
 }
 /**
- * Result returned from the 'sketching.get-active-sketch' and
- * 'sketching.get-active-node' operations.
+ * Result returned from the 'sketching.get-active-points' operation.
+ */
+export interface GetActivePointsResult extends GetActiveSketchResult {
+}
+/**
+ * Result returned from the 'sketching.get-active-sketch' operation.
  */
 export interface GetActiveSketchResult {
     /**
@@ -410,6 +565,84 @@ export interface GetActiveSketchResult {
      */
     maps: MapExtension;
 }
+/**
+ * Specifies if a desired point comes before or after a given reference point.
+ */
+export declare type PointOffset = "before" | "after";
+/**
+ * Arguments for the 'sketching.get-adjacent-point' operation.
+ */
+export interface GetAdjacentPointArgs extends HasMaps {
+    /**
+     * A point geometry that represents a vertex within an active editing
+     * graphic.
+     */
+    referencePoint: Point;
+    /**
+     * Specifies if the desired point comes before or after the referencePoint.
+     * Defaults to 'after'.
+     */
+    relativeOffset?: PointOffset;
+}
+/**
+ * Arguments for the "sketching.set-constraints" command.
+ */
+export interface SetConstraintsArgs extends HasMaps {
+    /**
+     * The constraint for the length of the line between the selected vertex and
+     * the new point.
+     */
+    length?: number;
+    /**
+     * The constraint for the angle of the line between the selected vertex and
+     * the new point, relative to the reference line. Remains unchanged until
+     * set to a different value, or cleared.
+     */
+    angle?: number;
+    /**
+     * A reference line that the angle will be relative to. Defaults to 'north'.
+     * Remains unchanged until set again.
+     */
+    referenceLine?: ReferenceLine;
+    /**
+     * Indicates whether constraints will be automatically cleared after a
+     * vertex is added or updated. If not set (value is null), then the value
+     * will remain unchanged with this operation. If the value has never been
+     * set, the default is false. Remains unchanged until set to a different
+     * value.
+     */
+    autoClear?: boolean;
+    /**
+     * The units to be used for length. If not specified, the units of the map's
+     * spatial reference will be used.
+     */
+    units?: LengthUnitsMobile;
+    /**
+     * Indicates whether the distance calculations will be geodetic or planar.
+     * Default is true.
+     */
+    geodetic?: boolean;
+    /**
+     * The geodetic curve type used when calculating the new point. Only applies
+     * when geodetic is set to true. Defaults to geodesic.
+     * */
+    geodeticCurveType?: GeodeticCurveType;
+}
+/**
+ * Arguments for the "sketching.clear-constraints" command.
+ */
+export interface ClearConstraintsArgs extends HasMaps {
+    /**
+     * Indicates whether the length constraint should be cleared. Defaults to
+     * true if not specified.
+     */
+    clearLengthConstraint?: boolean;
+    /**
+     * Indicates whether the angle constraint should be cleared. Defaults to
+     * true if not specified.
+     */
+    clearAngleConstraint?: boolean;
+}
 export declare class SketchingOperations extends OperationRegistry {
     /**
      * Allows the user to create geometry by sketching on a map. Returns the
@@ -455,20 +688,20 @@ export declare class SketchingOperations extends OperationRegistry {
      * they are not required for this operation.
      *
      * @webOnly
-     *
      */
     get rotateGeometry(): Operation<RotateGeometryArgs, GeometryOperationBase>;
     /**
      * Stops geometry capturing or editing on a given map. Returns the current
      * geometry. If validateGeometry parameter is true and geometry is invalid,
-     * returns null.
+     * the operation will return null.
      */
     get stop(): Operation<StopGeometryEditArgs | void, CaptureGeometryResult>;
     /**
-     * Adds a point to a given polyline or polygon geometry. Returns the
-     * resulting geometry.
+     * Deprecated - Mobile users should rather use "geometry.add-point"; Web
+     * users should use "sketching.add-point" or "sketching.insert-point"
+     * instead.
      *
-     * Deprecated in Mobile, use geometry.add-point instead.
+     * @deprecated
      */
     get addNodeToGeometry(): Operation<AddNodeToGeometryArgs, Geometry>;
     /**
@@ -478,11 +711,27 @@ export declare class SketchingOperations extends OperationRegistry {
      */
     get getActiveSketch(): Operation<void, GetActiveSketchResult>;
     /**
-     * Returns the active point graphic of the active sketch on a map.
+     * Deprecated - use 'sketching.get-active-points' instead.
+     *
+     * @deprecated
+     * @webOnly
+     */
+    get getActiveNode(): Operation<Maps, GetActivePointsResult>;
+    /**
+     * Returns the active point graphics of the active sketch or edit session on
+     * a map.
+     *
+     * @webOnly
+     */
+    get getActivePoints(): Operation<Maps, GetActivePointsResult>;
+    /**
+     * Return the adjacent point graphic(s), relative to a given vertex that's a
+     * part of an active editing or sketching session. This operation is only
+     * supported for Polyline and Polygon geometries.
      *
      * @webOnly
      */
-    get getActiveNode(): Operation<ItemRef, GetActiveSketchResult>;
+    get getAdjacentPoint(): Operation<GetAdjacentPointArgs, GetActiveSketchResult>;
     /**
      * Checks whether streaming is active.
      *
@@ -534,22 +783,37 @@ export declare class SketchingCommands extends CommandRegistry {
     /**
      * 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.
+     * point is supplied, any active points in the session will be deleted. If
+     * there are no active points in the session, the entire geometry will be
+     * deleted.
      */
-    get delete(): Command<DeleteGeometryArgs>;
+    get delete(): Command<void | DeleteGeometryArgs>;
     /**
-     * Moves a point within an active sketch to a new location.
+     * Deprecated - use 'sketching.move-point' instead.
      *
+     * @deprecated
      * @webOnly
      */
     get moveNode(): Command<MoveNodeArgs>;
     /**
-     * Switches the active point of an active sketch.
+     * Moves a point within an active sketch to a new location.
+     *
+     * @webOnly
+     */
+    get movePoint(): Command<MovePointArgs>;
+    /**
+     * Deprecated - use 'sketching.set-active-points' instead.
      *
+     * @deprecated
      * @webOnly
      */
     get switchActiveNode(): Command<SwitchActiveNodeArgs>;
+    /**
+     * Switches the active point of an active sketch.
+     *
+     * @webOnly
+     */
+    get setActivePoints(): Command<SetActivePointsArgs>;
     /**
      * Sets the interaction mode of the geometry editor.
      *
@@ -580,6 +844,29 @@ export declare class SketchingCommands extends CommandRegistry {
      * @webOnly
      */
     get disablePrecisionMode(): Command<void>;
+    /**
+     * Sets constraints on the active sketch.
+     *
+     * @mobileOnly
+     */
+    get setConstraints(): Command<SetConstraintsArgs>;
+    /**
+     * Clears constraints that have been previously set.
+     *
+     * @mobileOnly
+     */
+    get clearConstraints(): Command<ClearConstraintsArgs>;
+    /**
+     * Inserts a point into a polygon, polyline, or multipoint at the specified
+     * index. If the partIndex is null, then the last part is used. If the
+     * pointIndex is null, then the new point is inserted at the end.
+     */
+    get insertPoint(): Command<InsertPointArgs>;
+    /**
+     * Adds a point to polygon, polyline, or multipoint using the selected index
+     * as the point to insert after.
+     */
+    get addPoint(): Command<AddPointArgs>;
     /**
      * Starts streaming: recording your location at regular intervals and
      * adding the collected points to the currently active geometry editor.

package/messaging/registry/sketching.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.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")}get isStreaming(){return this._messages.operation("sketching.is-streaming")}}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")}get startStreaming(){return this._messages.command("sketching.start-streaming")}get stopStreaming(){return this._messages.command("sketching.stop-streaming")}}export class SketchingEvents extends EventRegistry{get streamingStarted(){return this._messages.event("sketching.streaming-started")}get streamingStopped(){return this._messages.event("sketching.streaming-stopped")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.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")}get getActivePoints(){return this._messages.operation("sketching.get-active-points")}get getAdjacentPoint(){return this._messages.operation("sketching.get-adjacent-point")}get isStreaming(){return this._messages.operation("sketching.is-streaming")}}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 movePoint(){return this._messages.command("sketching.move-point")}get switchActiveNode(){return this._messages.command("sketching.switch-active-node")}get setActivePoints(){return this._messages.command("sketching.set-active-points")}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")}get setConstraints(){return this._messages.command("sketching.set-constraints")}get clearConstraints(){return this._messages.command("sketching.clear-constraints")}get insertPoint(){return this._messages.command("sketching.insert-point")}get addPoint(){return this._messages.command("sketching.add-point")}get startStreaming(){return this._messages.command("sketching.start-streaming")}get stopStreaming(){return this._messages.command("sketching.stop-streaming")}}export class SketchingEvents extends EventRegistry{get streamingStarted(){return this._messages.event("sketching.streaming-started")}get streamingStopped(){return this._messages.event("sketching.streaming-stopped")}}

package/messaging/registry/ui.d.ts

@@ -1,5 +1,5 @@
 import type { UIDensity } from "../../app-config/common/BrandingModelProperties.js";
-import type { TranslateOptions } from "../../app-config/common/TranslatableText.js";
+import type { TranslatableText, TranslateOptions } from "../../app-config/common/TranslatableText.js";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
@@ -77,9 +77,10 @@ export interface DisplayNotificationArgs {
      */
     category?: NotificationCategory;
     /**
-     * The message to be displayed in the notification.
+     * The message to be displayed in the notification. Mobile only supports a
+     * string for this property.
      */
-    message: string;
+    message: TranslatableText;
     /**
      * The position of the notification on the screen.
      */