@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

package/layers/support/types.d.ts

@@ -1,28 +1,50 @@
-import type Extent from "../../geometry/Extent.js";
 import type Multipoint from "../../geometry/Multipoint.js";
 import type Point from "../../geometry/Point.js";
 import type Polyline from "../../geometry/Polyline.js";
 import type CodedValueDomain from "./CodedValueDomain.js";
 import type ControlPoint from "./ControlPoint.js";
 import type DateTimeFieldFormat from "./DateTimeFieldFormat.js";
-import type DimensionalDefinition from "./DimensionalDefinition.js";
 import type InheritedDomain from "./InheritedDomain.js";
 import type NumberFieldFormat from "./NumberFieldFormat.js";
 import type ParquetGeometryEncodingLocation from "./ParquetGeometryEncodingLocation.js";
 import type ParquetGeometryEncodingWkb from "./ParquetGeometryEncodingWkb.js";
-import type PixelBlock from "./PixelBlock.js";
 import type RangeDomain from "./RangeDomain.js";
 import type { AbortOptions } from "../../core/promiseUtils.js";
 import type { GroundElevationLayerUnion, QueryRelatedCapabilities } from "../types.js";
 
+/**
+ * Supported field types.
+ *
+ * @since 5.0
+ */
 export type FieldType = "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml" | "big-integer" | "date-only" | "time-only" | "timestamp-offset";
 
+/**
+ * Supported field value types.
+ *
+ * @since 5.0
+ */
 export type FieldValueType = "binary" | "coordinate" | "count-or-amount" | "currency" | "date-and-time" | "description" | "email-address" | "location-or-place-name" | "measurement" | "name-or-title" | "none" | "ordered-or-ranked" | "percentage-or-ratio" | "phone-number" | "type-or-category" | "unique-identifier";
 
+/**
+ * Supported field formatting types.
+ *
+ * @since 5.0
+ */
 export type FieldFormatUnion = DateTimeFieldFormat | NumberFieldFormat;
 
+/**
+ * Supported domain types.
+ *
+ * @since 5.0
+ */
 export type DomainUnion = RangeDomain | CodedValueDomain | InheritedDomain;
 
