@vertigis/viewer-spec 42.10.0

package/messaging/registry/edit.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export class EditCommands extends CommandRegistry{get addAttachment(){return this._messages.command("edit.add-attachment")}get addFeature(){return this._messages.command("edit.add-feature")}get deleteFeatures(){return this._messages.command("edit.delete-features")}get displayAddFeature(){return this._messages.command("edit.display-add-feature")}get displayUpdateFeature(){return this._messages.command("edit.display-update-feature")}get updateFeature(){return this._messages.command("edit.update-feature")}}export class EditEvents extends EventRegistry{get attachmentAdded(){return this._messages.event("edit.attachment-added")}get attachmentUpdated(){return this._messages.event("edit.attachment-updated")}get attachmentDeleted(){return this._messages.event("edit.attachment-deleted")}get featureAdded(){return this._messages.event("edit.feature-added")}get featureDeleted(){return this._messages.event("edit.feature-deleted")}get featureUpdated(){return this._messages.event("edit.feature-updated")}}

package/messaging/registry/file.d.ts

@@ -0,0 +1,58 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+/**
+ * A type of attachment.
+ */
+export declare type AttachmentType = "File" | "Media";
+/**
+ * The binary contents of the attachment.
+ */
+export interface EnhancedFileData {
+}
+/**
+ * Arguments to pick a file.
+ */
+export interface PickFileArgs {
+    /**
+     * Type of the attachment used to pick a file.
+     *
+     * @mobileOnly
+     */
+    attachmentType: AttachmentType;
+    /**
+     * Allowed types of file used to pick a file.
+     *
+     * @mobileOnly
+     */
+    allowedFileTypes: string[];
+}
+/**
+ * Arguments to open a file.
+ */
+export interface OpenFileArgs {
+    /**
+     * Name of the file to open.
+     *
+     * @mobileOnly
+     */
+    fileName: string;
+}
+export declare class FileOperations extends OperationRegistry {
+    /**
+     * Prompt the user to select a file from the file system, and return the
+     * resulting data.
+     *
+     * @mobileOnly
+     */
+    get pickFile(): Operation<PickFileArgs, EnhancedFileData>;
+}
+export declare class FileCommands extends CommandRegistry {
+    /**
+     * Opens a file in an app assigned to the file type.
+     *
+     * @mobileOnly
+     */
+    get openFile(): Command<OpenFileArgs | string>;
+}

package/messaging/registry/file.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class FileOperations extends OperationRegistry{get pickFile(){return this._messages.operation("file.pick-file")}}export class FileCommands extends CommandRegistry{get openFile(){return this._messages.command("file.open-file")}}

package/messaging/registry/geocode.d.ts

@@ -0,0 +1,91 @@
+import type Geometry from "@arcgis/core/geometry/Geometry";
+import type { AddressLike, GeocodeOptions } from "@vertigis/arcgis-extensions/tasks/geocoding/Geocoder";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+/**
+ * Arguments for the "geocode.geocode" and "geocode.count" operations.
+ */
+export interface GeocodeArgs {
+    /**
+     * The address to look up.
+     */
+    address: AddressLike;
+    /**
+     * Options that affect geocode results.
+     */
+    options: GeocodeOptions;
+}
+/**
+ * Arguments for the "geocode.batch-geocode" operation.
+ */
+export interface BatchGeocodeArgs {
+    /**
+     * The addresses to look up.
+     */
+    addresses: AddressLike[];
+    /**
+     * Options that affect geocode results.
+     */
+    options: GeocodeOptions;
+}
+/**
+ * Arguments for the "geocode.suggest" operation.
+ */
+export interface SuggestArgs {
+    /**
+     * The search text entered by the user.
+     */
+    searchText: string;
+    /**
+     * Options that affect geocode results.
+     */
+    options: GeocodeOptions;
+}
+/**
+ * Arguments for the "geocode.reverse-geocode" operation.
+ */
+export interface ReverseGeocodeArgs {
+    /**
+     * The location to look up.
+     */
+    geometry: Geometry;
+    /**
+     * Options that affect geocode results.
+     */
+    options: GeocodeOptions;
+}
+export declare class GeocodeOperations extends OperationRegistry {
+    /**
+     * Finds one or more locations corresponding to an address.
+     *
+     * @webOnly
+     */
+    get geocode(): Operation<GeocodeArgs>;
+    /**
+     * Finds locations corresponding to multiple addresses. The geocoder must
+     * have the supportsBatchGeocoding capability.
+     *
+     * @webOnly
+     */
+    get batchGeocode(): Operation<BatchGeocodeArgs>;
+    /**
+     * Counts the number of locations corresponding to an address.
+     *
+     * @webOnly
+     */
+    get count(): Operation<GeocodeArgs>;
+    /**
+     * Suggests matching addresses to search for based on some input text. The
+     * geocoder must have the supportsSuggest capability.
+     *
+     * @webOnly
+     */
+    get suggest(): Operation<SuggestArgs>;
+    /**
+     * Finds the address at a particular location. The geocoder must have the
+     * supportsReverseGeocoding capability.
+     *
+     * @webOnly
+     */
+    get reverseGeocode(): Operation<ReverseGeocodeArgs>;
+}

