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

package/Ground.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{__decorate as r}from"tslib";import e from"./Color.js";import o from"./core/Collection.js";import t from"./core/CollectionFlattener.js";import{referenceSetter as s}from"./core/collectionUtils.js";import{typeCast as a}from"./core/compilerUtils.js";import i from"./core/Error.js";import has from"./core/has.js";import{JSONSupportMixin as n}from"./core/JSONSupport.js";import{clone as l}from"./core/lang.js";import{Loadable as p}from"./core/Loadable.js";import{loadAll as c}from"./core/loadAll.js";import u from"./core/Logger.js";import{destroyMaybe as y}from"./core/maybe.js";import{isAbortError as d,throwIfAborted as m}from"./core/promiseUtils.js";import{property as h,subclass as f}from"./core/accessorSupport/decorators.js";import{Integer as g}from"./core/accessorSupport/ensureType.js";import v from"./ground/NavigationConstraint.js";import{GroundSymbol as j}from"./support/groundInstanceUtils.js";import{transparencyToOpacity as w,opacityToTransparency as C}from"./webdoc/support/opacityUtils.js";import{writer as L}from"./core/accessorSupport/decorators/writer.js";var S,I;let b=I=class extends(n(p)){static{S=j}constructor(r){super(r),this[S]=!0,this.parent=null,this.opacity=1,this.surfaceColor=null,this.undergroundColor=has("enable-feature:oit-ground")?void 0:new e("white"),this.navigationConstraint=null,this.layers=new o;const s=r=>{const{parent:e}=r;e&&e!==this&&"remove"in e&&e.remove?.(r),r.parent=this,"elevation"!==r.type&&"base-elevation"!==r.type&&u.getLogger(this).error(`Layer '${r.title}, id:${r.id}' of type '${r.type}' is not supported as a ground layer and will therefore be ignored. Only layers of type 'elevation' are supported.`)},a=r=>{r.parent=null};this.addHandles([this.layers.on("after-add",r=>s(r.item)),this.layers.on("after-remove",r=>a(r.item))]),this.allLayers=new t({getCollections:()=>[this.layers,this.parent?.basemap?.groundLayers]})}removeChildLayer(r){this.layers.remove(r)}initialize(){this.when().catch(r=>{d(r)||u.getLogger(this).error("#load()","Failed to load ground",r)}),this.resourceInfo&&this.read(this.resourceInfo.data,this.resourceInfo.context)}get integratedMeshGround(){const r=this.parent?.basemap?.groundLayers.at(0);return r?.replacesTerrain?r:null}destroy(){const r=this.layers.removeAll();for(const e of r)y(e);this.layers.destroy()}normalizeCtorArgs(r){return r&&"resourceInfo"in r&&(this._set("resourceInfo",r.resourceInfo),delete(r={...r}).resourceInfo),r}get loaded(){return super.loaded}get layers(){return this._get("layers")}set layers(r){this._set("layers",s(r,this._get("layers")))}writeLayers(r,e,o,t){const s=[];r?(t={...t,layerContainerType:"ground"},r.forEach(r=>{if("write"in r){const e={};a(r)().write(e,t)&&s.push(e)}else t?.messages&&t.messages.push(new i("layer:unsupported",`Layers (${r.title}, ${r.id}) of type '${r.declaredClass}' cannot be persisted in the ground`,{layer:r}))}),e.layers=s):e.layers=s}load(r){return this.addResolvingPromise(this._loadFromSource(r)),Promise.resolve(this)}loadAll(){return c(this,r=>r(this.layers))}async queryElevation(r,e){await this.load({signal:e?.signal});const{queryAll:o}=await import("./layers/support/ElevationQuery.js");m(e);return o(this.layers.filter(A).toArray(),r,e)}async createElevationSampler(r,e){await this.load({signal:e?.signal});const{createSampler:o}=await import("./layers/support/ElevationQuery.js");m(e);return o(this.layers.filter(A).toArray(),r,e)}clone(){const r={opacity:this.opacity,surfaceColor:l(this.surfaceColor),undergroundColor:l(this.undergroundColor),navigationConstraint:l(this.navigationConstraint),layers:this.layers.slice()};return this.loaded&&(r.loadStatus="loaded"),new I({resourceInfo:this.resourceInfo}).set(r)}read(r,e){this.resourceInfo||this._set("resourceInfo",{data:r,context:e}),super.read(r,e)}_loadFromSource(r){const e=this.resourceInfo;return e?this._loadLayersFromJSON(e.data,e.context,r):Promise.resolve()}async _loadLayersFromJSON(r,e,o){const t=e?.origin||"web-scene",s=e?.portal||null,a=e?.url||null,{populateOperationalLayers:i}=await import("./layers/support/layersCreator.js");m(o);const n=[];if(r.layers&&Array.isArray(r.layers)){const e={context:{origin:t,url:a,portal:s,layerContainerType:"ground"},defaultLayerType:"ArcGISTiledElevationServiceLayer"};n.push(i(this.layers,r.layers,e))}await Promise.allSettled(n)}};function A(r){return r&&"createElevationSampler"in r}r([h()],b.prototype,"parent",void 0),r([h()],b.prototype,"integratedMeshGround",null),r([h({json:{read:!1,write:{isRequired:!0}}})],b.prototype,"layers",null),r([h()],b.prototype,"allLayers",void 0),r([L("layers")],b.prototype,"writeLayers",null),r([h({readOnly:!0})],b.prototype,"resourceInfo",void 0),r([h({type:Number,nonNullable:!0,range:{min:0,max:1},json:{type:g,read:{reader:w,source:"transparency"},write:{writer:(r,e)=>{e.transparency=C(r)},target:"transparency"}}})],b.prototype,"opacity",void 0),r([h({type:e,json:{type:[g],write:(r,e)=>{e.surfaceColor=r.toJSON().slice(0,3)}}})],b.prototype,"surfaceColor",void 0),r([h({type:e})],b.prototype,"undergroundColor",void 0),r([h({type:v,json:{write:!0}})],b.prototype,"navigationConstraint",void 0),b=I=r([f("esri.Ground")],b);const _=b;export{_ as default};
+import{__decorate as r}from"tslib";import e from"./Color.js";import o from"./core/Collection.js";import t from"./core/CollectionFlattener.js";import{referenceSetter as s}from"./core/collectionUtils.js";import{typeCast as a}from"./core/compilerUtils.js";import i from"./core/Error.js";import has from"./core/has.js";import{JSONSupportMixin as n}from"./core/JSONSupport.js";import{clone as l}from"./core/lang.js";import{Loadable as p}from"./core/Loadable.js";import{loadAll as c}from"./core/loadAll.js";import u from"./core/Logger.js";import{destroyMaybe as y}from"./core/maybe.js";import{isAbortError as d,throwIfAborted as m}from"./core/promiseUtils.js";import{property as h,subclass as f}from"./core/accessorSupport/decorators.js";import{Integer as g}from"./core/accessorSupport/ensureType.js";import v from"./ground/NavigationConstraint.js";import{GroundSymbol as j}from"./support/groundInstanceUtils.js";import{transparencyToOpacity as w,opacityToTransparency as C}from"./webdoc/support/opacityUtils.js";import{writer as L}from"./core/accessorSupport/decorators/writer.js";var S,b;let I=b=class extends(n(p)){static{S=j}constructor(r){super(r),this[S]=!0,this.parent=null,this.opacity=1,this.surfaceColor=null,this.undergroundColor=has("enable-feature:oit-ground")?void 0:new e("white"),this.navigationConstraint=null,this.layers=new o;const s=r=>{const{parent:e}=r;e&&e!==this&&"remove"in e&&e.remove?.(r),r.parent=this,"elevation"!==r.type&&"base-elevation"!==r.type&&u.getLogger(this).error(`Layer '${r.title}, id:${r.id}' of type '${r.type}' is not supported as a ground layer and will therefore be ignored. Only layers of type 'elevation' are supported.`)},a=r=>{r.parent=null};this.addHandles([this.layers.on("after-add",r=>s(r.item)),this.layers.on("after-remove",r=>a(r.item))]),this.allLayers=new t({getCollections:()=>[this.layers,this.parent?.basemap?.groundLayers]})}removeChildLayer(r){this.layers.remove(r)}initialize(){this.when().catch(r=>{d(r)||u.getLogger(this).error("#load()","Failed to load ground",r)}),this.resourceInfo&&this.read(this.resourceInfo.data,this.resourceInfo.context)}get integratedMeshGround(){const r=this.parent?.basemap?.groundLayers.at(0);return r?.replacesTerrain?r:null}destroy(){const r=this.layers.removeAll();for(const e of r)y(e);this.layers.destroy()}normalizeCtorArgs(r){return r&&"resourceInfo"in r&&(this._set("resourceInfo",r.resourceInfo),delete(r={...r}).resourceInfo),r}get loaded(){return super.loaded}get layers(){return this._get("layers")}set layers(r){this._set("layers",s(r,this._get("layers")))}writeLayers(r,e,o,t){const s=[];r?(t={...t,layerContainerType:"ground"},r.forEach(r=>{if("write"in r){const e={};a(r)().write(e,t)&&s.push(e)}else t?.messages&&t.messages.push(new i("layer:unsupported",`Layers (${r.title}, ${r.id}) of type '${r.declaredClass}' cannot be persisted in the ground`,{layer:r}))}),e.layers=s):e.layers=s}load(r){return this.addResolvingPromise(this._loadFromSource(r)),Promise.resolve(this)}loadAll(){return c(this,r=>r(this.layers))}async queryElevation(r,e){await this.load({signal:e?.signal});const{queryAll:o}=await import("./layers/support/ElevationQuery.js");m(e);const t=this.layers.filter(A).toArray();return this.parent?.basemap?.groundLayers&&this.parent?.basemap?.groundLayers.forEach(r=>{t.push(r)}),o(t,r,e)}async createElevationSampler(r,e){await this.load({signal:e?.signal});const{createSampler:o}=await import("./layers/support/ElevationQuery.js");m(e);return o(this.layers.filter(A).toArray(),r,e)}clone(){const r={opacity:this.opacity,surfaceColor:l(this.surfaceColor),undergroundColor:l(this.undergroundColor),navigationConstraint:l(this.navigationConstraint),layers:this.layers.slice()};return this.loaded&&(r.loadStatus="loaded"),new b({resourceInfo:this.resourceInfo}).set(r)}read(r,e){this.resourceInfo||this._set("resourceInfo",{data:r,context:e}),super.read(r,e)}_loadFromSource(r){const e=this.resourceInfo;return e?this._loadLayersFromJSON(e.data,e.context,r):Promise.resolve()}async _loadLayersFromJSON(r,e,o){const t=e?.origin||"web-scene",s=e?.portal||null,a=e?.url||null,{populateOperationalLayers:i}=await import("./layers/support/layersCreator.js");m(o);const n=[];if(r.layers&&Array.isArray(r.layers)){const e={context:{origin:t,url:a,portal:s,layerContainerType:"ground"},defaultLayerType:"ArcGISTiledElevationServiceLayer"};n.push(i(this.layers,r.layers,e))}await Promise.allSettled(n)}};function A(r){return r&&"createElevationSampler"in r}r([h()],I.prototype,"parent",void 0),r([h()],I.prototype,"integratedMeshGround",null),r([h({json:{read:!1,write:{isRequired:!0}}})],I.prototype,"layers",null),r([h()],I.prototype,"allLayers",void 0),r([L("layers")],I.prototype,"writeLayers",null),r([h({readOnly:!0})],I.prototype,"resourceInfo",void 0),r([h({type:Number,nonNullable:!0,range:{min:0,max:1},json:{type:g,read:{reader:w,source:"transparency"},write:{writer:(r,e)=>{e.transparency=C(r)},target:"transparency"}}})],I.prototype,"opacity",void 0),r([h({type:e,json:{type:[g],write:(r,e)=>{e.surfaceColor=r.toJSON().slice(0,3)}}})],I.prototype,"surfaceColor",void 0),r([h({type:e})],I.prototype,"undergroundColor",void 0),r([h({type:v,json:{write:!0}})],I.prototype,"navigationConstraint",void 0),I=b=r([f("esri.Ground")],I);const E=I;export{E as default};

