@vertigis/viewer-spec 53.10.0 → 54.0.0

package/messaging/registry/location-marker.d.ts

@@ -126,19 +126,19 @@ export interface RemoveLocationMarkerArgs {
 }
 export declare class LocationMarkerEvents extends EventRegistry {
     /**
-     * Raised when a Marker is created.
+     * Raised when a Marker is created. Web only.
      *
      * @webOnly
      */
     get created(): Event<LocationMarkerEvent>;
     /**
-     * Raised when a Marker is removed.
+     * Raised when a Marker is removed. Web only.
      *
      * @webOnly
      */
     get removed(): Event<LocationMarkerEvent>;
     /**
-     * Raised when a Marker is updated.
+     * Raised when a Marker is updated. Web only.
      *
      * @webOnly
      */
@@ -146,25 +146,25 @@ export declare class LocationMarkerEvents extends EventRegistry {
 }
 export declare class LocationMarkerCommands extends CommandRegistry {
     /**
-     * Removes all Markers.
+     * Removes all Markers. Web only.
      *
      * @webOnly
      */
     get clear(): Command<MapsRef | HasMapsRef | void>;
     /**
-     * Create a new Marker.
+     * Create a new Marker. Web only.
      *
      * @webOnly
      */
     get create(): Command<CreateLocationMarkerArgs>;
     /**
-     * Remove a Marker.
+     * Remove a Marker. Web only.
      *
      * @webOnly
      */
     get remove(): Command<RemoveLocationMarkerArgs>;
     /**
-     * Update an existing Marker.
+     * Update an existing Marker. Web only.
      *
      * @webOnly
      */

package/messaging/registry/logViewer.d.ts

@@ -2,13 +2,13 @@ import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
 export declare class LogViewerOperations extends OperationRegistry {
     /**
-     * Displays the Log Viewer.
+     * Displays the Log Viewer. Mobile only.
      *
      * @mobileOnly
      */
     get display(): Operation<void>;
     /**
-     * Closes the Log Viewer.
+     * Closes the Log Viewer. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/map.d.ts

@@ -35,14 +35,14 @@ export type MarkupLevel = "ui" | "labels" | "custom3" | "custom2" | "custom1" |
  */
 export interface MapEvent {
     /**
-     * The map from which the event was generated.
+     * The map from which the event was generated. Web only.
      *
      * @webOnly
      */
     maps?: MapsLike;
     /**
      * The map extension for which the event was generated. This property is
-     * required in VertiGIS Studio Mobile.
+     * required in VertiGIS Studio Mobile. Mobile only.
      *
      * @mobileOnly
      */
@@ -186,6 +186,8 @@ export interface MarkupArgs extends HasMaps {
      * "vgs-transient-measurement-labels": Measurement labels used while
      * drawing.
      *
+     * Web only.
+     *
      * @webOnly
      */
     collection?: string;
@@ -200,7 +202,7 @@ export interface AddMarkupArgs extends MarkupArgs {
     graphics?: Graphic[] | GraphicsLike;
     /**
      * The level (z-order) to assign the markup to. If not specified uses the
-     * same level as default markup.
+     * same level as default markup. Web only.
      *
      * @webOnly
      */
@@ -774,43 +776,43 @@ export declare class MapCommands extends CommandRegistry {
      * Add the specified layer(s) to the maps(s). Layers will be inserted in the
      * order specified and will be added above existing layers in the drawing
      * order. Note that an Esri {@link Layer} object can only be added to one
-     * map.
+     * map. Web only.
      *
      * @webOnly
      */
     get addLayers(): Command<AddLayersArgs>;
     /**
-     * Applies a Filter Effect to the map(s).
+     * Applies a Filter Effect to the map(s). Web only.
      *
      * @webOnly
      */
     get applyFilterEffect(): Command<ApplyFilterEffectArgs>;
     /**
-     * Applies a LayerPreset to the map(s).
+     * Applies a LayerPreset to the map(s). Web only.
      *
      * @webOnly
      */
     get applyLayerPreset(): Command<ApplyLayerPresetArgs>;
     /**
-     * Create a map note.
+     * Create a map note. Web only.
      *
      * @webOnly
      */
     get createNote(): Command<CreateMapNoteArgs>;
     /**
-     * Edit an existing map note.
+     * Edit an existing map note. Web only.
      *
      * @webOnly
      */
     get editNote(): Command<EditMapNotesArgs>;
     /**
-     * Removes a Filter Effect(s) from the map(s).
+     * Removes a Filter Effect(s) from the map(s). Web only.
      *
      * @webOnly
      */
     get removeFilterEffects(): Command<Layers>;
     /**
-     * Clears all Filter Effects from the map(s).
+     * Clears all Filter Effects from the map(s). Web only.
      *
      * @webOnly
      */
@@ -821,53 +823,55 @@ export declare class MapCommands extends CommandRegistry {
     get clearMarkup(): Command<ClearMarkupArgs | void>;
     /**
      * Disables the click event handler on the map, so that if the user clicks
-     * on the map, the configured handler will not be invoked.
+     * on the map, the configured handler will not be invoked. Mobile only.
      *
      * @mobileOnly
      */
     get disableMapClick(): Command<HasMaps>;
     /**
      * Displays a square overlay on the map that allows the user to change the
-     * map extent within the overlay.
+     * map extent within the overlay. Mobile only.
      *
      * @mobileOnly
      */
     get displayExtentSelector(): Command<DisplayExtentSelectorArgs>;
     /**
      * Enables the click event handler on the map, so that if the user clicks on
-     * the map, the configured handler will be invoked.
+     * the map, the configured handler will be invoked. Mobile only.
      *
      * @mobileOnly
      */
     get enableMapClick(): Command<HasMaps>;
     /**
      * Zooms to (without animation) one or many features on the targeted map(s).
+     * Web only.
      *
      * @webOnly
      */
     get goToFeatures(): Command<Features>;
     /**
      * Zooms to (without animation) one or many geometries on the targeted
-     * map(s).
+     * map(s). Web only.
      *
      * @webOnly
      */
     get goToGeometry(): Command<Geometries | HasMapGeometry>;
     /**
-     * Zooms to (without animation) the given viewpoint.
+     * Zooms to (without animation) the given viewpoint. Web only.
      *
      * @webOnly
      */
     get goToViewpoint(): Command<ZoomToViewpointArgs | ViewpointLike>;
     /**
-     * Zooms (without animation) the map to a specified, numerical scale.
+     * Zooms (without animation) the map to a specified, numerical scale. Web
+     * only.
      *
      * @webOnly
      */
     get goToScale(): Command<ZoomToScaleArgs>;
     /**
      * Zooms (without animation) the map to its initial viewpoint. If map is
-     * omitted, all maps will be targeted.
+     * omitted, all maps will be targeted. Web only.
      *
      * @webOnly
      */
@@ -875,20 +879,20 @@ export declare class MapCommands extends CommandRegistry {
     /**
      * Go to (without animation) the full extent of the layer(s). If more than
      * one layer is specified, it will zoom to the combined extent of all
-     * layers.
+     * layers. Web only.
      *
      * @webOnly
      */
     get goToLayerExtent(): Command<ZoomToLayerArgs>;
     /**
-     * Hides the extent selector overlay on the map.
+     * Hides the extent selector overlay on the map. Mobile only.
      *
      * @mobileOnly
      */
     get hideExtentSelector(): Command<HasMaps>;
     /**
      * Show the specified markup collection, if hidden. If no collection is
-     * specified the default markup collection will be shown.
+     * specified the default markup collection will be shown. Web only.
      *
      * @webOnly
      */
@@ -899,26 +903,27 @@ export declare class MapCommands extends CommandRegistry {
     get panToFeatures(): Command<Features>;
     /**
      * Pan (without zooming) to one or many geometries on the targeted map(s).
+     * Web only.
      *
      * @webOnly
      */
     get panToGeometry(): Command<Geometries | HasMapGeometry>;
     /**
      * Pauses sketching on the map. Stores the current sketch editor and
-     * geometry for later use.
+     * geometry for later use. Mobile only.
      *
      * @mobileOnly
      */
     get pauseSketch(): Command<HasMaps>;
     /**
-     * Remove the specified layer(s) from the map(s).
+     * Remove the specified layer(s) from the map(s). Web only.
      *
      * @webOnly
      */
     get removeLayers(): Command<LayersLike | RemoveLayersArgs>;
     /**
      * Replaces the entire current map in the MapExtension and in the map
-     * component with a different map.
+     * component with a different map. Mobile only.
      *
      * @mobileOnly
      */
@@ -926,20 +931,21 @@ export declare class MapCommands extends CommandRegistry {
     /**
      * Replaces the additional layers on top of an mmpk with a new set of
      * layers, when using mmpk + WebMap. The mmpk part of the map is retained.
+     * Mobile only.
      *
      * @mobileOnly
      */
     get replaceAdditionalLayers(): Command<ReplaceMapArgs>;
     /**
      * Replaces the underlying mmpk part of the map when using mmpk + WebMap.
-     * The additional layers on top of the mmpk data are retained.
+     * The additional layers on top of the mmpk data are retained. Mobile only.
      *
      * @mobileOnly
      */
     get replaceMmpk(): Command<ReplaceMapArgs>;
     /**
      * Resumes sketching on the map. Uses the sketch editor and geometry stored
-     * when pausing.
+     * when pausing. Mobile only.
      *
      * @mobileOnly
      */
@@ -953,27 +959,27 @@ export declare class MapCommands extends CommandRegistry {
      */
     get rotateTo(): Command<MapRotateArgs>;
     /**
-     * Refreshes / reloads the map.
+     * Refreshes / reloads the map. Mobile only.
      *
      * @mobileOnly
      */
     get refresh(): Command<HasMaps>;
     /**
      * Changes the view mode of a map to the specified mode, if supported. If no
-     * maps are specified, all maps will be targeted.
+     * maps are specified, all maps will be targeted. Web only.
      *
      * @webOnly
      */
     get setViewMode(): Command<ViewMode | SetViewModeArgs>;
     /**
      * Show the specified markup collection, if hidden. If no collection is
-     * specified the default markup collection will be shown.
+     * specified the default markup collection will be shown. Web only.
      *
      * @webOnly
      */
     get showMarkup(): Command<MarkupArgs | void>;
     /**
-     * Updates a layer in the map.
+     * Updates a layer in the map. Web only.
      *
      * @webOnly
      */
@@ -983,25 +989,25 @@ export declare class MapCommands extends CommandRegistry {
      */
     get zoomToFeatures(): Command<Features>;
     /**
-     * Zooms to one or many geometries.
+     * Zooms to one or many geometries. Web only.
      *
      * @webOnly
      */
     get zoomToGeometry(): Command<Geometries | HasMapGeometry>;
     /**
-     * Zooms the map in by one level of detail.
+     * Zooms the map in by one level of detail. Web only.
      *
      * @webOnly
      */
     get zoomIn(): Command<Maps | void>;
     /**
-     * Zooms the map out by one level of detail.
+     * Zooms the map out by one level of detail. Web only.
      *
      * @webOnly
      */
     get zoomOut(): Command<Maps | void>;
     /**
-     * Zooms the map to a specified, numerical scale.
+     * Zooms the map to a specified, numerical scale. Web only.
      *
      * @webOnly
      */
@@ -1016,7 +1022,7 @@ export declare class MapCommands extends CommandRegistry {
     get zoomToViewpoint(): Command<ZoomToViewpointArgs | ViewpointLike>;
     /**
      * Go to the full extent of the layer(s). If more than one layer is
-     * specified, it will zoom to the combined extent of all layers.
+     * specified, it will zoom to the combined extent of all layers. Web only.
      *
      * @webOnly
      */
@@ -1027,7 +1033,7 @@ export declare class MapCommands extends CommandRegistry {
      * provided, it will attempt to zoom to a scale range that makes all of the
      * layers visible. If this is not possible (i.e. some of the layers' scale
      * ranges don't overlap), then priority will be given to layers that come
-     * earlier in the sequence.
+     * earlier in the sequence. Web only.
      *
      * @webOnly
      */
@@ -1043,62 +1049,63 @@ export declare class MapEvents extends EventRegistry {
      * Raised when a map is about to begin loading during startup. The map can
      * be swapped with a different map at this point if you want to circumvent
      * the map load process. For example in an app that supported offline, an
-     * offline map could be swapped in here.
+     * offline map could be swapped in here. Mobile only.
      *
      * @mobileOnly
      */
     get initializing(): Event<MapEvent>;
     /**
-     * Raised when markup is added to the map.
+     * Raised when markup is added to the map. Mobile only.
      *
      * @mobileOnly
      */
     get markupAdded(): Event<MarkupAddedEvent>;
     /**
-     * Raised when markup is cleared from the map.
+     * Raised when markup is cleared from the map. Mobile only.
      *
      * @mobileOnly
      */
     get markupCleared(): Event<MapEvent>;
     /**
-     * Raised when the a map navigation (eg. Pan or zoom) is complete.
+     * Raised when the a map navigation (eg. Pan or zoom) is complete. Mobile
+     * only.
      *
      * @mobileOnly
      */
     get navigationCompleted(): Event<MapEvent>;
     /**
-     * Raised when a map refresh completes.
+     * Raised when a map refresh completes. Mobile only.
      *
      * @mobileOnly
      */
     get refreshed(): Event<MapEvent>;
     /**
-     * Raised when a map refresh begins.
+     * Raised when a map refresh begins. Mobile only.
      *
      * @mobileOnly
      */
     get refreshing(): Event<MapEvent>;
     /**
-     * Raised when the Rotate operation has completed execution.
+     * Raised when the Rotate operation has completed execution. Mobile only.
      *
      * @mobileOnly
      */
     get rotated(): Event<MapEvent>;
     /**
-     * Raised when the Rotate operation is about to be called.
+     * Raised when the Rotate operation is about to be called. Mobile only.
      *
      * @mobileOnly
      */
     get rotating(): Event<MapEvent>;
     /**
-     * Raised when a map is replaced with a different map.
+     * Raised when a map is replaced with a different map. Mobile only.
      *
      * @mobileOnly
      */
     get switched(): Event<MapSwitchedEvent>;
     /**
      * Raised when a map's {@link ViewMode} is changed. This happens when the map
-     * view is changed between a WebMap and a WebScene.
+     * view is changed between a WebMap and a WebScene. Web only.
      *
      * @webOnly
      */
@@ -1110,7 +1117,7 @@ export declare class MapEvents extends EventRegistry {
      */
     get viewpointChanged(): Event<MapEvent>;
     /**
-     * Raised when a map export operation has completed.
+     * Raised when a map export operation has completed. Mobile only.
      *
      * @mobileOnly
      */
@@ -1118,7 +1125,7 @@ export declare class MapEvents extends EventRegistry {
 }
 export declare class MapOperations extends OperationRegistry {
     /**
-     * Prompts the user to enter and return a coordinate.
+     * Prompts the user to enter and return a coordinate. Web only.
      *
      * @webOnly
      */
@@ -1129,41 +1136,41 @@ export declare class MapOperations extends OperationRegistry {
      * coordinate transformation object of the first available map. The
      * coordinate transformation object contains information about the input and
      * output spatial reference, as well as the necessary transformations to
-     * convert between those coordinate systems.
+     * convert between those coordinate systems. Mobile only.
      *
      * @mobileOnly
      */
     get getCoordinateTransformation(): Operation<Maps | void, CoordinateTransformation[]>;
     /**
      * Exports the currently rendered map to a png image file on disk, and also
-     * returns that image.
+     * returns that image. Mobile only.
      *
      * @mobileOnly
      */
     get exportImage(): Operation<ExportMapImageArgs, EnhancedFileData>;
     /**
      * Exports the current configuration of the selected map component as a web
-     * map or scene.
+     * map or scene. Web only.
      *
      * @webOnly
      */
     get exportWebMapOrScene(): Operation<HasMaps, PortalItemData>;
     /**
      * Returns markup from the specified map that are intersected by the
-     * supplied geometry.
+     * supplied geometry. Web only.
      *
      * @webOnly
      */
     get getMarkup(): Operation<GetMarkupArgs, GetMarkupResult>;
     /**
-     * Returns the extent from the specified map.
+     * Returns the extent from the specified map. Web only.
      *
      * @webOnly
      */
     get getExtent(): Operation<GetExtentArgs, GetExtentResult>;
     /**
      * Returns the geometry that is contained within the square overlay of the
-     * extent selector.
+     * extent selector. Mobile only.
      *
      * @mobileOnly
      */
@@ -1172,7 +1179,7 @@ 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. Also returns the map(s) used for
-     * the operation.
+     * the operation. Web only.
      *
      * @webOnly
      */
@@ -1181,7 +1188,7 @@ export declare class MapOperations extends OperationRegistry {
      * 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. Also returns the map(s) used for the
-     * operation.
+     * operation. Web only.
      *
      * @webOnly
      */
@@ -1194,38 +1201,38 @@ export declare class MapOperations extends OperationRegistry {
     get getSpatialReference(): Operation<Maps | void, SpatialReference>;
     /**
      * Returns the point at the center of the visible map area. Accounts for
-     * panels displaying overtop of the map.
+     * panels displaying overtop of the map. Mobile only.
      *
      * @mobileOnly
      */
     get getVisibleCenter(): Operation<HasMaps, Point>;
     /**
-     * Hides the map.
+     * Hides the map. Mobile only.
      *
      * @mobileOnly
      */
     get hide(): Operation<HideMapArgs, boolean>;
     /**
-     * Shows the map if it is hidden.
+     * Shows the map if it is hidden. Mobile only.
      *
      * @mobileOnly
      */
     get show(): Operation<HasMaps, boolean>;
     /**
-     * Enables sketching on a map.
+     * Enables sketching on a map. Mobile only.
      *
      * @mobileOnly
      */
     get startSketch(): Operation<StartSketchArgs, Geometry>;
     /**
-     * Stops sketching on the map.
+     * Stops sketching on the map. Mobile only.
      *
      * @mobileOnly
      */
     get stopSketch(): Operation<HasMaps, Geometry>;
     /**
      * Returns the amount of the map that is currently covered by insets such as
-     * the panel component.
+     * the panel component. Mobile only.
      *
      * @mobileOnly
      */