@vertigis/viewer-spec 42.10.0

package/messaging/registry/geometry-toolbar.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";export class GeometryToolbarCommands extends CommandRegistry{get show(){return this._messages.command("geometry-toolbar.show")}get hide(){return this._messages.command("geometry-toolbar.hide")}}

package/messaging/registry/geometry.d.ts

@@ -0,0 +1,101 @@
+import type Geometry from "@arcgis/core/geometry/Geometry";
+import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
+import type GeographicTransformation from "@arcgis/core/geometry/support/GeographicTransformation";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Geometries, HasFeatures, HasGeometry, HasMaps, MapsLike } from "../common.js";
+import type { CaptureGeometryResult } from "./sketching.js";
+/**
+ * Arguments for the geometry.project operation.
+ */
+export interface ProjectArgs {
+    /**
+     * The geometries to project.
+     */
+    geometries: Geometry | Geometry[];
+    /**
+     * The target spatial reference.
+     */
+    outSpatialReference: SpatialReference;
+    /**
+     * The geographic transformation which contains the steps to transform the
+     * input spatial reference to the output spatial reference.
+     */
+    transformation?: GeographicTransformation;
+}
+/**
+ * The units for distance buffers supported by ArcGIS.
+ */
+export declare type LengthUnits = "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards";
+/**
+ * The result of a geometry.buffer operation.
+ */
+export interface BufferResult {
+    /**
+     * The buffered geometry.
+     */
+    geometry: Geometry | Geometry[];
+    /**
+     * Any maps that were included within the input arguments.
+     */
+    maps?: MapsLike;
+}
+export declare class GeometryOperations extends OperationRegistry {
+    /**
+     * Projects a set of geometries to a new spatial reference.
+     *
+     * @webOnly
+     */
+    get project(): Operation<ProjectArgs, Geometry[]>;
+    /**
+     * Buffers a point geometry by a distance equivalent to the number of pixels
+     * at the current map scale.
+     *
+     * @webOnly
+     */
+    get addPixelTolerance(): Operation<(HasFeatures | HasGeometry) & Required<HasMaps>, CaptureGeometryResult>;
+    /**
+     * Buffers a set of geometries by some distance to create a multi-part
+     * polygon geometry. The distance value respects the user's preferences and
+     * falls back on the default configured for the viewer session.
+     *
+     * @webOnly
+     */
+    get buffer(): Operation<Geometries, BufferResult>;
+    /**
+     * Returns the default buffer distance for the viewer session.
+     *
+     * @webOnly
+     */
+    get getBufferDistance(): Operation<void, number>;
+    /**
+     * Returns the default buffer units for the viewer session.
+     *
+     * @webOnly
+     */
+    get getBufferUnits(): Operation<void, LengthUnits>;
+}
+export declare class GeometryCommands extends CommandRegistry {
+    /**
+     * Sets the default buffer distance for the viewer session. The buffer
+     * distance must be a number > 0.
+     *
+     * @webOnly
+     */
+    get setBufferDistance(): Command<number>;
+    /**
+     * Sets the default buffer units for the viewer session.
+     *
+     * @webOnly
+     */
+    get setBufferUnits(): Command<LengthUnits>;
+    /**
+     * Show the geometry settings dialog. This allows you to configure buffer
+     * distance and buffer units.
+     *
+     * @webOnly
+     */
+    get showSettings(): Command<void>;
+}

package/messaging/registry/geometry.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class GeometryOperations extends OperationRegistry{get project(){return this._messages.operation("geometry.project")}get addPixelTolerance(){return this._messages.operation("geometry.add-pixel-tolerance")}get buffer(){return this._messages.operation("geometry.buffer")}get getBufferDistance(){return this._messages.operation("geometry.get-buffer-distance")}get getBufferUnits(){return this._messages.operation("geometry.get-buffer-units")}}export class GeometryCommands extends CommandRegistry{get setBufferDistance(){return this._messages.command("geometry.set-buffer-distance")}get setBufferUnits(){return this._messages.command("geometry.set-buffer-units")}get showSettings(){return this._messages.command("geometry.show-settings")}}

package/messaging/registry/highlights.d.ts

