@vertigis/viewer-spec 45.0.0 → 45.1.0

package/messaging/registry/sketching.d.ts

@@ -24,6 +24,8 @@ import type { Symbol as SymbolJson } from "@vertigis/arcgis-extensions/portal/Sy
 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";
@@ -355,6 +357,15 @@ export interface SetInteractionModeArgs extends HasMaps {
      */
     editorInteractionMode: EditorInteractionMode;
 }
+/**
+ * Arguments for the "sketching.start-streaming" command.
+ */
+export interface StartStreamingArgs extends HasMaps {
+    /**
+     * An optional value indicating, in seconds, how often points should be recorded.
+     */
+    interval?: number;
+}
 /**
  * The editor geometry mode.
  */
@@ -472,6 +483,12 @@ export declare class SketchingOperations extends OperationRegistry {
      * @webOnly
      */
     get getActiveNode(): Operation<ItemRef, GetActiveSketchResult>;
+    /**
+     * Checks whether streaming is active.
+     *
+     * @mobileOnly
+     */
+    get isStreaming(): Operation<HasMaps, boolean>;
 }
 export declare class SketchingCommands extends CommandRegistry {
     /**
@@ -506,9 +523,10 @@ export declare class SketchingCommands extends CommandRegistry {
      */
     get addPointAtCurrentLocation(): Command<HasMaps>;
     /**
-     * Sets a point at the user's current location while editing a geometry. In this context, "set" means
-     * to either add a point at the current location, or update the currently selected point to be the user's
-     * current location, depending on what edit mode the user is in.
+     * Sets a point at the user's current location while editing a geometry. In
+     * this context, "set" means to either add a point at the current location,
+     * or update the currently selected point to be the user's current
+     * location, depending on what edit mode the user is in.
      *
      * @mobileOnly
      */
@@ -562,4 +580,31 @@ export declare class SketchingCommands extends CommandRegistry {
      * @webOnly
      */
     get disablePrecisionMode(): Command<void>;
+    /**
+     * Starts streaming: recording your location at regular intervals and
+     * adding the collected points to the currently active geometry editor.
+     *
+     * @mobileOnly
+     */
+    get startStreaming(): Command<StartStreamingArgs>;
+    /**
+     * Stops streaming.
+     *
+     * @mobileOnly
+     */
+    get stopStreaming(): Command<HasMaps>;
+}
+export declare class SketchingEvents extends EventRegistry {
+    /**
+     * Raised when streaming has begun.
+     *
+     * @mobileOnly
+     */
+    get streamingStarted(): Event<HasMaps>;
+    /**
+     * Raised when streaming has stopped.
+     *
+     * @mobileOnly
+     */
+    get streamingStopped(): Event<HasMaps>;
 }

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 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")}}
+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")}}

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

@@ -2483,6 +2483,21 @@
             ],
             "type": "object"
         },
+        "StartStreamingArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"sketching.start-streaming\" command.",
+            "properties": {
+                "interval": {
+                    "description": "An optional value indicating, in seconds, how often points should be recorded.",
+                    "type": "number"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                }
+            },
+            "type": "object"
+        },
         "StopGeometryEditArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.stop\" operation.",
@@ -13005,6 +13020,18 @@
         "sketching.edit-geometry:output": {
             "$ref": "#/definitions/EditGeometryResult"
         },
+        "sketching.is-streaming": {
+            "description": "Checks whether streaming is active.",
+            "enum": [
+                "sketching.is-streaming"
+            ]
+        },
+        "sketching.is-streaming:input": {
+            "$ref": "#/definitions/HasMaps"
+        },
+        "sketching.is-streaming:output": {
+            "type": "boolean"
+        },
         "sketching.redo": {
             "description": "Redoes the last undone edit while editing a geometry.",
             "enum": [
@@ -13041,12 +13068,30 @@
         "sketching.set-point-at-current-location:input": {
             "$ref": "#/definitions/HasMaps"
         },
+        "sketching.start-streaming": {
+            "description": "Starts streaming: recording your location at regular intervals and adding the collected points to the currently active geometry editor.",
+            "enum": [
+                "sketching.start-streaming"
+            ]
+        },
+        "sketching.start-streaming:input": {
+            "$ref": "#/definitions/StartStreamingArgs"
+        },
         "sketching.stop": {
             "description": "Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, returns null.",
             "enum": [
                 "sketching.stop"
             ]
         },
+        "sketching.stop-streaming": {
+            "description": "Stops streaming.",
+            "enum": [
+                "sketching.stop-streaming"
+            ]
+        },
+        "sketching.stop-streaming:input": {
+            "$ref": "#/definitions/HasMaps"
+        },
         "sketching.stop:input": {
             "anyOf": [
                 {
@@ -14609,6 +14654,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.start-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.start-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.stop-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.stop-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15127,6 +15204,12 @@
                 {
                     "$ref": "#/definitions/sketching.set-point-at-current-location"
                 },
+                {
+                    "$ref": "#/definitions/sketching.start-streaming"
+                },
+                {
+                    "$ref": "#/definitions/sketching.stop-streaming"
+                },
                 {
                     "$ref": "#/definitions/sketching.undo"
                 },
@@ -15745,6 +15828,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.is-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.is-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15929,6 +16028,9 @@
                 {
                     "$ref": "#/definitions/sketching.edit-geometry"
                 },
+                {
+                    "$ref": "#/definitions/sketching.is-streaming"
+                },
                 {
                     "$ref": "#/definitions/sketching.stop"
                 },

package/package.json

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

package/version.js

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