+/**
+ * Control points used for image-to-map transformations.
+ *
+ * @since 5.0
+ */
 export type ControlPoints = [
     ControlPoint,
     ControlPoint
@@ -37,217 +59,99 @@ export type ControlPoints = [
     ControlPoint
 ];
 
-export type PlacementType = "above-center" | "above-left" | "above-right" | "center-center" | "center-left" | "center-right" | "below-center" | "below-left" | "below-right" | "always-horizontal" | "above-along" | "below-along" | "center-along";
-
-export type UnsupportedPlacementType = "above-after" | "above-before" | "above-start" | "above-end" | "below-after" | "below-before" | "below-start" | "below-end" | "center-after" | "center-before" | "center-start" | "center-end" | "always-horizontal";
-
-export type PlacementType3D = "above-center" | "above-left" | "above-right" | "center-center" | "center-left" | "center-right" | "below-center" | "below-left" | "below-right";
-
 /**
- * Data series returned in [RasterIdentifyResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterIdentifyResult) when [ImageryTileLayer#identify()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#identify) is called on a
- * transposed multidimensional ImageryTileLayer.
+ * Supported label placement types.
  *
- * @since 4.25
+ * @since 5.0
  */
-export interface RasterSliceValue {
-  /** The magnitude and direction values for services containing vector data. */
-  magdirValue?: [
-      number,
-      number
-  ];
-  /** A dimensional definition associated with a given slice. */
-  multidimensionalDefinition: DimensionalDefinition[];
-  /** Image service pixel values for a given slice. */
-  value?: number[] | null;
-}
-
-/**
- * The result of `identify` operation on [ImageryTileLayer#identify()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#identify) and [WCSLayer#identify()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html#identify).
- * It includes the processed pixel values for a given location.
- */
-export interface RasterIdentifyResult {
-  /**
-   * Transposed multidimensional data for the requested location and variable
-   * returned from a transposed multidimensional [ImageryTileLayer#identify()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#identify). Added since version 4.25.
-   */
-  dataSeries?: RasterSliceValue[];
-  /** The identified location. */
-  location: Point;
-  /** The processed pixel values showing results of the [ImageryTileLayer#rasterFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#rasterFunction) applied to the layer. Added since version 4.26. */
-  processedValue?: number[];
-  /** Image service pixel values. */
-  value?: number[] | null;
-}
+export type PlacementType = "above-center" | "above-left" | "above-right" | "center-center" | "center-left" | "center-right" | "below-center" | "below-left" | "below-right" | "always-horizontal" | "above-along" | "below-along" | "center-along";
 
 /**
- * An object that provides the user access to
- * [PixelBlock#pixels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-PixelBlock.html#pixels) and their values in the layer.
- * See the object specifications table below for details about each property. This object
- * is used as input in the [ImageryLayer#pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter) function
- * for filtering and processing each pixel in the block.
+ * Label placement types that are not supported.
+ *
+ * @since 5.0
  */
-export interface PixelData {
-  /** The extent of the `pixelBlock`. */
-  extent: Extent;
-  /**
-   * An object representing
-   *   the pixels in the view. This provides the user access to each pixel on the client
-   *   via the pixels property of this object.
-   */
-  pixelBlock?: PixelBlock | null;
-}
-
-/**
- * Raster statistics information returned that meets the specified [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html)
- * from the `computeStatisticsHistograms()` method on [ImageryLayer#computeStatisticsHistograms()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeStatisticsHistograms) or [ImageryTileLayer#computeStatisticsHistograms()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html#computeStatisticsHistograms).
- *
- * @since 4.18
- */
-export interface RasterBandStatistics {
-  /** Average of the statistics. */
-  avg?: number;
-  /** Count of the statistics. */
-  count?: number;
-  /** Maximum value of the statistics. */
-  max: number;
-  /** Median value of the statistics. */
-  median?: number;
-  /** Minimum value of the statistics. */
-  min: number;
-  /** Mode value of the statistics. */
-  mode?: number;
-  /** Standard deviation of the statistics. */
-  stddev?: number;
-  /** Sum of the statistics. */
-  sum?: number;
-}
+export type UnsupportedPlacementType = "above-after" | "above-before" | "above-start" | "above-end" | "below-after" | "below-before" | "below-start" | "below-end" | "center-after" | "center-before" | "center-start" | "center-end" | "always-horizontal";
 
 /**
- * Raster histogram information returned that meets the specified [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html)
- * from the [ImageryLayer#computeHistograms()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeHistograms) or [ImageryLayer#computeStatisticsHistograms()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#computeStatisticsHistograms) method.
+ * Supported 3D label placement types.
  *
- * @since 4.18
+ * @since 5.0
  */
-export interface RasterHistogram {
-  /** Count of pixels that fall into each bin. */
-  counts: number[] | Uint32Array;
-  /** The maximum pixel value of the histogram. Matches the maximum bound of the last bin. */
-  max: number;
-  /** The minimum pixel value of the histogram. Matches the minimum bound of the first bin. */
-  min: number;
-  /** Number of bins. */
-  size: number;
-}
-
-export interface RasterDimensionalInfo {
-  /** Dimension description. */
-  description?: string | null;
-  /** The extent of dimension values. */
-  extent?: number[];
-  /** Indicates if each dimension value is represented using a range. */
-  hasRanges?: boolean | null;
-  /** Indicates if the dimension is recorded at regular intervals. */
-  hasRegularIntervals?: boolean | null;
-  /** Dimension interval. */
-  interval?: number | null;
-  /** Dimension interval unit. */
-  intervalUnit?: string | null;
-  /** Dimension name. */
-  name: string;
-  /** Indicates if the dimension is recurring, e.g. data with 12 slices each represents aggregated value per month over the years. */
-  recurring?: boolean | null;
-  /** Dimension unit. */
-  unit?: string | null;
-  /** An array of single values or tuples [min, max] each defining a range of valid values along the specified dimension. */
-  values?: (number | [
-      number,
-      number
-  ])[] | null;
-}
+export type PlacementType3D = "above-center" | "above-left" | "above-right" | "center-center" | "center-left" | "center-right" | "below-center" | "below-left" | "below-right";
 
 /**
- * RasterMultidimensionalInfo contains dimensions for each variable in the service  describing information about the images collected at multiple times, depths, or heights.
+ * Describes supported capabilities for a sublayer.
  *
- * @example
- * // update the statistics of the layer's stretch renderer.
- * const renderer = layer.renderer.clone();
- *  const dimensions = layer.rasterInfo.multidimensionalInfo;
- * // get the salinity variable's statistics
- * const salinity = dimensions.variables.find((variable) => variable.name === variableName);
- * renderer.customStatistics = salinity.statistics;
- * layer.renderer = renderer;
+ * @since 5.0
  */
-export interface RasterMultidimensionalInfo {
+export interface SublayerCapabilities {
   /**
-   * The multi dimensional variables. It stores information such as name, unit and dimensions. For example, a temperature variable can store
-   * temperature data and the salinity variable can store the salinity data measured daily at different depths.
+   * **Since 4.32.** Describes attachment capabilities that can be performed on the features in the layer.
+   *
+   * @since 5.0
    */
-  variables: RasterMultidimensionalInfoVariable[];
-}
-
-export interface RasterMultidimensionalInfoVariable {
-  /** Variable description. */
-  description?: string | null;
+  attachment: SublayerCapabilitiesAttachment;
   /**
-   * A dimension may be used to represent real physical dimensions such as time or depth/height. It may also be used to represent more
-   * abstract quantities such as station id or station-time pair. For example, if your temperature data has a corresponding Date dimension field representing the day it was captured, and
-   * your salinity data has a Depth dimension field representing the depth at which it was measured, the Dimensions field for that variable would be Date and Depth.
+   * Describes characteristics of the data in the layer.
+   *
+   * @since 5.0
    */
-  dimensions: RasterDimensionalInfo[];
-  /** Variable histograms. */
-  histograms?: RasterHistogram[] | null;
-  /** Variable name. */
-  name: string;
-  /** Variable statistics. */
-  statistics?: RasterBandStatistics[] | null;
-  /** Unit of the variable measured in. */
-  unit?: string | null;
-}
-
-/**
- * The raster function published with the image service.
- *
- * @since 4.22
- */
-export interface RasterFunctionInfo {
-  /** Description of the raster function. */
-  description: string;
-  /** The function type. Possible values: //0 = Mosaic, 1 = Item, 2 = Item Group. */
-  functionType: number;
-  /** Additional info describing what the raster function does. */
-  help: string;
-  /** Name of the raster function. */
-  name: string;
-  /** Inline base64 encoded thumbnail of the raster function. */
-  thumbnail: string;
-}
-
-export interface SublayerCapabilities {
-  /** **Since 4.32.** Describes attachment capabilities that can be performed on the features in the layer. */
-  attachment: SublayerCapabilitiesAttachment;
-  /** Describes characteristics of the data in the layer. */
   data: SublayerCapabilitiesData;
-  /** Describes operations that can be performed on features in the layer. */
+  /**
+   * Describes operations that can be performed on features in the layer.
+   *
+   * @since 5.0
+   */
   operations: SublayerCapabilitiesOperations;
-  /** Indicates if the layer's query operation supports querying features or records related to features in the layer. */
+  /**
+   * Indicates if the layer's query operation supports querying features or records related to features in the layer.
+   *
+   * @since 5.0
+   */
   queryRelated: SublayerCapabilitiesQueryRelated;
 }
 
+/**
+ * Describes attachment-related capabilities for a sublayer.
+ *
+ * @since 5.0
+ */
 export interface SublayerCapabilitiesAttachment {
   /**
    * **Since 4.32.** Indicates if resized attachments are supported in the layer.
    * This is useful for showing thumbnails in [Popups](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).
+   *
+   * @since 5.0
    */
   supportsResize: boolean;
 }
 
+/**
+ * Describes data-related capabilities for a sublayer.
+ *
+ * @since 5.0
+ */
 export interface SublayerCapabilitiesData {
-  /** Indicates if attachments are enabled on the layer. */
+  /**
+   * Indicates if attachments are enabled on the layer.
+   *
+   * @since 5.0
+   */
   supportsAttachment: boolean;
 }
 
+/**
+ * Describes operation-related capabilities for a sublayer.
+ *
+ * @since 5.0
+ */
 export interface SublayerCapabilitiesOperations {
-  /** Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures). */
+  /**
+   * Indicates if features in the layer can be [queried](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures).
+   *
+   * @since 5.0
+   */
   supportsQuery: boolean;
   /**
    * Indicates if the layer supports
@@ -255,20 +159,49 @@ export interface SublayerCapabilitiesOperations {
    * operation.
    * If `false`, [queryAttachments() method](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryAttachments) can only return attachments for one feature at a time.
    * If `true`, `queryAttachments()` can return attachments for array of [AttachmentQuery#objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#objectIds).
+   *
+   * @since 5.0
    */
   supportsQueryAttachments: boolean;
 }
 
+/**
+ * Query-related capabilities for a sublayer.
+ *
+ * @since 5.0
+ */
 export type SublayerCapabilitiesQueryRelated = Omit<QueryRelatedCapabilities, "supportsCacheHint">;
 
+/**
+ * Supported I3S geometry types.
+ *
+ * @since 5.0
+ */
 export type I3SGeometryType = "point" | "mesh";
 
+/**
+ * The version information for a scene service.
+ *
+ * @since 5.0
+ */
 export interface SceneServiceVersion {
-  /** The major version of the scene layer. */
+  /**
+   * The major version of the scene layer.
+   *
+   * @since 5.0
+   */
   major: number;
-  /** The minor version of the scene layer. */
+  /**
+   * The minor version of the scene layer.
+   *
+   * @since 5.0
+   */
   minor: number;
-  /** The complete version string of the scene layer. */
+  /**
+   * The complete version string of the scene layer.
+   *
+   * @since 5.0
+   */
   versionString: string;
 }
 
@@ -279,29 +212,76 @@ export interface SceneServiceVersion {
  * @since 4.25
  */
 export interface SpriteInfo {
-  /** The height of the sprite. */
+  /**
+   * The height of the sprite.
+   *
+   * @since 5.0
+   */
   height: number;
-  /** The pixel ratio of the sprite. */
+  /**
+   * The pixel ratio of the sprite.
+   *
+   * @since 5.0
+   */
   pixelRatio?: number;
-  /** Whether the sprite is SDF or not. */
+  /**
+   * Whether the sprite is SDF or not.
+   *
+   * @since 5.0
+   */
   sdf?: boolean;
-  /** The width of the sprite. */
+  /**
+   * The width of the sprite.
+   *
+   * @since 5.0
+   */
   width: number;
-  /** The x position of the upper-left corner of the sprite. */
+  /**
+   * The x position of the upper-left corner of the sprite.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The y position of the upper-left corner of the sprite. */
+  /**
+   * The y position of the upper-left corner of the sprite.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/**
+ * Image containing sprite data when setting sprite source VectorTileLayer via its [setSpriteSource()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setSpriteSource).
+ *
+ * @see [SpriteSourceImageInfoSpriteSource1x](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#SpriteSourceImageInfoSpriteSource1x)
+ * @see [SpriteSourceImageInfoSpriteSource2x](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#SpriteSourceImageInfoSpriteSource2x)
+ * @since 5.0
+ */
 export type Image = HTMLImageElement | HTMLCanvasElement | ImageBitmap | ImageData | ImageObject;
 
-/** Defines an image object that can be used when setting [SpriteSourceImageInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#SpriteSourceImageInfo). */
+/**
+ * Defines an image object that can be used when setting [SpriteSourceImageInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#SpriteSourceImageInfo).
+ *
+ * @since 5.0
+ */
 export interface ImageObject {
-  /** The image data for the sprite. */
+  /**
+   * The image data for the sprite.
+   *
+   * @since 5.0
+   */
   data: ArrayBuffer;
-  /** The height of the sprite. */
+  /**
+   * The height of the sprite.
+   *
+   * @since 5.0
+   */
   height: number;
-  /** The width of the sprite. */
+  /**
+   * The width of the sprite.
+   *
+   * @since 5.0
+   */
   width: number;
 }
 
@@ -328,13 +308,29 @@ export interface ImageObject {
  * });
  */
 export interface SpriteSourceUrlInfo {
-  /** The device pixel ratio used to fetch the appropriate sprite source. */
+  /**
+   * The device pixel ratio used to fetch the appropriate sprite source.
+   *
+   * @since 5.0
+   */
   pixelRatio?: number;
-  /** The sprite image format. */
+  /**
+   * The sprite image format.
+   *
+   * @since 5.0
+   */
   spriteFormat?: "png" | "webp";
-  /** The sprite source url. */
+  /**
+   * The sprite source url.
+   *
+   * @since 5.0
+   */
   spriteUrl: string;
-  /** For SpriteSourceUrlInfo the type is always "url". */
+  /**
+   * For SpriteSourceUrlInfo the type is always "url".
+   *
+   * @since 5.0
+   */
   type: "url";
 }
 
@@ -378,77 +374,199 @@ export interface SpriteSourceUrlInfo {
  * }
  */
 export interface SpriteSourceImageInfo {
-  /** The device pixel ratio of the sprite source. */
+  /**
+   * The device pixel ratio of the sprite source.
+   *
+   * @since 5.0
+   */
   pixelRatio?: number;
-  /** Sprite source for non high-DPI devices. */
+  /**
+   * Sprite source for non high-DPI devices.
+   *
+   * @since 5.0
+   */
   spriteSource1x?: SpriteSourceImageInfoSpriteSource1x;
-  /** Sprite source for high-DPI devices. */
+  /**
+   * Sprite source for high-DPI devices.
+   *
+   * @since 5.0
+   */
   spriteSource2x?: SpriteSourceImageInfoSpriteSource2x;
-  /** The sprite source url. */
+  /**
+   * The sprite source url.
+   *
+   * @since 5.0
+   */
   spriteUrl?: string;
-  /** For SpriteSourceImageInfo the type is always "image". */
+  /**
+   * For SpriteSourceImageInfo the type is always "image".
+   *
+   * @since 5.0
+   */
   type: "image";
 }
 
+/**
+ * Image containing sprite data for non high-DPI devices when setting sprite source VectorTileLayer via its [setSpriteSource()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setSpriteSource).
+ *
+ * @since 5.0
+ */
 export interface SpriteSourceImageInfoSpriteSource1x {
-  /** Image containing sprite data for non high-DPI devices. */
+  /**
+   * Image containing sprite data for non high-DPI devices.
+   *
+   * @since 5.0
+   */
   image: Image;
-  /** The JSON representation of an index file containing a description of each image in the sprite for non high-DPI devices. */
+  /**
+   * The JSON representation of an index file containing a description of each image in the sprite for non high-DPI devices.
+   *
+   * @since 5.0
+   */
   json: Record<string, SpriteInfo | undefined>;
 }
 
+/**
+ * Image containing sprite data for high-DPI devices when setting sprite source VectorTileLayer via its [setSpriteSource()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#setSpriteSource).
+ *
+ * @since 5.0
+ */
 export interface SpriteSourceImageInfoSpriteSource2x {
-  /** Image containing sprite data for high-DPI devices. */
+  /**
+   * Image containing sprite data for high-DPI devices.
+   *
+   * @since 5.0
+   */
   image: Image;
-  /** The JSON representation of an index file containing a description of each image in the sprite for high-DPI devices. */
+  /**
+   * The JSON representation of an index file containing a description of each image in the sprite for high-DPI devices.
+   *
+   * @since 5.0
+   */
   json: Record<string, SpriteInfo | undefined>;
 }
 
+/**
+ * The sprite source info is used to set the sprites in the VectorTileLayer's [currentStyleInfo.style](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html#currentStyleInfo). The user can set the sprite
+ * source from a URL to fetch the sprite resources or from the image info to set the sprite resources directly on the layer.
+ *
+ * @since 5.0
+ */
 export type SpriteSourceInfo = SpriteSourceUrlInfo | SpriteSourceImageInfo;
 
+/**
+ * Indicates the stream connection status.
+ *
+ * @since 5.0
+ */
 export type StreamConnectionStatus = "disconnected" | "connected";
 
+/**
+ * Base editing capability flags.
+ *
+ * @since 5.0
+ */
 export interface BaseCapabilities {
-  /** Indicates whether specific operation or capability is enabled on the editable layer. */
+  /**
+   * Indicates whether specific operation or capability is enabled on the editable layer.
+   *
+   * @since 5.0
+   */
   enabled: boolean;
 }
 
+/**
+ * Editing capabilities that account for owner/admin privileges.
+ *
+ * @since 5.0
+ */
 export interface OwnerAdminCapabilities extends BaseCapabilities {
-  /** Indicates when editing is enabled and is *only* due to administrative permissions. It returns `false` for *any* users if editing is generally enabled. */
+  /**
+   * Indicates when editing is enabled and is *only* due to administrative permissions. It returns `false` for *any* users if editing is generally enabled.
+   *
+   * @since 5.0
+   */
   reliesOnOwnerAdminPrivileges: boolean;
 }
 
-/** Specific permissions for create operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings. */
+/**
+ * Specific permissions for create operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings.
+ *
+ * @since 5.0
+ */
 export interface CreateCapabilities extends OwnerAdminCapabilities {
-  /** The editing capabilities for attachments. */
+  /**
+   * The editing capabilities for attachments.
+   *
+   * @since 5.0
+   */
   attachments: AttachmentCapabilities;
-  /** Indicates whether attributes can be created on the editable layer. */
+  /**
+   * Indicates whether attributes can be created on the editable layer.
+   *
+   * @since 5.0
+   */
   attributes: boolean;
-  /** Indicates whether a geometry can be created on the editable layer. */
+  /**
+   * Indicates whether a geometry can be created on the editable layer.
+   *
+   * @since 5.0
+   */
   geometry: boolean;
 }
 
-/** Specific permissions for update operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings. */
+/**
+ * Specific permissions for update operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings.
+ *
+ * @since 5.0
+ */
 export interface UpdateCapabilities extends OwnerAdminCapabilities {
-  /** The editing capabilities for attachments. */
+  /**
+   * The editing capabilities for attachments.
+   *
+   * @since 5.0
+   */
   attachments: UpdateAttachmentCapabilities;
-  /** Indicates whether attributes can be updated on the editable layer. */
+  /**
+   * Indicates whether attributes can be updated on the editable layer.
+   *
+   * @since 5.0
+   */
   attributes: boolean;
-  /** Indicates whether a geometry can be updated on the editable layer. */
+  /**
+   * Indicates whether a geometry can be updated on the editable layer.
+   *
+   * @since 5.0
+   */
   geometry: boolean;
 }
 
-/** Specific permissions for delete operations. Accounts for layerInfo settings. */
+/**
+ * Specific permissions for delete operations. Accounts for layerInfo settings.
+ *
+ * @since 5.0
+ */
 export interface DeleteCapabilities extends OwnerAdminCapabilities {}
 
-/** The editing capabilities for attachments. */
+/**
+ * The editing capabilities for attachments.
+ *
+ * @since 5.0
+ */
 export interface AttachmentCapabilities extends BaseCapabilities {}
 
+/**
+ * Capabilities for updating attachments.
+ *
+ * @since 5.0
+ */
 export interface UpdateAttachmentCapabilities extends AttachmentCapabilities {}
 
 /**
  * Specific permissions for relationship operations. It takes into account the [Editor's layerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#LayerInfo) settings.
  * If enabled, indicates that the layer contains at least one relationship, in addition to having child [Workflow](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-Workflow.html) permissions.
+ *
+ * @since 5.0
  */
 export interface RelationshipCapabilities extends BaseCapabilities {}
 
@@ -456,25 +574,62 @@ export interface RelationshipCapabilities extends BaseCapabilities {}
  * An array of [Exchangeable image file format](https://en.wikipedia.org/wiki/Exif) information
  * for the attachment. You must set the attachment query's [AttachmentQuery#returnMetadata](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#returnMetadata) to `true` to get the `exif`
  * info associated with the attachment.
+ *
+ * @since 5.0
  */
 export interface ExifInfo {
-  /** The file name. */
+  /**
+   * The file name.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** Array of tag objects containing the following properties: */
+  /**
+   * Array of tag objects containing the following properties:
+   *
+   * @since 5.0
+   */
   tags?: ExifTag[];
 }
 
+/**
+ * A tag describing an EXIF metadata value.
+ *
+ * @since 5.0
+ */
 export interface ExifTag {
-  /** The tag description. */
+  /**
+   * The tag description.
+   *
+   * @since 5.0
+   */
   description: string;
-  /** The tag name. */
+  /**
+   * The tag name.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** The value of the tag. */
+  /**
+   * The value of the tag.
+   *
+   * @since 5.0
+   */
   value: any;
 }
 
+/**
+ * Supported Parquet geometry encoding types.
+ *
+ * @since 5.0
+ */
 export type ParquetGeometryEncodingUnion = ParquetGeometryEncodingWkb | ParquetGeometryEncodingLocation;
 
+/**
+ * Options for creating an elevation sampler.
+ *
+ * @since 5.0
+ */
 export interface CreateElevationSamplerOptions extends AbortOptions {
   /**
    * Controls the horizontal resolution (cell size) in meters
@@ -488,6 +643,7 @@ export interface CreateElevationSamplerOptions extends AbortOptions {
    * `{number}`             | Sample elevation from the resolution closest to the specified resolution (in meters).
    *
    * @default auto
+   * @since 5.0
    */
   demResolution?: ElevationQueryDemResolution;
   /**
@@ -495,49 +651,88 @@ export interface CreateElevationSamplerOptions extends AbortOptions {
    *   is no data available.
    *
    * @default 0
+   * @since 5.0
    */
   noDataValue?: number;
 }
 
+/**
+ * Options for querying elevation.
+ *
+ * @since 5.0
+ */
 export interface ElevationQueryOptions extends CreateElevationSamplerOptions {
   /**
    * Indicates whether to return additional sample information
    *   for each sampled coordinate.
    *
    * @default false
+   * @since 5.0
    */
   returnSampleInfo?: boolean;
 }
 
+/**
+ * Resolution options for elevation queries.
+ *
+ * @since 5.0
+ */
 export type ElevationQueryDemResolution = number | "finest-contiguous" | "auto";
 
-/** Supported geometries to query elevation for. */
+/**
+ * Supported geometries to query elevation for.
+ *
+ * @since 5.0
+ */
 export type ElevationQueryGeometry = Point | Multipoint | Polyline;
 
-/** Object returned when [ElevationLayer#queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation), [Ground#queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation), or [Ground#queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) promise resolves: */
+/**
+ * Object returned when [ElevationLayer#queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation), [Ground#queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation), or [Ground#queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html#queryElevation) promise resolves:
+ *
+ * @since 5.0
+ */
 export interface ElevationQueryResult<GeometryType> {
-  /** The geometry with sampled z-values. */
+  /**
+   * The geometry with sampled z-values.
+   *
+   * @since 5.0
+   */
   geometry: GeometryType;
-  /** The value used when there is no data available. */
+  /**
+   * The value used when there is no data available.
+   *
+   * @since 5.0
+   */
   noDataValue?: number | null;
   /**
    * Contains additional information about how the geometry was sampled.
    *                                   This property is present depending on whether the user set `options.returnSampleInfo = true`,
    *                                   for each coordinate in the geometry.
+   *
+   * @since 5.0
    */
   sampleInfo?: ElevationQuerySampleInfo[];
 }
 
+/**
+ * Sampling metadata returned with elevation query results.
+ *
+ * @since 5.0
+ */
 export interface ElevationQuerySampleInfo {
   /**
    * The resolution at which the z-value was sampled.
    *                                   If no data was available for sampling for a given coordinate,
    *                                   the dem resolution value will be -1 for that coordinate.
+   *
+   * @since 5.0
    */
   demResolution: number;
   /**
    * The elevation source from which
    *                                   the data for the corresponding coordinate was sampled.
+   *
+   * @since 5.0
    */
   source?: GroundElevationLayerUnion;
 }