@@ -0,0 +1,83 @@
+import type { FeatureSet } from "@vertigis/arcgis-extensions/data/FeatureSet";
+import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Features, Maps } from "../common.js";
+import type { MapExtensionArgs, MapExtensionFeatureArgs } from "../mobile.js";
+export declare class HighlightsCommands extends CommandRegistry {
+    /**
+     * Applies highlighting to one or more features.
+     */
+    get add(): Command<Features>;
+    /**
+     * Removes highlighting from one or many features.
+     */
+    get remove(): Command<Features>;
+    /**
+     * Removes highlighting from all features on the given map(s). If no map is
+     * provided, features from all maps will be cleared.
+     */
+    get clear(): Command<Maps | void>;
+    /**
+     * Adds a temporary focused-state highlight to one or more features.
+     */
+    get pulse(): Command<Features>;
+    /**
+     * Adds focused-state highlighting to one or more features.
+     */
+    get addFocus(): Command<Features>;
+    /**
+     * Removes focused-state highlighting from one or more features.
+     */
+    get removeFocus(): Command<Features>;
+    /**
+     * Removes focused-state highlighting from all features.
+     */
+    get clearFocus(): Command<Maps | void>;
+    /**
+     * Hides all highlight overlays (can be undone with highlights.show).
+     *
+     * @mobileOnly
+     */
+    get hide(): Command<MapExtensionArgs>;
+    /**
+     * Hides the focus highlight (can be undone with highlights.show-focus).
+     *
+     * @mobileOnly
+     */
+    get hideFocus(): Command<MapExtensionArgs>;
+    /**
+     * Refreshes highlighting for one or many features.
+     *
+     * @mobileOnly
+     */
+    get refresh(): Command<MapExtensionFeatureArgs>;
+    /**
+     * Shows all highlight overlays (makes not hidden).
+     *
+     * @mobileOnly
+     */
+    get show(): Command<MapExtensionArgs>;
+    /**
+     * Shows the highlight focus (makes focus not hidden).
+     *
+     * @mobileOnly
+     */
+    get showFocus(): Command<MapExtensionArgs>;
+}
+export declare class HighlightsOperations extends OperationRegistry {
+    /**
+     * Returns all highlighted features for a given map.
+     *
+     * @webOnly
+     */
+    get get(): Operation<MapExtension, FeatureSet>;
+    /**
+     * Returns all focused features for a given map.
+     *
+     * @webOnly
+     */
+    get getFocused(): Operation<MapExtension, FeatureSet>;
+}

package/messaging/registry/highlights.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class HighlightsCommands extends CommandRegistry{get add(){return this._messages.command("highlights.add")}get remove(){return this._messages.command("highlights.remove")}get clear(){return this._messages.command("highlights.clear")}get pulse(){return this._messages.command("highlights.pulse")}get addFocus(){return this._messages.command("highlights.add-focus")}get removeFocus(){return this._messages.command("highlights.remove-focus")}get clearFocus(){return this._messages.command("highlights.clear-focus")}get hide(){return this._messages.command("highlights.hide")}get hideFocus(){return this._messages.command("highlights.hide-focus")}get refresh(){return this._messages.command("highlights.refresh")}get show(){return this._messages.command("highlights.show")}get showFocus(){return this._messages.command("highlights.show-focus")}}export class HighlightsOperations extends OperationRegistry{get get(){return this._messages.operation("highlights.get")}get getFocused(){return this._messages.operation("highlights.get-focused")}}

package/messaging/registry/input.d.ts

@@ -0,0 +1,21 @@
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+/**
+ * Arguments for the "input.keyboard-shortcut-pressed" event.
+ */
+export interface ConsoleKeyInfoObj {
+}
+export declare class InputEvents extends EventRegistry {
+    /**
+     * Raised when the user shakes the device.
+     *
+     * @mobileOnly
+     */
+    get shake(): Event;
+    /**
+     * Raised when the user presses a keyboard shortcut.
+     *
+     * @mobileOnly
+     */
+    get keyboardShortcutPressed(): Event<ConsoleKeyInfoObj>;
+}

package/messaging/registry/input.js

@@ -0,0 +1 @@
+import{EventRegistry}from"../EventRegistry.js";export class InputEvents extends EventRegistry{get shake(){return this._messages.event("input.shake")}get keyboardShortcutPressed(){return this._messages.event("input.keyboard-shortcut-pressed")}}

package/messaging/registry/iwtm.d.ts

@@ -0,0 +1,10 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+export declare class IwtmCommands extends CommandRegistry {
+    /**
+     * Displays the I Want To Menu with the given ID.
+     *
+     * @mobileOnly
+     */
+    get open(): Command<string>;
+}

