@vertigis/viewer-spec 42.10.0

package/messaging/registry/offline.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var OfflineErrorCode;!function(e){e[e.NETWORK_CONNECTION_REQUIRED=100]="NETWORK_CONNECTION_REQUIRED",e[e.PORTAL_CONNECTION_FAILURE=101]="PORTAL_CONNECTION_FAILURE",e[e.ALREADY_STARTED=102]="ALREADY_STARTED",e[e.EXCEPTION_THROWN=103]="EXCEPTION_THROWN",e[e.INVALID_MAP_AREA_DATA=104]="INVALID_MAP_AREA_DATA",e[e.BACKGROUND_TIME_EXPIRED=105]="BACKGROUND_TIME_EXPIRED",e[e.MULTIPLE_ERRORS=106]="MULTIPLE_ERRORS",e[e.WEBMAP_REQUIRED=200]="WEBMAP_REQUIRED",e[e.WEBMAP_LOAD_FAILURE=201]="WEBMAP_LOAD_FAILURE",e[e.WEBMAP_NOT_LOADED=202]="WEBMAP_NOT_LOADED",e[e.WEBMAP_UNAUTHORIZED=203]="WEBMAP_UNAUTHORIZED"}(OfflineErrorCode||(OfflineErrorCode={}));export class OfflineCommands extends CommandRegistry{get cancelCreateArea(){return this._messages.command("offline.cancel-create-area")}get cancelDownload(){return this._messages.command("offline.cancel-download")}get deleteArea(){return this._messages.command("offline.delete-area")}get displayCreateArea(){return this._messages.command("offline.display-create-area")}}export class OfflineEvents extends EventRegistry{get areaActivated(){return this._messages.event("offline.area-activated")}get areaActivating(){return this._messages.event("offline.area-activating")}get areaDeleted(){return this._messages.event("offline.area-deleted")}get areaDownloadCanceled(){return this._messages.event("offline.area-download-canceled")}get areaDownloadFailed(){return this._messages.event("offline.area-download-failed")}get areaDownloaded(){return this._messages.event("offline.area-downloaded")}get areaUpdated(){return this._messages.event("offline.area-updated")}get areaUpdateFailed(){return this._messages.event("offline.area-update-failed")}get areaEditsSubmitted(){return this._messages.event("offline.area-edits-submitted")}get areaEditsSubmitFailed(){return this._messages.event("offline.area-edits-submit-failed")}get customAreaCreated(){return this._messages.event("offline.custom-area-created")}get userWentOnline(){return this._messages.event("offline.user-went-online")}}export class OfflineOperations extends OperationRegistry{get createArea(){return this._messages.operation("offline.create-area")}get getAreas(){return this._messages.operation("offline.get-areas")}get getEdits(){return this._messages.operation("offline.get-edits")}get activateArea(){return this._messages.operation("offline.activate-area")}get downloadArea(){return this._messages.operation("offline.download-area")}get goOnline(){return this._messages.operation("offline.go-online")}get checkForActiveArea(){return this._messages.operation("offline.check-for-active-area")}get submitEdits(){return this._messages.operation("offline.submit-edits")}get updateArea(){return this._messages.operation("offline.update-area")}}

package/messaging/registry/panel.d.ts

