@vertigis/viewer-spec 46.3.0 → 46.4.2

package/messaging/registry/map.d.ts

@@ -8,7 +8,7 @@ import type GeographicTransformation from "@arcgis/core/geometry/support/Geograp
 import type Layer from "@arcgis/core/layers/Layer";
 import type { LayerPreset } from "@vertigis/arcgis-extensions/layer-preset/LayerPreset";
 import type { LayerExtension } from "@vertigis/arcgis-extensions/mapping/LayerExtension";
-import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
+import type { MapExtension, ViewMode } from "@vertigis/arcgis-extensions/mapping/MapExtension";
 import type { GeometryType } from "@vertigis/arcgis-extensions/portal/Geometry";
 import type { OperationalLayer as OperationalLayerJson } from "@vertigis/arcgis-extensions/portal/OperationalLayer";
 import type { Action } from "@vertigis/arcgis-extensions/support/Action";
@@ -34,6 +34,15 @@ export interface MapEvent {
      */
     maps?: MapsLike;
 }
+/**
+ * Arguments for the ViewModeChanged event.
+ */
+export interface ViewModeChangedEvent extends MapEvent {
+    /**
+     * The new ViewMode.
+     */
+    viewMode?: ViewMode;
+}
 /**
  * Arguments for the map.zoom-to-viewpoint command.
  */
@@ -47,6 +56,19 @@ export interface ZoomToViewpointArgs {
      */
     viewpoint: ViewpointLike | string;
 }
+/**
+ * The result of getting a Viewpoint.
+ */
+export interface GetViewpointResult {
+    /**
+     * The map(s) used in the operation.
+     */
+    maps?: MapsLike;
+    /**
+     * The viewpoint.
+     */
+    viewpoint: Viewpoint;
+}
 /**
  * Arguments for the map.zoom-to-layer-extent and
  * map.zoom-to-layer-visible-scale commands.
@@ -892,6 +914,13 @@ export declare class MapEvents extends EventRegistry {
      * @mobileOnly
      */
     get rotating(): Event<MapEvent>;
+    /**
+     * Raised when a map's {@link ViewMode} is changed. This happens when the map
+     * view is changed between a WebMap and a WebScene.
+     *
+     * @webOnly
+     */
+    get viewModeChanged(): Event<ViewModeChangedEvent>;
     /**
      * Raised when the a map extent is changed. This event is raised in
      * extremely high frequency - for example, every few pixels the map is
@@ -947,19 +976,21 @@ export declare class MapOperations extends OperationRegistry {
     /**
      * Returns the initial viewpoint for the active map or scene of the
      * specified map. If no map extension is specified, returns the initial
-     * viewpoint for the first available map.
+     * viewpoint for the first available map. Also returns the map(s) used for
+     * the operation.
      *
      * @webOnly
      */
-    get getInitialViewpoint(): Operation<Maps | void, Viewpoint>;
+    get getInitialViewpoint(): Operation<Maps | void, GetViewpointResult>;
     /**
      * Returns the current viewpoint for the active map or scene of the
      * specified map. If no map extension is specified, returns the viewpoint
-     * for the first available map.
+     * for the first available map. Also returns the map(s) used for the
+     * operation.
      *
      * @webOnly
      */
