@vertigis/viewer-spec 59.30.0 → 60.0.0

package/messaging/registry/map.d.ts

@@ -304,7 +304,7 @@ export interface EditMapNotesArgs extends HasUITarget {
      */
     maps: MapsLike;
     /**
-     * The geometry from which to attempt to select the Note.
+     * The geometry from which to attempt to select the note.
      */
     geometry?: Point;
 }
@@ -488,9 +488,9 @@ export interface ApplyFilterEffectArgs {
      */
     spatialRelationship?: FilterSpatialRelationship;
     /**
-     * Specifies a search distance from a given 'geometry' in th spatial filter.
-     * In essence, setting this property creates a buffer at the specified size
-     * around the input 'geometry'.
+     * Specifies a search distance from a given 'geometry' in the spatial
+     * filter. In essence, setting this property creates a buffer at the
+     * specified size around the input 'geometry'.
      */
     distance?: number;
     /**
@@ -514,7 +514,7 @@ export interface ApplyFilterEffectArgs {
     excludedEffect?: FilterEffectSettings;
 }
 /**
- * Result of the "map.get-view-insets" operation.
+ * Result of the "map.get-view-insets" operation {@link Thickness}.
  */
 export interface GetViewInsetsArgs {
     /**

package/messaging/registry/measurement.d.ts

@@ -109,7 +109,7 @@ export declare class MeasurementOperations extends OperationRegistry {
     protected readonly _prefix = "measurement";
     /**
      * Creates graphics out of geometries with the default symbology set by the
-     * "measurement.set-default-symbol" command'. Web only.
+     * "measurement.set-default-symbol" command. Web only.
      *
      * @webOnly
      */

package/messaging/registry/network.d.ts

@@ -58,8 +58,8 @@ export declare class NetworkEvents extends EventRegistry {
 export declare class NetworkOperations extends OperationRegistry {
     protected readonly _prefix = "network";
     /**
-     * Determines if Disconnected Mode is enabled and web requests can be sent
-     * by the app.
+     * Determines if Disconnected Mode is enabled and web requests cannot be
+     * sent by the app.
      *
      * @mobileOnly
      */

package/messaging/registry/printing.d.ts

@@ -40,7 +40,7 @@ export interface PrintSpatialReference {
      */
     latestWkid?: number;
     /**
-     * WKT String.
+     * WKT string.
      */
     wkt?: string;
 }
@@ -145,8 +145,8 @@ export interface ExportOptions {
 export interface LegendOptions {
     /**
      * Specifies if the legend of all operational layers should be added to the
-     * layout. If true, operationalLayers can be undefined. Note: this is no
-     * ESRI standard property and only works with VertiGIS Studio Printing
+     * layout. If true, operationalLayers can be undefined. Note: this is not a
+     * standard Esri property and it only works with VertiGIS Studio Printing
      * Engine.
      */
     operationalLayersAutoSet?: boolean;
@@ -316,7 +316,7 @@ export interface TimeSeries {
      * Maximum count of time series PDF documents within the returned ZIP
      * archive. If not set, no limit for time series PDF document exports is
      * used. Depending on the client and the execution environment and the
-     * template- / map properties, the clients should always define a suitable
+     * template/map properties, the clients should always define a suitable
      * value.
      */
     maxCount?: number;
@@ -519,7 +519,7 @@ export interface Page {
      * elements in exportWebMap:layoutOptions:customTextElement and the dynamic
      * elements in additionalSettings. These elements take precedence over the
      * elements in exportWebMap:layoutOptions:customTextElement and the elements
-     * in addtional Settings root, if they have the same type and name.
+     * in additional Settings root, if they have the same type and name.
      */
     dynamicElements?: DynamicElement[];
     /**
@@ -567,7 +567,7 @@ export interface PageCover {
      * elements in exportWebMap:layoutOptions:customTextElement and the dynamic
      * elements in additionalSettings. These elements take precedence over the
      * elements in exportWebMap:layoutOptions:customTextElement and the elements
-     * in addtional settings root, if they have the same type and name.
+     * in additional settings root, if they have the same type and name.
      */
     dynamicElements?: DynamicElement[];
 }
@@ -584,7 +584,7 @@ export interface PageOverview {
      * elements in exportWebMap:layoutOptions:customTextElement and the dynamic
      * elements in additionalSettings. These elements take precedence over the
      * elements in exportWebMap:layoutOptions:customTextElement and the elements
-     * in addtional settings root, if they have the same type and name.
+     * in additional settings root, if they have the same type and name.
      */
     dynamicElements?: DynamicElement[];
     /**
@@ -655,13 +655,13 @@ export interface PageLegend {
      * elements in exportWebMap:layoutOptions:customTextElement and the dynamic
      * elements in additionalSettings. These elements take precedence over the
      * elements in exportWebMap:layoutOptions:customTextElement and the elements
-     * in addtional settings root, if they have the same type and name.
+     * in additional settings root, if they have the same type and name.
      */
     dynamicElements?: DynamicElement[];
     /**
      * Whether the legend items of dynamic layers, organized in composite layers
-     * on root level, should be exported in seperate legend pages. Legend items
-     * are seperated if this value is set to 'true'. This might result in
+     * on root level, should be exported in separate legend pages. Legend items
+     * are separated if this value is set to 'true'. This might result in
      * additional legend page exports.
      */
     layerCompositeExport?: boolean;

package/messaging/registry/reports.d.ts

@@ -80,7 +80,7 @@ export interface ReportErrorEventArgs extends ReportEventArgsBase {
  */
 export interface ReportFinishedEventArgs extends ReportEventArgsBase {
     /**
-     * The URL to download the report at.
+     * The URL to download the report from.
      */
     downloadUrl: string;
 }

package/messaging/registry/results.d.ts

@@ -404,7 +404,8 @@ export declare class ResultsCommands extends CommandRegistry {
      * features, such as a feature list, feature table, or feature details
      * component. The argument is the features to display, or an object
      * specifying both features and the target results component to update (Web
-     * only).
+     * only). If features are specified, they will overwrite any incoming
+     * features from previous operations up the action chain.
      */
     get display(): Command<Features | UpdateResultsFeaturesArgs>;
     /**
@@ -431,8 +432,8 @@ export declare class ResultsCommands extends CommandRegistry {
     /**
      * Presents feature details to the user within the feature-details
      * component. The argument is the feature(s) to display, or an object
-     * specifying both features and the target results component to update (Web
-     * only).
+     * specifying both features and the target results component to update (this
+     * object, UpdateResultsFeaturesArgs, is Web only).
      */
     get displayDetails(): Command<Features | UpdateResultsFeaturesArgs>;
     /**
@@ -468,7 +469,7 @@ export declare class ResultsCommands extends CommandRegistry {
     /**
      * Replaces feature(s) in the shown set of features. If a feature is not
      * contained in the current set it is ignored. Features are uniquely
-     * identified by ID and not by object quality. Web only.
+     * identified by ID and not by object equality. Web only.
      *
      * @webOnly
      */
@@ -522,7 +523,7 @@ export declare class ResultsCommands extends CommandRegistry {
 export declare class ResultsEvents extends EventRegistry {
     protected readonly _prefix = "results";
     /**
-     * Raised when results are added or removed to a named results set. Web
+     * Raised when results are added to or removed from a named results set. Web
      * only.
      *
      * @webOnly

package/messaging/registry/sketching.d.ts

@@ -93,22 +93,6 @@ export declare enum SketchTool {
  * point in a sketch.
  */
 export type AddNodeOrder = "add-after-active" | "add-before-active";
-/**
- * Deprecated - use "sketching.move-point" with {@link MovePointArgs}.
- *
- * @deprecated
- */
-export interface MoveNodeArgs extends HasMaps {
-    /**
-     * The point to move, which must already exist within the active sketch. If
-     * not provided, the active point will be used.
-     */
-    node?: Point;
-    /**
-     * The new position for the point.
-     */
-    position: GeometryUnion;
-}
 /**
  * The arguments for the "sketching.move-point" command.
  */
@@ -153,18 +137,6 @@ export interface MovePointArgs extends HasMaps {
      */
     units?: LengthUnits;
 }
-/**
- * Deprecated - use "sketching.set-active-points" with
- * {@link SetActivePointsArgs}.
- *
- * @deprecated
- */
-export interface SwitchActiveNodeArgs extends HasMaps {
-    /**
-     * The new point that will become the active point of an active sketch.
-     */
-    node: Point;
-}
 /**
  * The arguments for the "sketching.set-active-points" command.
  */
@@ -230,10 +202,10 @@ export interface CaptureGeometryArgs {
      */
     disableFreehand?: boolean;
     /**
-     * Web only. Additional settings that are specific to sketching plugins,
-     * keyed by plugin ID. The only currently supported plugin is "snapping". A
-     * boolean value can also be assigned to completely disable, or enable with
-     * default settings.
+     * Additional settings that are specific to sketching plugins, keyed by
+     * plugin ID. The only currently supported plugin is "snapping". A boolean
+     * value can also be assigned to completely disable, or enable with default
+     * settings. Web only.
      */
     pluginSettings?: Record<string, boolean | Record<string, unknown>>;
 }
@@ -448,7 +420,7 @@ export interface AddPointArgs extends HasMaps {
     newPoint: Point;
     /**
      * The geometry to add the point to, if multiple are present in an active
-     * editing session. Not supported by Mobile.
+     * editing session. Not supported by VertiGIS Studio Mobile.
      */
     geometry?: GeometryUnion;
 }
@@ -472,41 +444,10 @@ export interface InsertPointArgs extends HasMaps {
     newPoint: Point;
     /**
      * The geometry to add the point to, if multiple are present in an active
-     * editing session. Not supported by Mobile.
+     * editing session. Not supported by VertiGIS Studio Mobile.
      */
     geometry?: GeometryUnion;
 }
-/**
- * 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 {
-    /**
-     * The initial geometry to add the point to. Can be null.
-     */
-    geometry: GeometryUnion;
-    /**
-     * The type of geometry to create if the initial geometry is null. In
-     * VertiGIS Studio Mobile, this value must be 'polygon' or 'polyline'. In
-     * VertiGIS Studio Web, this value may also be null if the point being added
-     * is intended to be added to the active sketch.
-     */
-    geometryType: string;
-    /**
-     * A point geometry to add to the initial geometry. In VertiGIS Studio Web,
-     * this value may be null if the intention is to add a point at the position
-     * of the active point of an active sketch.
-     */
-    node: GeometryUnion;
-    /**
-     * Indicates whether the new point should be added before or after the
-     * active point in the sketch. Not supported by VertiGIS Studio Mobile.
-     */
-    nodeOrder?: AddNodeOrder;
-}
 /**
  * Arguments for the "sketching.delete" command.
  */
@@ -783,27 +724,12 @@ export declare class SketchingOperations extends OperationRegistry {
      * the operation will return null.
      */
     get stop(): Operation<StopGeometryEditArgs | void, CaptureGeometryResult>;
-    /**
-     * Deprecated - Mobile users should rather use "geometry.add-point"; Web
-     * users should use "sketching.add-point" or "sketching.insert-point"
-     * instead.
-     *
-     * @deprecated
-     */
-    get addNodeToGeometry(): Operation<AddNodeToGeometryArgs, GeometryUnion>;
     /**
      * Returns the active sketch graphic from a map. Web only.
      *
      * @webOnly
      */
     get getActiveSketch(): Operation<void, GetActiveSketchResult>;
-    /**
-     * Deprecated - use 'sketching.get-active-points' instead. Web only.
-     *
-     * @deprecated
-     * @webOnly
-     */
-    get getActiveNode(): Operation<Maps, GetActivePointsResult>;
     /**
      * Returns the active point graphics of the active sketch or edit session on
      * a map. Web only.
@@ -829,7 +755,8 @@ export declare class SketchingOperations extends OperationRegistry {
 export declare class SketchingCommands extends CommandRegistry {
     protected readonly _prefix = "sketching";
     /**
-     * Set the snapping default to 'on' for all subsequent operations. Web only.
+     * Set the snapping default to 'on' for all in progress and subsequent
+     * operations. Web only.
      *
      * @webOnly
      */
@@ -877,7 +804,7 @@ export declare class SketchingCommands extends CommandRegistry {
      */
     get setSnappingConfiguration(): Command<SetSnappingConfigurationArgs>;
     /**
-     * Sets the global snapping configuration. Web only.
+     * Sets the topology configuration. Web only.
      *
      * @webOnly
      */
@@ -913,26 +840,12 @@ export declare class SketchingCommands extends CommandRegistry {
      * deleted.
      */
     get delete(): Command<void | DeleteGeometryArgs>;
-    /**
-     * Deprecated - use 'sketching.move-point' instead. Web only.
-     *
-     * @deprecated
-     * @webOnly
-     */
-    get moveNode(): Command<MoveNodeArgs>;
     /**
      * Moves a point within an active sketch to a new location. Web only.
      *
      * @webOnly
      */
     get movePoint(): Command<MovePointArgs>;
-    /**
-     * Deprecated - use 'sketching.set-active-points' instead. Web only.
-     *
-     * @deprecated
-     * @webOnly
-     */
-    get switchActiveNode(): Command<SwitchActiveNodeArgs>;
     /**
      * Switches the active point of an active sketch. Web only.
      *

package/messaging/registry/sketching.js

@@ -1 +1 @@
-import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export var SketchTool;!function(t){t.POINT="point",t.MULTIPOINT="multipoint",t.LINE="line",t.POLYLINE="polyline",t.POLYGON="polygon",t.EXTENT="extent",t.SQUARE="square",t.CIRCLE="circle"}(SketchTool||(SketchTool={}));export class SketchingOperations extends r{_prefix="sketching";get captureGeometry(){return this._get("capture-geometry")}get editActiveSymbol(){return this._get("edit-active-symbol")}get editGeometry(){return this._get("edit-geometry")}get moveGeometry(){return this._get("move-geometry")}get scaleGeometry(){return this._get("scale-geometry")}get rotateGeometry(){return this._get("rotate-geometry")}get stop(){return this._get("stop")}get addNodeToGeometry(){return this._get("add-node-to-geometry")}get getActiveSketch(){return this._get("get-active-sketch")}get getActiveNode(){return this._get("get-active-node")}get getActivePoints(){return this._get("get-active-points")}get getAdjacentPoint(){return this._get("get-adjacent-point")}get isStreaming(){return this._get("is-streaming")}}export class SketchingCommands extends t{_prefix="sketching";get activateSnapping(){return this._get("activate-snapping")}get activateTopology(){return this._get("activate-topology")}get cancel(){return this._get("cancel")}get deactivateSnapping(){return this._get("deactivate-snapping")}get deactivateTopology(){return this._get("deactivate-topology")}get undo(){return this._get("undo")}get redo(){return this._get("redo")}get setGeometryMode(){return this._get("set-geometry-mode")}get setSnappingConfiguration(){return this._get("set-snapping-configuration")}get setTopologyConfiguration(){return this._get("set-topology-configuration")}get addPointAtCenter(){return this._get("add-point-at-center")}get addPointAtCurrentLocation(){return this._get("add-point-at-current-location")}get setPointAtCurrentLocation(){return this._get("set-point-at-current-location")}get delete(){return this._get("delete")}get moveNode(){return this._get("move-node")}get movePoint(){return this._get("move-point")}get switchActiveNode(){return this._get("switch-active-node")}get setActivePoints(){return this._get("set-active-points")}get setInteractionMode(){return this._get("set-interaction-mode")}get enableFreeScaleMode(){return this._get("enable-free-scale-mode")}get disableFreeScaleMode(){return this._get("disable-free-scale-mode")}get enablePrecisionMode(){return this._get("enable-precision-mode")}get disablePrecisionMode(){return this._get("disable-precision-mode")}get setConstraints(){return this._get("set-constraints")}get clearConstraints(){return this._get("clear-constraints")}get insertPoint(){return this._get("insert-point")}get addPoint(){return this._get("add-point")}get startStreaming(){return this._get("start-streaming")}get stopStreaming(){return this._get("stop-streaming")}}export class SketchingEvents extends e{_prefix="sketching";get streamingStarted(){return this._get("streaming-started")}get streamingStopped(){return this._get("streaming-stopped")}}
+import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export var SketchTool;!function(t){t.POINT="point",t.MULTIPOINT="multipoint",t.LINE="line",t.POLYLINE="polyline",t.POLYGON="polygon",t.EXTENT="extent",t.SQUARE="square",t.CIRCLE="circle"}(SketchTool||(SketchTool={}));export class SketchingOperations extends r{_prefix="sketching";get captureGeometry(){return this._get("capture-geometry")}get editActiveSymbol(){return this._get("edit-active-symbol")}get editGeometry(){return this._get("edit-geometry")}get moveGeometry(){return this._get("move-geometry")}get scaleGeometry(){return this._get("scale-geometry")}get rotateGeometry(){return this._get("rotate-geometry")}get stop(){return this._get("stop")}get getActiveSketch(){return this._get("get-active-sketch")}get getActivePoints(){return this._get("get-active-points")}get getAdjacentPoint(){return this._get("get-adjacent-point")}get isStreaming(){return this._get("is-streaming")}}export class SketchingCommands extends t{_prefix="sketching";get activateSnapping(){return this._get("activate-snapping")}get activateTopology(){return this._get("activate-topology")}get cancel(){return this._get("cancel")}get deactivateSnapping(){return this._get("deactivate-snapping")}get deactivateTopology(){return this._get("deactivate-topology")}get undo(){return this._get("undo")}get redo(){return this._get("redo")}get setGeometryMode(){return this._get("set-geometry-mode")}get setSnappingConfiguration(){return this._get("set-snapping-configuration")}get setTopologyConfiguration(){return this._get("set-topology-configuration")}get addPointAtCenter(){return this._get("add-point-at-center")}get addPointAtCurrentLocation(){return this._get("add-point-at-current-location")}get setPointAtCurrentLocation(){return this._get("set-point-at-current-location")}get delete(){return this._get("delete")}get movePoint(){return this._get("move-point")}get setActivePoints(){return this._get("set-active-points")}get setInteractionMode(){return this._get("set-interaction-mode")}get enableFreeScaleMode(){return this._get("enable-free-scale-mode")}get disableFreeScaleMode(){return this._get("disable-free-scale-mode")}get enablePrecisionMode(){return this._get("enable-precision-mode")}get disablePrecisionMode(){return this._get("disable-precision-mode")}get setConstraints(){return this._get("set-constraints")}get clearConstraints(){return this._get("clear-constraints")}get insertPoint(){return this._get("insert-point")}get addPoint(){return this._get("add-point")}get startStreaming(){return this._get("start-streaming")}get stopStreaming(){return this._get("stop-streaming")}}export class SketchingEvents extends e{_prefix="sketching";get streamingStarted(){return this._get("streaming-started")}get streamingStopped(){return this._get("streaming-stopped")}}

package/messaging/registry/system.d.ts

@@ -76,7 +76,7 @@ export interface ReadFileArgs extends HasUITarget {
     promptMessage?: string;
     /**
      * If present, provides information about what file types are accepted by
-     * this dialog, eg: "*.jpg, *.gif and *.bmp files accepted".
+     * this dialog, e.g. "*.jpg, *.gif and *.bmp files accepted".
      */
     fileTypeDescription?: string;
 }

package/messaging/registry/tasks.d.ts

@@ -126,7 +126,8 @@ export interface IdentifyArgs {
     geometry: GeometryLike;
     /**
      * The feature sources to identify. Can be used instead of or in addition to
-     * "maps". Not supported in VertiGIS Studio Mobile (use "maps").
+     * "maps". Not supported in VertiGIS Studio Mobile (use "maps"). Source will
+     * be used in addition to the maps.
      */
     sources?: FeatureSource[];
     /**

package/messaging/registry/tracing.d.ts

@@ -7,7 +7,7 @@ import type { TraceCompletedArgs } from "./utility-network.js";
 export declare class TracingEvents extends EventRegistry {
     protected readonly _prefix = "tracing";
     /**
-     * Raised when a utility network trace is succesfully completed.
+     * Raised when a utility network trace is successfully completed.
      *
      * @mobileOnly
      */

package/messaging/registry/ui.d.ts

@@ -35,7 +35,7 @@ export interface MessageBoxArgs {
     isDraggable?: boolean;
     /**
      * Where the dialog appears in the app when it is created. Defaults to
-     * center position. Web only.
+     * "center" position. Web only.
      */
     initialPosition?: MessageBoxPosition;
 }
@@ -544,6 +544,7 @@ export declare class UIOperations extends OperationRegistry {
     /**
      * Prompts the user to enter a value in a popup box. Web only.
      *
+     * @throws `Cancellation` on user popup cancel.
      * @webOnly
      */
     get prompt(): Operation<PromptOperationArgs, string>;