@vertigis/viewer-spec 50.5.0 → 50.6.0

package/messaging/registry/measurement.d.ts

@@ -14,7 +14,8 @@ declare enum GeometryMode {
     AREA = "area"
 }
 /**
- * Arguments for the measurement.get-symbol operation. Only available in Geocortex Web.
+ * Arguments for the measurement.get-symbol operation. Only available in
+ * VertiGIS Studio Web.
  */
 export interface GetDefaultSymbolArgs {
     /**
@@ -23,7 +24,8 @@ export interface GetDefaultSymbolArgs {
     geometryType?: GeometryType;
 }
 /**
- * Arguments for the measurement events. Only available in VertiGIS Studio Mobile.
+ * Arguments for the measurement events. Only available in VertiGIS Studio
+ * Mobile.
  */
 export interface GeometryModeArgs extends HasMaps {
     /**

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
-     * Geocortex Workflow or custom code written using the SDK.
+     * VertiGIS Studio Workflow or custom code written using the SDK.
      *
      * @webOnly
      */

package/messaging/registry/offline.d.ts

@@ -185,7 +185,8 @@ export interface OfflineOperationResult {
      */
     success: boolean;
     /**
-     * The Exception that occurred during the operation, or null if no Exception occurred.
+     * The Exception that occurred during the operation, or null if no Exception
+     * occurred.
      */
     error: Exception;
     /**
@@ -195,8 +196,8 @@ export interface OfflineOperationResult {
     errorCode: OfflineErrorCode;
     /**
      * Gets a string representation of the ErrorCode enum; or null if
-     * successful. Useful for consumption in Geocortex Workflow, instead of
-     * having to deal with an integer value for the ErrorCode.
+     * successful. Useful for consumption in VertiGIS Studio Workflow, instead
+     * of having to deal with an integer value for the ErrorCode.
      */
     errorCodeString: string;
     /**
@@ -243,7 +244,8 @@ export interface OfflineOperationResult {
  */
 export declare enum OfflineErrorCode {
     /**
-     * The operation requires network connectivity, but the network is disconnected.
+     * The operation requires network connectivity, but the network is
+     * disconnected.
      */
     NETWORK_CONNECTION_REQUIRED = 100,
     /**
@@ -263,7 +265,8 @@ export declare enum OfflineErrorCode {
      */
     INVALID_MAP_AREA_DATA = 104,
     /**
-     * The amount of allowable time spent with the app in the background was exceeded.
+     * The amount of allowable time spent with the app in the background was
+     * exceeded.
      */
     BACKGROUND_TIME_EXPIRED = 105,
     /**
@@ -296,7 +299,8 @@ export declare class OfflineCommands extends CommandRegistry {
      */
     get cancelCreateArea(): Command;
     /**
-     * Cancels the download of the specified offline area, if it is currently in progress.
+     * Cancels the download of the specified offline area, if it is currently in
+     * progress.
      *
      * @mobileOnly
      */
@@ -310,7 +314,8 @@ export declare class OfflineCommands extends CommandRegistry {
      */
     get deleteArea(): Command<OfflineCommandArgs>;
     /**
-     * Displays a form that allows for the creation of a custom offline map area.
+     * Displays a form that allows for the creation of a custom offline map
+     * area.
      *
      * @mobileOnly
      */
@@ -461,13 +466,15 @@ export declare class OfflineOperations extends OperationRegistry {
      */
     get checkForActiveArea(): Operation<MapExtension, boolean>;
     /**
-     * Pushes any edits to the server that have been done in the indicated offline map.
+     * Pushes any edits to the server that have been done in the indicated
+     * offline map.
      *
      * @mobileOnly
      */
     get submitEdits(): Operation<OfflineCommandArgs, OfflineOperationResult>;
     /**
-     * Pulls down any new map changes from the server to the indicated offline map.
+     * Pulls down any new map changes from the server to the indicated offline
+     * map.
      *
      * @mobileOnly
      */

package/messaging/registry/panel.d.ts

@@ -61,7 +61,8 @@ 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.
+     * no component is specified (input null), then the host panel will always
+     * be closed.
      *
      * @mobileOnly
      */

package/messaging/registry/portal.d.ts

@@ -15,7 +15,8 @@ export interface ArcGISPortalExtension {
  */
 export interface ChooseLayersOptions extends HasMaps, HasUITarget {
     /**
-     * Whether the user can choose multiple layers, or just one. Default is `false`.
+     * Whether the user can choose multiple layers, or just one. Default is
+     * `false`.
      */
     allowMultiple?: boolean;
 }
@@ -50,16 +51,19 @@ export interface PortalItemData {
  */
 export interface CreateOrUpdateItemArgs extends PortalItemData {
     /**
-     * The title of the resulting portal item. Must be provided if `showUI` is `false`.
+     * The title of the resulting portal item. Must be provided if `showUI` is
+     * `false`.
      */
     title?: string;
     /**
-     * Whether to show UI elements associated with this operation. Defaults to `true`.
+     * Whether to show UI elements associated with this operation. Defaults to
+     * `true`.
      */
     showUI?: boolean;
     /**
      * Whether to prompt before overwriting an existing item. This must be set
-     * to `false` to allow overwriting if `showUI` is also `false`. Defaults to `true`.
+     * to `false` to allow overwriting if `showUI` is also `false`. Defaults to
+     * `true`.
      */
     promptForOverwrite?: boolean;
 }

package/messaging/registry/printing.d.ts

@@ -45,7 +45,8 @@ export interface RunPrintArgs {
      */
     extent?: Extent;
     /**
-     * The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint.
+     * The initial viewpoint of the 3D map(s). Defaults to the scene's current
+     * viewpoint.
      */
     viewpoint?: Viewpoint;
     /**
@@ -57,7 +58,8 @@ export interface RunPrintArgs {
      */
     grid?: SpatialReference;
     /**
-     * Additional parameters used in the print template, specified as key-value pairs.
+     * Additional parameters used in the print template, specified as key-value
+     * pairs.
      */
     parameters?: JobParameters;
     /**

package/messaging/registry/results.d.ts

@@ -184,7 +184,8 @@ export interface FromGraphicsArgs {
      */
     title?: string;
     /**
-     * The feature source ID to use if the results are associated with a workflow.
+     * The feature source ID to use if the results are associated with a
+     * workflow.
      */
     workflowItemId?: string;
 }
@@ -263,7 +264,8 @@ export interface SetListCardSizeArgs {
     results?: ModelRef;
 }
 /**
- * Arguments for various commands that manipulate the current set of shown results.
+ * Arguments for various commands that manipulate the current set of shown
+ * results.
  */
 export declare type ShowResultsArgs = Features | (UpdateResultsFeaturesArgs & {
     /**
@@ -326,7 +328,8 @@ export declare class ResultsCommands extends CommandRegistry {
      * Presents features to the user within any components that can display
      * features, such as a feature list, feature table, or feature details
      * component. The argument is the features to display, or an object
-     * specifying both features and the target results component to update (Web only).
+     * specifying both features and the target results component to update (Web
+     * only).
      */
     get display(): Command<Features | UpdateResultsFeaturesArgs>;
     /**
@@ -343,13 +346,15 @@ export declare class ResultsCommands extends CommandRegistry {
     /**
      * Presents feature details to the user within the feature-details
      * component. The argument is the feature(s) to display, or an object
-     * specifying both features and the target results component to update (Web only).
+     * specifying both features and the target results component to update (Web
+     * only).
      */
     get displayDetails(): Command<Features | UpdateResultsFeaturesArgs>;
     /**
      * Presents a feature summary to the user within the feature-summary
      * component. The argument is the feature(s) to display, or an object
-     * specifying both features and the target results component to update (Web only).
+     * specifying both features and the target results component to update (Web
+     * only).
      *
      * @webOnly
      */
@@ -358,7 +363,8 @@ export declare class ResultsCommands extends CommandRegistry {
      * Presents new feature details to the user within the feature-details
      * component. If the feature-details component is contained within a panel,
      * a 'back' button will be provided to navigate to the previous content;
-     * otherwise, the content of the feature-details component will be replaced.
+     * otherwise, the content of the feature-details component will be
+     * replaced.
      */
     get displayNewDetails(): Command<Features | UpdateResultsFeaturesArgs>;
     /**
@@ -387,7 +393,8 @@ export declare class ResultsCommands extends CommandRegistry {
      */
     get clearDetails(): Command;
     /**
-     * Deactivates the feature details component that is displaying the given feature.
+     * Deactivates the feature details component that is displaying the given
+     * feature.
      *
      * @mobileOnly
      */
@@ -467,7 +474,8 @@ export declare class ResultsOperations extends OperationRegistry {
     get convertToCsv(): Operation<ToCsvConversionArgs | Features, ConversionResult>;
     /**
      * Converts the provided Feature(s) to a XLSX file grouped by feature
-     * source. If there are multiple sources the XLSX(s) will be bundled in a zip file.
+     * source. If there are multiple sources the XLSX(s) will be bundled in a
+     * zip file.
      *
      * @webOnly
      */
@@ -505,11 +513,12 @@ export declare class ResultsOperations extends OperationRegistry {
      */
     get fromXlsx(): Operation<FromXLSXConversionArgs | Blob | Blob[], Features>;
     /**
-     * Converts provided GraphicsLike to Geocortex Features using any available metadata.
+     * Converts provided GraphicsLike to VertiGIS Studio Features using any
+     * available metadata.
      */
     get fromGraphics(): Operation<FromGraphicsArgs, Features>;
     /**
-     * Converts Geocortex Features to Esri graphics.
+     * Converts VertiGIS Studio Features to Esri graphics.
      */
     get toGraphics(): Operation<Features, Graphic[]>;
     /**

package/messaging/registry/settings.d.ts

@@ -13,7 +13,8 @@ export declare class SettingsEvents extends EventRegistry {
  */
 export interface SettingsInfo {
     /**
-     * Indicates if layer visibilities are remembered and restored upon app startup.
+     * Indicates if layer visibilities are remembered and restored upon app
+     * startup.
      */
     rememberLayerVisibilities: boolean;
     /**
@@ -21,7 +22,8 @@ export interface SettingsInfo {
      */
     rememberMapExtent: boolean;
     /**
-     * The size that photos will be resized to when adding as a feature attachment.
+     * The size that photos will be resized to when adding as a feature
+     * attachment.
      */
     photoResize: PhotoResizeOption;
     /**

package/messaging/registry/sketching.d.ts

@@ -160,7 +160,8 @@ export interface MovePointArgs extends HasMaps {
     units?: LengthUnits;
 }
 /**
- * Deprecated - use "sketching.set-active-points" with {@link SetActivePointsArgs}.
+ * Deprecated - use "sketching.set-active-points" with
+ * {@link SetActivePointsArgs}.
  *
  * @deprecated
  */
@@ -208,15 +209,16 @@ export interface CaptureGeometryArgs {
     maps?: MapsLike;
     /**
      * The geometry/shape to use for sketching. * Multiple sketch tools are only
-     * supported by Geocortex Web. When multiple sketch tools are provided, the
-     * sketch will begin with the first one in the list. If "point" is the first
-     * of multiple options in the list, click actions will create points while
-     * click-and-drag actions will automatically begin the freehand variation of
-     * the next included geometry type.
+     * supported by VertiGIS Studio Web. When multiple sketch tools are
+     * provided, the sketch will begin with the first one in the list. If
+     * "point" is the first of multiple options in the list, click actions will
+     * create points while click-and-drag actions will automatically begin the
+     * freehand variation of the next included geometry type.
      */
     geometryType: SketchTool | SketchTool[];
     /**
-     * An optional symbol to use. SymbolSets are not supported by Geocortex Mobile.
+     * An optional symbol to use. SymbolSets are not supported by VertiGIS
+     * Studio Mobile.
      */
     symbol?: SymbolJson | SymbolSet;
     /**
@@ -242,8 +244,8 @@ export interface CaptureGeometryResult {
      */
     geometry: Geometry;
     /**
-     * The map that the user sketched the geometry on. Unavailable in Geocortex
-     * Mobile Viewer.
+     * The map that the user sketched the geometry on. Unavailable in VertiGIS
+     * Studio Mobile.
      */
     maps: MapsLike;
     /**
@@ -392,7 +394,8 @@ export interface StopGeometryEditArgs {
      */
     maps: MapsLike;
     /**
-     * Whether to validate the geometry before returning it. Defaults to true if not set.
+     * Whether to validate the geometry before returning it. Defaults to true if
+     * not set.
      */
     validateGeometry?: boolean;
 }
@@ -448,20 +451,20 @@ export interface AddNodeToGeometryArgs extends HasMaps {
     geometry: Geometry;
     /**
      * The type of geometry to create if the initial geometry is null. In
-     * Geocortex Mobile, this value must be 'polygon' or 'polyline'. In
-     * Geocortex Web, this value may also be null if the point being added is
-     * intended to be added to the active sketch.
+     * VertiGIS Studio Mobile, this value must be 'polygon' or 'polyline'. In
+     * VertiGIS Studio Web, this value may also be null if the point being added
+     * is intended to be added to the active sketch.
      */
     geometryType: string;
     /**
-     * A point geometry to add to the initial geometry. In geocortex Web, this
-     * value may be null if the intention is to add a point at the position of
-     * the active point of an active sketch.
+     * A point geometry to add to the initial geometry. In VertiGIS Studio Web,
+     * this value may be null if the intention is to add a point at the position
+     * of the active point of an active sketch.
      */
     node: Geometry;
     /**
      * Indicates whether the new point should be added before or after the
-     * active point in the sketch. Not supported by Geocortex Mobile.
+     * active point in the sketch. Not supported by VertiGIS Studio Mobile.
      */
     nodeOrder?: AddNodeOrder;
 }
@@ -498,7 +501,8 @@ export interface DeleteGeometryArgs extends HasMaps {
  */
 export interface SetGeometryModeArgs extends HasMaps {
     /**
-     * The geometry mode to switch to. Geocortex Mobile only supports "line" and "area".
+     * The geometry mode to switch to. VertiGIS Studio Mobile only supports
+     * "line" and "area".
      */
     editorGeometryMode: EditorGeometryMode | SketchTool;
 }
@@ -516,7 +520,8 @@ export interface SetInteractionModeArgs extends HasMaps {
  */
 export interface StartStreamingArgs extends HasMaps {
     /**
-     * An optional value indicating, in seconds, how often points should be recorded.
+     * An optional value indicating, in seconds, how often points should be
+     * recorded.
      */
     interval?: number;
 }
@@ -557,7 +562,8 @@ export interface GeometryEditorSettings {
      */
     finishOnDoubleClick?: boolean;
     /**
-     * Whether the sketch should commit its geometry if another sketch is activated.
+     * Whether the sketch should commit its geometry if another sketch is
+     * activated.
      */
     finishIfInterrupted?: boolean;
 }
@@ -588,7 +594,8 @@ export declare type PointOffset = "before" | "after";
  */
 export interface GetAdjacentPointArgs extends HasMaps {
     /**
-     * A point geometry that represents a vertex within an active editing graphic.
+     * A point geometry that represents a vertex within an active editing
+     * graphic.
      */
     referencePoint: Point;
     /**
@@ -621,7 +628,8 @@ export interface SetConstraintsArgs extends HasMaps {
      * Indicates whether constraints will be automatically cleared after a
      * vertex is added or updated. If not set (value is null), then the value
      * will remain unchanged with this operation. If the value has never been
-     * set, the default is false. Remains unchanged until set to a different value.
+     * set, the default is false. Remains unchanged until set to a different
+     * value.
      */
     autoClear?: boolean;
     /**
@@ -662,7 +670,8 @@ export declare class SketchingOperations extends OperationRegistry {
      */
     get captureGeometry(): Operation<CaptureGeometryArgs, CaptureGeometryResult>;
     /**
-     * Allows the user to edit the symbology used by the graphics actively being edited.
+     * Allows the user to edit the symbology used by the graphics actively being
+     * edited.
      *
      * @webOnly
      */
@@ -708,7 +717,8 @@ export declare class SketchingOperations extends OperationRegistry {
     get stop(): Operation<StopGeometryEditArgs | void, CaptureGeometryResult>;
     /**
      * Deprecated - Mobile users should rather use "geometry.add-point"; Web
-     * users should use "sketching.add-point" or "sketching.insert-point" instead.
+     * users should use "sketching.add-point" or "sketching.insert-point"
+     * instead.
      *
      * @deprecated
      */
@@ -727,7 +737,8 @@ export declare class SketchingOperations extends OperationRegistry {
      */
     get getActiveNode(): Operation<Maps, GetActivePointsResult>;
     /**
-     * Returns the active point graphics of the active sketch or edit session on a map.
+     * Returns the active point graphics of the active sketch or edit session on
+     * a map.
      *
      * @webOnly
      */
@@ -792,7 +803,8 @@ export declare class SketchingCommands extends CommandRegistry {
      * If a point is supplied while a sketching or editing operation is active,
      * the vertex at that point will be deleted from the current geometry. If no
      * point is supplied, any active points in the session will be deleted. If
-     * there are no active points in the session, the entire geometry will be deleted.
+     * there are no active points in the session, the entire geometry will be
+     * deleted.
      */
     get delete(): Command<void | DeleteGeometryArgs>;
     /**

package/messaging/registry/tasks.d.ts

@@ -46,20 +46,23 @@ export interface SearchArgs {
      */
     maxQueryResults?: number;
     /**
-     * If specified, results are limited to features that intersect the geometry.
+     * If specified, results are limited to features that intersect the
+     * geometry.
      */
     searchArea?: Geometry;
     /**
      * If specified, this will influence the score of spatial features based on
      * their proximity to this point. Most commonly this would be the user's
      * current location, but can be any point of interest. This option requires
-     * searchArea to also be specified. Not supported in VertiGIS Studio Mobile.
+     * searchArea to also be specified. Not supported in VertiGIS Studio
+     * Mobile.
      */
     near?: Point;
     /**
-     * The map Viewpoint at the time of the search. Mobile only.
+     * The map Viewpoint at the time of the search. Mobile only. This property
+     * is required in VertiGIS Studio Mobile.
      */
-    mapViewpoint: Viewpoint;
+    mapViewpoint?: Viewpoint;
     /**
      * The spatial reference for the returned geometry. Not supported in
      * VertiGIS Studio Mobile.

package/messaging/registry/ui.d.ts

@@ -96,7 +96,8 @@ export interface DisplayNotificationArgs {
      */
     notificationGroup?: string;
     /**
-     * The notification title - only shown for system notifications. Mobile only.
+     * The notification title - only shown for system notifications. Mobile
+     * only.
      */
     title?: string;
     /**
@@ -106,7 +107,8 @@ export interface DisplayNotificationArgs {
     type?: NotificationType;
 }
 /**
- * The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only.
+ * The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'.
+ * Mobile only.
  */
 export declare enum NotificationType {
     /**
@@ -261,7 +263,8 @@ export declare class UICommands extends CommandRegistry {
      */
     get deactivate(): Command<ComponentId | Model>;
     /**
-     * Displays a spinner and custom message to the user to indicate that the UI is busy.
+     * Displays a spinner and custom message to the user to indicate that the UI
+     * is busy.
      *
      * @mobileOnly
      */
@@ -319,7 +322,8 @@ export declare class UICommands extends CommandRegistry {
      */
     get setLocale(): Command<string>;
     /**
-     * Sets the color theme of the viewer. The required argument is the new theme's ID.
+     * Sets the color theme of the viewer. The required argument is the new
+     * theme's ID.
      */
     get setTheme(): Command<string>;
     /**
@@ -395,13 +399,15 @@ export declare class UIEvents extends EventRegistry {
      */
     get densityChanged(): Event<UIDensity>;
     /**
-     * Raised when the locale is changed by the user. The argument is the locale code.
+     * Raised when the locale is changed by the user. The argument is the locale
+     * code.
      *
      * @webOnly
      */
     get localeChanged(): Event<string>;
     /**
-     * Raised when a component begins initialization. The argument is the component ID.
+     * Raised when a component begins initialization. The argument is the
+     * component ID.
      *
      * @webOnly
      */
@@ -420,7 +426,8 @@ export declare class UIEvents extends EventRegistry {
      */
     get removed(): Event<ComponentId>;
     /**
-     * Raised when a component is reordered in the layout relative to its siblings.
+     * Raised when a component is reordered in the layout relative to its
+     * siblings.
      *
      * @webOnly
      */

package/messaging/registry/viewer.d.ts

@@ -7,7 +7,8 @@ import { OperationRegistry } from "../OperationRegistry.js";
 import type { Model } from "../common.js";
 export declare class ViewerCommands extends CommandRegistry {
     /**
-     * Loads a new layout. Can be a layout URL or layout XML, or a Layout object.
+     * Loads a new layout. Can be a layout URL or layout XML, or a Layout
+     * object.
      *
      * @webOnly
      */

package/messaging/registry/workflow.d.ts

@@ -33,7 +33,8 @@ interface ExecuteWorkflowArgs {
      */
     instanceId?: string;
     /**
-     * The map to target, if omitted Web will attempt to choose the best map for you.
+     * The map to target, if omitted Web will attempt to choose the best map for
+     * you.
      *
      * @webOnly
      */
@@ -42,7 +43,8 @@ interface ExecuteWorkflowArgs {
      * The layout ID of the workflow component to use for any workflow forms, or
      * the ID of a container component like taskbar, panel, stack, etc. In the
      * latter case, a new workflow component will be created dynamically as a
-     * child of the targeted container, and removed when the workflow finishes running.
+     * child of the targeted container, and removed when the workflow finishes
+     * running.
      */
     target?: string;
 }
@@ -106,7 +108,8 @@ export interface WorkflowFinishedEventArgs extends WorkflowEventBase {
 export declare class WorkflowCommands extends CommandRegistry {
     /**
      * Runs a workflow with the given arguments. See the `workflow.evaluate`
-     * operation if you want to run a workflow and expect output values to be returned.
+     * operation if you want to run a workflow and expect output values to be
+     * returned.
      */
     get run(): Command<RunWorkflowArgs>;
     /**