@vertigis/viewer-spec 53.10.0 → 54.0.0

package/messaging/registry/geolocation.d.ts

@@ -116,7 +116,8 @@ export declare enum GeolocateState {
  */
 export interface GeolocationEvent {
     /**
-     * The GNSS source associated with the raised geolocation event.
+     * The GNSS source associated with the raised geolocation event. Mobile
+     * only.
      *
      * @mobileOnly
      */
@@ -289,7 +290,7 @@ export declare class GeolocationCommands extends CommandRegistry {
      * 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.
+     * successfully. Mobile only.
      *
      * @mobileOnly
      */
@@ -303,31 +304,31 @@ export declare class GeolocationCommands extends CommandRegistry {
      */
     get turnOffGeolocation(): Command;
     /**
-     * Displays the GNSS device settings view.
+     * Displays the GNSS device settings view. Mobile only.
      *
      * @mobileOnly
      */
     get displayDeviceSettings(): Command<GnssDeviceConnectionInfo>;
     /**
-     * Displays the GNSS device metadata view.
+     * Displays the GNSS device metadata view. Mobile only.
      *
      * @mobileOnly
      */
     get displayDeviceMetadata(): Command;
     /**
-     * Displays the GNSS device selection view.
+     * Displays the GNSS device selection view. Mobile only.
      *
      * @mobileOnly
      */
     get displayDeviceSelection(): Command;
     /**
-     * Applies a datum transformation to the current GNSS device.
+     * Applies a datum transformation to the current GNSS device. Mobile only.
      *
      * @mobileOnly
      */
     get applyDatumTransformation(): Command<CoordinateTransformation | string | number | number[]>;
     /**
-     * Modifies the location display symbol.
+     * Modifies the location display symbol. Mobile only.
      *
      * @mobileOnly
      */
@@ -335,20 +336,20 @@ export declare class GeolocationCommands extends CommandRegistry {
 }
 export declare class GeolocationOperations extends OperationRegistry {
     /**
-     * Updates the currently active GNSS receiver.
+     * Updates the currently active GNSS receiver. Mobile only.
      *
      * @mobileOnly
      */
     get changeSource(): Operation<GnssDeviceConnectionInfo, void>;
     /**
-     * Gets the currently active geolocation source.
+     * Gets the currently active geolocation source. Mobile only.
      *
      * @mobileOnly
      */
     get getActiveSource(): Operation<GnssDeviceConnectionInfo>;
     /**
      * Gets the list of currently available geolocation sources. Includes
-     * integrated receivers, GNSS devices, and emulators.
+     * integrated receivers, GNSS devices, and emulators. Mobile only.
      *
      * @mobileOnly
      */
@@ -370,7 +371,7 @@ export declare class GeolocationOperations extends OperationRegistry {
     get getPosition(): Operation<void, Point>;
     /**
      * Returns a list of valid coordinate transformations for given input and
-     * output spatial references.
+     * output spatial references. Mobile only.
      *
      * @mobileOnly
      */
@@ -384,7 +385,7 @@ export declare class GeolocationEvents extends EventRegistry {
     get accuracyChanged(): Event<GeolocateAccuracyChangedEventArgs>;
     /**
      * Raised when a GNSS receiver is active and metadata about the device or
-     * location change.
+     * location change. Mobile only.
      *
      * @mobileOnly
      */
@@ -398,7 +399,7 @@ export declare class GeolocationEvents extends EventRegistry {
     /**
      * Raised when the user changes the geolocation mode to
      * recenter-and-reorient (updates map orientation to match device
-     * direction).
+     * direction). Mobile only.
      *
      * @mobileOnly
      */
@@ -411,31 +412,33 @@ export declare class GeolocationEvents extends EventRegistry {
     get autoRecenterStopped(): Event<HasMaps | void>;
     /**
      * Raised when the user changes the geolocation mode to not
-     * recenter-and-reorient.
+     * recenter-and-reorient. Mobile only.
      *
      * @mobileOnly
      */
     get autoRecenterAndReorientStopped(): Event<HasMaps>;
     /**
-     * Raised when detection of connected GNSS receivers begins.
+     * Raised when detection of connected GNSS receivers begins. Mobile only.
      *
      * @mobileOnly
      */
     get gnssDeviceDetectionStarted(): Event;
     /**
-     * Raised when detection of connected GNSS receivers ends.
+     * Raised when detection of connected GNSS receivers ends. Mobile only.
      *
      * @mobileOnly
      */
     get gnssDeviceDetectionStopped(): Event;
     /**
-     * Raised when the lock status of an active GNSS device changes.
+     * Raised when the lock status of an active GNSS device changes. Mobile
+     * only.
      *
      * @mobileOnly
      */
     get gnssLockStatusChanged(): Event<GnssLockStateEventArgs>;
     /**
-     * Raised when geolocation is activated and the user's heading changes.
+     * Raised when geolocation is activated and the user's heading changes. Web
+     * only.
      *
      * @webOnly
      */
@@ -456,7 +459,7 @@ export declare class GeolocationEvents extends EventRegistry {
     get positionLost(): Event<GeolocationEvent>;
     /**
      * Raised when the source of geolocation data is changed to a different
-     * source (e.g. a GNSS receiver).
+     * source (e.g. a GNSS receiver). Mobile only.
      *
      * @mobileOnly
      */
@@ -467,31 +470,31 @@ export declare class GeolocationEvents extends EventRegistry {
      */
     get statusChanged(): Event<GeolocationStatusChangedEventArgs>;
     /**
-     * Raised when geolocation enters displaying location mode.
+     * Raised when geolocation enters displaying location mode. Web only.
      *
      * @webOnly
      */
     get displayLocationStarted(): Event;
     /**
-     * Raised when geolocation leaves displaying location mode.
+     * Raised when geolocation leaves displaying location mode. Web only.
      *
      * @webOnly
      */
     get displayLocationStopped(): Event;
     /**
-     * Raised when the GNSS transformation is changed.
+     * Raised when the GNSS transformation is changed. Mobile only.
      *
      * @mobileOnly
      */
     get transformationChanged(): Event<GnssDeviceTransformationOverrideEventArgs>;
     /**
-     * Raised when the GNSS antenna height is changed.
+     * Raised when the GNSS antenna height is changed. Mobile only.
      *
      * @mobileOnly
      */
     get antennaHeightChanged(): Event<GnssDeviceAntennaHeightEventArgs>;
     /**
-     * Raised when the location display mode is changed.
+     * Raised when the location display mode is changed. Mobile only.
      *
      * @mobileOnly
      */

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

@@ -14,13 +14,13 @@ export interface GeometryToolbarArgs extends HasMaps {
 }
 export declare class GeometryToolbarCommands extends CommandRegistry {
     /**
-     * Shows the Geometry Toolbar.
+     * Shows the Geometry Toolbar. Mobile only.
      *
      * @mobileOnly
      */
     get show(): Command<GeometryToolbarArgs | void>;
     /**
-     * Hides the Geometry Toolbar.
+     * Hides the Geometry Toolbar. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/geometry.d.ts

@@ -186,14 +186,14 @@ export interface RemovePointArgs {
 }
 export declare class GeometryOperations extends OperationRegistry {
     /**
-     * Projects a set of geometries to a new spatial reference.
+     * Projects a set of geometries to a new spatial reference. Web only.
      *
      * @webOnly
      */
     get project(): Operation<ProjectArgs, Geometry[]>;
     /**
      * Buffers a point geometry by a distance equivalent to the number of pixels
-     * at the current map scale.
+     * at the current map scale. Web only.
      *
      * @webOnly
      */
@@ -201,43 +201,43 @@ export declare class GeometryOperations extends OperationRegistry {
     /**
      * 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.
+     * falls back on the default configured for the viewer session. Web only.
      *
      * @webOnly
      */
     get buffer(): Operation<Geometries, BufferResult>;
     /**
-     * Returns the default buffer distance for the viewer session.
+     * Returns the default buffer distance for the viewer session. Web only.
      *
      * @webOnly
      */
     get getBufferDistance(): Operation<void, number>;
     /**
-     * Returns the default buffer units for the viewer session.
+     * Returns the default buffer units for the viewer session. Web only.
      *
      * @webOnly
      */
     get getBufferUnits(): Operation<void, LengthUnits>;
     /**
-     * Adds a point to a given geometry.
+     * Adds a point to a given geometry. Mobile only.
      *
      * @mobileOnly
      */
     get addPoint(): Operation<AddPointArgs, Geometry>;
     /**
-     * Adds a part to a given geometry.
+     * Adds a part to a given geometry. Mobile only.
      *
      * @mobileOnly
      */
     get addPart(): Operation<AddPartArgs, Geometry>;
     /**
-     * Calculates a point relative to a given reference line.
+     * Calculates a point relative to a given reference line. Mobile only.
      *
      * @mobileOnly
      */
     get calculatePoint(): Operation<CalculatePointArgs, Point>;
     /**
-     * Removes a point from a given geometry.
+     * Removes a point from a given geometry. Mobile only.
      *
      * @mobileOnly
      */
@@ -246,20 +246,20 @@ export declare class GeometryOperations extends OperationRegistry {
 export declare class GeometryCommands extends CommandRegistry {
     /**
      * Display the geometry settings dialog. This allows you to configure buffer
-     * distance and buffer units.
+     * distance and buffer units. Web only.
      *
      * @webOnly
      */
     get displaySettings(): Command<HasUITarget>;
     /**
      * Sets the default buffer distance for the viewer session. The buffer
-     * distance must be a number > 0.
+     * distance must be a number > 0. Web only.
      *
      * @webOnly
      */
     get setBufferDistance(): Command<number>;
     /**
-     * Sets the default buffer units for the viewer session.
+     * Sets the default buffer units for the viewer session. Web only.
      *
      * @webOnly
      */

package/messaging/registry/highlights.d.ts

@@ -36,31 +36,33 @@ export declare class HighlightsCommands extends CommandRegistry {
      */
     get clearFocus(): Command<Maps | void>;
     /**
-     * Hides all highlight overlays (can be undone with highlights.show).
+     * Hides all highlight overlays (can be undone with highlights.show). Mobile
+     * only.
      *
      * @mobileOnly
      */
     get hide(): Command<HasMaps>;
     /**
      * Hides the focus highlight (can be undone with highlights.show-focus).
+     * Mobile only.
      *
      * @mobileOnly
      */
     get hideFocus(): Command<HasMaps>;
     /**
-     * Refreshes highlighting for one or many features.
+     * Refreshes highlighting for one or many features. Mobile only.
      *
      * @mobileOnly
      */
     get refresh(): Command<HasMapsAndFeatures>;
     /**
-     * Shows all highlight overlays (makes not hidden).
+     * Shows all highlight overlays (makes not hidden). Mobile only.
      *
      * @mobileOnly
      */
     get show(): Command<HasMaps>;
     /**
-     * Shows the highlight focus (makes focus not hidden).
+     * Shows the highlight focus (makes focus not hidden). Mobile only.
      *
      * @mobileOnly
      */
@@ -68,13 +70,13 @@ export declare class HighlightsCommands extends CommandRegistry {
 }
 export declare class HighlightsOperations extends OperationRegistry {
     /**
-     * Returns all highlighted features for a given map.
+     * Returns all highlighted features for a given map. Web only.
      *
      * @webOnly
      */
     get get(): Operation<MapExtension, FeatureSet>;
     /**
-     * Returns all focused features for a given map.
+     * Returns all focused features for a given map. Web only.
      *
      * @webOnly
      */

package/messaging/registry/input.d.ts

@@ -7,13 +7,13 @@ export interface ConsoleKeyInfoObj {
 }
 export declare class InputEvents extends EventRegistry {
     /**
-     * Raised when the user shakes the device.
+     * Raised when the user shakes the device. Mobile only.
      *
      * @mobileOnly
      */
     get shake(): Event;
     /**
-     * Raised when the user presses a keyboard shortcut.
+     * Raised when the user presses a keyboard shortcut. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/iwtm.d.ts

@@ -2,7 +2,7 @@ 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.
+     * Displays the I Want To Menu with the given ID. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/kpi.d.ts

@@ -48,31 +48,31 @@ export interface GetKpiDefinitionResult {
 }
 export declare class KpiCommands extends CommandRegistry {
     /**
-     * Displays the KPI card and updates it with provided features.
+     * Displays the KPI card and updates it with provided features. Web only.
      *
      * @webOnly
      */
     get display(): Command<Features | UpdateKpiCardFeaturesArgs>;
     /**
-     * Add one or more features to active KPI cards.
+     * Add one or more features to active KPI cards. Web only.
      *
      * @webOnly
      */
     get addFeatures(): Command<Features | UpdateKpiCardFeaturesArgs>;
     /**
-     * Remove one or more features from active KPI cards.
+     * Remove one or more features from active KPI cards. Web only.
      *
      * @webOnly
      */
     get removeFeatures(): Command<Features | UpdateKpiCardFeaturesArgs>;
     /**
-     * Clear features from active KPI cards.
+     * Clear features from active KPI cards. Web only.
      *
      * @webOnly
      */
     get clear(): Command<ModelRef | void>;
     /**
-     * Updates the definition of a KPI Card.
+     * Updates the definition of a KPI Card. Web only.
      *
      * @webOnly
      */
@@ -80,14 +80,15 @@ export declare class KpiCommands extends CommandRegistry {
 }
 export declare class KpiOperations extends OperationRegistry {
     /**
-     * Returns the current set of features from all active KPI Cards.
+     * Returns the current set of features from all active KPI Cards. Web only.
      *
      * @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.
+     * instance of the KPI card model that's passed in as an argument. Web
+     * only.
      *
      * @webOnly
      */

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

@@ -37,14 +37,15 @@ export interface SetLayerComparisonDirectionArgs {
 }
 export declare class LayerComparisonCommands extends CommandRegistry {
     /**
-     * Activates or deactivates the layer-comparison mode on the map(s).
+     * Activates or deactivates the layer-comparison mode on the map(s). Web
+     * only.
      *
      * @webOnly
      */
     get setMode(): Command<SetLayerComparisonModeArgs>;
     /**
      * Changes the orientation of the map(s') layer-comparison bar between
-     * 'horizontal' and 'vertical'.
+     * 'horizontal' and 'vertical'. Web only.
      *
      * @webOnly
      */
@@ -56,7 +57,7 @@ export declare class LayerComparisonCommands extends CommandRegistry {
      * 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.
+     * others will be ignored. Web only.
      *
      * @webOnly
      */
@@ -68,33 +69,33 @@ export declare class LayerComparisonCommands extends CommandRegistry {
      * 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.
+     * valid - others will be ignored. Web only.
      *
      * @webOnly
      */
     get addTrailingLayers(): Command<Layers>;
     /**
      * Removes the layer(s) from the map's leading layers, which are used by the
-     * layer-comparison tool.
+     * layer-comparison tool. Web only.
      *
      * @webOnly
      */
     get removeLeadingLayers(): Command<Layers>;
     /**
      * Removes the layer(s) from the map's trailing layers, which are used by
-     * the layer-comparison tool.
+     * the layer-comparison tool. Web only.
      *
      * @webOnly
      */
     get removeTrailingLayers(): Command<Layers>;
     /**
-     * Removes all leading layers from the map(s).
+     * Removes all leading layers from the map(s). Web only.
      *
      * @webOnly
      */
     get clearLeadingLayers(): Command<MapsLike | void>;
     /**
-     * Removes all trailing layers from the map(s).
+     * Removes all trailing layers from the map(s). Web only.
      *
      * @webOnly
      */

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

@@ -31,7 +31,7 @@ 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.
+     * state of the map to a pre-configured state. Mobile only.
      *
      * @mobileOnly
      */
@@ -39,7 +39,7 @@ export declare class LayerPresetsCommands extends CommandRegistry {
 }
 export declare class LayerPresetsEvents extends EventRegistry {
     /**
-     * Raised when a layer preset is applied.
+     * Raised when a layer preset is applied. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/layers.d.ts

@@ -71,49 +71,50 @@ export interface LayerSettingsArgs extends HasLayerSettings, HasLayers, HasSymbo
 }
 export declare class LayersCommands extends CommandRegistry {
     /**
-     * Guard command for enabling the layers.set-symbol command.
+     * Guard command for enabling the layers.set-symbol command. Web only.
      *
      * @webOnly
      */
     get ensureCanSetSymbol(): Command<SetSymbolArgs>;
     /**
-     * Updates the provided layer(s) with new popup template configuration.
+     * Updates the provided layer(s) with new popup template configuration. Web
+     * only.
      *
      * @webOnly
      */
     get setPopupTemplate(): Command<LayerSettingsArgs>;
     /**
-     * Updates the symbol for the provided layer(s).
+     * Updates the symbol for the provided layer(s). Web only.
      *
      * @webOnly
      */
     get setSymbol(): Command<SetSymbolArgs>;
     /**
-     * Updates the provided layer(s) with new task settings.
+     * Updates the provided layer(s) with new task settings. Web only.
      *
      * @webOnly
      */
     get setTaskSettings(): Command<LayerSettingsArgs>;
     /**
-     * Changes the title of the provided layer(s).
+     * Changes the title of the provided layer(s). Web only.
      *
      * @webOnly
      */
     get setTitle(): Command<LayerSettingsArgs>;
     /**
-     * Updates the visibility of the provided layer(s).
+     * Updates the visibility of the provided layer(s). Web only.
      *
      * @webOnly
      */
     get setVisibility(): Command<SetVisibilityArgs>;
     /**
-     * Turns on the layer's labels on the map.
+     * Turns on the layer's labels on the map. Web only.
      *
      * @webOnly
      */
     get showLabels(): Command<SetLabelVisibilityArgs>;
     /**
-     * Turns off the layer's labels on the map.
+     * Turns off the layer's labels on the map. Web only.
      *
      * @webOnly
      */
@@ -121,20 +122,21 @@ export declare class LayersCommands extends CommandRegistry {
 }
 export declare class LayersOperations extends OperationRegistry {
     /**
-     * Retrieves the popup configuration applied to the supplied layer(s).
+     * Retrieves the popup configuration applied to the supplied layer(s). Web
+     * only.
      *
      * @webOnly
      */
     get getPopupTemplate(): Operation<HasLayers, LayerSettingsArgs>;
     /**
      * Retrieves the values for the 'taskSettings' applied to the supplied
-     * layer(s).
+     * layer(s). Web only.
      *
      * @webOnly
      */
     get getTaskSettings(): Operation<HasLayers, LayerSettingsArgs>;
     /**
-     * Retrieves the titles of the supplied layer(s).
+     * Retrieves the titles of the supplied layer(s). Web only.
      *
      * @webOnly
      */
@@ -142,7 +144,7 @@ export declare class LayersOperations extends OperationRegistry {
     /**
      * Shows a UI for editing the settings on an existing layer or layers. Note
      * that changes will not be applied to the supplied layers by this
-     * operation. Use `layers.set-*` for this.
+     * operation. Use `layers.set-*` for this. Web only.
      *
      * @webOnly
      */
@@ -150,7 +152,7 @@ export declare class LayersOperations extends OperationRegistry {
     /**
      * Edit the symbol from an existing layer or layers. Note that changes to
      * these symbols will not be applied to the layers by this operation. Use
-     * `layers.set-symbol` for this.
+     * `layers.set-symbol` for this. Web only.
      *
      * @webOnly
      */
@@ -158,7 +160,7 @@ export declare class LayersOperations extends OperationRegistry {
 }
 export declare class LayersEvents extends EventRegistry {
     /**
-     * Raised when a layer's visibility changes.
+     * Raised when a layer's visibility changes. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/layout.d.ts

@@ -21,26 +21,26 @@ export interface LayoutMarginChangedArgs {
 }
 export declare class LayoutEvents extends EventRegistry {
     /**
-     * Raised when a layout is finished being displayed.
+     * Raised when a layout is finished being displayed. Mobile only.
      *
      * @mobileOnly
      */
     get displayed(): Event;
     /**
-     * Raised when a layout is loaded.
+     * Raised when a layout is loaded. Mobile only.
      *
      * @mobileOnly
      */
     get loaded(): Event<Page>;
     /**
      * Raised when a layout is unloaded (typically so that a new layout can be
-     * loaded).
+     * loaded). Mobile only.
      *
      * @mobileOnly
      */
     get unloaded(): Event;
     /**
-     * Raised when a layout's margin values have been updated.
+     * Raised when a layout's margin values have been updated. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/licensing.d.ts

@@ -19,7 +19,7 @@ export declare class LicenseRequestArgs {
 export declare class LicensingCommands extends CommandRegistry {
     /**
      * Validate the current application license and show appropriate prompts or
-     * errors.
+     * errors. Web only.
      *
      * @webOnly
      */
@@ -28,7 +28,7 @@ export declare class LicensingCommands extends CommandRegistry {
 export declare class LicensingOperations extends OperationRegistry {
     /**
      * Retrieve the license state for the specified account and SKU. Defaults to
-     * returning Web current state.
+     * returning Web current state. Web only.
      *
      * @webOnly
      */