package/analysis/Dimension/types.d.ts

@@ -1,3 +1,7 @@
 
-/** Supported measurement types for [LengthDimension](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html). */
+/**
+ * Supported measurement types for [LengthDimension](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html).
+ *
+ * @since 5.0
+ */
 export type LengthDimensionMeasureType = "horizontal" | "vertical" | "direct";

package/analysis/DistanceMeasurementAnalysis.d.ts

@@ -4,13 +4,19 @@ import type { SystemOrLengthUnit } from "../core/units.js";
 import type { PolylineProperties } from "../geometry/Polyline.js";
 import type { AnalysisProperties } from "./Analysis.js";
 
-/** Properties that can be used to construct a [DistanceMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DistanceMeasurementAnalysis.html) instance. */
+/**
+ * Properties that can be used to construct a [DistanceMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DistanceMeasurementAnalysis.html) instance.
+ *
+ * @since 5.0
+ */
 export interface DistanceMeasurementAnalysisProperties extends AnalysisProperties, Partial<Pick<DistanceMeasurementAnalysis, "unit">> {
   /**
    * Polyline whose length is to be computed and displayed in the view.
    *
    * If the polyline has [z-values](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) then these will be treated
    * as absolute values.
+   *
+   * @since 5.0
    */
   geometry?: PolylineProperties | null;
 }
