@vertigis/viewer-spec 47.5.0 → 48.0.0

package/messaging/Operation.d.ts

@@ -23,8 +23,7 @@ export interface Operation<T = void, TResult = undefined> extends Message {
      * Executes the operation and returns its result.
      *
      * @param argument The argument to the operation.
-     * @param options CancelToken or options to apply to the Operation execute
-     * behavior.
+     * @param options CancelToken or options to apply to the Operation execute behavior.
      */
     execute: (argument: T, options?: CancelToken | MessageExecuteOptions) => Promise<TResult>;
     /**

package/messaging/common.d.ts

@@ -44,8 +44,7 @@ export interface Model extends Entity {
  */
 export declare type ModelRef = string | Model;
 /**
- * Result of the "drawing.create-graphics" and "measurement.create-graphics"
- * operations.
+ * Result of the "drawing.create-graphics" and "measurement.create-graphics" operations.
  */
 export interface CreateGraphicsResult {
     /**
@@ -97,8 +96,7 @@ export interface HasMaps {
  */
 export declare type Maps = MapsLike | HasMaps;
 /**
- * A reference to an existing layer, which is the ID or title of the layer (or
- * both).
+ * A reference to an existing layer, which is the ID or title of the layer (or both).
  */
 export declare type LayerReference = string | LayerReferenceObject;
 /**
@@ -119,8 +117,7 @@ export interface HasLayers {
     layers?: LayersLike;
 }
 /**
- * One or more layer extensions, or an object that has one or more layer
- * extensions.
+ * One or more layer extensions, or an object that has one or more layer extensions.
  */
 export declare type Layers = LayersLike | HasLayers;
 /**
@@ -145,8 +142,7 @@ export interface HasGraphics {
     graphics?: GraphicsLike;
 }
 /**
- * An object with arguments for a command or operation that can display
- * temporary UI.
+ * An object with arguments for a command or operation that can display temporary UI.
  */
 export interface HasUITarget {
     /**
@@ -214,8 +210,7 @@ export interface HasSymbol {
     symbol?: SymbolLike;
 }
 /**
- * An object that is convertible to an Esri Viewpoint, or that has a viewpoint
- * property.
+ * An object that is convertible to an Esri Viewpoint, or that has a viewpoint property.
  */
 export declare type ViewpointArg = ViewpointLike | HasViewPoint;
 /**
@@ -240,12 +235,12 @@ export interface Blob {
      * on which it's called.
      *
      * @param start An index into the Blob indicating the first byte to include
-     * in the new Blob.
+     *   in the new Blob.
      * @param end An index into the Blob indicating the first byte that will
-     * *not* be included in the new Blob (i.e. the byte exactly at this index is
-     * not included).
+     *   _not_ be included in the new Blob (i.e. the byte exactly at this index
+     *   is not included).
      * @param contentType The content type to assign to the new Blob; this will
-     * be the value of its type property. The default value is an empty string.
+     *   be the value of its type property. The default value is an empty string.
      */
     slice(start?: number, end?: number, contentType?: string): Blob;
     /**

package/messaging/registry/app.d.ts

@@ -7,8 +7,7 @@ import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
 import type { Blob } from "../common.js";
 /**
- * Arguments for the app started events. Only available in the Geocortex Mobile
- * Viewer.
+ * Arguments for the app started events. Only available in the Geocortex Mobile Viewer.
  */
 export interface SpecificAppArgs {
     /**
@@ -51,8 +50,7 @@ export declare class AppCommands extends CommandRegistry {
      */
     get goToAppSelector(): Command;
     /**
-     * Refreshes the currently loaded app so that it can download updates if
-     * available.
+     * Refreshes the currently loaded app so that it can download updates if available.
      *
      * @mobileOnly
      */
@@ -71,8 +69,7 @@ export declare class AppCommands extends CommandRegistry {
     get unfavorite(): Command;
     /**
      * 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.
+     * accordingly. If more than one file is provided, only the first will be loaded.
      *
      * @webOnly
      */
@@ -132,15 +129,14 @@ export declare class AppGenericEvents extends EventRegistry {
 }
 export declare class AppOperations extends OperationRegistry {
     /**
-     * Gets the current version stamped in the application (i.e. the version of the viewer
-     * this application was created with).
+     * Gets the current version stamped in the application (i.e. the version of
+     * the viewer this application was created with).
      *
      * @webOnly
      */
     get getVersion(): Operation<void, string>;
     /**
-     * Creates app config for a project, based on the current state of the
-     * application.
+     * Creates app config for a project, based on the current state of the application.
      *
      * @webOnly
      */

package/messaging/registry/arcade.d.ts

@@ -21,8 +21,7 @@ export interface RunArcadeArgs {
     canExecuteScript?: string;
     /**
      * An arguments object that provides named variables and associated values,
-     * which can be referenced from within the executeScript and
-     * canExecuteScript.
+     * which can be referenced from within the executeScript and canExecuteScript.
      *
      * NOTE: All variable keys must consist of only lowercase letters;
      * camel-cased context variables will break the script when they are
@@ -60,13 +59,11 @@ export declare class ArcadeOperations extends OperationRegistry {
      * the operation will throw a {@link Cancellation}.
      *
      * @webOnly
-     *
      */
     get run(): Operation<RunArcadeArgs | string, unknown>;
 }
 /**
- * Properties used to set a series of watch handles and/or event listeners on
- * an item.
+ * Properties used to set a series of watch handles and/or event listeners on an item.
  */
 export interface WatchEventHandleProperties {
     /**
@@ -77,8 +74,7 @@ export interface WatchEventHandleProperties {
      * One or more properties on the item that will be watched for changes
      * and/or events. Any strings will be used as propertyPaths that will be
      * watched for changes; for this to work, the item and all properties
-     * referenced within the path (except for the last) must implement
-     * {@link Observable}.
+     * referenced within the path (except for the last) must implement {@link Observable}.
      */
     watch: string | WatchEventProperty | (string | WatchEventProperty)[];
 }

package/messaging/registry/auth.d.ts

@@ -22,14 +22,12 @@ export declare enum AuthenticationType {
  */
 export interface Principal {
     /**
-     * The ArcGIS JavaScript API PortalUser object containing information about
-     * the user.
+     * The ArcGIS JavaScript API PortalUser object containing information about the user.
      */
     portalUser: PortalUser;
 }
 /**
- * Arguments for the auth.sign-in events. Only available in the Geocortex Mobile
- * Viewer.
+ * Arguments for the auth.sign-in events. Only available in the Geocortex Mobile Viewer.
  */
 export interface SignInEventArgs {
     /**
@@ -59,8 +57,7 @@ export declare class AuthCommands extends CommandRegistry {
     /**
      * Initiates user sign-in if they aren't already signed in. The argument
      * indicates whether or not the map should be reloaded when the sign-in is
-     * complete. This argument is optional and only supported by Geocortex
-     * Mobile Viewer.
+     * complete. This argument is optional and only supported by Geocortex Mobile Viewer.
      */
     get signIn(): Command<boolean | void>;
     /**
@@ -76,8 +73,8 @@ export declare class AuthOperations extends OperationRegistry {
      */
     get getCurrentUser(): Operation<void, Principal>;
     /**
-     * Looks for an existing Esri credential. Does not prompt the user to
-     * sign in if credential cannot be found.
+     * Looks for an existing Esri credential. Does not prompt the user to sign
+     * in if credential cannot be found.
      *
      * @mobileOnly
      */
@@ -118,8 +115,7 @@ export declare class AuthEvents extends EventRegistry {
     get signOutRequested(): Event;
     /**
      * Raised when the user's token is refreshed. Will be the new token in the
-     * Geocortex Web Viewer, and a TokenCredential object in the Geocortex
-     * Mobile Viewer.
+     * Geocortex Web Viewer, and a TokenCredential object in the Geocortex Mobile Viewer.
      */
     get tokenRefreshed(): Event<string>;
 }

package/messaging/registry/basemap.d.ts

@@ -15,26 +15,26 @@ export declare class BasemapOperations extends OperationRegistry {
      * Gets all configured basemaps.
      *
      * Having argument:
+     *
      * - Multiple maps: the union of all basemap options from each
      * - No maps: the union of all basemap options for every map in the application.
      */
     get getAll(): Operation<MapsLike, BasemapExtension[]>;
     /**
-     * Gets currently selected basemap for the given map.
-     * If more than one map is specified, only the first map is used.
+     * Gets currently selected basemap for the given map. If more than one map
+     * is specified, only the first map is used.
      */
     get getCurrent(): Operation<MapsLike, BasemapExtension>;
 }
 /**
- * Argument used in case when we have only 1 map in the app
- * or when the first active map should be used.
- * Basemap extension ID or the basemap self.
- * If more than one basemap is specified, only the first one is used.
+ * Argument used in case when we have only 1 map in the app or when the first
+ * active map should be used. Basemap extension ID or the basemap self. If more
+ * than one basemap is specified, only the first one is used.
  */
 export declare type SetBasemapArg = string | BasemapsLike;
 /**
- * Argument used in case when we have more than 1 map in the app,
- * and we need to pass the target map from outside (eg basemap picker in web viewer).
+ * Argument used in case when we have more than 1 map in the app, and we need to
+ * pass the target map from outside (eg basemap picker in web viewer).
  */
 export interface SetBasemapWithTargetMapArg {
     /**

package/messaging/registry/charts.d.ts

@@ -48,8 +48,8 @@ export declare class ChartsCommands extends CommandRegistry {
      */
     get removeFeatures(): Command<Features | UpdateChartFeaturesArgs>;
     /**
-     * Clear features from active charts. If a chart is specified, then only
-     * the given chart will be updated, otherwise all charts will.
+     * Clear features from active charts. If a chart is specified, then only the
+     * given chart will be updated, otherwise all charts will.
      *
      * @webOnly
      */

package/messaging/registry/debugConsole.d.ts

@@ -3,22 +3,21 @@ import { OperationRegistry } from "../OperationRegistry.js";
 /**
  * Deprecated; use LogViewerOperations instead.
  *
- *  @deprecated
- *
+ * @deprecated
  */
 export declare class DebugConsoleOperations extends OperationRegistry {
     /**
      * Displays the Debug Console. Deprecated; use log-viewer.display instead.
      *
-     * @mobileOnly
      * @deprecated
+     * @mobileOnly
      */
     get display(): Operation<void>;
     /**
      * Closes the Debug Console. Deprecated; use log-viewer.close instead.
      *
-     * @mobileOnly
      * @deprecated
+     * @mobileOnly
      */
     get close(): Operation<void>;
 }

package/messaging/registry/drawing.d.ts

@@ -27,8 +27,7 @@ import type { CreateGraphicsResult, GeometryLike, HasFeatures, HasGraphics, HasL
  */
 export declare type DrawingSymbolConfig = SimpleMarkerSymbol | SimpleMarkerSymbolProperties | PictureMarkerSymbol | PictureMarkerSymbolProperties | SimpleLineSymbol | SimpleLineSymbolProperties | SimpleFillSymbol | SimpleFillSymbolProperties | PictureFillSymbol | PictureFillSymbolProperties | PointSymbol3D | PointSymbol3DProperties | LineSymbol3D | LineSymbol3DProperties | PolygonSymbol3D | PolygonSymbol3DProperties;
 /**
- * Arguments for the drawing.get-symbol operation. Only available in Geocortex
- * Web.
+ * Arguments for the drawing.get-symbol operation. Only available in Geocortex Web.
  */
 export interface GetDefaultSymbolArgs {
     /**
@@ -37,8 +36,7 @@ export interface GetDefaultSymbolArgs {
     geometryType?: GeometryType;
 }
 /**
- * Arguments for the drawing.edit-symbol operation. Only available in Geocortex
- * Web.
+ * Arguments for the drawing.edit-symbol operation. Only available in Geocortex Web.
  */
 export interface EditSymbolArgs extends HasMaps, HasLayers, HasGraphics, HasFeatures, HasUITarget {
     /**
@@ -64,8 +62,7 @@ export interface EditSymbolArgs extends HasMaps, HasLayers, HasGraphics, HasFeat
     showOnlySymbolPresets?: boolean;
 }
 /**
- * Arguments for the drawing.edit-symbol operation. Only available in Geocortex
- * Web.
+ * Arguments for the drawing.edit-symbol operation. Only available in Geocortex Web.
  */
 export interface EditSymbolResult extends HasMaps, HasLayers, HasGraphics, HasFeatures {
     /**

package/messaging/registry/edit.d.ts

@@ -10,8 +10,7 @@ import { OperationRegistry } from "../OperationRegistry.js";
 import type { Features, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget, MapsLike } from "../common.js";
 import type { EditGeometryOptions } from "./sketching.js";
 /**
- * Arguments for the "edit.add-attachment" command. Supported by both Web and
- * Mobile.
+ * Arguments for the "edit.add-attachment" command. Supported by both Web and Mobile.
  */
 export interface AddAttachmentArgs {
     /**
@@ -62,8 +61,7 @@ export interface DeleteAttachmentArgs {
     /**
      * The attachment(s) to remove from the feature(s). This property can be
      * populated with the title(s) or ID(s) of the attachments(s). Any and all
-     * matching attachments found on the input features will be deleted. Web
-     * only.
+     * matching attachments found on the input features will be deleted. Web only.
      */
     attachments?: string[];
     /**
@@ -102,8 +100,7 @@ export interface EditUIOptions {
     showTitles?: boolean;
 }
 /**
- * A collection of options common to interactive feature editing sessions. Web
- * only.
+ * A collection of options common to interactive feature editing sessions. Web only.
  */
 export interface EditOptions {
     /**
@@ -136,8 +133,8 @@ export interface UpdateSessionArgs extends HasGeometry {
     attachments?: Attachment[];
 }
 /**
- * Arguments for the "edit.create-feature" operation. A valid feature layer is required.
- * The geometry is required for non-tabular features. Web only.
+ * Arguments for the "edit.create-feature" operation. A valid feature layer is
+ * required. The geometry is required for non-tabular features. Web only.
  */
 export interface CreateFeatureArgs extends HasGeometry, HasLayers, HasMaps, EditUIOptions {
     /**
@@ -195,17 +192,15 @@ export declare class EditCommands extends CommandRegistry {
     /**
      * Create and add an attachment to a provided feature, using the given
      * attachment data.
-     *
      */
     get addAttachment(): Command<AddAttachmentArgs | WebAddAttachmentArgs>;
     /**
      * Deletes attachments from feature(s).
-     *
      */
     get deleteAttachment(): Command<DeleteAttachmentArgs>;
     /**
-     * Adds a feature to a particular layer. `Features` and
-     * `EditCommandArgs` are not supported on Mobile.
+     * Adds a feature to a particular layer. `Features` and `EditCommandArgs`
+     * are not supported on Mobile.
      */
     get addFeature(): Command<Feature | Features | EditCommandArgs>;
     /**
@@ -240,8 +235,8 @@ export declare class EditCommands extends CommandRegistry {
     get displayUpdateFeature(): Command<Feature | DisplayUpdateFeatureArgs>;
     /**
      * Updates a layer feature or features. Edits to the geometry and attributes
-     * of the supplied features will be committed to their respective feature sources.
-     * `Features` and `EditCommandArgs` are not supported on Mobile.
+     * of the supplied features will be committed to their respective feature
+     * sources. `Features` and `EditCommandArgs` are not supported on Mobile.
      */
     get updateFeature(): Command<Feature | Features | EditCommandArgs>;
     /**

package/messaging/registry/geolocation.d.ts

@@ -74,14 +74,12 @@ export interface GnssDeviceConnectionInfo {
      */
     deviceName: string;
     /**
-     * The type of the device. Options are Integrated, Bluetooth, USB, and
-     * Emulator.
+     * The type of the device. Options are Integrated, Bluetooth, USB, and Emulator.
      */
     deviceType: GnssDeviceType;
     /**
      * The device settings, including the correction service's spatial
-     * reference, the desired datum transformation, and the device's antenna
-     * height.
+     * reference, the desired datum transformation, and the device's antenna height.
      */
     settings: GnssDeviceSettings;
 }
@@ -148,8 +146,8 @@ export declare class GeolocationOperations extends OperationRegistry {
      */
     get getActiveSource(): Operation<GnssDeviceConnectionInfo>;
     /**
-     * Gets the list of currently available geolocation sources.
-     * Includes integrated receivers, GNSS devices, and emulators.
+     * Gets the list of currently available geolocation sources. Includes
+     * integrated receivers, GNSS devices, and emulators.
      *
      * @mobileOnly
      */
@@ -165,20 +163,19 @@ export declare class GeolocationOperations extends OperationRegistry {
     get getLocationPermissionsEnabled(): Operation<boolean>;
     /**
      * Returns the current user position. This Operation can block while the
-     * user is prompted for permission, as such it is considered best practice not to
-     * perform this during startup.
+     * user is prompted for permission, as such it is considered best practice
+     * not to perform this during startup.
      */
     get getPosition(): Operation<void, Point>;
 }
 export declare class GeolocationEvents extends EventRegistry {
     /**
-     * Raised when geolocation is activated and the accuracy of geolocation
-     * changes.
+     * Raised when geolocation is activated and the accuracy of geolocation changes.
      */
     get accuracyChanged(): Event<GeolocateAccuracyChangedEventArgs>;
     /**
-     * Raised when a GNSS receiver is active and metadata about the device
-     * or location change.
+     * Raised when a GNSS receiver is active and metadata about the device or
+     * location change.
      *
      * @mobileOnly
      */
@@ -190,8 +187,7 @@ export declare class GeolocationEvents extends EventRegistry {
     get autoRecenterStarted(): Event<HasMaps | void>;
     /**
      * Raised when the user changes the geolocation mode to
-     * recenter-and-reorient (updates map orientation to match device
-     * direction).
+     * recenter-and-reorient (updates map orientation to match device direction).
      *
      * @mobileOnly
      */
@@ -202,8 +198,7 @@ export declare class GeolocationEvents extends EventRegistry {
      */
     get autoRecenterStopped(): Event<HasMaps | void>;
     /**
-     * Raised when the user changes the geolocation mode to not
-     * recenter-and-reorient.
+     * Raised when the user changes the geolocation mode to not recenter-and-reorient.
      *
      * @mobileOnly
      */
@@ -227,8 +222,7 @@ export declare class GeolocationEvents extends EventRegistry {
      */
     get headingChanged(): Event<number>;
     /**
-     * Raised when geolocation is activated and a user position has been
-     * received.
+     * Raised when geolocation is activated and a user position has been received.
      */
     get positionAcquired(): Event<GeolocationEvent>;
     /**
@@ -248,8 +242,7 @@ export declare class GeolocationEvents extends EventRegistry {
      */
     get sourceChanged(): Event<GnssDeviceConnectionInfo>;
     /**
-     * Raised when geolocation status (enabled or disabled via app permissions)
-     * changes.
+     * Raised when geolocation status (enabled or disabled via app permissions) changes.
      */
     get statusChanged(): Event<GeolocationStatusChangedEventArgs>;
     /**

package/messaging/registry/geometry.d.ts

@@ -58,18 +58,18 @@ export interface AddPointArgs {
      */
     geometry: Polyline | Polygon;
     /**
-     * The index of the part to which the point will be added.
-     * If null, the last part will be used.
+     * The index of the part to which the point will be added. If null, the last
+     * part will be used.
      */
     partIndex?: number;
     /**
-     * The index at which the point will be added.
-     * If null, the point will be added as the last point.
+     * The index at which the point will be added. If null, the point will be
+     * added as the last point.
      */
     pointIndex?: number;
     /**
-     * The new point to be added to 'geometry'. The spatial reference must
-     * match 'geometry' or an error will be thrown.
+     * The new point to be added to 'geometry'. The spatial reference must match
+     * 'geometry' or an error will be thrown.
      */
     newPoint: Point;
 }
@@ -95,19 +95,18 @@ export interface ReferenceLine {
      */
     geometry: Polyline | Polygon;
     /**
-     * The index of the part in 'geometry' that contains the reference line.
-     * If null, the last part will be used.
+     * The index of the part in 'geometry' that contains the reference line. If
+     * null, the last part will be used.
      */
     partIndex?: number;
     /**
-     * The index of the segment that will be used as the reference line.
-     * If null, the last segment will be used.
+     * The index of the segment that will be used as the reference line. If
+     * null, the last segment will be used.
      */
     segmentIndex?: number;
 }
 /**
- * The different types of curves that can be used for geodetic distance
- * calculations.
+ * The different types of curves that can be used for geodetic distance calculations.
  */
 export declare type GeodeticCurveType = "geodesic" | "loxodrome" | "normal-section" | "great-elliptic";
 /**
@@ -115,8 +114,8 @@ export declare type GeodeticCurveType = "geodesic" | "loxodrome" | "normal-secti
  */
 export interface CalculatePointArgs {
     /**
-     * The units to be used for 'distance' and 'offset'.
-     * Defaults to the default units of the map.
+     * The units to be used for 'distance' and 'offset'. Defaults to the default
+     * units of the map.
      */
     units: LengthUnitsMobile;
     /**
@@ -126,19 +125,17 @@ export interface CalculatePointArgs {
     /**
      * The distance that will be used to calculate the new point.
      *
-     * If using 'offset', this indicates the distance along
-     * the reference line.
+     * If using 'offset', this indicates the distance along the reference line.
      *
-     * If using 'angle', this indicates the distance directly
-     * from the new point to the start point of the reference line.
+     * If using 'angle', this indicates the distance directly from the new point
+     * to the start point of the reference line.
      *
      * Cannot be negative.
      */
     distance: number;
     /**
-     * The offset that will be used to calculate the new point.
-     * The 'offset' corresponds to the distance perpendicularly away from the
-     * reference line.
+     * The offset that will be used to calculate the new point. The 'offset'
+     * corresponds to the distance perpendicularly away from the reference line.
      *
      * Positive values will result in a point to the right of the reference
      * line, negative values will be to the left.
@@ -147,17 +144,16 @@ export interface CalculatePointArgs {
      */
     offset?: number;
     /**
-     * The angle, relative to the angle of the reference line, that
-     * will be used to calculate the new point. Positive angles are
-     * calculated clockwise from the angle of the reference line,
-     * negative angles are calculated counter-clockwise.
+     * The angle, relative to the angle of the reference line, that will be used
+     * to calculate the new point. Positive angles are calculated clockwise from
+     * the angle of the reference line, negative angles are calculated counter-clockwise.
      *
      * Exactly one of 'offset' and 'angle' must be set.
      */
     angle?: number;
     /**
-     * Gets or sets a value indicating whether the distance calculations will
-     * be geodetic or planar. Defaults to true.
+     * Gets or sets a value indicating whether the distance calculations will be
+     * geodetic or planar. Defaults to true.
      */
     geodetic?: boolean;
     /**
@@ -175,13 +171,12 @@ export interface RemovePointArgs {
      */
     geometry: Polyline | Polygon;
     /**
-     * The index of the part from which the point will be removed.
-     * If null, the last part will be used.
+     * The index of the part from which the point will be removed. If null, the
+     * last part will be used.
      */
     partIndex?: number;
     /**
-     * The index of the point to be removed.
-     * If null, the last point wil be removed.
+     * The index of the point to be removed. If null, the last point wil be removed.
      */
     pointIndex?: number;
 }

package/messaging/registry/kpi.d.ts

@@ -21,8 +21,7 @@ export interface UpdateKpiCardDefinitionArgs {
      */
     kpiCard: ModelRef;
     /**
-     * The stringified Arcade script used to calculate the 'value' token of the
-     * KPI Card.
+     * The stringified Arcade script used to calculate the 'value' token of the KPI Card.
      */
     valueExpression?: string;
     /**
@@ -36,8 +35,7 @@ export interface UpdateKpiCardDefinitionArgs {
  */
 export interface GetKpiDefinitionResult {
     /**
-     * The stringified Arcade script used to calculate the 'value' token of the
-     * KPI card.
+     * The stringified Arcade script used to calculate the 'value' token of the KPI card.
      */
     valueExpression: string;
     /**

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

@@ -81,8 +81,8 @@ export declare class LayerComparisonCommands extends CommandRegistry {
      */
     get removeLeadingLayers(): Command<Layers>;
     /**
-     * Removes the layer(s) from the map's trailing layers, which are used by the
-     * layer-comparison tool.
+     * Removes the layer(s) from the map's trailing layers, which are used by
+     * the layer-comparison tool.
      *
      * @webOnly
      */

package/messaging/registry/layout.d.ts

@@ -33,8 +33,7 @@ export declare class LayoutEvents extends EventRegistry {
      */
     get loaded(): Event<Page>;
     /**
-     * Raised when a layout is unloaded (typically so that a new layout can be
-     * loaded).
+     * Raised when a layout is unloaded (typically so that a new layout can be loaded).
      *
      * @mobileOnly
      */