@arcgis/map-components 5.1.0-next.2 → 5.1.0-next.21

package/dist/components/arcgis-shadow-cast/customElement.d.ts

@@ -1,61 +1,60 @@
 /// <reference path="../../index.d.ts" />
-import type Point from "@arcgis/core/geometry/Point";
+import type Point from "@arcgis/core/geometry/Point.js";
 import type ShadowCastAnalysis from "@arcgis/core/analysis/ShadowCastAnalysis.js";
 import type SceneView from "@arcgis/core/views/SceneView.js";
 import type Color from "@arcgis/core/Color.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { HeadingLevel } from "../../support/heading.js";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
+import type { ArcgisReferenceElement, HeadingLevel } from "../types.js";
+import type { ShadowCastMode, ShadowCastTotalDurationMode } from "@arcgis/core/analysis/ShadowCast/types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { Icon as Icon } from "@esri/calcite-components/components/calcite-icon";
-import type { ShadowCastMode as ShadowCastMode2, ShadowCastTotalDurationMode } from "@arcgis/core/analysis/ShadowCast/types.js";
 
 /**
  * The Shadow Cast component displays the cumulative shadows of 3D features in a
- * [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).
+ * [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).
  * This type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.
  *
  * The component 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/arcgis-daylight/) component.
+ * [arcgis-daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/) component.
  * Changing the timezone in the component updates the visualization by interpreting the time range as being
  * in that timezone. This behavior is different from the
- * [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,
+ * [arcgis-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/arcgis-scene/#environment)
+ * [arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment)
  * date and time according to the camera position.
  *
- * The component provides three [modes](#mode): minimum duration, total duration, and discrete mode.
+ * The component provides three [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode): minimum duration, total duration, and discrete mode.
  *
  * **Minimum duration** mode displays shadows only in areas where shading accumulates for longer than a specified duration
  * within the selected time range. Areas that receive less shading than the minimum show no shadow. In the image below,
  * on May 1, 2021, shadows are displayed only where shading exceeds 4 hours between 10AM and 4PM.
  *
- * [![minimum-duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-threshold.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ * [![minimum-duration mode](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/shadow-cast/shadow-cast-threshold.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
  *
  * **Total shadow 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. This mode can visualize shadows continuously or
  * in 1-hour intervals.
  *
- * [![total-duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-duration.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ * [![total-duration mode](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/shadow-cast/shadow-cast-duration.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
  *
  * **Discrete shadows** mode displays individual shadows at regular intervals within the selected time range.
  * 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.
  *
- * [![discrete mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-discrete.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ * [![discrete mode](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/shadow-cast/shadow-cast-discrete.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
  *
  * Hovering over the Scene will display a tooltip showing the  amount of time that location is in shadow, rounded to 15-minute intervals.
  *
- * The defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay),
- * [endTimeOfDay](#endTimeOfDay), and [mode](#mode) properties.
+ * The defaults for the time range and visualization settings can be changed using the [startTimeOfDay](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#startTimeOfDay),
+ * [endTimeOfDay](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#endTimeOfDay), and [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) properties.
  *
  * **Known limitations**
  *
- * * Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ * * Shadow Cast is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.
  * * 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.
@@ -72,13 +71,13 @@ import type { ShadowCastMode as ShadowCastMode2, ShadowCastTotalDurationMode } f
  */
 export abstract class ArcgisShadowCast extends LitElement {
   /**
-   * The [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html)
+   * The [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/)
    * created or modified by the component.
    *
-   * When connecting the Shadow Cast component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)
-   * component, it automatically creates an empty analysis and adds it to the [analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses)
+   * When connecting the Shadow Cast component to the [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)
+   * component, it automatically creates an empty analysis and adds it to the [arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses)
    * collection.
-   * You can then wait for the [ShadowCastAnalysisView3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ShadowCastAnalysisView3D.html)
+   * You can then wait for the [ShadowCastAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/)
    * to be created before accessing the analysis results.
    *
    * ```js
@@ -103,7 +102,7 @@ export abstract class ArcgisShadowCast extends LitElement {
    * ```
    * Whenever the component is destroyed, the analysis is automatically removed from the collection.
    *
-   * Alternatively, a programmatically created [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html)
+   * Alternatively, a programmatically created [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/)
    * can be provided to the component.
    * Then, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.
    *
@@ -123,6 +122,8 @@ export abstract class ArcgisShadowCast extends LitElement {
    * // Connect the analysis to the shadow cast component.
    * shadowCastElement.analysis = analysis;
    * ```
+   *
+   * @since 5.0
    */
   accessor analysis: ShadowCastAnalysis;
   /**
@@ -146,21 +147,25 @@ export abstract class ArcgisShadowCast extends LitElement {
   get date(): Date;
   set date(value: Date | number | string);
   /**
-   * Color of the shadow visualization in "discrete" [mode](#mode). The opacity of the visualization is mapped to the
+   * Color of the shadow visualization in "discrete" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The opacity of the visualization is mapped to the
    * number of overlapping shadows. No shadow corresponds to opacity 0 and maximum number of shadows corresponds to the
    * opacity set in this color value.
+   *
+   * @since 5.0
    */
   accessor discreteColor: Color;
   /**
-   * Individual shadows are displayed at this time interval in "discrete" [mode](#mode), starting with the start time of
+   * Individual shadows are displayed at this time interval in "discrete" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode), starting with the start time of
    * day. The interval is expressed in milliseconds. If set to 0, we'll use the smallest possible interval, up to a
    * maximum of 255 samples.
+   *
+   * @since 5.0
    */
   accessor discreteInterval: number;
   /**
-   * Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.
+   * Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date)) when the shadow cast computation should stop.
    *
-   * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#endTimeOfDay)
+   * [Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#endTimeOfDay)
    */
   accessor endTimeOfDay: number;
   /**
@@ -179,66 +184,77 @@ export abstract class ArcgisShadowCast extends LitElement {
    * If true, the color picker will be hidden in the discrete mode options.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideDiscreteColorPicker: boolean;
   /**
    * If true, the interval selector will be hidden in the discrete mode options.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideDiscreteInterval: boolean;
   /**
    * If true, the visualization options will be hidden in discrete mode.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideDiscreteOptions: boolean;
   /**
    * If true, the color picker will be hidden in the minimum duration mode options.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideMinDurationColorPicker: boolean;
   /**
    * If true, the color picker will be hidden in the context options in minimum duration mode.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideMinDurationContextColorPicker: boolean;
   /**
    * If true, the interval selector will be hidden in the context options in minimum duration mode.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideMinDurationContextInterval: boolean;
   /**
    * If true, the context options will be hidden in the minimum duration mode options.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideMinDurationContextOptions: boolean;
   /**
    * If true, the toggle used to show or hide the context options will be hidden.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideMinDurationContextToggle: boolean;
   /**
    * If true, the visualization options will be hidden in minimum duration mode.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideMinDurationOptions: boolean;
   /**
    * If true, the minimum duration slider will be hidden in the minimum duration mode options.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideMinDurationSlider: boolean;
   /**
    * If true, the tooltip which displays the amount of shadow at a certain location will be hidden.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideShadowDurationTooltip: boolean;
   /**
@@ -257,30 +273,35 @@ export abstract class ArcgisShadowCast extends LitElement {
    * If true, the color picker will be hidden in the total duration mode options.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideTotalDurationColorPicker: boolean;
   /**
    * If true, the mode selector will be hidden in the total duration mode options.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideTotalDurationModeSelect: boolean;
   /**
    * If true, the visualization options will be hidden in the total duration mode.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideTotalDurationOptions: boolean;
   /**
    * Indicates whether the component's visualization is hidden in the view.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideVisualization: boolean;
   /**
    * If true, the visualization options will be hidden.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideVisualizationOptions: boolean;
   /**
@@ -293,7 +314,11 @@ export abstract class ArcgisShadowCast extends LitElement {
   accessor icon: Icon["icon"] | undefined;
   /** The component's default label. */
   accessor label: string | undefined;
-  /** Maximum allowed value for the [minDuration](#minDuration) property, in milliseconds. */
+  /**
+   * Maximum allowed value for the [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration) property, in milliseconds.
+   *
+   * @since 5.0
+   */
   accessor maxMinDuration: number;
   /** @internal */
   protected messages: Partial<{
@@ -351,36 +376,48 @@ export abstract class ArcgisShadowCast extends LitElement {
       timezoneLabel: string;
       visualizationLabel: string;
   }>;
-  /** The minimum duration (in milliseconds) used in "min-duration" [mode](#mode) to determine which shadow areas are displayed. */
+  /**
+   * The minimum duration (in milliseconds) used in "min-duration" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) to determine which shadow areas are displayed.
+   *
+   * @since 5.0
+   */
   accessor minDuration: number;
   /**
-   * Color of the shadow visualization in "min-duration" [mode](#mode). The areas with cumulative shadow time longer than
+   * Color of the shadow visualization in "min-duration" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The areas with cumulative shadow time longer than
    * the minimum duration value are displayed with this color.
+   *
+   * @since 5.0
    */
   accessor minDurationColor: Color;
   /**
-   * The color used when showing additional context in "min-duration" [mode](#mode) when
-   * [minDurationContextEnabled](#contextEnabled) is true.
+   * The color used when showing additional context in "min-duration" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) when
+   * [minDurationContextEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextEnabled) is true.
+   *
+   * @since 5.0
    */
   accessor minDurationContextColor: Color;
   /**
    * Whether to enable additional context showing discrete shadows at the same time as displaying shadows above a
-   * minimum duration when in the "min-duration" [mode](#mode). The [minDurationContextColor](#minDurationContextColor)
-   * and [minDurationContextInterval](#minDurationContextInterval) properties are used to configure the visualization of the
+   * minimum duration when in the "min-duration" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The [minDurationContextColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextColor)
+   * and [minDurationContextInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextInterval) properties are used to configure the visualization of the
    * discrete shadows when context is enabled.
    *
    * @default false
+   * @since 5.0
    */
   accessor minDurationContextEnabled: boolean;
   /**
-   * The interval in milliseconds used when showing additional context in "min-duration" [mode](#mode) when
-   * [minDurationContextEnabled](#contextEnabled) is true.
+   * The interval in milliseconds used when showing additional context in "min-duration" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) when
+   * [minDurationContextEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextEnabled) is true.
+   *
+   * @since 5.0
    */
   accessor minDurationContextInterval: number;
   /**
-   * Minimum allowed value for the [minDuration](#minDuration) property, in milliseconds.
+   * Minimum allowed value for the [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration) property, in milliseconds.
    *
    * @default 0
+   * @since 5.0
    */
   accessor minMinDuration: number;
   /**
@@ -390,8 +427,10 @@ export abstract class ArcgisShadowCast extends LitElement {
    * within the selected time range. Optional discrete shadow 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.
+   *
+   * @since 5.0
    */
-  accessor mode: ShadowCastMode2;
+  accessor mode: ShadowCastMode;
   /**
    * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
    *
@@ -399,9 +438,9 @@ export abstract class ArcgisShadowCast extends LitElement {
    */
   accessor referenceElement: ArcgisReferenceElement | string | undefined;
   /**
-   * Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.
+   * Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date)) when the shadow cast computation should start.
    *
-   * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#startTimeOfDay)
+   * [Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#startTimeOfDay)
    */
   accessor startTimeOfDay: number;
   /**
@@ -412,14 +451,18 @@ export abstract class ArcgisShadowCast extends LitElement {
    */
   get state(): "disabled" | "ready";
   /**
-   * Color of the shadow visualization in "total-duration" [mode](#mode). The opacity is mapped to the time spent in shadow.
+   * Color of the shadow visualization in "total-duration" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The opacity is mapped to the time spent in shadow.
    * Areas that don't receive any shadow are displayed with zero opacity and areas that receive shadows for the entire
    * time range are displayed with the opacity specified in this property.
+   *
+   * @since 5.0
    */
   accessor totalDurationColor: Color;
   /**
-   * Mode in which the cumulative shadow duration should be displayed in "total-duration" [mode](#mode): as a continuous
+   * Mode in which the cumulative shadow duration should be displayed in "total-duration" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode): as a continuous
    * surface or as an hourly aggregation of values.
+   *
+   * @since 5.0
    */
   accessor totalDurationMode: ShadowCastTotalDurationMode;
   /** The difference in hours between UTC time and the times displayed in the component. */
@@ -442,9 +485,10 @@ export abstract class ArcgisShadowCast extends LitElement {
   /**
    * Returns the time (in milliseconds) spent in shadow for a certain point on the screen.
    *
-   * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ShadowCast-ShadowCastAnalysisView3D.html#getDurationAtScreen)
+   * [Read more](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCast/ShadowCastAnalysisView3D/#getDurationAtScreen)
    *
    * @param point
+   * @since 5.0
    */
   getDurationAtScreen(point: Point): Promise<number>;
   "@setterTypes": {