@@ -66,22 +72,35 @@ export interface DistanceMeasurementAnalysisProperties extends AnalysisPropertie
  * @since 5.0
  */
 export default class DistanceMeasurementAnalysis extends Analysis {
+  /** @since 5.0 */
   constructor(properties?: DistanceMeasurementAnalysisProperties);
   /**
    * Polyline whose length is to be computed and displayed in the view.
    *
    * If the polyline has [z-values](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html#hasZ) then these will be treated
    * as absolute values.
+   *
+   * @since 5.0
    */
   get geometry(): Polyline | null | undefined;
   set geometry(value: PolylineProperties | null | undefined);
-  /** The type of analysis. For distance measurement analysis, this is always "distance-measurement". */
+  /**
+   * The type of analysis. For distance measurement analysis, this is always "distance-measurement".
+   *
+   * @since 5.0
+   */
   get type(): "distance-measurement";
-  /** Unit system (imperial, metric) or specific unit used for displaying the computed lengths in the view. */
+  /**
+   * Unit system (imperial, metric) or specific unit used for displaying the computed lengths in the view.
+   *
+   * @since 5.0
+   */
   accessor unit: SystemOrLengthUnit | null | undefined;
   /**
    * Indicates whether the analysis is ready to be computed and interacted with in the view. It requires the
    * geometry to be a valid polyline whose first path contains at least 2 points.
+   *
+   * @since 5.0
    */
   get valid(): boolean;
 }

