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

package/Map.d.ts

@@ -408,7 +408,9 @@ export default class Map extends MapSuperclass {
   get basemap(): Basemap | null | undefined;
   set basemap(value: BasemapProperties | string | null | undefined);
   /**
-   * A collection of editable layers. Layers are considered editable if they have editing capabilities, and if the authenticated user has the necessary privileges needed to edit the layers.
+   * 
+   * A collection of editable layers. Layers are considered editable if they have editing capabilities, and if the authenticated user has the
+   * necessary privileges needed to edit the layers.
    *
    * @since 4.20
    * @see [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html)

package/analysis/Analysis.d.ts

@@ -38,6 +38,7 @@ export default abstract class Analysis extends AnalysisSuperclass {
    */
   get origin(): AnalysisOriginWebScene | null | undefined;
   set origin(value: (AnalysisOriginWebSceneProperties & { type: "web-scene" }) | null | undefined);
+  /** Identifier for the analysis type. */
   abstract readonly type: AnalysisType;
 }
 declare const AnalysisSuperclass: typeof Accessor & typeof IdentifiableMixin & typeof ClonableMixin & typeof JSONSupportMixin

package/analysis/Dimension/types.d.ts

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

package/analysis/DimensionAnalysis.d.ts

@@ -25,15 +25,15 @@ export interface DimensionAnalysisProperties extends AnalysisProperties {
  * ```js
  * // create analysis with dimensions
  * const dimensionAnalysis = new DimensionAnalysis({
- *    dimensions: [
- *      new LengthDimension({
- *        startPoint: new Point({ }),
- *        endPoint: new Point({ })
- *      })
- *    ],
- *    style: new DimensionSimpleStyle({
- *      color: "white"
- *    }),
+ *   dimensions: [
+ *     new LengthDimension({
+ *       startPoint: new Point({ }),
+ *       endPoint: new Point({ })
+ *     })
+ *   ],
+ *   style: new DimensionSimpleStyle({
+ *     color: "white"
+ *   }),
  * });
  *
  * // add the analysis to the view
@@ -45,7 +45,7 @@ export interface DimensionAnalysisProperties extends AnalysisProperties {
  * ```js
  * // retrieve measured results from the analysis view
  * const analysisView = await view.whenAnalysisView(dimensionAnalysis);
- * const results = dimensionAnalysisView.results;
+ * const results = analysisView.results;
  * ```
  *
  * To place a length dimension interactively, use the

package/analysis/DimensionSimpleStyle.d.ts

@@ -44,22 +44,23 @@ export interface DimensionSimpleStyleProperties extends ClonableMixinProperties,
  * The simple style is either set on a [DimensionAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionAnalysis.html) or on a
  * [DimensionLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-DimensionLayer.html) and applies to all [dimensions](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LengthDimension.html)
  * added to them.
+ *
  * ```js
  * // create analysis with dimensions
  * const dimensionAnalysis = new DimensionAnalysis({
- *    dimensions: [
- *      new LengthDimension({
- *        startPoint: new Point({ }),
- *        endPoint: new Point({ })
- *      })
- *    ],
- *    style: new DimensionSimpleStyle({
- *      color: "white",
- *      lineSize: 1.5,
- *      textBackgroundColor: "white",
- *      textColor: "black",
- *      fontSize: 9
- *    }),
+ *   dimensions: [
+ *     new LengthDimension({
+ *       startPoint: new Point({ }),
+ *       endPoint: new Point({ })
+ *     })
+ *   ],
+ *   style: new DimensionSimpleStyle({
+ *     color: "white",
+ *     lineSize: 1.5,
+ *     textBackgroundColor: "white",
+ *     textColor: "black",
+ *     fontSize: 9
+ *   }),
  * });
  * // add the analysis to the view
  * view.analyses.add(dimensionAnalysis);

package/analysis/DirectLineMeasurementAnalysis.d.ts

@@ -79,7 +79,7 @@ export interface DirectLineMeasurementAnalysisProperties extends AnalysisPropert
  *
  * DirectLineMeasurementAnalysis visualizes and labels the direct, horizontal, and vertical distances
  * When the distance between the points is greater than 100 kilometers, the measurement visualization is simplified,
- * and in the {@link views/3d/analysis/DirectLineMeasurementAnalysisView3D#results analysis results}
+ * and in the [analysis results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#result)
  * only the horizontal and vertical distances are calculated.
  *
  * ![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/direct-line-measurement-3d.png)

package/analysis/DistanceMeasurementAnalysis.d.ts

@@ -4,6 +4,7 @@ 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. */
 export interface DistanceMeasurementAnalysisProperties extends AnalysisProperties, Partial<Pick<DistanceMeasurementAnalysis, "unit">> {
   /**
    * Polyline whose length is to be computed and displayed in the view.
@@ -29,7 +30,7 @@ export interface DistanceMeasurementAnalysisProperties extends AnalysisPropertie
  *   geometry: new Polyline({ })
  * });
  *
- * // add to scene view
+ * // add to map view
  * view.analyses.add(distanceMeasurement);
  *
  * // retrieve measured results from analysis view once available

package/analysis/ElevationProfile/ElevationProfileLineScene.d.ts

@@ -41,8 +41,8 @@ export interface ElevationProfileLineSceneProperties extends ElevationProfileLin
  * // Create an elevation profile analysis with a scene profile line
  * const analysis = new ElevationProfileAnalysis({
  *   profiles: [{
- *    type: "scene",
- *    exclude: [view.map.ground], // Exclude ground from elevation sampling
+ *     type: "scene",
+ *     exclude: [view.map.ground], // Exclude ground from elevation sampling
  *   }],
  * });
  */
@@ -63,7 +63,7 @@ export default class ElevationProfileLineScene extends ElevationProfileLine {
    * const analysis = new ElevationProfileAnalysis({
    *   profiles: [{
    *     type: "scene",
-   *     exclude: [view.map.ground], // Exclude ground from elevation samplingif this profile line
+   *     exclude: [view.map.ground], // Exclude ground from elevation sampling for this profile line
    *   }],
    * });
    */

package/analysis/ElevationProfile/ElevationProfileLineViewOptions.d.ts

@@ -15,7 +15,7 @@ export default class ElevationProfileLineViewOptions extends Clonable {
   constructor(properties?: ElevationProfileLineViewOptionsProperties);
   /**
    * Whether to show an indicator point in the view when an
-   * {@link views/3d/analysis/ElevationProfileAnalysisView2D#indicatorRelativePosition indicator location} is set.
+   * [indicator location](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ElevationProfileAnalysisView3D.html#indicatorRelativePosition) is set.
    * If false, the indicator point is not displayed, but results are still available.
    *
    * @default true

package/analysis/ElevationProfile/types.d.ts

@@ -3,6 +3,8 @@ 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. */
 export type ElevationProfileLineUnion = ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineScene;
 
+/** Supported elevation profile line types. */
 export type ElevationProfileLineType = ElevationProfileLineUnion["type"];

package/analysis/LengthDimension.d.ts

@@ -19,32 +19,33 @@ export interface LengthDimensionProperties extends ClonableMixinProperties, JSON
  *
  * Length dimensions can be displayed by adding them to a [DimensionAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DimensionAnalysis.html).
  *
+ *
  * ```js
  * // create the dimension object
  * const lengthDimension = new LengthDimension({
- *    measureType: "vertical",
- *    startPoint: new Point({
- *       spatialReference: {
- *         wkid: 32610
- *       },
- *       x: 265,
- *       y: 24,
- *       z: 26
- *    }),
- *    endPoint: new Point({
- *       spatialReference: {
- *         wkid: 32610
- *       },
- *       x: 265,
- *       y: 24,
- *       z: 38
- *    }),
- *    orientation: 90,
- *    offset: 2
+ *   measureType: "vertical",
+ *   startPoint: new Point({
+ *     spatialReference: {
+ *       wkid: 32610
+ *     },
+ *     x: 265,
+ *     y: 24,
+ *     z: 26
+ *   }),
+ *   endPoint: new Point({
+ *     spatialReference: {
+ *       wkid: 32610
+ *     },
+ *     x: 265,
+ *     y: 24,
+ *     z: 38
+ *   }),
+ *   orientation: 90,
+ *   offset: 2
  * });
- * // create analysis and add the dimension object to it.
+ * // create the analysis and add the dimension object to it
  * const dimensionAnalysis = new DimensionAnalysis({
- *    dimensions: [lengthDimension]
+ *   dimensions: [lengthDimension]
  * });
  * // add the analysis to the view
  * view.analyses.add(dimensionAnalysis);

package/analysis/LineOfSightAnalysis.d.ts

@@ -33,7 +33,7 @@ export interface LineOfSightAnalysisProperties extends AnalysisProperties {
  * // create line of sight analysis
  * const lineOfSightAnalysis = new LineOfSightAnalysis({
  *   observer: new LineOfSightAnalysisObserver({ position: new Point({ }) }),
- *   targets:[
+ *   targets: [
  *     new LineOfSightAnalysisTarget({ position: new Point({ }) })
  *   ]
  * });
@@ -41,7 +41,7 @@ export interface LineOfSightAnalysisProperties extends AnalysisProperties {
  * // add to the view
  * view.analyses.add(lineOfSightAnalysis);
  *
- * // wait for the view to not be updating to ensure we get the latest results.
+ * // wait until the view finishes updating so the results are current
  * await reactiveUtils.whenOnce(() => !view.updating);
  *
  * // retrieve the results from the analysis view.

package/analysis/ShadowCast/MinDurationOptions.d.ts

@@ -10,7 +10,7 @@ export interface MinDurationOptionsProperties extends ClonableMixinProperties, P
    * 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]
+   * @default [255, 0, 0, 0.7]
    */
   color?: ColorLike;
   /**
@@ -38,7 +38,7 @@ export default class MinDurationOptions extends Clonable {
    * 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]
+   * @default [255, 0, 0, 0.7]
    */
   get color(): Color;
   set color(value: ColorLike);

package/analysis/ShadowCast/types.d.ts

@@ -1,10 +1,14 @@
 
 /**
- * Types for the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html).
+ * Modes supported by the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html).
  *
  * @since 5.0
  */
 export type ShadowCastMode = "discrete" | "min-duration" | "total-duration";
 
-/** @since 5.0 */
+/**
+ * Modes supported by the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html) when using the "total-duration" mode.
+ *
+ * @since 5.0
+ */
 export type ShadowCastTotalDurationMode = "continuous" | "hourly";

package/analysis/Slice/types.d.ts

@@ -1,4 +1,5 @@
 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). */
 export type SliceableLayer = Layer | BuildingComponentSublayer;

package/analysis/Viewshed.d.ts

@@ -14,28 +14,30 @@ export interface ViewshedProperties extends ClonableMixinProperties, JSONSupport
  * The viewshed is determined by a position, distance, orientation (defined by heading and tilt),
  * and field of view angles.
  *
+ *
  * ```js
- *  const viewshed = new Viewshed({
- *    observer: new Point({
- *      spatialReference: {
- *        latestWkid: 3857,
- *        wkid: 102100
- *      },
- *      x: -9754426,
- *      y: 5143111,
- *      z: 330
- *    }),
- *    farDistance: 900,
- *    heading: 64,
- *    tilt: 84,
- *    horizontalFieldOfView: 85,
- *    verticalFieldOfView: 52
- *  });
- *  const viewshedAnalysis = new ViewshedAnalysis({
- *    viewsheds: [viewshed],
- *  });
+ * const viewshed = new Viewshed({
+ *   observer: new Point({
+ *     spatialReference: {
+ *       latestWkid: 3857,
+ *       wkid: 102100
+ *     },
+ *     x: -9754426,
+ *     y: 5143111,
+ *     z: 330
+ *   }),
+ *   farDistance: 900,
+ *   heading: 64,
+ *   tilt: 84,
+ *   horizontalFieldOfView: 85,
+ *   verticalFieldOfView: 52
+ * });
+ * const viewshedAnalysis = new ViewshedAnalysis({
+ *   viewsheds: [viewshed],
+ * });
  *
- *  view.analyses.add(viewshedAnalysis);
+ * // add the analysis to the view
+ * view.analyses.add(viewshedAnalysis);
  * ```
  *
  * To create a view dome, set [horizontalFieldOfView](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-Viewshed.html#horizontalFieldOfView) to 360, and [verticalFieldOfView](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-Viewshed.html#verticalFieldOfView) to 180.

package/analysis/ViewshedAnalysis.d.ts

@@ -18,20 +18,20 @@ export interface ViewshedAnalysisProperties extends AnalysisProperties {
  * [ViewshedLayer#source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ViewshedLayer.html#source) in a [SceneView#map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#map).
  *
  * ```js
- *  const viewshed = new Viewshed({
- *    observer: new Point({ }),
- *    farDistance: 900,
- *    heading: 64,
- *    tilt: 84,
- *    horizontalFieldOfView: 85,
- *    verticalFieldOfView: 52
- *  });
- *  const viewshedAnalysis = new ViewshedAnalysis({
- *    viewsheds: [viewshed],
- *  });
+ * const viewshed = new Viewshed({
+ *   observer: new Point({ }),
+ *   farDistance: 900,
+ *   heading: 64,
+ *   tilt: 84,
+ *   horizontalFieldOfView: 85,
+ *   verticalFieldOfView: 52
+ * });
+ * const viewshedAnalysis = new ViewshedAnalysis({
+ *   viewsheds: [viewshed],
+ * });
  *
- *  // add the analysis to the view
- *  view.analyses.add(viewshedAnalysis);
+ * // add the analysis to the view
+ * view.analyses.add(viewshedAnalysis);
  * ```
  *
  * To add a viewshed interactively, use the

package/analysis/VolumeMeasurement/VolumeMeasurementDisplayUnits.d.ts

@@ -5,8 +5,7 @@ import type { SystemOrLengthUnit, SystemOrVolumeUnit } from "../../core/units.js
 export interface VolumeMeasurementDisplayUnitsProperties extends ClonableMixinProperties, JSONSupportMixinProperties, Partial<Pick<VolumeMeasurementDisplayUnits, "elevation" | "volume">> {}
 
 /**
- * Units used for displaying values in the UI
- * for the [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html).
+ * Units used for displaying values in the UI for the [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html).
  *
  * @beta
  * @since 4.34

package/analysis/VolumeMeasurement/VolumeMeasurementInputUnits.d.ts

@@ -2,11 +2,11 @@ import type { Clonable, ClonableMixinProperties } from "../../core/Clonable.js";
 import type { JSONSupportMixin, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 import type { LengthUnit } from "../../core/units.js";
 
+/** Properties that can be used to construct a [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementInputUnits.html) instance. */
 export interface VolumeMeasurementInputUnitsProperties extends ClonableMixinProperties, JSONSupportMixinProperties, Partial<Pick<VolumeMeasurementInputUnits, "elevation">> {}
 
 /**
- * Units used for interpreting input values
- * for the [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html).
+ * Units used for interpreting input values for the [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html).
  *
  * @beta
  * @since 4.34

package/analysis/VolumeMeasurement/types.d.ts

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

package/analysis/VolumeMeasurementAnalysis.d.ts

@@ -153,6 +153,7 @@ export default class VolumeMeasurementAnalysis extends Analysis {
    * @default "cut-fill"
    */
   accessor measureType: VolumeMeasureType;
+  /** Identifier for the analysis type. */
   get type(): "volume-measurement";
   /**
    * Indicates whether the analysis is ready to be computed and interacted with in the view. It requires the

package/analysis/types.d.ts

@@ -8,6 +8,7 @@ import type ShadowCastAnalysis from "./ShadowCastAnalysis.js";
 import type SliceAnalysis from "./SliceAnalysis.js";
 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). */
 export type AnalysisUnion = AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | DistanceMeasurementAnalysis | ElevationProfileAnalysis | LineOfSightAnalysis | ShadowCastAnalysis | SliceAnalysis | ViewshedAnalysis | VolumeMeasurementAnalysis;
@@ -31,4 +32,8 @@ export interface FeatureReference {
   attributes: any;
   /** Reference to a layer. */
   layer?: FeatureReferenceLayer | null;
+  /** Object identifier of the feature in its source layer. */
+  objectId?: ObjectId | null;
+  /** Unique identifier assigned to the feature on the client. */
+  uid: number | null;
 }

package/arcade.d.ts

@@ -376,7 +376,7 @@ export interface ExecuteContext {
   /**
    * _Since 4.33_
    *
-   * @deprecated since 5.0. Use `cache`.
+   * @deprecated since version 5.0. Use `cache` instead.
    */
   lruCache?: ArcadeCache;
   /**
@@ -423,7 +423,7 @@ export interface ExecutorOptions {
   /**
    * _Since 4.33_
    *
-   * @deprecated since 5.0. Use `cache`.
+   * @deprecated since version 5.0. Use `cache` instead.
    */
   lruCache?: ArcadeCache;
   /**