package/messaging/registry/iwtm.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";export class IwtmCommands extends CommandRegistry{get open(){return this._messages.command("iwtm.open")}}

package/messaging/registry/kpi.d.ts

@@ -0,0 +1,95 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Features, HasFeatures, ModelRef } from "../common.js";
+/**
+ * Arguments for various commands that affect a KPI card's features.
+ */
+export interface UpdateKpiCardFeaturesArgs extends HasFeatures {
+    /**
+     * The KPI card to update, referenced by KPI card model or its ID.
+     */
+    kpiCard: ModelRef;
+}
+/**
+ * Arguments for the kpi.update-definition command.
+ */
+export interface UpdateKpiCardDefinitionArgs {
+    /**
+     * The KPI card model or its ID.
+     */
+    kpiCard: ModelRef;
+    /**
+     * The stringified Arcade script used to calculate the 'value' token of the
+     * KPI Card.
+     */
+    valueExpression?: string;
+    /**
+     * The stringified Arcade script used to calculate the 'reference' token of
+     * the KPI card.
+     */
+    referenceExpression?: string;
+}
+/**
+ * The result of the the charts.update-definition operation.
+ */
+export interface GetKpiDefinitionResult {
+    /**
+     * The stringified Arcade script used to calculate the 'value' token of the
+     * KPI card.
+     */
+    valueExpression: string;
+    /**
+     * The stringified Arcade script used to calculate the 'reference' token of
+     * the KPI Card.
+     */
+    referenceExpression: string;
+}
+export declare class KpiCommands extends CommandRegistry {
+    /**
+     * Displays the KPI card and updates it with provided features.
+     *
+     * @webOnly
+     */
+    get display(): Command<Features | UpdateKpiCardFeaturesArgs>;
+    /**
+     * Add one or more features to active KPI cards.
+     *
+     * @webOnly
+     */
+    get addFeatures(): Command<Features | UpdateKpiCardFeaturesArgs>;
+    /**
+     * Remove one or more features from active KPI cards.
+     *
+     * @webOnly
+     */
+    get removeFeatures(): Command<Features | UpdateKpiCardFeaturesArgs>;
+    /**
+     * Clear features from active KPI cards.
+     *
+     * @webOnly
+     */
+    get clear(): Command<ModelRef | void>;
+    /**
+     * Updates the definition of a KPI Card.
+     *
+     * @webOnly
+     */
+    get updateDefinition(): Command<UpdateKpiCardDefinitionArgs>;
+}
+export declare class KpiOperations extends OperationRegistry {
+    /**
+     * Returns the current set of features from all active KPI Cards.
+     *
+     * @webOnly
+     */
+    get getFeatures(): Operation<ModelRef | void, Features>;
+    /**
+     * Gets the definition of a KPI card that corresponds to the ID or the
+     * instance of the KPI card model that's passed in as an argument.
+     *
+     * @webOnly
+     */
+    get getDefinition(): Operation<ModelRef, GetKpiDefinitionResult>;
+}

package/messaging/registry/kpi.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class KpiCommands extends CommandRegistry{get display(){return this._messages.command("kpi.display")}get addFeatures(){return this._messages.command("kpi.add-features")}get removeFeatures(){return this._messages.command("kpi.remove-features")}get clear(){return this._messages.command("kpi.clear")}get updateDefinition(){return this._messages.command("kpi.update-definition")}}export class KpiOperations extends OperationRegistry{get getFeatures(){return this._messages.operation("kpi.get-features")}get getDefinition(){return this._messages.operation("kpi.get-definition")}}

package/messaging/registry/layer-comparison.d.ts

