@vertigis/viewer-spec 53.10.1 → 55.0.0

package/messaging/registry/measurement.d.ts

@@ -58,7 +58,7 @@ export declare enum GeometryEditorGeometryMode {
 export declare class MeasurementCommands extends CommandRegistry {
     /**
      * Display the measurements settings dialog. This allows you to configure
-     * measurements system, area and length units.
+     * measurements system, area and length units. Web only.
      *
      * @webOnly
      */
@@ -66,47 +66,47 @@ export declare class MeasurementCommands extends CommandRegistry {
     /**
      * Sets the value of the default point, line, or polygon symbol. The symbol
      * can be configured with an instance of the Esri symbol or with the Esri
-     * WebMap JSON.
+     * WebMap JSON. Web only.
      *
      * @webOnly
      */
     get setDefaultSymbol(): Command<SymbolLike | HasSymbol>;
     /**
      * Sets the area units used for measurements. Set as undefined for units to
-     * be intelligently selected based on dimensions.
+     * be intelligently selected based on dimensions. Web only.
      *
      * @webOnly
      */
     get setAreaUnits(): Command<AreaMeasurementUnits | undefined>;
     /**
      * Sets the length units used for measurements. Set as undefined for units
-     * to be intelligently selected based on dimensions.
+     * to be intelligently selected based on dimensions. Web only.
      *
      * @webOnly
      */
     get setLengthUnits(): Command<LengthMeasurementUnits | undefined>;
     /**
      * Starts drawing a measurement on the map. If a drawing has previously been
-     * started and stopped it will be resumed.
+     * started and stopped it will be resumed. Mobile only.
      *
      * @mobileOnly
      */
     get start(): Command<Maps | void>;
     /**
      * Stops drawing a measurement on the map. Graphic remains visible and
-     * drawing can be resumed.
+     * drawing can be resumed. Mobile only.
      *
      * @mobileOnly
      */
     get stop(): Command<Maps | void>;
     /**
-     * Stops drawing and clears graphics from the map.
+     * Stops drawing and clears graphics from the map. Mobile only.
      *
      * @mobileOnly
      */
     get clear(): Command<Maps | void>;
     /**
-     * Sets the geometry mode in use.
+     * Sets the geometry mode in use. Mobile only.
      *
      * @mobileOnly
      */
@@ -115,7 +115,7 @@ export declare class MeasurementCommands extends CommandRegistry {
 export declare class MeasurementOperations extends OperationRegistry {
     /**
      * Creates graphics out of geometries with the default symbology set by the
-     * "measurement.set-default-symbol" command'.
+     * "measurement.set-default-symbol" command'. Web only.
      *
      * @webOnly
      */
@@ -123,35 +123,35 @@ export declare class MeasurementOperations extends OperationRegistry {
     /**
      * Allows the user to create geometry by sketching on a map with live
      * measurement labels. Returns the geometry that was drawn, along with the
-     * map that it was drawn on.
+     * map that it was drawn on. Web only.
      *
      * @webOnly
      */
     get captureGeometry(): Operation<CaptureGeometryArgs, CaptureGeometryResult>;
     /**
      * Gets the value of the default point, line, or polygon symbol for the
-     * provided geometry type.
+     * provided geometry type. Web only.
      *
      * @webOnly
      */
     get getDefaultSymbol(): Operation<GetDefaultSymbolArgs | GeometryType, DrawingSymbolConfig>;
     /**
      * Gets the value of the default 3D point, line, or polygon symbol for the
-     * provided geometry type.
+     * provided geometry type. Web only.
      *
      * @webOnly
      */
     get getDefaultSymbol3D(): Operation<GetDefaultSymbolArgs | GeometryType, DrawingSymbolConfig>;
     /**
      * Gets the area units used for measurements. If undefined the units will be
-     * selected intelligently based on dimensions.
+     * selected intelligently based on dimensions. Web only.
      *
      * @webOnly
      */
     get getAreaUnits(): Operation<void, AreaMeasurementUnits | undefined>;
     /**
      * Gets the length units used for measurements. If undefined the units will
-     * be selected intelligently based on dimensions.
+     * be selected intelligently based on dimensions. Web only.
      *
      * @webOnly
      */
@@ -159,13 +159,13 @@ export declare class MeasurementOperations extends OperationRegistry {
 }
 export declare class MeasurementEvents extends EventRegistry {
     /**
-     * Raised when a measurement is started.
+     * Raised when a measurement is started. Mobile only.
      *
      * @mobileOnly
      */
     get started(): Event<MeasurementEventArgs>;
     /**
-     * Raised when a measurement is stopped.
+     * Raised when a measurement is stopped. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/messaging.d.ts

@@ -14,7 +14,7 @@ export declare class MessagingOperations extends OperationRegistry {
      *
      * Note that argument merging already occurs automatically in command
      * chains; this explicit operation exists for advanced scenarios like
-     * VertiGIS Studio Workflow or custom code written using the SDK.
+     * VertiGIS Studio Workflow or custom code written using the SDK. Web only.
      *
      * @webOnly
      */

package/messaging/registry/network.d.ts

@@ -24,25 +24,25 @@ export interface HostAndPortArgs {
 }
 export declare class NetworkOperations extends OperationRegistry {
     /**
-     * Determines if the device has a network connection.
+     * Determines if the device has a network connection. Mobile only.
      *
      * @mobileOnly
      */
     get hasConnection(): Operation<void, boolean>;
     /**
-     * Returns the network status.
+     * Returns the network status. Mobile only.
      *
      * @mobileOnly
      */
     get getStatus(): Operation<void, NetworkStatus>;
     /**
-     * Determines if the device can reach a given host and port.
+     * Determines if the device can reach a given host and port. Mobile only.
      *
      * @mobileOnly
      */
     get canReachHost(): Operation<HostAndPortArgs, boolean>;
     /**
-     * Determines if the device can reach a given url.
+     * Determines if the device can reach a given url. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/offline.d.ts

@@ -303,14 +303,14 @@ export declare enum OfflineErrorCode {
 export declare class OfflineCommands extends CommandRegistry {
     /**
      * Cancels any create offline map area operation in progress and resets the
-     * form used to create custom offline map areas.
+     * form used to create custom offline map areas. Mobile only.
      *
      * @mobileOnly
      */
     get cancelCreateArea(): Command;
     /**
      * Cancels the download of the specified offline area, if it is currently in
-     * progress.
+     * progress. Mobile only.
      *
      * @mobileOnly
      */
@@ -318,14 +318,14 @@ export declare class OfflineCommands extends CommandRegistry {
     /**
      * Deletes the data stored on the device for the specified offline area. If
      * a custom offline area is specified, and the area is not downloaded,
-     * deletes the custom area definition instead.
+     * deletes the custom area definition instead. Mobile only.
      *
      * @mobileOnly
      */
     get deleteArea(): Command<OfflineCommandArgs>;
     /**
      * Displays a form that allows for the creation of a custom offline map
-     * area.
+     * area. Mobile only.
      *
      * @mobileOnly
      */
@@ -333,98 +333,102 @@ export declare class OfflineCommands extends CommandRegistry {
 }
 export declare class OfflineEvents extends EventRegistry {
     /**
-     * Raised when an offline area is activated.
+     * Raised when an offline area is activated. Mobile only.
      *
      * @mobileOnly
      */
     get areaActivated(): Event<AreaActivatedEventArgs>;
     /**
-     * Raised when an offline area is about to be activated.
+     * Raised when an offline area is about to be activated. Mobile only.
      *
      * @mobileOnly
      */
     get areaActivating(): Event<OfflineAreaBase>;
     /**
-     * Raised when the data for offline map area is deleted.
+     * Raised when the data for offline map area is deleted. Mobile only.
      *
      * @mobileOnly
      */
     get areaDeleted(): Event<OfflineAreaBase>;
     /**
-     * Raised when an offline area download has started.
+     * Raised when an offline area download has started. Mobile only.
      *
      * @mobileOnly
      */
     get areaDownloadStarted(): Event<OfflineAreaBase>;
     /**
-     * Raised when an offline area download is canceled by the user.
+     * Raised when an offline area download is canceled by the user. Mobile
+     * only.
      *
      * @mobileOnly
      */
     get areaDownloadCanceled(): Event<AreaOperationEndedEventArgs>;
     /**
-     * Raised when an offline area download fails.
+     * Raised when an offline area download fails. Mobile only.
      *
      * @mobileOnly
      */
     get areaDownloadFailed(): Event<AreaOperationEndedEventArgs>;
     /**
-     * Raised when an offline area download completes.
+     * Raised when an offline area download completes. Mobile only.
      *
      * @mobileOnly
      */
     get areaDownloaded(): Event<AreaOperationEndedEventArgs>;
     /**
-     * Raised when an offline area update has started.
+     * Raised when an offline area update has started. Mobile only.
      *
      * @mobileOnly
      */
     get areaUpdateStarted(): Event<OfflineAreaBase>;
     /**
-     * Raised when an offline area has been updated.
+     * Raised when an offline area has been updated. Mobile only.
      *
      * @mobileOnly
      */
     get areaUpdated(): Event<AreaOperationEndedEventArgs>;
     /**
-     * Raised when an any error occurs during an offline map update.
+     * Raised when an any error occurs during an offline map update. Mobile
+     * only.
      *
      * @mobileOnly
      */
     get areaUpdateFailed(): Event<AreaOperationEndedEventArgs>;
     /**
-     * Raised when an operation to submit offline area edits has started.
+     * Raised when an operation to submit offline area edits has started. Mobile
+     * only.
      *
      * @mobileOnly
      */
     get areaEditsSubmitStarted(): Event<AreaEditsSubmitStartedEventArgs>;
     /**
      * Raised when offline area edits have been submitted and this operation is
-     * successfully completed.
+     * successfully completed. Mobile only.
      *
      * @mobileOnly
      */
     get areaEditsSubmitted(): Event<AreaOperationEndedEventArgs>;
     /**
-     * Raised when any error occurs during an offline map submit edits.
+     * Raised when any error occurs during an offline map submit edits. Mobile
+     * only.
      *
      * @mobileOnly
      */
     get areaEditsSubmitFailed(): Event<AreaOperationEndedEventArgs>;
     /**
-     * Raised when a new custom offline map area is created.
+     * Raised when a new custom offline map area is created. Mobile only.
      *
      * @mobileOnly
      */
     get customAreaCreated(): Event<CustomOfflineArea>;
     /**
-     * Raised when the definition of a custom map area is deleted.
+     * Raised when the definition of a custom map area is deleted. Mobile only.
      *
      * @mobileOnly
      */
     get customAreaDeleted(): Event<CustomOfflineArea>;
     /**
-     * Raised when a map is switched to the online map.
+     * Raised when a map is switched to the online map. Mobile only.
      *
      * @mobileOnly
      */
@@ -432,59 +436,60 @@ export declare class OfflineEvents extends EventRegistry {
 }
 export declare class OfflineOperations extends OperationRegistry {
     /**
-     * Creates a new custom offline map area.
+     * Creates a new custom offline map area. Mobile only.
      *
      * @mobileOnly
      */
     get createArea(): Operation<CreateOfflineAreaArgs, CustomOfflineArea>;
     /**
-     * Gets a list of available offline areas for the web map.
+     * Gets a list of available offline areas for the web map. Mobile only.
      *
      * @mobileOnly
      */
     get getAreas(): Operation<MapExtension, OfflineAreaBase[]>;
     /**
-     * Gets a list of layer edits for a given map area.
+     * Gets a list of layer edits for a given map area. Mobile only.
      *
      * @mobileOnly
      */
     get getEdits(): Operation<OfflineCommandArgs, LayerEdits[]>;
     /**
      * Activates the specified offline area, replacing the map on the MapView
-     * with the offline map associated with the specified offline area.
+     * with the offline map associated with the specified offline area. Mobile
+     * only.
      *
      * @mobileOnly
      */
     get activateArea(): Operation<OfflineCommandArgs, OfflineOperationResult>;
     /**
-     * Downloads the data for the specified offline area.
+     * Downloads the data for the specified offline area. Mobile only.
      *
      * @mobileOnly
      */
     get downloadArea(): Operation<OfflineCommandArgs, OfflineOperationResult>;
     /**
-     * Switches from an offline map to the online map.
+     * Switches from an offline map to the online map. Mobile only.
      *
      * @mobileOnly
      */
     get goOnline(): Operation<OfflineCommandArgs, OfflineOperationResult>;
     /**
      * Checks whether a map area is active for the specified map, or for any map
-     * if argument is null.
+     * if argument is null. Mobile only.
      *
      * @mobileOnly
      */
     get checkForActiveArea(): Operation<MapExtension, boolean>;
     /**
      * Pushes any edits to the server that have been done in the indicated
-     * offline map.
+     * offline map. Mobile only.
      *
      * @mobileOnly
      */
     get submitEdits(): Operation<OfflineCommandArgs, OfflineOperationResult>;
     /**
      * Pulls down any new map changes from the server to the indicated offline
-     * map.
+     * map. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/panel.d.ts

@@ -54,6 +54,7 @@ export declare class PanelCommands extends CommandRegistry {
      * 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.
+     * Mobile only.
      *
      * @mobileOnly
      */
@@ -62,7 +63,7 @@ export declare class PanelCommands extends CommandRegistry {
      * 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.
+     * be closed. Mobile only.
      *
      * @mobileOnly
      */
@@ -70,7 +71,7 @@ export declare class PanelCommands extends CommandRegistry {
     /**
      * 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).
+     * anchor component is on the left or right side of the app). Mobile only.
      *
      * @mobileOnly
      */
@@ -78,19 +79,21 @@ export declare class PanelCommands extends CommandRegistry {
     /**
      * 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.
+     * the taskbar panel content slides up from the bottom. Mobile only.
      *
      * @mobileOnly
      */
     get snapHostPanel(): Command<SnapHostPanelArgs>;
     /**
      * Closes the popout window for a panel and restores the original layout.
+     * Web only.
      *
      * @webOnly
      */
     get popIn(): Command<Model["id"] | Model>;
     /**
      * Removes a panel from the main layout and opens it in a new popout window.
+     * Web only.
      *
      * @webOnly
      */
@@ -99,14 +102,15 @@ export declare class PanelCommands extends CommandRegistry {
 export declare class PanelEvents extends EventRegistry {
     /**
      * Raised when the component that is currently being displayed by the host
-     * panel is changed. Argument is the id of the component.
+     * panel is changed. Argument is the id of the component. Mobile only.
      *
      * @mobileOnly
      */
     get hostPanelComponentChanged(): Event<string>;
     /**
      * Raised when the component that is currently being displayed by the host
-     * panel is about to change. Argument is the id of the component.
+     * panel is about to change. Argument is the id of the component. Mobile
+     * only.
      *
      * @mobileOnly
      */

package/messaging/registry/photos.d.ts

@@ -23,13 +23,13 @@ export interface DisplayPhotoDetailsArgs {
 }
 export declare class PhotosCommands extends CommandRegistry {
     /**
-     * Displays a photo in expanded / details view.
+     * Displays a photo in expanded / details view. Mobile only.
      *
      * @mobileOnly
      */
     get displayDetails(): Command<DisplayPhotoDetailsArgs>;
     /**
-     * Hides the currently displayed photo details.
+     * Hides the currently displayed photo details. Mobile only.
      *
      * @mobileOnly
      */
@@ -37,7 +37,7 @@ export declare class PhotosCommands extends CommandRegistry {
 }
 export declare class PhotosEvents extends EventRegistry {
     /**
-     * Raised when photo details are hidden.
+     * Raised when photo details are hidden. Mobile only.
      *
      * @mobileOnly
      */

package/messaging/registry/portal.d.ts

@@ -69,7 +69,7 @@ export interface CreateOrUpdateItemArgs extends PortalItemData {
 }
 export declare class PortalEvents extends EventRegistry {
     /**
-     * Raised when an ArcGIS Portal is initialized.
+     * Raised when an ArcGIS Portal is initialized. Mobile only.
      *
      * @mobileOnly
      */
@@ -78,13 +78,13 @@ export declare class PortalEvents extends EventRegistry {
 export declare class PortalOperations extends OperationRegistry {
     /**
      * Allows the user to browse/search the application's associated portal for
-     * one or more layers.
+     * one or more layers. Web only.
      *
      * @webOnly
      */
     get chooseLayers(): Operation<ChooseLayersOptions, ChooseLayersResult>;
     /**
-     * Creates or updates a portal item from the supplied data.
+     * Creates or updates a portal item from the supplied data. Web only.
      *
      * @webOnly
      */

package/messaging/registry/project.d.ts

@@ -53,40 +53,40 @@ export declare class ProjectCommands extends CommandRegistry {
     /**
      * Loads a project's app config and updates the application's current state,
      * accordingly. If more than one file is provided, only the first will be
-     * loaded.
+     * loaded. Web only.
      *
      * @webOnly
      */
     get load(): Command<AppConfig | HasAppConfig | SharedProject | Blob | Blob[]>;
     /**
      * Create or updates a shared project with the specified shared project
-     * details and project config.
+     * details and project config. Web only.
      *
      * @webOnly
      */
     get saveShared(): Command<SaveSharedProjectArgs>;
     /**
-     * Guard command for enabling the project.save-shared command.
+     * Guard command for enabling the project.save-shared command. Web only.
      *
      * @webOnly
      */
     get ensureCanSaveShared(): Command<SaveSharedProjectArgs>;
     /**
      * Shows a shared projects settings. Requires a shared-projects component to
-     * be in the layout.
+     * be in the layout. Web only.
      *
      * @webOnly
      */
     get showSettings(): Command<ShowSharedProjectArgs>;
     /**
      * Shows a shared projects share link. Requires a shared-projects component
-     * to be in the layout.
+     * to be in the layout. Web only.
      *
      * @webOnly
      */
     get showShareLink(): Command<SharedProject>;
     /**
-     * Deletes a shared project and its associated project config.
+     * Deletes a shared project and its associated project config. Web only.
      *
      * @webOnly
      */
@@ -95,25 +95,25 @@ export declare class ProjectCommands extends CommandRegistry {
 export declare class ProjectOperations extends OperationRegistry {
     /**
      * Creates app config for a project, based on the current state of the
-     * application.
+     * application. Web only.
      *
      * @webOnly
      */
     get create(): Operation<unknown, AppConfig | HasAppConfig>;
     /**
-     * Returns a Shared Project Content.
+     * Returns a Shared Project Content. Web only.
      *
      * @webOnly
      */
     get getSharedContent(): Operation<SharedProject, HasAppConfig>;
     /**
-     * Returns a url share link for the provided Shared Project.
+     * Returns a url share link for the provided Shared Project. Web only.
      *
      * @webOnly
      */
     get getShareLink(): Operation<SharedProject, string>;
     /**
-     * Returns a list of Shared Projects.
+     * Returns a list of Shared Projects. Web only.
      *
      * @webOnly
      */
@@ -121,19 +121,19 @@ export declare class ProjectOperations extends OperationRegistry {
 }
 export declare class ProjectEvents extends EventRegistry {
     /**
-     * Raised when a project is loaded.
+     * Raised when a project is loaded. Web only.
      *
      * @webOnly
      */
     get loaded(): Event<SharedProject>;
     /**
-     * Raised when a shared project is added.
+     * Raised when a shared project is added. Web only.
      *
      * @webOnly
      */
     get shareAdded(): Event<SharedProject>;
     /**
-     * Raised when a shared project is removed.
+     * Raised when a shared project is removed. Web only.
      *
      * @webOnly
      */

package/messaging/registry/query-builder.d.ts

@@ -47,13 +47,13 @@ export interface SetQueryArgs extends QueryBuilderArgsBase, Query {
 export declare class QueryBuilderCommands extends CommandRegistry {
     /**
      * Sets the current query criteria in the query builder and also activates
-     * the component.
+     * the component. Web only.
      *
      * @webOnly
      */
     get displayQuery(): Command<SetQueryArgs>;
     /**
-     * Sets the current query criteria in the query builder.
+     * Sets the current query criteria in the query builder. Web only.
      *
      * @webOnly
      */
@@ -67,7 +67,7 @@ export interface GetQueryArgs extends Required<QueryBuilderArgsBase> {
 export declare class QueryBuilderOperations extends OperationRegistry {
     /**
      * Gets the currently visible query from the specified query builder
-     * component.
+     * component. Web only.
      *
      * @webOnly
      */

package/messaging/registry/region.d.ts

@@ -5,7 +5,7 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 export declare class RegionCommands extends CommandRegistry {
     /**
-     * Sets the current measurement system.
+     * Sets the current measurement system. Web only.
      *
      * @webOnly
      */
@@ -13,7 +13,7 @@ export declare class RegionCommands extends CommandRegistry {
 }
 export declare class RegionEvents extends EventRegistry {
     /**
-     * Raised when the current measurement system is changed.
+     * Raised when the current measurement system is changed. Web only.
      *
      * @webOnly
      */