@@ -0,0 +1,93 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+/**
+ * Arguments for the "panel.anchor-host-panel" command.
+ */
+export interface AnchorHostPanelArgs {
+    /**
+     * The offset from the side of the screen.
+     */
+    offsetWidth: number;
+    /**
+     * The offset from the top or bottom of the screen.
+     */
+    offsetHeight: number;
+    /**
+     * The component to anchor to.
+     */
+    anchorComponent: ComponentBase;
+}
+/**
+ * Arguments for the "panel.snap-host-panel" command.
+ */
+export interface SnapHostPanelArgs {
+    /**
+     * The position to snap to.
+     */
+    snapPosition?: SnapPosition;
+    /**
+     * Snap to the last position set by the user.
+     */
+    userSet?: boolean;
+}
+/**
+ * A snapping position.
+ */
+export declare enum SnapPosition {
+    HIDDEN = "hidden",
+    MIDDLE = "middle",
+    TOP = "top"
+}
+/**
+ * Corresponds to `VertiGIS.Mobile.Composition.Layout.ComponentBase` in the
+ * VertiGIS.Mobile SDK.
+ */
+export interface ComponentBase {
+}
+export declare class PanelCommands extends CommandRegistry {
+    /**
+     * Displays the specified component in the host panel (a view that slides
+     * out from the side of the screen). The component input parameter is
+     * required, and if you don't provide it, or pass in a component that is
+     * already hosted elsewhere in the application, you will get an exception.
+     *
+     * @mobileOnly
+     */
+    get openHostPanel(): Command<ComponentBase>;
+    /**
+     * Closes the host panel. If a component is specified, the panel is only
+     * closed if the specified component is currently open in the host panel. If
+     * no component is specified (input null), then the host panel will always
+     * be closed.
+     *
+     * @mobileOnly
+     */
+    get closeHostPanel(): Command<ComponentBase>;
+    /**
+     * Anchors the host panel so that content will open with a certain offset
+     * from the left or right side of the application (depending on if provided
+     * anchor component is on the left or right side of the app).
+     *
+     * @mobileOnly
+     */
+    get anchorHostPanel(): Command<AnchorHostPanelArgs>;
+    /**
+     * Snaps the host panel to a particular position (eg. Middle, top, or
+     * hidden). For use only with the horizontal taskbar on mobile phones, where
+     * the taskbar panel content slides up from the bottom.
+     *
+     * @mobileOnly
+     */
+    get snapHostPanel(): Command<SnapHostPanelArgs>;
+}
+export declare class PanelEvents extends EventRegistry {
+    /**
+     * Raised when the component that is currently being displayed by the host
+     * panel is changed.
+     *
+     * @mobileOnly
+     */
+    get hostPanelComponentChanged(): Event<string>;
+}

package/messaging/registry/panel.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export var SnapPosition;!function(e){e.HIDDEN="hidden",e.MIDDLE="middle",e.TOP="top"}(SnapPosition||(SnapPosition={}));export class PanelCommands extends CommandRegistry{get openHostPanel(){return this._messages.command("panel.open-host-panel")}get closeHostPanel(){return this._messages.command("panel.close-host-panel")}get anchorHostPanel(){return this._messages.command("panel.anchor-host-panel")}get snapHostPanel(){return this._messages.command("panel.snap-host-panel")}}export class PanelEvents extends EventRegistry{get hostPanelComponentChanged(){return this._messages.event("panel.host-panel-component-changed")}}

package/messaging/registry/photos.d.ts

@@ -0,0 +1,45 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { Photo, VisualElement } from "../mobile.js";
+/**
+ * Arguments for the "photos.display-details" command.
+ */
+export interface DisplayPhotoDetailsArgs {
+    /**
+     * The index of the photo to start at.
+     */
+    startIndex: number;
+    /**
+     * The photo(s) to display.
+     */
+    photos: Photo[];
+    /**
+     * The sender UI element to use as an anchor point for animation when
+     * opening the attachment.
+     */
+    sender: VisualElement;
+}
+export declare class PhotosCommands extends CommandRegistry {
+    /**
+     * Displays a photo in expanded / details view.
+     *
+     * @mobileOnly
+     */
+    get displayDetails(): Command<DisplayPhotoDetailsArgs>;
+    /**
+     * Hides the currently displayed photo details.
+     *
+     * @mobileOnly
+     */
+    get hideDetails(): Command;
+}
+export declare class PhotosEvents extends EventRegistry {
+    /**
+     * Raised when photo details are hidden.
+     *
+     * @mobileOnly
+     */
+    get detailsHidden(): Event;
+}

package/messaging/registry/photos.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export class PhotosCommands extends CommandRegistry{get displayDetails(){return this._messages.command("photos.display-details")}get hideDetails(){return this._messages.command("photos.hide-details")}}export class PhotosEvents extends EventRegistry{get detailsHidden(){return this._messages.event("panel.details-hidden")}}

package/messaging/registry/portal.d.ts

@@ -0,0 +1,47 @@
+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, LayersLike } from "../common.js";
+/**
+ * Corresponds to `VertiGIS.Mobile.Infrastructure.Portal.ArcGISPortalExtension`
+ * in the VertiGIS.Mobile SDK.
+ */
+export interface ArcGISPortalExtension {
+}
+/**
+ * Arguments for the "portal.choose-layers" operation.
+ */
+export interface ChooseLayersOptions extends HasMaps {
+    /**
+     * Whether the user can choose multiple layers, or just one. Default is
+     * `false`.
+     */
+    allowMultiple?: boolean;
+}
+/**
+ * Result of the "portal.choose-layers" operation.
+ */
+export interface ChooseLayersResult extends HasMaps {
+    /**
+     * The layer(s) chosen by the user.
+     */
+    layers?: LayersLike;
+}
+export declare class PortalEvents extends EventRegistry {
+    /**
+     * Raised when an ArcGIS Portal is initialized.
+     *
+     * @mobileOnly
+     */
+    get initialized(): Event<ArcGISPortalExtension>;
+}
+export declare class PortalOperations extends OperationRegistry {
+    /**
+     * Allows the user to browse/search the application's associated portal for
+     * one or more layers.
+     *
+     * @webOnly
+     */
+    get chooseLayers(): Operation<ChooseLayersOptions, ChooseLayersResult>;
+}