package/messaging/registry/geocode.js

@@ -0,0 +1 @@
+import{OperationRegistry}from"../OperationRegistry.js";export class GeocodeOperations extends OperationRegistry{get geocode(){return this._messages.operation("geocode.geocode")}get batchGeocode(){return this._messages.operation("geocode.batch-geocode")}get count(){return this._messages.operation("geocode.count")}get suggest(){return this._messages.operation("geocode.suggest")}get reverseGeocode(){return this._messages.operation("geocode.reverse-geocode")}}

package/messaging/registry/geolocation.d.ts

@@ -0,0 +1,268 @@
+import type Point from "@arcgis/core/geometry/Point";
+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 { HasMaps, Maps } from "../common.js";
+import type { MapExtensionArgs } from "../mobile.js";
+/**
+ * Arguments for the "geolocation.accuracy-changed" event.
+ */
+export interface GeolocateAccuracyChangedEventArgs {
+    /**
+     * The current geolocation accuracy, in meters.
+     */
+    accuracy: number;
+}
+/**
+ * Arguments for the "geolocation.metadata-changed" event.
+ */
+export interface GeolocateMetadataChangedEventArgs {
+}
+/**
+ * Current GNSS device settings.
+ */
+export interface GnssDeviceSettings {
+}
+/**
+ * Result for the "geolocation.get-current-state" operation.
+ */
+export interface GeolocateCurrentState {
+    /**
+     * Whether or not a position is actively being reported and received.
+     */
+    isGeolocationAvailable: boolean;
+    /**
+     * Whether or not the app has been permitted to use geolocation according to
+     * the OS level settings.
+     */
+    isGeolocationEnabled: boolean;
+    /**
+     * The current accuracy in meters.
+     */
+    accuracy: number;
+    /**
+     * The current position.
+     */
+    position: Point;
+}
+/**
+ * Arguments for the "geolocation.status-changed" event.
+ */
+export interface GeolocationStatusChangedEventArgs {
+}
+/**
+ * Arguments for geolocation events such as "geolocation.position-acquired" and
+ * "geolocation.position-lost".
+ */
+export interface GeolocationEvent {
+    /**
+     * The GNSS source associated with the raised geolocation event.
+     *
+     * @mobileOnly
+     */
+    gnssDeviceConnectionInfo?: GnssDeviceConnectionInfo;
+}
+/**
+ * A geolocation source.
+ */
+export interface GnssDeviceConnectionInfo {
+    /**
+     * Name of the GNSS device.
+     */
+    deviceName: string;
+    /**
+     * The type of the device. Options are Integrated, Bluetooth, USB, and
+     * Emulator.
+     */
+    deviceType: GnssDeviceType;
+    /**
+     * The device settings, including the correction service's spatial
+     * reference, the desired datum transformation, and the device's antenna
+     * height.
+     */
+    settings: GnssDeviceSettings;
+}
+declare enum GnssDeviceType {
+    INTEGRATED = "integrated",
+    BLUETOOTH = "bluetooth",
+    USB = "usb",
+    EMULATOR = "emulator"
+}
+export declare class GeolocationCommands extends CommandRegistry {
+    /**
+     * Centers the map on the user's current location and keeps the location
+     * centered as it moves around. The maps parameter is only supported in
+     * Geocortex Mobile Viewer. In Geocortex Web Viewer, all maps are affected.
+     */
+    get autoRecenter(): Command<Maps | void>;
+    /**
+     * Centers the map on the user's current location and updates the
+     * orientation of the map to face the direction of the device. Keeps the
+     * location centered as it moves around. Returns whether guiding started
+     * successfully.
+     *
+     * @mobileOnly
+     */
+    get autoRecenterAndReorient(): Command<MapExtensionArgs>;
+    /**
+     * Show the user's location while the location is in the map's extent.
+     */
+    get displayLocation(): Command;
+    /**
+     * Turns off geolocation.
+     */
+    get turnOffGeolocation(): Command;
+    /**
+     * Displays the GNSS device settings view.
+     *
+     * @mobileOnly
+     */
+    get displayDeviceSettings(): Command<GnssDeviceConnectionInfo>;
+    /**
+     * Displays the GNSS device metadata view.
+     *
+     * @mobileOnly
+     */
+    get displayDeviceMetadata(): Command;
+    /**
+     * Displays the GNSS device selection view.
+     *
+     * @mobileOnly
+     */
+    get displayDeviceSelection(): Command;
+}
+export declare class GeolocationOperations extends OperationRegistry {
+    /**
+     * Updates the currently active GNSS receiver.
+     *
+     * @mobileOnly
+     */
+    get changeSource(): Operation<GnssDeviceConnectionInfo, void>;
+    /**
+     * Gets the currently active geolocation source.
+     *
+     * @mobileOnly
+     */
+    get getActiveSource(): Operation<GnssDeviceConnectionInfo>;
+    /**
+     * Gets the list of currently available geolocation sources.
+     * Includes integrated receivers, GNSS devices, and emulators.
+     *
+     * @mobileOnly
+     */
+    get getAllSources(): Operation<boolean, GnssDeviceConnectionInfo[]>;
+    /**
+     * Gets the current geolocate state.
+     */
+    get getCurrentState(): Operation<void, GeolocateCurrentState>;
+    /**
+     * Returns whether integrated location services have been permitted via app
+     * or browser permissions.
+     */
+    get getLocationPermissionsEnabled(): Operation<boolean>;
+    /**
+     * Returns the current user position. This Operation can block while the
+     * user is prompted for permission, as such it is considered best practice not to
+     * perform this during startup.
+     */
+    get getPosition(): Operation<void, Point>;
+}
+export declare class GeolocationEvents extends EventRegistry {
+    /**
+     * Raised when geolocation is activated and the accuracy of geolocation
+     * changes.
+     */
+    get accuracyChanged(): Event<GeolocateAccuracyChangedEventArgs>;
+    /**
+     * Raised when a GNSS receiver is active and metadata about the device
+     * or location change.
+     *
+     * @mobileOnly
+     */
+    get metadataChanged(): Event<GeolocateMetadataChangedEventArgs>;
+    /**
+     * Raised when geolocation enters auto recenter mode. For Geocortex Web
+     * Viewer, the event will have no parameter (all maps are always affected).
+     */
+    get autoRecenterStarted(): Event<HasMaps | void>;
+    /**
+     * Raised when the user changes the geolocation mode to
+     * recenter-and-reorient (updates map orientation to match device
+     * direction).
+     *
+     * @mobileOnly
+     */
+    get autoRecenterAndReorientStarted(): Event<MapExtensionArgs>;
+    /**
+     * Raised when geolocation leaves auto recenter mode. For Geocortex Web
+     * Viewer, the event will have no parameter (all maps are always affected).
+     */
+    get autoRecenterStopped(): Event<HasMaps | void>;
+    /**
+     * Raised when the user changes the geolocation mode to not
+     * recenter-and-reorient.
+     *
+     * @mobileOnly
+     */
+    get autoRecenterAndReorientStopped(): Event<MapExtensionArgs>;
+    /**
+     * Raised when detection of connected GNSS receivers begins.
+     *
+     * @mobileOnly
+     */
+    get GnssDeviceDetectionStarted(): Event<GnssDeviceConnectionInfo[]>;
+    /**
+     * Raised when detection of connected GNSS receivers ends.
+     *
+     * @mobileOnly
+     */
+    get GnssDeviceDetectionStopped(): Event;
+    /**
+     * Raised when geolocation is activated and the user's heading changes.
+     *
+     * @webOnly
+     */
+    get headingChanged(): Event<number>;
+    /**
+     * Raised when geolocation is activated and a user position has been
+     * received.
+     */
+    get positionAcquired(): Event<GeolocationEvent>;
+    /**
+     * Raised when geolocation is activated and the user's position changes.
+     */
+    get positionChanged(): Event<Point>;
+    /**
+     * Raised when geolocation is disabled, either through signal loss or being
+     * turned off, and a user position is not available.
+     */
+    get positionLost(): Event<GeolocationEvent>;
+    /**
+     * Raised when the source of geolocation data is changed to a different
+     * source (e.g. a GNSS receiver).
+     *
+     * @mobileOnly
+     */
+    get sourceChanged(): Event<GnssDeviceConnectionInfo>;
+    /**
+     * Raised when geolocation status (enabled or disabled via app permissions)
+     * changes.
+     */
+    get statusChanged(): Event<GeolocationStatusChangedEventArgs>;
+    /**
+     * Raised when geolocation enters displaying location mode.
+     *
+     * @webOnly
+     */
+    get displayLocationStarted(): Event;
+    /**
+     * Raised when geolocation leaves displaying location mode.
+     *
+     * @webOnly
+     */
+    get displayLocationStopped(): Event;
+}
+export {};

