@arcgis/core 5.1.0-next.104 → 5.1.0-next.106

package/analysis/AreaMeasurementAnalysis.d.ts

@@ -13,7 +13,7 @@ export interface AreaMeasurementAnalysisProperties extends AnalysisProperties, P
    *
    * > [!WARNING]
    * >
-   * > **Known Limitation**
+   * > **Known Limitations**
    * >
    * > For polygons with multiple rings, only the measurement of the first [ring](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon/#rings) will be displayed.
    */
@@ -32,15 +32,15 @@ export interface AreaMeasurementAnalysisProperties extends AnalysisProperties, P
  *
  * ```js
  * // create analysis
- * const areaMeasurement = new AreaMeasurementAnalysis({
+ * const analysis = new AreaMeasurementAnalysis({
  *   geometry: new Polygon({ })
  * });
  *
  * // add to a view
- * view.analyses.add(areaMeasurement);
+ * view.analyses.add(analysis);
  *
  * // retrieve measured results from analysis view once available
- * const analysisView = await view.whenAnalysisView(areaMeasurement);
+ * const analysisView = await view.whenAnalysisView(analysis);
  * await reactiveUtils.whenOnce(() => analysisView.result);
  *
  * const result = analysisView.result;
@@ -108,7 +108,7 @@ export default class AreaMeasurementAnalysis extends Analysis {
    *
    * > [!WARNING]
    * >
-   * > **Known Limitation**
+   * > **Known Limitations**
    * >
    * > For polygons with multiple rings, only the measurement of the first [ring](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon/#rings) will be displayed.
    */

package/analysis/DimensionAnalysis.d.ts

@@ -24,7 +24,7 @@ export interface DimensionAnalysisProperties extends AnalysisProperties {
  *
  * ```js
  * // create analysis with dimensions
- * const dimensionAnalysis = new DimensionAnalysis({
+ * const analysis = new DimensionAnalysis({
  *   dimensions: [
  *     new LengthDimension({
  *       startPoint: new Point({ }),
@@ -37,14 +37,14 @@ export interface DimensionAnalysisProperties extends AnalysisProperties {
  * });
  *
  * // add the analysis to the view
- * view.analyses.add(dimensionAnalysis);
+ * view.analyses.add(analysis);
  * ```
  *
  * Use the [DimensionAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/DimensionAnalysisView3D/) to retrieve the analysis results.
  *
  * ```js
  * // retrieve measured results from the analysis view
- * const analysisView = await view.whenAnalysisView(dimensionAnalysis);
+ * const analysisView = await view.whenAnalysisView(analysis);
  * const results = analysisView.results;
  * ```
  *

package/analysis/DimensionSimpleStyle.d.ts

@@ -47,7 +47,7 @@ export interface DimensionSimpleStyleProperties {
  *
  * ```js
  * // create analysis with dimensions
- * const dimensionAnalysis = new DimensionAnalysis({
+ * const analysis = new DimensionAnalysis({
  *   dimensions: [
  *     new LengthDimension({
  *       startPoint: new Point({ }),
@@ -63,7 +63,7 @@ export interface DimensionSimpleStyleProperties {
  *   }),
  * });
  * // add the analysis to the view
- * view.analyses.add(dimensionAnalysis);
+ * view.analyses.add(analysis);
  * ```
  *
  * @since 4.25

package/analysis/DirectLineMeasurementAnalysis.d.ts

@@ -33,17 +33,17 @@ export interface DirectLineMeasurementAnalysisProperties extends AnalysisPropert
  *
  * ```js
  * // create analysis
- * const directLineMeasurement = new DirectLineMeasurementAnalysis({
+ * const analysis = new DirectLineMeasurementAnalysis({
  *   startPoint: new Point({ }),
  *   endPoint: new Point({ }),
  *   unit: "imperial"
  * });
  *
  * // add to the scene view
- * view.analyses.add(directLineMeasurement);
+ * view.analyses.add(analysis);
  *
  * // retrieve measured results from analysis view once available
- * const analysisView = await view.whenAnalysisView(directLineMeasurement);
+ * const analysisView = await view.whenAnalysisView(analysis);
  * await reactiveUtils.whenOnce(() => analysisView.result);
  *
  * const result = analysisView.result;
@@ -89,7 +89,7 @@ export interface DirectLineMeasurementAnalysisProperties extends AnalysisPropert
  *
  * > [!WARNING]
  * >
- * > **Known Limitation**
+ * > **Known Limitations**
  * >
  * > This analysis is only supported in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
  *

package/analysis/DistanceMeasurementAnalysis.d.ts

@@ -32,15 +32,15 @@ export interface DistanceMeasurementAnalysisProperties extends AnalysisPropertie
  *
  * ```js
  * // create analysis
- * const distanceMeasurement = new DistanceMeasurementAnalysis({
+ * const analysis = new DistanceMeasurementAnalysis({
  *   geometry: new Polyline({ })
  * });
  *
  * // add to map view
- * view.analyses.add(distanceMeasurement);
+ * view.analyses.add(analysis);
  *
  * // retrieve measured results from analysis view once available
- * const analysisView = await view.whenAnalysisView(distanceMeasurement);
+ * const analysisView = await view.whenAnalysisView(analysis);
  * await reactiveUtils.whenOnce(() => analysisView.result);
  *
  * const result = analysisView.result;
@@ -65,7 +65,7 @@ export interface DistanceMeasurementAnalysisProperties extends AnalysisPropertie
  * ```
  * > [!WARNING]
  * >
- * > **Known Limitation**
+ * > **Known Limitations**
  * >
  * > This analysis is only supported in a 2D [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/).
  *

package/analysis/ElevationProfileAnalysis.d.ts

@@ -68,7 +68,7 @@ export interface ElevationProfileAnalysisProperties extends AnalysisProperties {
  * To add an elevation profile analysis to a view:
  *
  * ```js
- * const elevationProfileAnalysis = new ElevationProfileAnalysis({
+ * const analysis = new ElevationProfileAnalysis({
  *   profiles: [
  *     // Profile line that samples the ground elevation
  *     {
@@ -79,7 +79,7 @@ export interface ElevationProfileAnalysisProperties extends AnalysisProperties {
  *   geometry: new Polyline({ })
  * });
  *
- * view.analyses.add(elevationProfileAnalysis);
+ * view.analyses.add(analysis);
  * ```
  *
  * The [MapView.analyses](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#analyses) and
@@ -93,7 +93,7 @@ export interface ElevationProfileAnalysisProperties extends AnalysisProperties {
  *
  * ```js
  * // Get the analysis view
- * const analysisView = await view.whenAnalysisView(elevationProfileAnalysis);
+ * const analysisView = await view.whenAnalysisView(analysis);
  * // Retrieve the results, once they are ready
  * reactiveUtils.watch(
  *   () => analysisView.progress,

package/analysis/LengthDimension.d.ts

@@ -44,11 +44,11 @@ export interface LengthDimensionProperties extends Partial<Pick<LengthDimension,
  *   offset: 2
  * });
  * // create the analysis and add the dimension object to it
- * const dimensionAnalysis = new DimensionAnalysis({
+ * const analysis = new DimensionAnalysis({
  *   dimensions: [lengthDimension]
  * });
  * // add the analysis to the view
- * view.analyses.add(dimensionAnalysis);
+ * view.analyses.add(analysis);
  * ```
  *
  * > [!WARNING]

package/analysis/LineOfSightAnalysis.d.ts

@@ -31,7 +31,7 @@ export interface LineOfSightAnalysisProperties extends AnalysisProperties {
  *
  * ```js
  * // create line of sight analysis
- * const lineOfSightAnalysis = new LineOfSightAnalysis({
+ * const analysis = new LineOfSightAnalysis({
  *   observer: new LineOfSightAnalysisObserver({ position: new Point({ }) }),
  *   targets: [
  *     new LineOfSightAnalysisTarget({ position: new Point({ }) })
@@ -39,13 +39,13 @@ export interface LineOfSightAnalysisProperties extends AnalysisProperties {
  * });
  *
  * // add to the view
- * view.analyses.add(lineOfSightAnalysis);
+ * view.analyses.add(analysis);
  *
  * // wait until the view finishes updating so the results are current
  * await reactiveUtils.whenOnce(() => !view.updating);
  *
  * // retrieve the results from the analysis view.
- * const analysisView = await view.whenAnalysisView(lineOfSightAnalysis);
+ * const analysisView = await view.whenAnalysisView(analysis);
  * const results = analysisView.results;
  * ```
  *
@@ -90,7 +90,7 @@ export interface LineOfSightAnalysisProperties extends AnalysisProperties {
  *
  * > [!WARNING]
  * >
- * > **Known Limitation**
+ * > **Known Limitations**
  * >
  * > This analysis is only supported in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
  * > The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.

package/analysis/ShadowCast/DiscreteOptions.d.ts

@@ -4,7 +4,11 @@ import type { ColorLike } from "../../Color.js";
 import type { Clonable } from "../../core/Clonable.js";
 import type { ColorStopProperties } from "../../renderers/visualVariables/support/ColorStop.js";
 
-/** @since 5.0 */
+/**
+ * Properties that can be used to construct a [DiscreteOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/DiscreteOptions/) instance.
+ *
+ * @since 5.0
+ */
 export interface DiscreteOptionsProperties extends Partial<Pick<DiscreteOptions, "interval">> {
   /**
    * Defines the color used by the default color ramp for the visualization. The opacity is mapped to the number of
@@ -29,7 +33,7 @@ export interface DiscreteOptionsProperties extends Partial<Pick<DiscreteOptions,
    *
    * > [!WARNING]
    * >
-   * > **Known Limitation**
+   * > **Known Limitations**
    * >
    * > In a [3D SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/), a maximum of 8 color stops is supported.
    *
@@ -74,7 +78,7 @@ export default class DiscreteOptions extends Clonable {
    *
    * > [!WARNING]
    * >
-   * > **Known Limitation**
+   * > **Known Limitations**
    * >
    * > In a [3D SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/), a maximum of 8 color stops is supported.
    *

package/analysis/ShadowCast/MinDurationOptions.d.ts

@@ -4,7 +4,11 @@ import type { ColorLike } from "../../Color.js";
 import type { DiscreteOptionsProperties } from "./DiscreteOptions.js";
 import type { Clonable } from "../../core/Clonable.js";
 
-/** @since 5.0 */
+/**
+ * Properties that can be used to construct a [MinDurationOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/MinDurationOptions/) instance.
+ *
+ * @since 5.0
+ */
 export interface MinDurationOptionsProperties extends Partial<Pick<MinDurationOptions, "contextEnabled" | "minDuration">> {
   /**
    * Defines the color used to display areas where the cumulative shadow duration meets

package/analysis/ShadowCast/TotalDurationOptions.d.ts

@@ -5,7 +5,11 @@ import type { ShadowCastTotalDurationMode } from "./types.js";
 import type { Clonable } from "../../core/Clonable.js";
 import type { ColorStopProperties } from "../../renderers/visualVariables/support/ColorStop.js";
 
-/** @since 5.0 */
+/**
+ * Properties that can be used to construct a [TotalDurationOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/TotalDurationOptions/) instance.
+ *
+ * @since 5.0
+ */
 export interface TotalDurationOptionsProperties extends Partial<Pick<TotalDurationOptions, "mode">> {
   /**
    * Defines the color used by the default color ramp for the visualization. The opacity is mapped to the time spent
@@ -29,7 +33,7 @@ export interface TotalDurationOptionsProperties extends Partial<Pick<TotalDurati
    *
    * > [!WARNING]
    * >
-   * > **Known Limitation**
+   * > **Known Limitations**
    * >
    * > In a [3D SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/), a maximum of 8 color stops is supported.
    *
@@ -73,7 +77,7 @@ export default class TotalDurationOptions extends Clonable {
    *
    * > [!WARNING]
    * >
-   * > **Known Limitation**
+   * > **Known Limitations**
    * >
    * > In a [3D SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/), a maximum of 8 color stops is supported.
    *

package/analysis/ShadowCast/types.d.ts

@@ -6,7 +6,7 @@
 export type ShadowCastMode = "discrete" | "min-duration" | "total-duration";
 
 /**
- * Modes supported by the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/) when using the "total-duration" mode.
+ * Modes supported by the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/) when using the `"total-duration"` mode.
  *
  * @since 5.0
  */

package/analysis/ShadowCastAnalysis.d.ts

@@ -10,7 +10,11 @@ import type { TotalDurationOptionsProperties } from "./ShadowCast/TotalDurationO
 import type { ShadowCastMode } from "./ShadowCast/types.js";
 import type { PolygonProperties } from "../geometry/Polygon.js";
 
-/** @since 5.0 */
+/**
+ * Properties that can be used to construct a [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/) instance.
+ *
+ * @since 5.0
+ */
 export interface ShadowCastAnalysisProperties extends AnalysisProperties, Partial<Pick<ShadowCastAnalysis, "endTimeOfDay" | "mode" | "startTimeOfDay" | "utcOffset" | "visualizeSunlight">> {
   /**
    * The calendar date used to calculate the shadow cast. This date excludes the time.
@@ -27,7 +31,8 @@ export interface ShadowCastAnalysisProperties extends AnalysisProperties, Partia
    */
   discreteOptions?: DiscreteOptionsProperties;
   /**
-   * Area inside which to apply the shadow cast. If not set it will apply to the entire scene.
+   * Polygonal area inside which to apply the shadow cast analysis. Use this property to limit the visualization to a
+   * project area, such as a parcel, park, or courtyard. If not set, the analysis applies to the entire scene.
    *
    * @since 5.1
    */
@@ -47,43 +52,40 @@ export interface ShadowCastAnalysisProperties extends AnalysisProperties, Partia
 }
 
 /**
- * The ShadowCastAnalysis displays the cumulative shadows or sunlight of 3D features in a
- * [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). This type of analysis is helpful in urban development,
- * where new projects have to satisfy certain shadow or sunlight duration constraints.
- *
- * The analysis calculates the cumulative shadows for a time range during a single day. The user can
- * configure the time range and select a calendar date. This time range and calendar date are only used
- * for the shadow analysis and are not connected to the lighting in the scene.
- * To control the lighting in the scene, use the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/) component.
- * Changing the timezone in the analysis updates the visualization by interpreting the time range as being
- * in that timezone. This behavior is different than for the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/)
- * component where selecting a timezone updates the
- * [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment)
- * date and time according to the camera position.
+ * The ShadowCastAnalysis visualizes shadows cast by 3D features or sunlight exposure in a
+ * [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). This type of analysis is helpful in urban development, where projects may need to satisfy
+ * shadow or sunlight exposure requirements for a selected day and time range.
  *
- * The analysis provides three visualization modes.
+ * [![total duration mode](https://developers.arcgis.com/javascript/latest/assets/references/core/analysis/shadow-cast-analysis-duration.avif)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
  *
- * **Minimum duration** mode displays shadows only in areas where shading accumulates for longer than a specified duration
- * within the selected time range. When [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight) is `true`, the same mode
- * displays sunlight only in areas where sunlight accumulates for longer than the specified duration. In the image below,
- * on May 1, 2021, shadows are displayed only where shading exceeds 4 hours between 10AM and 4PM.
+ * By default, the analysis visualizes shadows. When [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight) is `true`,
+ * it visualizes sunlight exposure instead.
  *
- * [![minimum duration mode](https://developers.arcgis.com/javascript/latest/assets/references/core/analysis/shadow-cast-analysis-threshold.avif)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ * The [date](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#date), [startTimeOfDay](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#startTimeOfDay),
+ * [endTimeOfDay](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#endTimeOfDay), and [utcOffset](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#utcOffset) properties define
+ * the date, time range, and UTC offset used to compute the analysis overlay. They do not change the lighting in the
+ * scene. To control scene lighting, use [SunLighting](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/) or the
+ * [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/)
+ * component.
  *
- * **Total duration** mode displays the cumulative duration of shadow within the selected time range using opacity:
- * areas that receive no shadow remain fully transparent, while areas receiving the highest accumulated shadow duration
- * use a default opacity of 0.7. Intermediate values are interpolated. When
- * [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight) is `true`, opacity is mapped to cumulative sunlight duration
- * instead. This mode can visualize duration continuously or in 1-hour intervals.
+ * The [utcOffset](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#utcOffset) property determines which timezone the selected date and time range
+ * are interpreted in for the analysis. This differs from the Daylight component, where selecting a timezone updates the
+ * [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment)
+ * date and time according to the camera position.
  *
- * [![total duration mode](https://developers.arcgis.com/javascript/latest/assets/references/core/analysis/shadow-cast-analysis-duration.avif)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ * When set, the [geometry](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#geometry) property limits the visualization to a polygonal project
+ * area, such as a parcel, park, or courtyard. If no geometry is provided, the analysis applies to the entire scene.
+ * For `total-duration` and `discrete` visualizations, the [TotalDurationOptions.colorStops](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/TotalDurationOptions/#colorStops) or
+ * [DiscreteOptions.colorStops](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/DiscreteOptions/#colorStops) properties define a custom color ramp for duration or
+ * sample-count values. If color stops are not provided, the visualization uses a default transparent-to-color ramp.
  *
- * **Discrete** mode displays individual shadows at regular intervals within the selected time range. When
- * [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight) is `true`, it displays the sunlight at those intervals instead.
- * For example, with a time range from 10AM to 11AM and an interval set to 30 minutes, the shadows at 10AM, 10:30AM and
- * 11:00AM will be displayed.
+ * The [mode](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#mode) property controls how shadow or sunlight exposure is visualized:
  *
- * [![discrete mode](https://developers.arcgis.com/javascript/latest/assets/references/core/analysis/shadow-cast-analysis-discrete.avif)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ * | Mode | Use for | Details |
+ * | --- | --- | --- |
+ * | `min-duration` | Highlighting areas that meet or exceed a minimum shadow or sunlight duration. | The threshold is defined by [MinDurationOptions.minDuration](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/MinDurationOptions/#minDuration). |
+ * | `total-duration` | Showing cumulative shadow or sunlight duration across the analysis area. | Supports continuous visualization or 1-hour intervals. Without color stops, areas with no duration remain transparent, intermediate values are interpolated, and the highest duration uses the opacity from [TotalDurationOptions.color](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/TotalDurationOptions/#color). |
+ * | `discrete` | Displaying individual shadow or sunlight samples at regular intervals. | The interval is defined by [DiscreteOptions.interval](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/DiscreteOptions/#interval). For example, a one-hour range with a 30-minute interval displays samples at the start, middle, and end of the range. |
  *
  * By default, the analysis also displays a tooltip next to the pointer that reports the total duration at that
  * location, rounded to 15-minute increments. The tooltip reports shadow duration by default and sunlight duration when
@@ -94,54 +96,72 @@ export interface ShadowCastAnalysisProperties extends AnalysisProperties, Partia
  * - Set the desired [mode](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#mode).
  * - Configure the analysis time range using the [date](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#date), [startTimeOfDay](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#startTimeOfDay),
  * and [endTimeOfDay](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#endTimeOfDay) properties.
+ * - Optionally set [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight) to visualize sunlight duration instead of shadow duration.
+ * - Optionally set [geometry](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#geometry) to limit the analysis to a polygonal project area.
  * - Optionally set the [utcOffset](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#utcOffset) property to define the timezone used for the analysis.
- * - If using the "discrete" [mode](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#mode), optionally set custom properties with [DiscreteOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/DiscreteOptions/).
- * - If using the "min-duration" [mode](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#mode), optionally set custom properties with [MinDurationOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/MinDurationOptions/).
- * - If using the "total-duration" [mode](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#mode), optionally set custom properties with [TotalDurationOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/TotalDurationOptions/).
+ * - If using the `discrete` [mode](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#mode), optionally set custom properties with [DiscreteOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/DiscreteOptions/).
+ * - If using the `min-duration` [mode](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#mode), optionally set custom properties with [MinDurationOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/MinDurationOptions/).
+ * - If using the `total-duration` [mode](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#mode), optionally set custom properties with [TotalDurationOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/TotalDurationOptions/).
  * - Add the ShadowCastAnalysis instance to [SceneView.analyses](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#analyses).
  *
- * Use the [ShadowCastAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/) class and its
- * [ShadowCastAnalysisView3D.getDurationAtScreen()](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/#getDurationAtScreen) method to
- * obtain the shadow or sunlight duration at a specific screen location programmatically.
- * To disable the shadow tooltip next to the pointer set the [ShadowCastAnalysisView3D.interactive](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/#interactive)
- * property to `false`.
- *
  * ```js
- * // create analysis
- * const shadowCastAnalysis = new ShadowCastAnalysis({
+ * const projectArea = new Polygon({
+ *   rings: [
+ *     [
+ *       [-122.421, 37.781],
+ *       [-122.42, 37.781],
+ *       [-122.42, 37.782],
+ *       // ...
+ *     ]
+ *   ]
+ * });
+ *
+ * const analysis = new ShadowCastAnalysis({
  *   date: new Date("March 1, 2026"),
- *   startTimeOfDay: 10 * 3600 * 1000, // 10AM,
- *   endTimeOfDay: 16 * 3600 * 1000, // 4PM,
- *   mode: "min-duration",
- *   minDurationOptions: {
- *     minDuration: 3 * 3600 * 1000, // 3 hours
- *     color: [255, 0, 0, 0.4], // Transparent red
+ *   startTimeOfDay: 10 * 3600 * 1000, // 10AM
+ *   endTimeOfDay: 16 * 3600 * 1000, // 4PM
+ *   mode: "total-duration",
+ *   visualizeSunlight: true,
+ *   geometry: projectArea,
+ *   totalDurationOptions: {
+ *     mode: "continuous",
+ *     colorStops: [
+ *       // Map sunlight duration to colors. Values are in milliseconds.
+ *       { value: 0, color: [255, 255, 255, 0] },
+ *       { value: 2 * 3600 * 1000, color: [255, 198, 87, 0.5] },
+ *       { value: 4 * 3600 * 1000, color: [84, 176, 74, 0.85] }
+ *     ]
  *   },
- *   utcOffset: -8, // Pacific Standard Time
+ *   utcOffset: -8 // Pacific Standard Time
  * });
  *
- * // add to scene view
- * view.analyses.add(shadowCastAnalysis);
+ * view.analyses.add(analysis);
+ * ```
  *
+ * Use the [ShadowCastAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/) class and its
+ * [ShadowCastAnalysisView3D.getDurationAtScreen()](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/#getDurationAtScreen) method to
+ * obtain the shadow or sunlight duration at a specific screen location programmatically.
+ * To disable the shadow or sunlight tooltip next to the pointer set the [ShadowCastAnalysisView3D.interactive](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/#interactive)
+ * property to `false`.
+ *
+ * ```js
  * // use getDurationAtScreen method from the analysis view once available
- * const analysisView = await view.whenAnalysisView(shadowCastAnalysis);
+ * const analysisView = await view.whenAnalysisView(analysis);
  *
- * // get shadow or sunlight duration at the pointer location
  * view.on("pointer-move", async (event) => {
- *   // duration in milliseconds
+ *   // duration is the sunlight duration in milliseconds because visualizeSunlight is true
  *   const duration = await analysisView.getDurationAtScreen({ x: event.x, y: event.y });
  *   // ... do something with the duration
- * })
- *
+ * });
  * ```
  * > [!WARNING]
  * >
  * > **Known Limitations**
  * >
  * > - Terrain does not cast shadows in this analysis.
- * > - As a result, to avoid incorrect shadow visualization, `startTimeOfDay` should be set after local sunrise and
- * > `endTimeOfDay` before local sunset. If these times fall outside daylight hours, shadows may be missing in areas where
- * > terrain would normally block sunlight.
+ * > - As a result, shadow duration may be underestimated and sunlight duration may be overestimated in areas where
+ * > terrain would normally block sunlight. To avoid incorrect visualization, `startTimeOfDay` should be set after local
+ * > sunrise and `endTimeOfDay` before local sunset.
  * > - The analysis does not take daylight savings into account. Use the timezone dropdown to adjust the offset from
  * > the Coordinated Universal Time (UTC) and account for the daylight
  * > saving time.
@@ -153,7 +173,9 @@ export interface ShadowCastAnalysisProperties extends AnalysisProperties, Partia
  * @see [DiscreteOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/DiscreteOptions/)
  * @see [TotalDurationOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/TotalDurationOptions/)
  * @see [MinDurationOptions](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCast/MinDurationOptions/)
+ * @see [SunLighting](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/)
  * @see [Sample - Shadow Cast analysis object](https://developers.arcgis.com/javascript/latest/sample-code/analysis-shadow-cast/)
+ * @see [Sample - Sunlight analysis](https://developers.arcgis.com/javascript/latest/sample-code/analysis-sunlight/)
  * @see [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)
  * @see [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/)
  */
@@ -185,7 +207,8 @@ export default class ShadowCastAnalysis extends Analysis {
    */
   accessor endTimeOfDay: number;
   /**
-   * Area inside which to apply the shadow cast. If not set it will apply to the entire scene.
+   * Polygonal area inside which to apply the shadow cast analysis. Use this property to limit the visualization to a
+   * project area, such as a parcel, park, or courtyard. If not set, the analysis applies to the entire scene.
    *
    * @since 5.1
    */
@@ -201,9 +224,9 @@ export default class ShadowCastAnalysis extends Analysis {
   /**
    * Mode of analysis to use when computing and displaying shadows or sunlight.
    *
-   * - "discrete": Displays individual shadow snapshots at regular time intervals within the selected time range.
-   * - "min-duration": Displays areas where accumulated shading exceeds a user-defined minimum duration within the selected time range. Optional discrete overlays can provide additional context.
-   * - "total-duration": Displays total shadow accumulation within the selected time range using opacity: areas with longer shadow duration appear more opaque. Supports continuous or 1-hour aggregated modes.
+   * - `"discrete"`: Displays individual shadow or sunlight snapshots at regular time intervals within the selected time range.
+   * - `"min-duration"`: Displays areas where accumulated shadow or sunlight exceeds a user-defined minimum duration within the selected time range. Optional discrete overlays can provide additional context.
+   * - `"total-duration"`: Displays total shadow or sunlight accumulation within the selected time range. Supports continuous or 1-hour aggregated modes.
    *
    * When [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight) is `true`, the selected mode displays sunlight duration
    * instead of shadow duration.
@@ -257,8 +280,9 @@ export default class ShadowCastAnalysis extends Analysis {
    */
   get valid(): boolean;
   /**
-   * When `true`, the analysis visualizes sunlight duration instead of shadow duration. This applies to all modes and
-   * their respective options.
+   * When `true`, the analysis visualizes sunlight duration instead of shadow duration. This applies to all modes,
+   * their respective options, and the duration reported by
+   * [ShadowCastAnalysisView3D.getDurationAtScreen()](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/#getDurationAtScreen).
    *
    * @default false
    * @since 5.1

package/analysis/SliceAnalysis.d.ts

@@ -31,7 +31,7 @@ export interface SliceAnalysisProperties extends AnalysisProperties, Partial<Pic
  * is only considered if the [tiltEnabled](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/#tiltEnabled) property is set to `true`.
  *
  * ```js
- * const sliceAnalysis = new SliceAnalysis({
+ * const analysis = new SliceAnalysis({
  *   shape: new SlicePlane({
  *     position: new Point({ }),
  *     width: 50,
@@ -41,7 +41,7 @@ export interface SliceAnalysisProperties extends AnalysisProperties, Partial<Pic
  *   tiltEnabled: true
  * });
  *
- * view.analyses.add(sliceAnalysis);
+ * view.analyses.add(analysis);
  * ```
  *
  * [SceneView.analyses](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#analyses) can contain multiple slice analyses, but only one of
@@ -50,10 +50,10 @@ export interface SliceAnalysisProperties extends AnalysisProperties, Partial<Pic
  * plane. When a slice analysis view is activated, all other slice analysis views are automatically deactivated.
  *
  * ```js
- * const sliceAnalysisView = await view.whenAnalysisView(sliceAnalysis);
+ * const analysisView = await view.whenAnalysisView(analysis);
  *
  * // make the slice active in the view (only one slice can be active at a time)
- * sliceAnalysisView.active = true;
+ * analysisView.active = true;
  * ```
  *
  * To place a slice interactively, use the

package/analysis/SlicePlane.d.ts

@@ -19,9 +19,9 @@ export interface SlicePlaneProperties extends Partial<Pick<SlicePlane, "heading"
  * [SliceAnalysis.shape](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/#shape) property.
  *
  * ```js
- * const sliceAnalysis = new SliceAnalysis({
+ * const analysis = new SliceAnalysis({
  *   shape: new SlicePlane({
- *     position: new Point({ x: -0.1, y: 51.5 }),
+ *     position: new Point({ }),
  *     width: 50,
  *     height: 50,
  *     tilt: 45
@@ -29,7 +29,7 @@ export interface SlicePlaneProperties extends Partial<Pick<SlicePlane, "heading"
  *   tiltEnabled: true
  * });
  *
- * view.analyses.add(sliceAnalysis);
+ * view.analyses.add(analysis);
  * ```
  *
  * @since 4.23

package/analysis/Viewshed.d.ts

@@ -46,12 +46,12 @@ export interface ViewshedProperties extends Partial<Pick<Viewshed, "farDistance"
  *   horizontalFieldOfView: 85,
  *   verticalFieldOfView: 52
  * });
- * const viewshedAnalysis = new ViewshedAnalysis({
+ * const analysis = new ViewshedAnalysis({
  *   viewsheds: [viewshed],
  * });
  *
  * // add the analysis to the view
- * view.analyses.add(viewshedAnalysis);
+ * view.analyses.add(analysis);
  * ```
  *
  * To create a view dome, set [horizontalFieldOfView](https://developers.arcgis.com/javascript/latest/references/core/analysis/Viewshed/#horizontalFieldOfView) to 360, and [verticalFieldOfView](https://developers.arcgis.com/javascript/latest/references/core/analysis/Viewshed/#verticalFieldOfView) to 180.