package/messaging/registry/portal.js

@@ -0,0 +1 @@
+import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class PortalEvents extends EventRegistry{get initialized(){return this._messages.event("portal.initialized")}}export class PortalOperations extends OperationRegistry{get chooseLayers(){return this._messages.operation("portal.choose-layers")}}

package/messaging/registry/printing.d.ts

@@ -0,0 +1,138 @@
+import type Viewpoint from "@arcgis/core/Viewpoint";
+import type Extent from "@arcgis/core/geometry/Extent";
+import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
+import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { MapsLike } from "../common.js";
+/**
+ * A set of parameters used to run a job.
+ */
+export declare type JobParameters = Record<string, unknown>;
+/**
+ * The arguments required by the printing.run command.
+ */
+export interface RunPrintArgs {
+    /**
+     * The map(s) to print.
+     */
+    maps: MapsLike;
+    /**
+     * The ID of the report item.
+     */
+    id?: string;
+    /**
+     * The title of the report.
+     */
+    title?: string;
+    /**
+     * The portal item where the report is located.
+     */
+    portalItem?: PortalItemLike;
+    /**
+     * The DPI with which to print.
+     */
+    dpi?: number;
+    /**
+     * The scale of the map(s). Defaults to the map's current scale.
+     */
+    scale?: number;
+    /**
+     * The initial extent of the 2D map(s). Defaults to the map's current
+     * extent. If scale is provided, only the center point is used.
+     */
+    extent?: Extent;
+    /**
+     * The initial viewpoint of the 3D map(s). Defaults to the scene's current
+     * viewpoint.
+     */
+    viewpoint?: Viewpoint;
+    /**
+     * The rotation of the map(s). Defaults to the map's current rotation.
+     */
+    rotation?: number;
+    /**
+     * The WKID of the spatial reference used to draw a grid on the map(s).
+     */
+    grid?: SpatialReference;
+    /**
+     * Additional parameters used in the print template, specified as key-value pairs.
+     */
+    parameters?: JobParameters;
+    /**
+     * A unique ID used to track a print job.
+     */
+    instanceId?: string;
+}
+/**
+ * Base for the Print Event Args interfaces.
+ */
+export interface PrintEventArgsBase {
+    /**
+     * The ID of the print template being used.
+     */
+    printTemplateId: string;
+    /**
+     * A unique ID to track the running of this print.
+     */
+    instanceId: string;
+}
+/**
+ * Arguments for the printing.print-error event.
+ */
+export interface PrintErrorEventArgs extends PrintEventArgsBase {
+    /**
+     * The error message.
+     */
+    message: string;
+    /**
+     * The HTTP status code associated with the error, if it's a HTTP error.
+     */
+    errorCode?: number;
+}
+/**
+ * Arguments for the printing.print-finished event.
+ */
+export interface PrintFinishedEventArgs extends PrintEventArgsBase {
+    /**
+     * The URL from which to download the print.
+     */
+    downloadUrl: string;
+}
+/**
+ * Arguments for the printing.print-progress event.
+ */
+export interface PrintProgressEventArgs extends PrintEventArgsBase {
+}
+/**
+ * Arguments for the printing.print-started event.
+ */
+export interface PrintStartedEventArgs extends PrintEventArgsBase {
+}
+export declare class PrintCommands extends CommandRegistry {
+    /**
+     * Run a print job with a given map and template.
+     */
+    get run(): Command<RunPrintArgs>;
+}
+export declare class PrintEvents extends EventRegistry {
+    /**
+     * Raised when a print has started running.
+     */
+    get printStarted(): Event<PrintStartedEventArgs>;
+    /**
+     * Raised while a print is running to provide updates on its status.
+     */
+    get printProgress(): Event<PrintProgressEventArgs>;
+    /**
+     * Raised when a print has finished running. Event arguments include
+     * the print download URL.
+     */
+    get printFinished(): Event<PrintFinishedEventArgs>;
+    /**
+     * Raised when an error occurs with running a print.
+     */
+    get printError(): Event<PrintErrorEventArgs>;
+}