package/messaging/registry/geolocation.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";var GnssDeviceType;!function(e){e.INTEGRATED="integrated",e.BLUETOOTH="bluetooth",e.USB="usb",e.EMULATOR="emulator"}(GnssDeviceType||(GnssDeviceType={}));export class GeolocationCommands extends CommandRegistry{get autoRecenter(){return this._messages.command("geolocation.auto-recenter")}get autoRecenterAndReorient(){return this._messages.command("geolocation.auto-recenter-and-reorient")}get displayLocation(){return this._messages.command("geolocation.display-location")}get turnOffGeolocation(){return this._messages.command("geolocation.turn-off-geolocation")}get displayDeviceSettings(){return this._messages.command("geolocation.display-device-settings")}get displayDeviceMetadata(){return this._messages.command("geolocation.display-device-metadata")}get displayDeviceSelection(){return this._messages.command("geolocation.display-device-selection")}}export class GeolocationOperations extends OperationRegistry{get changeSource(){return this._messages.operation("geolocation.change-source")}get getActiveSource(){return this._messages.operation("geolocation.get-active-source")}get getAllSources(){return this._messages.operation("geolocation.get-all-sources")}get getCurrentState(){return this._messages.operation("geolocation.get-current-state")}get getLocationPermissionsEnabled(){return this._messages.operation("geolocation.get-location-permissions-enabled")}get getPosition(){return this._messages.operation("geolocation.get-position")}}export class GeolocationEvents extends EventRegistry{get accuracyChanged(){return this._messages.event("geolocation.accuracy-changed")}get metadataChanged(){return this._messages.event("geolocation.metadata-changed")}get autoRecenterStarted(){return this._messages.event("geolocation.auto-recenter-started")}get autoRecenterAndReorientStarted(){return this._messages.event("geolocation.auto-recenter-and-reorient-started")}get autoRecenterStopped(){return this._messages.event("geolocation.auto-recenter-stopped")}get autoRecenterAndReorientStopped(){return this._messages.event("geolocation.auto-recenter-and-reorient-stopped")}get GnssDeviceDetectionStarted(){return this._messages.event("geolocation.gnss-device-detection-started")}get GnssDeviceDetectionStopped(){return this._messages.event("geolocation.gnss-device-detection-stopped")}get headingChanged(){return this._messages.event("geolocation.heading-changed")}get positionAcquired(){return this._messages.event("geolocation.position-acquired")}get positionChanged(){return this._messages.event("geolocation.position-changed")}get positionLost(){return this._messages.event("geolocation.position-lost")}get sourceChanged(){return this._messages.event("geolocation.source-changed")}get statusChanged(){return this._messages.event("geolocation.status-changed")}get displayLocationStarted(){return this._messages.event("geolocation.display-location-started")}get displayLocationStopped(){return this._messages.event("geolocation.display-location-stopped")}}

package/messaging/registry/geometry-toolbar.d.ts

@@ -0,0 +1,28 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { MapExtensionArgs } from "../mobile.js";
+/**
+ * Arguments for the Geometry Toolbar show command. Only available in the
+ * Geocortex Mobile Viewer.
+ */
+export interface GeometryToolbarArgs extends MapExtensionArgs {
+    /**
+     * Whether the toolbar will allow users to toggle between area and line
+     * drawing modes. Defaults to true.
+     */
+    isAreaToggleable: boolean;
+}
+export declare class GeometryToolbarCommands extends CommandRegistry {
+    /**
+     * Shows the Geometry Toolbar.
+     *
+     * @mobileOnly
+     */
+    get show(): Command<GeometryToolbarArgs | void>;
+    /**
+     * Hides the Geometry Toolbar.
+     *
+     * @mobileOnly
+     */
+    get hide(): Command<MapExtensionArgs | void>;
+}