@vertigis/viewer-spec 42.10.0

package/messaging/registry/results.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class ResultsCommands extends CommandRegistry{get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends EventRegistry{get displayed(){return this._messages.event("results.displayed")}}export class ResultsOperations extends OperationRegistry{get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}

package/messaging/registry/search.d.ts

@@ -0,0 +1,51 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { Features } from "../common.js";
+import type { SearchArgs } from "./tasks.js";
+/**
+ * The search source.
+ */
+export declare enum SearchSource {
+    ADDRESSES = "addresses",
+    FEATURES = "features"
+}
+export declare class SearchCommands extends CommandRegistry {
+    /**
+     * Clears the search input.
+     */
+    get clear(): Command;
+    /**
+     * Sets the search source.
+     *
+     * @mobileOnly
+     */
+    get setSource(): Command<SearchSource>;
+}
+export declare class SearchEvents extends EventRegistry {
+    /**
+     * Raised when a search component is activated.
+     *
+     * @mobileOnly
+     */
+    get activated(): Event;
+    /**
+     * Raised when a search completes.
+     *
+     * @mobileOnly
+     */
+    get completed(): Event<Features>;
+    /**
+     * Raised when a search begins.
+     *
+     * @mobileOnly
+     */
+    get started(): Event<SearchArgs>;
+    /**
+     * Raised when a search component is deactivated.
+     *
+     * @mobileOnly
+     */
+    get deactivated(): Event;
+}

package/messaging/registry/search.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export var SearchSource;!function(e){e.ADDRESSES="addresses",e.FEATURES="features"}(SearchSource||(SearchSource={}));export class SearchCommands extends CommandRegistry{get clear(){return this._messages.command("search.clear")}get setSource(){return this._messages.command("search.set-source")}}export class SearchEvents extends EventRegistry{get activated(){return this._messages.event("search.activated")}get completed(){return this._messages.event("search.completed")}get started(){return this._messages.event("search.started")}get deactivated(){return this._messages.event("search.deactivated")}}

package/messaging/registry/sketching.d.ts

@@ -0,0 +1,521 @@
+import type Graphic from "@arcgis/core/Graphic";
+import type Geometry from "@arcgis/core/geometry/Geometry";
+import type Point from "@arcgis/core/geometry/Point";
+import type LineSymbol3D from "@arcgis/core/symbols/LineSymbol3D";
+import type PictureFillSymbol from "@arcgis/core/symbols/PictureFillSymbol";
+import type PictureMarkerSymbol from "@arcgis/core/symbols/PictureMarkerSymbol";
+import type PointSymbol3D from "@arcgis/core/symbols/PointSymbol3D";
+import type PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D";
+import type SimpleFillSymbol from "@arcgis/core/symbols/SimpleFillSymbol";
+import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol";
+import type SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol";
+import type Symbol from "@arcgis/core/symbols/Symbol";
+import type TextSymbol from "@arcgis/core/symbols/TextSymbol";
+import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
+import type { LineSymbol3D as LineSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/LineSymbol3D";
+import type { PictureFillSymbol as PictureFillSymbolProperties } from "@vertigis/arcgis-extensions/portal/PictureFillSymbol";
+import type { PictureMarkerSymbol as PictureMarkerSymbolProperties } from "@vertigis/arcgis-extensions/portal/PictureMarkerSymbol";
+import type { PointSymbol3D as PointSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/PointSymbol3D";
+import type { PolygonSymbol3D as PolygonSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/PolygonSymbol3D";
+import type { SimpleFillSymbol as SimpleFillSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleFillSymbol";
+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 { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { FeaturesLike, GeometryLike, GraphicsLike, HasMaps, MapsLike } from "../common.js";
+import type { LengthUnits } from "./geometry.js";
+/**
+ * A representation of a 2D vector or point.
+ */
+export interface Vector2D {
+    /**
+     * The x component.
+     */
+    x: number;
+    /**
+     * The y component.
+     */
+    y: number;
+}
+/**
+ * A set of symbols that can be used to sketch geometries.
+ */
+export interface SymbolSet {
+    /**
+     * The symbol used to draw points.
+     */
+    pointSymbol?: SimpleMarkerSymbol | SimpleMarkerSymbolProperties | PictureMarkerSymbol | PictureMarkerSymbolProperties;
+    /**
+     * The symbol used to draw 3D points.
+     */
+    pointSymbol3D?: PointSymbol3D | PointSymbol3DProperties;
+    /**
+     * The symbol used to draw lines.
+     */
+    lineSymbol?: SimpleLineSymbol | SimpleLineSymbolProperties;
+    /**
+     * The symbol used to draw 3D lines.
+     */
+    lineSymbol3D?: LineSymbol3D | LineSymbol3DProperties;
+    /**
+     * The symbol used to draw polygons.
+     */
+    polygonSymbol?: SimpleFillSymbol | SimpleFillSymbolProperties | PictureFillSymbol | PictureFillSymbolProperties;
+    /**
+     * The symbol used to draw 3D polygons.
+     */
+    polygonSymbol3D?: PolygonSymbol3D | PolygonSymbol3DProperties;
+}
+/**
+ * The type of tool used for sketching.
+ */
+export declare enum SketchTool {
+    POINT = "point",
+    MULTIPOINT = "multipoint",
+    /**
+     * Not supported in Geocortex Mobile Viewer.
+     */
+    LINE = "line",
+    POLYLINE = "polyline",
+    POLYGON = "polygon",
+    EXTENT = "extent",
+    /**
+     * Not supported in Geocortex Mobile Viewer.
+     */
+    SQUARE = "square",
+    /**
+     * Not supported in Geocortex Mobile Viewer.
+     */
+    CIRCLE = "circle"
+}
+/**
+ * Indicates whether a new point should be added before or after the active
+ * point in a sketch.
+ */
+export declare type AddNodeOrder = "add-after-active" | "add-before-active";
+/**
+ * The arguments for the "sketching.move-node" command.
+ */
+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: Geometry;
+}
+/**
+ * The arguments for the "sketching.switch-active-node" command.
+ */
+export interface SwitchActiveNodeArgs extends HasMaps {
+    /**
+     * The new point that will become the active point of an active sketch.
+     */
+    node: Point;
+}
+/**
+ * Arguments for the "sketching.capture-geometry" operation.
+ */
+export interface CaptureGeometryArgs {
+    /**
+     * The maps to activate drawing on. By default it will be all maps.
+     */
+    maps?: MapsLike;
+    /**
+     * The geometry/shape to use for sketching.
+     * *
+     * Multiple sketch tools are only supported by Geocortex Web. When multiple
+     * sketch tools are provided, the sketch will begin with the first one in
+     * the list. If "point" is the first of multiple options in the list, click
+     * actions will create points while click-and-drag actions will
+     * automatically begin the freehand variation of the next included geometry
+     * type.
+     */
+    geometryType: SketchTool | SketchTool[];
+    /**
+     * An optional symbol to use. SymbolSets are not supported by Geocortex
+     * Mobile.
+     */
+    symbol?: SymbolJson | SymbolSet;
+}
+/**
+ * Result of the "sketching.capture-geometry" operation.
+ */
+export interface CaptureGeometryResult {
+    /**
+     * The geometry that was captured.
+     */
+    geometry: Geometry;
+    /**
+     * The map that the user sketched the geometry on. Unavailable in Geocortex
+     * Mobile Viewer.
+     */
+    maps: MapsLike;
+    /**
+     * The symbol that was used. Unavailable in Geocortex Web Viewer.
+     */
+    symbol?: Symbol;
+}
+/**
+ * A generic context for operations that act on geometries.
+ */
+export interface GeometryOperationBase {
+    /**
+     * The maps to activate editing on. By default it will be all maps.
+     */
+    maps?: MapsLike;
+    /**
+     * The geometries to edit.
+     */
+    geometry?: GeometryLike;
+    /**
+     * The graphics containing geometries to edit. The graphics will pass
+     * through and be assigned the altered geometries. Not supported in Mobile.
+     */
+    graphics?: GraphicsLike;
+    /**
+     * The features containing geometries to edit. The features will pass
+     * through and be assigned the altered geometries. Not supported in Mobile.
+     */
+    features?: FeaturesLike;
+    /**
+     * Flag all inputs as measured geometries. Geometry operations will show
+     * measurements for in progress operations. Not supported in Mobile.
+     */
+    isMeasurement?: boolean;
+    /**
+     * An optional symbol to use while editing.
+     */
+    symbol?: SimpleLineSymbol | PictureFillSymbol | PictureMarkerSymbol | SimpleFillSymbol | SimpleMarkerSymbol | TextSymbol | Symbol;
+}
+/**
+ * Arguments for the "sketching.edit-geometry" operation.
+ */
+export interface EditGeometryArgs extends GeometryOperationBase {
+    /**
+     * The options for this edit operation. Not supported in Mobile.
+     */
+    options?: EditGeometryOptions;
+}
+/**
+ * Options for the "sketching.edit-geometry operation.
+ */
+export interface EditGeometryOptions {
+    /**
+     * Whether to allow deletion of the edited geometry. Defaults to false.
+     */
+    enableDelete?: boolean;
+    /**
+     * Whether to allow rotation of the edited geometry. Defaults to true.
+     */
+    enableRotation?: boolean;
+    /**
+     * Whether to allow scaling of the edited geometry. Defaults to true.
+     */
+    enableScaling?: boolean;
+    /**
+     * Whether to allow the user to toggle to the non-default scale mode.
+     * Defaults to true.
+     */
+    enableScaleModeToggle?: 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";
+    /**
+     * Where to anchor the geometry when performing a free scale operation.
+     * Defaults to "center".
+     */
+    anchor?: "center" | "opposite";
+}
+/**
+ * Result of the "sketching.edit-geometry" operation.
+ */
+export interface EditGeometryResult extends GeometryOperationBase {
+}
+/**
+ * Arguments for the "sketching.move-geometry" operation.
+ */
+export interface MoveGeometryArgs extends GeometryOperationBase {
+    /**
+     * An amount to move the geometry on the X and Y axes.
+     */
+    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;
+}
+/**
+ * Arguments for the "sketching.scale-geometry" operation.
+ */
+export interface ScaleGeometryArgs extends GeometryOperationBase {
+    /**
+     * The amount to scale the geometry, specified either uniformly or
+     * independently on the x and y axis. Point geometries will not be modified
+     * by this operation.
+     */
+    scale: Vector2D | number;
+}
+/**
+ * Arguments for the "sketching.rotate-geometry" operation.
+ */
+export interface RotateGeometryArgs extends GeometryOperationBase {
+    /**
+     * The number of degrees to rotate the geometry.
+     */
+    degrees: number;
+    /**
+     * The origin around which to rotate the geometry. Defaults to the centroid.
+     */
+    origin?: Point;
+}
+/**
+ * Arguments for the "sketching.stop" operation.
+ */
+export interface StopGeometryEditArgs {
+    /**
+     * The maps on which to stop editing geometry.
+     */
+    maps: MapsLike;
+    /**
+     *  Whether to validate the geometry before returning it. Defaults to true
+     *  if not set.
+     */
+    validateGeometry?: boolean;
+}
+/**
+ * Arguments for the "sketching.add-node-to-geometry" operation.
+ */
+export interface AddNodeToGeometryArgs extends HasMaps {
+    /**
+     * The initial geometry to add the point to. Can be null.
+     */
+    geometry: Geometry;
+    /**
+     * The type of geometry to create if the initial geometry is null. In
+     * Geocorex Mobile, this value must be 'polygon' or 'polyline'. In Geocortex
+     * 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 geocortex 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: Geometry;
+    /**
+     * Indicates whether the new point should be added before or after the active
+     * point in the sketch. Not supported by Geocortex Mobile.
+     */
+    nodeOrder?: AddNodeOrder;
+}
+/**
+ * Arguments for the "sketching.delete" command.
+ */
+export interface DeleteGeometryArgs extends HasMaps {
+    /**
+     * The point to delete from the active sketch. Not supported in Geocortex
+     * Mobile.
+     */
+    geometry?: Point;
+}
+/**
+ * Arguments for the "sketching.set-geometry-mode" command.
+ */
+export interface SetGeometryModeArgs extends HasMaps {
+    /**
+     * The geometry mode to switch to. Geocortex Mobile only supports "line" and
+     * "area".
+     */
+    editorGeometryMode: EditorGeometryMode | SketchTool;
+}
+/**
+ * Arguments for the "sketching.set-interaction-mode" command.
+ */
+export interface SetInteractionModeArgs extends HasMaps {
+    /**
+     * The interaction mode to switch to.
+     */
+    editorInteractionMode: EditorInteractionMode;
+}
+/**
+ * The editor geometry mode.
+ */
+export declare type EditorGeometryMode = "line" | "area";
+/**
+ * The editor interaction mode.
+ */
+export declare type EditorInteractionMode = "centerCrosshair" | "freehand";
+/**
+ * Settings for the geometry editor.
+ */
+export interface GeometryEditorSettings {
+    /**
+     * A value indicating whether snapping should be enabled.
+     */
+    snappingEnabled?: boolean;
+    /**
+     * A value indicating whether bearing labels should be
+     * shown on the map.
+     */
+    showBearings?: boolean;
+    /**
+     * The editor geometry mode.
+     */
+    editorGeometryMode?: EditorGeometryMode;
+    /**
+     * The editor interaction mode.
+     */
+    editorInteractionMode?: EditorInteractionMode;
+}
+/**
+ * Result returned from the 'sketching.get-active-sketch' and
+ * 'sketching.get-active-node' operations.
+ */
+export interface GetActiveSketchResult {
+    /**
+     * The active graphic(s).
+     */
+    graphics: Graphic[] | undefined;
+    /**
+     * The map associated with the graphics.
+     */
+    maps: MapExtension;
+}
+export declare class SketchingOperations extends OperationRegistry {
+    /**
+     * Allows the user to create geometry by sketching on a map. Returns the
+     * geometry that was drawn, along with the map that it was drawn on.
+     */
+    get captureGeometry(): Operation<CaptureGeometryArgs, CaptureGeometryResult>;
+    /**
+     * Allows the user to edit an existing geometry by drawing on a map. Returns
+     * the geometry that was edited, or the supplied feature with the altered
+     * geometry applied, along with the map that it was drawn on.
+     */
+    get editGeometry(): Operation<EditGeometryArgs, EditGeometryResult>;
+    /**
+     * Allows the user to move an existing geometry by a specified amount.
+     * Returns the altered geometry or the supplied feature with altered
+     * geometry applied. Will also pass through any map or symbol associated
+     * with the command chain, but only the map is required for this operation.
+     *
+     * @webOnly
+     *
+     */
+    get moveGeometry(): Operation<MoveGeometryArgs, GeometryOperationBase>;
+    /**
+     * Allows the user to scale and mirror an existing geometry on either axis.
+     * Returns the altered geometry or the supplied feature with altered
+     * geometry applied. Will also pass through any map or symbol associated
+     * with the command chain, but they are not required for this operation.
+     *
+     * @webOnly
+     *
+     */
+    get scaleGeometry(): Operation<ScaleGeometryArgs, GeometryOperationBase>;
+    /**
+     * Allows the user to rotate an existing geometry. Returns the altered
+     * geometry or the supplied feature with altered geometry applied. Will also
+     * pass through any map or symbol associated with the command chain, but
+     * 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.
+     */
+    get stop(): Operation<StopGeometryEditArgs, CaptureGeometryResult>;
+    /**
+     * Adds a point to a given polyline or polygon geometry. Returns the
+     * resulting geometry.
+     */
+    get addNodeToGeometry(): Operation<AddNodeToGeometryArgs, Geometry>;
+    /**
+     * Returns the active sketch graphic from a map.
+     *
+     * @webOnly
+     */
+    get getActiveSketch(): Operation<void, GetActiveSketchResult>;
+    /**
+     * Returns the active point graphic of the active sketch on a map.
+     *
+     * @webOnly
+     */
+    get getActiveNode(): Operation<ItemRef, GetActiveSketchResult>;
+}
+export declare class SketchingCommands extends CommandRegistry {
+    /**
+     * Undoes the last edit while editing a geometry.
+     */
+    get undo(): Command<HasMaps>;
+    /**
+     * Redoes the last undone edit while editing a geometry.
+     */
+    get redo(): Command<HasMaps>;
+    /**
+     * Sets the geometry mode of the geometry editor.
+     */
+    get setGeometryMode(): Command<SetGeometryModeArgs>;
+    /**
+     * Adds a point at the center of the map while editing a geometry. Works in
+     * centerCrosshair mode only.
+     *
+     * @mobileOnly
+     */
+    get addPointAtCenter(): Command<HasMaps>;
+    /**
+     * Adds a point at the user's current location while editing a geometry.
+     *
+     * @mobileOnly
+     */
+    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.
+     *
+     * @mobileOnly
+     */
+    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).
+     */
+    get delete(): Command<DeleteGeometryArgs>;
+    /**
+     * Moves a point within an active sketch to a new location.
+     *
+     * @webOnly
+     */
+    get moveNode(): Command<MoveNodeArgs>;
+    /**
+     * Switches the active point of an active sketch.
+     *
+     * @webOnly
+     */
+    get switchActiveNode(): Command<SwitchActiveNodeArgs>;
+    /**
+     * Sets the interaction mode of the geometry editor.
+     *
+     * @mobileOnly
+     */
+    get setInteractionMode(): Command<SetInteractionModeArgs>;
+}