package/messaging/registry/printing.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export class PrintCommands extends CommandRegistry{get run(){return this._messages.command("printing.run")}}export class PrintEvents extends EventRegistry{get printStarted(){return this._messages.event("printing.print-started")}get printProgress(){return this._messages.event("printing.print-progress")}get printFinished(){return this._messages.event("printing.print-finished")}get printError(){return this._messages.event("printing.print-error")}}

package/messaging/registry/region.d.ts

@@ -0,0 +1,21 @@
+import type { MeasurementSystem } from "../../app-config/common/RegionModelProperties.js";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+export declare class RegionCommands extends CommandRegistry {
+    /**
+     * Sets the current measurement system.
+     *
+     * @webOnly
+     */
+    get setMeasurementSystem(): Command<MeasurementSystem>;
+}
+export declare class RegionEvents extends EventRegistry {
+    /**
+     * Raised when the current measurement system is changed.
+     *
+     * @webOnly
+     */
+    get measurementSystemChanged(): Event<MeasurementSystem>;
+}

package/messaging/registry/region.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export class RegionCommands extends CommandRegistry{get setMeasurementSystem(){return this._messages.command("region.set-measurement-system")}}export class RegionEvents extends EventRegistry{get measurementSystemChanged(){return this._messages.event("region.measurement-system-changed")}}

package/messaging/registry/reports.d.ts

@@ -0,0 +1,112 @@
+import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { FeaturesLike } from "../common.js";
+/**
+ * The arguments required by the reports.run command.
+ */
+export interface RunReportArgs {
+    /**
+     * The ID of the report item.
+     */
+    id?: string;
+    /**
+     * The title of the report.
+     */
+    title?: string;
+    /**
+     * The portal item where the report is located.
+     */
+    portalItem?: PortalItemLike;
+    /**
+     * A unique ID to identify an instance of this report running.
+     */
+    instanceId?: string;
+    /**
+     * The features passed to the report.
+     */
+    features?: FeaturesLike;
+}
+/**
+ * Base for the Report Event Args interfaces.
+ */
+export interface ReportEventArgsBase {
+    /**
+     * The ID of the report being run.
+     */
+    reportId: string;
+    /**
+     * A unique ID to track the running of this report.
+     */
+    instanceId: string;
+}
+/**
+ * Arguments for the reports.report-error event.
+ */
+export interface ReportErrorEventArgs extends ReportEventArgsBase {
+    /**
+     * The error message.
+     */
+    message: string;
+    /**
+     * The HTTP status code associated with the error, if it's a HTTP error.
+     */
+    errorCode?: number;
+}
+/**
+ * Arguments for the reports.report-finished event.
+ */
+export interface ReportFinishedEventArgs extends ReportEventArgsBase {
+    /**
+     * The URL to download the report at.
+     */
+    downloadUrl: string;
+}
+/**
+ * Arguments for the reports.report-progress event.
+ */
+export interface ReportProgressEventArgs extends ReportEventArgsBase {
+}
+/**
+ * Arguments for the reports.report-started event.
+ */
+export interface ReportStartedEventArgs extends ReportEventArgsBase {
+}
+export declare class ReportsCommands extends CommandRegistry {
+    /**
+     * Run a report on the given features. The report URL and feature IDs are
+     * provided by the viewer.
+     *
+     * @webOnly
+     */
+    get run(): Command<RunReportArgs>;
+}
+export declare class ReportEvents extends EventRegistry {
+    /**
+     * Raised when a report has started running.
+     *
+     * @webOnly
+     */
+    get reportStarted(): Event<ReportStartedEventArgs>;
+    /**
+     * Raised while a report is running to provide updates on its status.
+     *
+     * @webOnly
+     */
+    get reportProgress(): Event<ReportProgressEventArgs>;
+    /**
+     * Raised when a report has finished running. Event arguments include the
+     * report download URL.
+     *
+     * @webOnly
+     */
+    get reportFinished(): Event<ReportFinishedEventArgs>;
+    /**
+     * Raised when an error occurs with running a report.
+     *
+     * @webOnly
+     */
+    get reportError(): Event<ReportErrorEventArgs>;
+}