-    get getViewpoint(): Operation<Maps | void, Viewpoint>;
+    get getViewpoint(): Operation<Maps | void, GetViewpointResult>;
     /**
      * If a map extension ID is specified, returns the spatial reference for
      * that map. If no map extension ID is specified, returns the spatial

package/messaging/registry/map.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class MapCommands extends CommandRegistry{get addMarkup(){return this._messages.command("map.add-markup")}get addLayers(){return this._messages.command("map.add-layers")}get applyFilterEffect(){return this._messages.command("map.apply-filter-effect")}get applyLayerPreset(){return this._messages.command("map.apply-layer-preset")}get createNote(){return this._messages.command("map.create-note")}get editNote(){return this._messages.command("map.edit-note")}get removeFilterEffects(){return this._messages.command("map.remove-filter-effects")}get clearFilterEffects(){return this._messages.command("map.clear-filter-effects")}get clearMarkup(){return this._messages.command("map.clear-markup")}get disableMapClick(){return this._messages.command("map.disable-map-click")}get displayExtentSelector(){return this._messages.command("map.display-extent-selector")}get enableMapClick(){return this._messages.command("map.enable-map-click")}get goToFeatures(){return this._messages.command("map.go-to-features")}get goToGeometry(){return this._messages.command("map.go-to-geometry")}get goToViewpoint(){return this._messages.command("map.go-to-viewpoint")}get goToScale(){return this._messages.command("map.go-to-scale")}get goToInitialViewpoint(){return this._messages.command("map.go-to-initial-viewpoint")}get goToLayerExtent(){return this._messages.command("map.go-to-layer-extent")}get hideExtentSelector(){return this._messages.command("map.hide-extent-selector")}get panToFeatures(){return this._messages.command("map.pan-to-features")}get panToGeometry(){return this._messages.command("map.pan-to-geometry")}get pauseSketch(){return this._messages.command("map.pause-sketch")}get removeLayers(){return this._messages.command("map.remove-layers")}get replace(){return this._messages.command("map.replace")}get replaceAdditionalLayers(){return this._messages.command("map.replace-additional-layers")}get replaceMmpk(){return this._messages.command("map.replace-mmpk")}get resumeSketch(){return this._messages.command("map.resume-sketch")}get rotateBy(){return this._messages.command("map.rotate-by")}get rotateTo(){return this._messages.command("map.rotate-to")}get refresh(){return this._messages.command("map.refresh")}get updateLayer(){return this._messages.command("map.update-layer")}get zoomToFeatures(){return this._messages.command("map.zoom-to-features")}get zoomToGeometry(){return this._messages.command("map.zoom-to-geometry")}get zoomIn(){return this._messages.command("map.zoom-in")}get zoomOut(){return this._messages.command("map.zoom-out")}get zoomToScale(){return this._messages.command("map.zoom-to-scale")}get zoomToInitialViewpoint(){return this._messages.command("map.zoom-to-initial-viewpoint")}get zoomToViewpoint(){return this._messages.command("map.zoom-to-viewpoint")}get zoomToLayerExtent(){return this._messages.command("map.zoom-to-layer-extent")}get zoomToLayerVisibleScale(){return this._messages.command("map.zoom-to-layer-visible-scale")}}export class MapEvents extends EventRegistry{get initialized(){return this._messages.event("map.initialized")}get initializing(){return this._messages.event("map.initializing")}get navigationCompleted(){return this._messages.event("map.navigation-completed")}get refreshed(){return this._messages.event("map.refreshed")}get refreshing(){return this._messages.event("map.refreshing")}get rotated(){return this._messages.event("map.rotated")}get rotating(){return this._messages.event("map.rotating")}get viewpointChanged(){return this._messages.event("map.viewpoint-changed")}}export class MapOperations extends OperationRegistry{get getUserCoordinatesInput(){return this._messages.operation("map.get-user-coordinates-input")}get getCoordinateTransformation(){return this._messages.operation("map.get-coordinate-transformation")}get exportImage(){return this._messages.operation("map.export-image")}get getMarkup(){return this._messages.operation("map.get-markup")}get getExtent(){return this._messages.operation("map.get-extent")}get getGeometryFromSelector(){return this._messages.operation("map.get-geometry-from-selector")}get getInitialViewpoint(){return this._messages.operation("map.get-initial-viewpoint")}get getViewpoint(){return this._messages.operation("map.get-viewpoint")}get getSpatialReference(){return this._messages.operation("map.get-spatial-reference")}get getVisibleCenter(){return this._messages.operation("map.get-visible-center")}get hide(){return this._messages.operation("map.hide")}get show(){return this._messages.operation("map.show")}get startSketch(){return this._messages.operation("map.start-sketch")}get stopSketch(){return this._messages.operation("map.stop-sketch")}get getViewInsets(){return this._messages.operation("map.get-view-insets")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class MapCommands extends CommandRegistry{get addMarkup(){return this._messages.command("map.add-markup")}get addLayers(){return this._messages.command("map.add-layers")}get applyFilterEffect(){return this._messages.command("map.apply-filter-effect")}get applyLayerPreset(){return this._messages.command("map.apply-layer-preset")}get createNote(){return this._messages.command("map.create-note")}get editNote(){return this._messages.command("map.edit-note")}get removeFilterEffects(){return this._messages.command("map.remove-filter-effects")}get clearFilterEffects(){return this._messages.command("map.clear-filter-effects")}get clearMarkup(){return this._messages.command("map.clear-markup")}get disableMapClick(){return this._messages.command("map.disable-map-click")}get displayExtentSelector(){return this._messages.command("map.display-extent-selector")}get enableMapClick(){return this._messages.command("map.enable-map-click")}get goToFeatures(){return this._messages.command("map.go-to-features")}get goToGeometry(){return this._messages.command("map.go-to-geometry")}get goToViewpoint(){return this._messages.command("map.go-to-viewpoint")}get goToScale(){return this._messages.command("map.go-to-scale")}get goToInitialViewpoint(){return this._messages.command("map.go-to-initial-viewpoint")}get goToLayerExtent(){return this._messages.command("map.go-to-layer-extent")}get hideExtentSelector(){return this._messages.command("map.hide-extent-selector")}get panToFeatures(){return this._messages.command("map.pan-to-features")}get panToGeometry(){return this._messages.command("map.pan-to-geometry")}get pauseSketch(){return this._messages.command("map.pause-sketch")}get removeLayers(){return this._messages.command("map.remove-layers")}get replace(){return this._messages.command("map.replace")}get replaceAdditionalLayers(){return this._messages.command("map.replace-additional-layers")}get replaceMmpk(){return this._messages.command("map.replace-mmpk")}get resumeSketch(){return this._messages.command("map.resume-sketch")}get rotateBy(){return this._messages.command("map.rotate-by")}get rotateTo(){return this._messages.command("map.rotate-to")}get refresh(){return this._messages.command("map.refresh")}get updateLayer(){return this._messages.command("map.update-layer")}get zoomToFeatures(){return this._messages.command("map.zoom-to-features")}get zoomToGeometry(){return this._messages.command("map.zoom-to-geometry")}get zoomIn(){return this._messages.command("map.zoom-in")}get zoomOut(){return this._messages.command("map.zoom-out")}get zoomToScale(){return this._messages.command("map.zoom-to-scale")}get zoomToInitialViewpoint(){return this._messages.command("map.zoom-to-initial-viewpoint")}get zoomToViewpoint(){return this._messages.command("map.zoom-to-viewpoint")}get zoomToLayerExtent(){return this._messages.command("map.zoom-to-layer-extent")}get zoomToLayerVisibleScale(){return this._messages.command("map.zoom-to-layer-visible-scale")}}export class MapEvents extends EventRegistry{get initialized(){return this._messages.event("map.initialized")}get initializing(){return this._messages.event("map.initializing")}get navigationCompleted(){return this._messages.event("map.navigation-completed")}get refreshed(){return this._messages.event("map.refreshed")}get refreshing(){return this._messages.event("map.refreshing")}get rotated(){return this._messages.event("map.rotated")}get rotating(){return this._messages.event("map.rotating")}get viewModeChanged(){return this._messages.event("map.view-mode-changed")}get viewpointChanged(){return this._messages.event("map.viewpoint-changed")}}export class MapOperations extends OperationRegistry{get getUserCoordinatesInput(){return this._messages.operation("map.get-user-coordinates-input")}get getCoordinateTransformation(){return this._messages.operation("map.get-coordinate-transformation")}get exportImage(){return this._messages.operation("map.export-image")}get getMarkup(){return this._messages.operation("map.get-markup")}get getExtent(){return this._messages.operation("map.get-extent")}get getGeometryFromSelector(){return this._messages.operation("map.get-geometry-from-selector")}get getInitialViewpoint(){return this._messages.operation("map.get-initial-viewpoint")}get getViewpoint(){return this._messages.operation("map.get-viewpoint")}get getSpatialReference(){return this._messages.operation("map.get-spatial-reference")}get getVisibleCenter(){return this._messages.operation("map.get-visible-center")}get hide(){return this._messages.operation("map.hide")}get show(){return this._messages.operation("map.show")}get startSketch(){return this._messages.operation("map.start-sketch")}get stopSketch(){return this._messages.operation("map.stop-sketch")}get getViewInsets(){return this._messages.operation("map.get-view-insets")}}