@@ -0,0 +1,102 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Layers, MapsLike } from "../common.js";
+/**
+ * Arguments for the layer-comparison.set-mode command.
+ */
+export interface SetLayerComparisonModeArgs {
+    /**
+     * Whether or not the layer-comparison mode should be active.
+     */
+    active: boolean;
+    /**
+     * The map(s) on which to set the layer-comparison mode.
+     */
+    maps?: MapsLike;
+    /**
+     * Sets the leading layers on the map.
+     */
+    leadingLayers?: Layers;
+    /**
+     * Sets the trailing layers on the map.
+     */
+    trailingLayers?: Layers;
+}
+/**
+ * Arguments for the layer-comparison.set-direction command.
+ */
+export interface SetLayerComparisonDirectionArgs {
+    /**
+     * The direction in which the layer-comparison tool should slide.
+     */
+    direction: "horizontal" | "vertical";
+    /**
+     * The map(s) on which to set the layer-comparison direction.
+     */
+    maps?: MapsLike;
+}
+export declare class LayerComparisonCommands extends CommandRegistry {
+    /**
+     * Activates or deactivates the layer-comparison mode on the map(s).
+     *
+     * @webOnly
+     */
+    get setMode(): Command<SetLayerComparisonModeArgs>;
+    /**
+     * Changes the orientation of the map(s') layer-comparison bar between
+     * 'horizontal' and 'vertical'.
+     *
+     * @webOnly
+     */
+    get setDirection(): Command<SetLayerComparisonDirectionArgs>;
+    /**
+     * Adds the layer(s) to the map's leading layers, which are used by the
+     * layer-comparison tool. Leading layers are positioned at the left of the
+     * map if the layer-comparison orientation is 'horizontal' and at the top of
+     * the map if the layer-comparison orientation is 'vertical'. Adding a layer
+     * to the leading layers will automatically remove it from the trailing
+     * layers. Only operational layers that exist within a given map are valid -
+     * others will be ignored.
+     *
+     * @webOnly
+     */
+    get addLeadingLayers(): Command<Layers>;
+    /**
+     * Adds the layer(s) to the map's trailing layers, which are used by the
+     * layer-comparison tool. Trailing layers are positioned at the right of the
+     * map if the layer-comparison orientation is 'horizontal' and at the bottom
+     * of the map if the layer-comparison orientation is 'vertical'. Adding a
+     * layer to the trailing layers will automatically remove it from the
+     * leading layers. Only operational layers that exist within a given map are
+     * valid - others will be ignored.
+     *
+     * @webOnly
+     */
+    get addTrailingLayers(): Command<Layers>;
+    /**
+     * Removes the layer(s) from the map's leading layers, which are used by the
+     * layer-comparison tool.
+     *
+     * @webOnly
+     */
+    get removeLeadingLayers(): Command<Layers>;
+    /**
+     * Removes the layer(s) from the map's trailing layers, which are used by the
+     * layer-comparison tool.
+     *
+     * @webOnly
+     */
+    get removeTrailingLayers(): Command<Layers>;
+    /**
+     * Removes all leading layers from the map(s).
+     *
+     * @webOnly
+     */
+    get clearLeadingLayers(): Command<MapsLike | void>;
+    /**
+     * Removes all trailing layers from the map(s).
+     *
+     * @webOnly
+     */
+    get clearTrailingLayers(): Command<MapsLike | void>;
+}

package/messaging/registry/layer-comparison.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";export class LayerComparisonCommands extends CommandRegistry{get setMode(){return this._messages.command("layer-comparison.set-mode")}get setDirection(){return this._messages.command("layer-comparison.set-direction")}get addLeadingLayers(){return this._messages.command("layer-comparison.add-leading-layers")}get addTrailingLayers(){return this._messages.command("layer-comparison.add-trailing-layers")}get removeLeadingLayers(){return this._messages.command("layer-comparison.remove-leading-layers")}get removeTrailingLayers(){return this._messages.command("layer-comparison.remove-trailing-layers")}get clearLeadingLayers(){return this._messages.command("layer-comparison.clear-leading-layers")}get clearTrailingLayers(){return this._messages.command("layer-comparison.clear-trailing-layers")}}

package/messaging/registry/layer-presets.d.ts

@@ -0,0 +1,28 @@
+import type { LayerPreset } from "@vertigis/arcgis-extensions/layer-preset/LayerPreset";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { MapsLike } from "../common.js";
+/**
+ * Arguments for the 'layer-presets.apply' command.
+ */
+export interface LayerPresetsArgs {
+    /**
+     * The associated map to apply the preset to.
+     */
+    maps?: MapsLike;
+    /**
+     * The LayerPreset to apply to the map.
+     */
+    preset: LayerPreset;
+}
+export declare class LayerPresetsCommands extends CommandRegistry {
+    /**
+     * Applies a layer-preset to a map. Applying a layer-preset means that the
+     * layer visibilities, opacity, and the map's basemap are changed to match
+     * the layer-preset definition. It's a quick way for a user to toggle the
+     * state of the map to a pre-configured state.
+     *
+     * @mobileOnly
+     */
+    get apply(): Command<LayerPresetsArgs>;
+}