package/analysis/ElevationProfile/types.d.ts

@@ -3,8 +3,16 @@ import type ElevationProfileLineInput from "./ElevationProfileLineInput.js";
 import type ElevationProfileLineQuery from "./ElevationProfileLineQuery.js";
 import type ElevationProfileLineScene from "./ElevationProfileLineScene.js";
 
-/** Union of all supported elevation profile lines. */
+/**
+ * Union of all supported elevation profile lines.
+ *
+ * @since 5.0
+ */
 export type ElevationProfileLineUnion = ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineScene;
 
-/** Supported elevation profile line types. */
+/**
+ * Supported elevation profile line types.
+ *
+ * @since 5.0
+ */
 export type ElevationProfileLineType = ElevationProfileLineUnion["type"];

package/analysis/ShadowCast/DiscreteOptions.d.ts

@@ -10,6 +10,7 @@ export interface DiscreteOptionsProperties extends ClonableMixinProperties, Part
    * color value.
    *
    * @default [50, 50, 50, 0.7]
+   * @since 5.0
    */
   color?: ColorLike;
 }
@@ -24,6 +25,7 @@ export interface DiscreteOptionsProperties extends ClonableMixinProperties, Part
  * @see [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/)
  */
 export default class DiscreteOptions extends Clonable {
+  /** @since 5.0 */
   constructor(properties?: DiscreteOptionsProperties);
   /**
    * Color of the shadow visualization. The opacity of the visualization is mapped to the number of overlapping
@@ -31,6 +33,7 @@ export default class DiscreteOptions extends Clonable {
    * color value.
    *
    * @default [50, 50, 50, 0.7]
+   * @since 5.0
    */
   get color(): Color;
   set color(value: ColorLike);
@@ -40,6 +43,7 @@ export default class DiscreteOptions extends Clonable {
    * maximum of 255 samples.
    *
    * @default 1 * 3600 * 1000
+   * @since 5.0
    */
   accessor interval: number;
 }

package/analysis/ShadowCast/MinDurationOptions.d.ts

@@ -11,6 +11,7 @@ export interface MinDurationOptionsProperties extends ClonableMixinProperties, P
    * [minDuration](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCast-MinDurationOptions.html#minDuration) are displayed with this color.
    *
    * @default [255, 0, 0, 0.7]
+   * @since 5.0
    */
   color?: ColorLike;
   /**
@@ -18,6 +19,7 @@ export interface MinDurationOptionsProperties extends ClonableMixinProperties, P
    * [contextEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCast-MinDurationOptions.html#contextEnabled) to true.
    * The default configuration will show the shadows at one hour intervals as context for the visualization.
    *
+   * @since 5.0
    * @see [contextEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCast-MinDurationOptions.html#contextEnabled)
    */
   contextOptions?: DiscreteOptionsProperties;
@@ -33,12 +35,14 @@ export interface MinDurationOptionsProperties extends ClonableMixinProperties, P
  * @see [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/)
  */
 export default class MinDurationOptions extends Clonable {
+  /** @since 5.0 */
   constructor(properties?: MinDurationOptionsProperties);
   /**
    * Color of the shadow visualization. The areas with cumulative shadow time longer than the
    * [minDuration](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCast-MinDurationOptions.html#minDuration) are displayed with this color.
    *
    * @default [255, 0, 0, 0.7]
+   * @since 5.0
    */
   get color(): Color;
   set color(value: ColorLike);
@@ -48,6 +52,7 @@ export default class MinDurationOptions extends Clonable {
    * of the discrete shadows when context is enabled.
    *
    * @default false
+   * @since 5.0
    * @see [contextOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCast-MinDurationOptions.html#contextOptions)
    */
   accessor contextEnabled: boolean;
@@ -56,6 +61,7 @@ export default class MinDurationOptions extends Clonable {
    * [contextEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCast-MinDurationOptions.html#contextEnabled) to true.
    * The default configuration will show the shadows at one hour intervals as context for the visualization.
    *
+   * @since 5.0
    * @see [contextEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCast-MinDurationOptions.html#contextEnabled)
    */
   get contextOptions(): DiscreteOptions;
@@ -65,6 +71,7 @@ export default class MinDurationOptions extends Clonable {
    * meets or exceeds this value. Areas with shorter shadow durations will appear without shadows.
    *
    * @default 4 * 3600 * 1000
+   * @since 5.0
    */
   accessor minDuration: number;
 }

package/analysis/ShadowCast/TotalDurationOptions.d.ts

@@ -11,6 +11,7 @@ export interface TotalDurationOptionsProperties extends ClonableMixinProperties,
    * with the opacity specified in this property.
    *
    * @default [0, 0, 255, 0.7]
+   * @since 5.0
    */
   color?: ColorLike;
 }
@@ -25,6 +26,7 @@ export interface TotalDurationOptionsProperties extends ClonableMixinProperties,
  * @see [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/)
  */
 export default class TotalDurationOptions extends Clonable {
+  /** @since 5.0 */
   constructor(properties?: TotalDurationOptionsProperties);
   /**
    * Color of the shadow visualization. The opacity is mapped to the time spent in shadow. Areas that don't receive any
@@ -32,6 +34,7 @@ export default class TotalDurationOptions extends Clonable {
    * with the opacity specified in this property.
    *
    * @default [0, 0, 255, 0.7]
+   * @since 5.0
    */
   get color(): Color;
   set color(value: ColorLike);
@@ -40,6 +43,7 @@ export default class TotalDurationOptions extends Clonable {
    * aggregation of values.
    *
    * @default "continuous"
+   * @since 5.0
    */
   accessor mode: ShadowCastTotalDurationMode;
 }

package/analysis/ShadowCastAnalysis.d.ts

@@ -8,18 +8,33 @@ import type { MinDurationOptionsProperties } from "./ShadowCast/MinDurationOptio
 import type { TotalDurationOptionsProperties } from "./ShadowCast/TotalDurationOptions.js";
 import type { ShadowCastMode } from "./ShadowCast/types.js";
 
+/** @since 5.0 */
 export interface ShadowCastAnalysisProperties extends AnalysisProperties, Partial<Pick<ShadowCastAnalysis, "endTimeOfDay" | "mode" | "startTimeOfDay" | "utcOffset">> {
   /**
    * The calendar date used to calculate the shadow cast. This date excludes the time.
    * If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.
    * If no date is set, then it defaults to the current date in local system time.
+   *
+   * @since 5.0
    */
   date?: (Date | number | string);
-  /** Options specific to the `discrete` mode. */
+  /**
+   * Options specific to the `discrete` mode.
+   *
+   * @since 5.0
+   */
   discreteOptions?: DiscreteOptionsProperties;
-  /** Options specific to the `min-duration` mode. */
+  /**
+   * Options specific to the `min-duration` mode.
+   *
+   * @since 5.0
+   */
   minDurationOptions?: MinDurationOptionsProperties;
-  /** Options specific to the `total-duration` mode. */
+  /**
+   * Options specific to the `total-duration` mode.
+   *
+   * @since 5.0
+   */
   totalDurationOptions?: TotalDurationOptionsProperties;
 }
 
@@ -123,15 +138,22 @@ export interface ShadowCastAnalysisProperties extends AnalysisProperties, Partia
  * @see [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/)
  */
 export default class ShadowCastAnalysis extends Analysis {
+  /** @since 5.0 */
   constructor(properties?: ShadowCastAnalysisProperties);
   /**
    * The calendar date used to calculate the shadow cast. This date excludes the time.
    * If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.
    * If no date is set, then it defaults to the current date in local system time.
+   *
+   * @since 5.0
    */
   get date(): Date;
   set date(value: (Date | number | string));
-  /** Options specific to the `discrete` mode. */
+  /**
+   * Options specific to the `discrete` mode.
+   *
+   * @since 5.0
+   */
   get discreteOptions(): DiscreteOptions;
   set discreteOptions(value: DiscreteOptionsProperties);
   /**
@@ -139,9 +161,14 @@ export default class ShadowCastAnalysis extends Analysis {
    * By default the shadow cast end time is set to 4PM (16 * 3600 * 1000ms).
    *
    * @default 57_600_000
+   * @since 5.0
    */
   accessor endTimeOfDay: number;
-  /** Options specific to the `min-duration` mode. */
+  /**
+   * Options specific to the `min-duration` mode.
+   *
+   * @since 5.0
+   */
   get minDurationOptions(): MinDurationOptions;
   set minDurationOptions(value: MinDurationOptionsProperties);
   /**
@@ -152,6 +179,7 @@ export default class ShadowCastAnalysis extends Analysis {
    * - "total-duration": Displays total shadow duration using opacity, where higher opacity indicates longer shadow accumulation. Duration can be aggregated either continuously or in one-hour time intervals.
    *
    * @default "min-duration"
+   * @since 5.0
    */
   accessor mode: ShadowCastMode;
   /**
@@ -159,12 +187,21 @@ export default class ShadowCastAnalysis extends Analysis {
    * By default the shadow cast start time is set to 10AM (10 * 3600 * 1000ms).
    *
    * @default 36_000_000
+   * @since 5.0
    */
   accessor startTimeOfDay: number;
-  /** Options specific to the `total-duration` mode. */
+  /**
+   * Options specific to the `total-duration` mode.
+   *
+   * @since 5.0
+   */
   get totalDurationOptions(): TotalDurationOptions;
   set totalDurationOptions(value: TotalDurationOptionsProperties);
-  /** The analysis type. */
+  /**
+   * The analysis type.
+   *
+   * @since 5.0
+   */
   get type(): "shadow-cast";
   /**
    * The UTC offset in hours (e.g., `-8` for PST, `1` for CET). This value determines how the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#date),
@@ -179,8 +216,14 @@ export default class ShadowCastAnalysis extends Analysis {
    * > **Known Limitations**
    * >
    * > Full support for time zones with daylight saving time is not yet supported.
+   *
+   * @since 5.0
    */
   accessor utcOffset: number | null | undefined;
-  /** Indicates whether the analysis is ready to be computed and interacted with in the view. */
+  /**
+   * Indicates whether the analysis is ready to be computed and interacted with in the view.
+   *
+   * @since 5.0
+   */
   get valid(): boolean;
 }

package/analysis/Slice/types.d.ts

@@ -1,5 +1,9 @@
 import type Layer from "../../layers/Layer.js";
 import type BuildingComponentSublayer from "../../layers/buildingSublayers/BuildingComponentSublayer.js";
 
-/** Layers that can be excluded from a [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html). */
+/**
+ * Layers that can be excluded from a [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html).
+ *
+ * @since 5.0
+ */
 export type SliceableLayer = Layer | BuildingComponentSublayer;

package/analysis/VolumeMeasurement/types.d.ts

@@ -1,3 +1,7 @@
 
-/** Supported volume measurement types. */
+/**
+ * Supported volume measurement types.
+ *
+ * @since 5.0
+ */
 export type VolumeMeasureType = "cut-fill" | "stockpile";

package/analysis/VolumeMeasurement/volumeMeasurementConfiguration.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import e from"../../Color.js";const i=new e("black");class t{constructor(){this.geometryOutlineWidth=1.5,this.geometryOutlineColor=new e("rgb(128,128,128)"),this.cutColor=new e("rgba(153, 198, 111, 0.75)"),this.fillColor=new e("rgba(200, 200, 230, 0.75)"),this.cutColorMuted=new e("rgba(176, 176, 176, 0.75)"),this.fillColorMuted=new e("rgba(194, 194, 194, 0.75)"),this.cutProjectionLineColor=e.blendColors(this.cutColor,i,.4),this.fillProjectionLineColor=e.blendColors(this.fillColor,i,.4),this.projectionLineWidth=2,this.projectionLineStippleSize=4,this.labelDistance=30,this.labelPrecisions={"cubic-millimeters":0,"cubic-centimeters":0,"cubic-decimeters":1,"cubic-meters":2,"cubic-kilometers":6,"cubic-inches":0,"cubic-feet":2,"cubic-yards":2,"cubic-miles":6,liters:2},this.maxVolumeExtentSizeVw=.7,this.minVolumeExtentSizePixels=250,this.minTargetElevation=-11e3,this.maxTargetElevation=9e3,this.targetElevationRange=this.maxTargetElevation-this.minTargetElevation,this.maxPerimeterLocalWebMercator=1e4,this.maxPerimeterGlobal=5e4}}const o=new t;export{o as volumeMeasurementConfiguration};
+import t from"../../Color.js";const e=new t("black");class i{constructor(){this.geometryOutlineWidth=1.5,this.geometryOutlineColor=new t("rgb(128,128,128)"),this.cutColor=new t("rgba(153, 198, 111, 0.75)"),this.fillColor=new t("rgba(200, 200, 230, 0.75)"),this.cutColorMuted=new t("rgba(176, 176, 176, 0.75)"),this.fillColorMuted=new t("rgba(194, 194, 194, 0.75)"),this.cutProjectionLineColor=t.blendColors(this.cutColor,e,.4),this.fillProjectionLineColor=t.blendColors(this.fillColor,e,.4),this.projectionLineWidth=2,this.projectionLineStippleSize=4,this.labelDistance=30,this.maxVolumeExtentSizeVw=.7,this.minVolumeExtentSizePixels=250,this.minTargetElevation=-11e3,this.maxTargetElevation=9e3,this.targetElevationRange=this.maxTargetElevation-this.minTargetElevation,this.maxPerimeterLocalWebMercator=1e4,this.maxPerimeterGlobal=5e4}}const o=new i;export{o as volumeMeasurementConfiguration};

package/analysis/types.d.ts

@@ -10,15 +10,29 @@ import type ViewshedAnalysis from "./ViewshedAnalysis.js";
 import type VolumeMeasurementAnalysis from "./VolumeMeasurementAnalysis.js";
 import type { ObjectId } from "../views/types.js";
 
-/** Union of all possible analysis types that can be added to a [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). */
+/**
+ * Union of all possible analysis types that can be added to a [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).
+ *
+ * @since 5.0
+ */
 export type AnalysisUnion = AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | DistanceMeasurementAnalysis | ElevationProfileAnalysis | LineOfSightAnalysis | ShadowCastAnalysis | SliceAnalysis | ViewshedAnalysis | VolumeMeasurementAnalysis;
 
+/** @since 5.0 */
 export type AnalysisType = AnalysisUnion["type"];
 
+/** @since 5.0 */
 export interface FeatureReferenceLayer {
-  /** The layer id. */
+  /**
+   * The layer id.
+   *
+   * @since 5.0
+   */
   id: string | number;
-  /** The object id field. */
+  /**
+   * The object id field.
+   *
+   * @since 5.0
+   */
   objectIdField?: string | null;
 }
 
@@ -26,14 +40,32 @@ export interface FeatureReferenceLayer {
  * A reference to a feature in a layer. The interface of a feature reference is compatible with a
  * [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html), but contains only the minimal set of information required
  * to reference a feature.
+ *
+ * @since 5.0
  */
 export interface FeatureReference {
-  /** Feature attributes. */
+  /**
+   * Feature attributes.
+   *
+   * @since 5.0
+   */
   attributes: any;
-  /** Reference to a layer. */
+  /**
+   * Reference to a layer.
+   *
+   * @since 5.0
+   */
   layer?: FeatureReferenceLayer | null;
-  /** Object identifier of the feature in its source layer. */
+  /**
+   * Object identifier of the feature in its source layer.
+   *
+   * @since 5.0
+   */
   objectId?: ObjectId | null;
-  /** Unique identifier assigned to the feature on the client. */
+  /**
+   * Unique identifier assigned to the feature on the client.
+   *
+   * @since 5.0
+   */
   uid: number | null;
 }

package/applications/Components/QuantityFormatter.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{__decorate as s}from"tslib";import{onLocaleChange as e,fetchMessageBundle as t}from"../../intl.js";import r from"../../core/Accessor.js";import{createTask as a}from"../../core/asyncUtils.js";import{formatLength as i,formatVerticalLength as o,formatArea as m,formatVolume as n,formatDecimal as g}from"../../core/quantityFormatUtils.js";import{formatAngleDegrees as u}from"../../core/unitFormatUtils.js";import{property as h,subclass as l}from"../../core/accessorSupport/decorators.js";let _=class extends r{constructor(s){super(s)}initialize(){this.addHandles(e(()=>this._load())),this._load()}destroy(){this._messagesTask.abort()}async when(){await this._messagesTask.promise}_load(){return null!=this._messagesTask&&this._messagesTask.abort(),this._messagesTask=a(()=>t("esri/core/t9n/Units")),this._messagesTask.promise}get _messages(){return this._messagesTask.value}formatLength(s,e,t){return this._messages?i(this._messages,s,s.unit,e,t):""}formatVerticalLength(s,e,t){return this._messages?o(this._messages,s,s.unit,e,t):""}formatArea(s,e,t){return this._messages?m(this._messages,s,s.unit,e,t):""}formatVolume(s,e,t){return this._messages?n(this._messages,s,s.unit,e,t):""}formatDecimal(s,e,t){return this._messages?g(this._messages,s,s.unit,e,t):""}formatAngleDegrees(s,e,t,r,a){return u(s,e,t,r,a)}};s([h()],_.prototype,"_messagesTask",void 0),s([h()],_.prototype,"_messages",null),_=s([l("esri.applications.Components.QuantityFormatter")],_);const c=_;export{c as default};
+import{__decorate as s}from"tslib";import{onLocaleChange as t,fetchMessageBundle as e}from"../../intl.js";import r from"../../core/Accessor.js";import{createTask as a}from"../../core/asyncUtils.js";import{formatLength as i,formatVerticalLength as o,formatArea as m,preferredVolumePrecision as n,formatVolume as g,formatDecimal as u}from"../../core/quantityFormatUtils.js";import{formatAngleDegrees as h}from"../../core/unitFormatUtils.js";import{property as l,subclass as _}from"../../core/accessorSupport/decorators.js";let c=class extends r{constructor(s){super(s)}initialize(){this.addHandles(t(()=>this._load())),this._load()}destroy(){this._messagesTask.abort()}async when(){await this._messagesTask.promise}_load(){return null!=this._messagesTask&&this._messagesTask.abort(),this._messagesTask=a(()=>e("esri/core/t9n/Units")),this._messagesTask.promise}get _messages(){return this._messagesTask.value}formatLength(s,t,e){return this._messages?i(this._messages,s,s.unit,t,e):""}formatVerticalLength(s,t,e){return this._messages?o(this._messages,s,s.unit,t,e):""}formatArea(s,t,e){return this._messages?m(this._messages,s,s.unit,t,e):""}formatVolume(s,t,e){const r=t??n(s.unit);return this._messages?g(this._messages,s,s.unit,r,e):""}formatDecimal(s,t,e){return this._messages?u(this._messages,s,s.unit,t,e):""}formatAngleDegrees(s,t,e,r,a){return h(s,t,e,r,a)}};s([l()],c.prototype,"_messagesTask",void 0),s([l()],c.prototype,"_messages",null),c=s([_("esri.applications.Components.QuantityFormatter")],c);const p=c;export{p as default};

package/applications/Components/analysisUtils.d.ts

@@ -34,8 +34,7 @@ export function forceInteractive(analysisView: AnalysisViewUnion): ResourceHandl
 export function isAboveGeodesicDistanceThreshold(length: Length): boolean;
 
 /**
- * Gets whether the specified analysis view contains a valid result. The result is valid if there are no intersecting
- * segments on the geometry.
+ * Gets whether the specified analysis view contains a valid result.
  *
  * @param analysisView - The analysis view to check.
  * @returns `true` if the analysis view contains a valid result, `false` otherwise.

package/applications/Components/analysisUtils.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{throwIfAborted as n}from"../../core/promiseUtils.js";import{toUnit as e}from"../../core/quantity.js";import{setTestConfig as i}from"../../views/analysis/ElevationProfile/constants.js";import{geodesicDistanceThreshold as o}from"../../views/support/geodesicMeasurementUtils.js";function r(n){return n.forceInteractive()}function t(n){return e(n,"meters").value>o}function s(n){return 0===n.viewData.intersectingSegments.size}function a(){return i()}async function c(e){const{ElevationProfileChart:i}=await import("../../views/analysis/ElevationProfile/ElevationProfileChart.js");return n(e.signal),new i({analysisView:e.analysisView,container:e.container,messages:e.messages,onCursorPositionChange:e.onCursorPositionChange,onRangeChange:e.onRangeChange,uniformScaling:e.uniformScaling??!1,view:e.view})}export{c as createChart,r as forceInteractive,s as hasValidAreaResult,t as isAboveGeodesicDistanceThreshold,a as setElevationProfileTestConfig};
+import{throwIfAborted as n}from"../../core/promiseUtils.js";import{toUnit as e}from"../../core/quantity.js";import{setTestConfig as i}from"../../views/analysis/ElevationProfile/constants.js";import{geodesicDistanceThreshold as o}from"../../views/support/geodesicMeasurementUtils.js";function r(n){return n.forceInteractive()}function t(n){return e(n,"meters").value>o}function s(n){return null!=n.measurementData?.measurements}function a(){return i()}async function u(e){const{ElevationProfileChart:i}=await import("../../views/analysis/ElevationProfile/ElevationProfileChart.js");return n(e.signal),new i({analysisView:e.analysisView,container:e.container,messages:e.messages,onCursorPositionChange:e.onCursorPositionChange,onRangeChange:e.onRangeChange,uniformScaling:e.uniformScaling??!1,view:e.view})}export{u as createChart,r as forceInteractive,s as hasValidAreaResult,t as isAboveGeodesicDistanceThreshold,a as setElevationProfileTestConfig};

package/applications/Components/imageryUtils.d.ts

@@ -190,8 +190,8 @@ export interface ComputeBoxStatisticsParameters {
  *
  * Property | Type | Description
  * ---------|------|-------------
- * histograms[] | [RasterHistogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterHistogram) | Result containing raster histograms.
- * bandStatistics[] | [RasterBandStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterBandStatistics) | Raster band statistics.
+ * histograms[] | [RasterHistogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-raster-types.html#RasterHistogram) | Result containing raster histograms.
+ * bandStatistics[] | [RasterBandStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-raster-types.html#RasterBandStatistics) | Raster band statistics.
  * @experimental
  * @internal
  */

package/applications/Components/testUtils.d.ts

@@ -10,6 +10,7 @@ import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
  * Waits until the specified view is not updating anymore.
  *
  * @param view
+ * @since 5.0
  * @experimental
  * @internal
  */
@@ -18,6 +19,7 @@ export function waitUpdated(view: MapViewOrSceneView): Promise<void>;
 /**
  * Gets all the service mock dependencies.
  *
+ * @since 5.0
  * @experimental
  * @internal
  */

package/applications/KnowledgeStudio/dataModelVisualization.d.ts

@@ -14,6 +14,7 @@ import type { DataModelViewProperties, DataModelViewReturnType } from "../../lay
 /**
  * @param properties - The options object for the datamodel view.
  * @returns An object with load and destroy functions for the data model view.
+ * @since 5.0
  * @experimental
  * @internal
  */