@arcgis/map-components 5.0.0-next.98 → 5.0.0

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

@@ -1,57 +1,65 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
-import { PublicLitElement as LitElement, JsxNode, TargetedEvent } from '@arcgis/lumina';
-import { Use } from '@arcgis/lumina/controllers';
-import { HeadingLevel } from '../../support/heading';
-import { ArcgisReferenceElement } from '../../utils/component-utils';
-import { default as ShadowCastViewModel } from './ShadowCastViewModel';
-import { ShadowCastMode } from '@arcgis/core/analysis/ShadowCast/types';
+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 { 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";
 
-declare const useShadowCastViewModel: (component: LitElement & Pick<ShadowCastViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<ShadowCastViewModel>) => ShadowCastViewModel;
 /**
- * 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/).
+ * The Shadow Cast component displays the cumulative shadows of 3D features in a
+ * [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, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.
+ * To control the lighting in the scene, use the
+ * [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,
- * where selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.
+ * in that timezone. This behavior is different from the
+ * [arcgis-daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/) component,
+ * where selecting a timezone updates the
+ * [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.
  *
- * In the **minimum duration** mode, only the areas that receive
- * shadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive
- * shadow for more than 4 hours within the time interval of 10AM to 4PM.
+ * **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.
  *
- * [![threshold 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 duration of the cumulative shadow using opacity: areas that don't
- * receive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity
- * of 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the
- * amount of time that location is in shadow, rounded to 15-minute intervals. In this mode, the visualization
- * can display shadow cast in a continuous way or in 1-hour intervals.
+ * **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.
  *
- * [![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** is a third mode which displays individual shadows at a given time interval.
- * For example, setting the time range to 10AM-11AM and the interval to 30 minutes will display
- * shadows for 10AM, 10:30AM and 11:00AM.
+ * **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/)
  *
- * The defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay),
- * [endTimeOfDay](#endTimeOfDay), and [mode](#mode) properties.
+ * 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](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.
- * * Terrain does not cast shadows and it is therefore not taken into account in this analysis.
- * This influences the results when the start time of the range is before sunrise or when the end time is after the sunset.
- * * The component does not take into account the daylight savings.
- * Use the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.
+ * * 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.
+ * * 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.
  * * The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.
  * In case of an inaccurate timezone, users can set it manually using the timezone dropdown.
  *
@@ -59,306 +67,439 @@ declare const useShadowCastViewModel: (component: LitElement & Pick<ShadowCastVi
  *
  * - [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
  *
- * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/)
- *
  * @since 4.28
  */
-export declare class ArcgisShadowCast extends LitElement {
-    /**
-     * The [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html)
-     * 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)
-     * collection. Whenever the component is destroyed, the analysis is automatically removed from the collection.
-     *
-     * Alternatively, a programmatically created analysis can be provided to the component.
-     * Then, the application itself needs to add it to and later remove it from the analyses collection.
-     *
-     * ```js
-     * // Create the analysis.
-     * const analysis = new ShadowCastAnalysis();
-     *
-     * // Get the view element and the component and wait until they are ready.
-     * const viewElement = document.querySelector("arcgis-scene");
-     * await viewElement.viewOnReady();
-     * const shadowCastElement = document.querySelector("arcgis-shadow-cast");
-     * await shadowCastElement.componentOnReady();
-     *
-     * // Add the analysis to the analyses collection.
-     * viewElement.analyses.add(analysis);
-     *
-     * // Connect the analysis to the shadow cast component.
-     * shadowCastElement.analysis = analysis;
-     * ```
-     */
-    analysis: import('@arcgis/core/analysis/ShadowCastAnalysis').default;
-    /**
-     * The view associated with the component.
-     *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Shadow Cast component will be associated with a map or scene component rather than using the `view` property.
-     */
-    view: import('@arcgis/core/views/SceneView').default | undefined;
-    /**
-     * If true, the component will not be destroyed automatically when it is
-     * disconnected from the document. This is useful when you want to move the
-     * component to a different place on the page, or temporarily hide it. If this
-     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/#destroy) method when you are done to
-     * prevent memory leaks.
-     *
-     * @default false
-     */
-    autoDestroyDisabled: boolean;
-    /**
-     * 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.
-     *
-     * _See also_
-     *
-     * * [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)
-     */
-    get date(): Date;
-    set date(value: Date | number | string);
-    /**
-     * Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.
-     *
-     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#endTimeOfDay)
-     */
-    endTimeOfDay: number;
-    /**
-     * Indicates the heading level to use for the component title.
-     *
-     * @default 4
-     */
-    headingLevel: HeadingLevel;
-    /**
-     * If true, the time range slider will be hidden.
-     *
-     * @default false
-     */
-    hideTimeRangeSlider: boolean;
-    /**
-     * If true, the timezone picker will be hidden.
-     *
-     * @default false
-     */
-    hideTimezone: boolean;
-    /**
-     * If true, the date picker will be hidden.
-     *
-     * @default false
-     */
-    hideDatePicker: boolean;
-    /**
-     * If true, the tooltip which displays the amount of shadow at a certain location will be hidden.
-     *
-     * @default false
-     */
-    hideShadowDurationTooltip: boolean;
-    /**
-     * Whether to hide the analysis visualization in the view.
-     *
-     * @default false
-     */
-    hideVisualization: boolean;
-    /**
-     * If true, the visualization options will be hidden.
-     *
-     * @default false
-     */
-    hideVisualizationOptions: boolean;
-    /**
-     * If true, the visualization options will be hidden in discrete mode.
-     *
-     * @default false
-     */
-    hideDiscreteOptions: boolean;
-    /**
-     * If true, the color picker will be hidden in the discrete mode options.
-     *
-     * @default false
-     */
-    hideDiscreteColorPicker: boolean;
-    /**
-     * If true, the interval selector will be hidden in the discrete mode options.
-     *
-     * @default false
-     */
-    hideDiscreteInterval: boolean;
-    /**
-     * If true, the visualization options will be hidden in the total duration mode.
-     *
-     * @default false
-     */
-    hideTotalDurationOptions: boolean;
-    /**
-     * If true, the color picker will be hidden in the total duration mode options.
-     *
-     * @default false
-     */
-    hideTotalDurationColorPicker: boolean;
-    /**
-     * If true, the mode selector will be hidden in the total duration mode options.
-     *
-     * @default false
-     */
-    hideTotalDurationModeSelect: boolean;
-    /**
-     * If true, the visualization options will be hidden in minimum duration mode.
-     *
-     * @default false
-     */
-    hideMinDurationOptions: boolean;
-    /**
-     * If true, the color picker will be hidden in the minimum duration mode options.
-     *
-     * @default false
-     */
-    hideMinDurationColorPicker: boolean;
-    /**
-     * If true, the minimum duration slider will be hidden in the minimum duration mode options.
-     *
-     * @default false
-     */
-    hideMinDurationSlider: boolean;
-    /**
-     * If true, the context options will be hidden in the minimum duration mode options.
-     *
-     * @default false
-     */
-    hideMinDurationContextOptions: boolean;
-    /**
-     * If true, the toggle used to show or hide the context options will be hidden.
-     *
-     * @default false
-     */
-    hideMinDurationContextToggle: boolean;
-    /**
-     * If true, the color picker will be hidden in the context options in minimum duration mode.
-     *
-     * @default false
-     */
-    hideMinDurationContextColorPicker: boolean;
-    /**
-     * If true, the interval selector will be hidden in the context options in minimum duration mode.
-     *
-     * @default false
-     */
-    hideMinDurationContextInterval: boolean;
-    /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     *
-     * @default "measure-building-height-shadow"
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     */
-    icon?: HTMLCalciteIconElement["icon"];
-    /** The component's default label. */
-    label?: string;
-    /**
-     * Mode of analysis to use when computing and displaying the shadows. There are 3 types:
-     * - "discrete" mode displays individual shadows cast at a given time interval.
-     * - "total-duration" displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals.
-     * - "min-duration" only displays areas that receive shadows for a period longer than a given minimum duration.
-     */
-    mode: ShadowCastMode;
-    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
-    position?: __esri.UIPosition;
-    /**
-     * 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.
-     *
-     * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
-     */
-    referenceElement?: ArcgisReferenceElement | string;
-    /**
-     * Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.
-     *
-     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#startTimeOfDay)
-     */
-    startTimeOfDay: number;
-    /**
-     * The component's state. The values mean the following:
-     *
-     * * `disabled` -  component is being created
-     * * `ready` - component is ready
-     */
-    readonly state: "disabled" | "ready";
-    /** The difference in hours between UTC time and the times displayed in the component. */
-    utcOffset: number | null | undefined;
-    /**
-     * Color of the shadow visualization in "discrete" [mode](#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.
-     */
-    discreteColor: import('@arcgis/core/Color').default;
-    /**
-     * Individual shadows are displayed at this time interval in "discrete" [mode](#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.
-     */
-    discreteInterval: number;
-    /**
-     * Color of the shadow visualization in "total-duration" [mode](#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.
-     */
-    totalDurationColor: import('@arcgis/core/Color').default;
-    /**
-     * Mode in which the cumulative shadow duration should be displayed in "total-duration" [mode](#mode): as a continuous
-     * surface or as an hourly aggregation of values.
-     */
-    totalDurationMode: import('@arcgis/core/analysis/ShadowCast/types').ShadowCastTotalDurationMode;
-    /** The minimum duration (in milliseconds) used in "min-duration" [mode](#mode) to determine which shadow areas are displayed. */
-    minDuration: number;
-    /**
-     * Color of the shadow visualization in "min-duration" [mode](#mode). The areas with cumulative shadow time longer than
-     * the minimum duration value are displayed with this color.
-     */
-    minDurationColor: import('@arcgis/core/Color').default;
-    /**
-     * Minimum allowed value for the [minDuration](#minDuration) property, in milliseconds.
-     *
-     * @default 0
-     */
-    minMinDuration: number;
-    /** Maximum allowed value for the [minDuration](#minDuration) property, in milliseconds. */
-    maxMinDuration: number;
-    /**
-     * 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
-     * discrete shadows when context is enabled.
-     *
-     * @default false
-     */
-    minDurationContextEnabled: boolean;
-    /**
-     * The color used when showing additional context in "min-duration" [mode](#mode) when
-     * [minDurationContextEnabled](#contextEnabled) is true.
-     */
-    minDurationContextColor: import('@arcgis/core/Color').default;
-    /**
-     * The interval in milliseconds used when showing additional context in "min-duration" [mode](#mode) when
-     * [minDurationContextEnabled](#contextEnabled) is true.
-     */
-    minDurationContextInterval: number;
-    /** Permanently destroy the component. */
-    destroy(): Promise<void>;
-    /**
-     * 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)
-     *
-     * @param point
-     */
-    getDurationAtScreen(point: __esri.Point): Promise<number>;
-    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
-    readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "state";
-    }>;
-    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
-    readonly arcgisReady: TargetedEvent<this, void>;
-    readonly _setterTypes: {
-        date?: Date | number | string;
-    };
-}
-export {};
+export abstract class ArcgisShadowCast extends LitElement {
+  /**
+   * 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 [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/references/core/views/3d/analysis/ShadowCastAnalysisView3D/)
+   * to be created before accessing the analysis results.
+   *
+   * ```js
+   * // Get the Scene component and the Shadow Cast component, and wait until both are ready.
+   * const viewElement = document.querySelector("arcgis-scene");
+   * await viewElement.viewOnReady();
+   * const shadowCastElement = document.querySelector("arcgis-shadow-cast");
+   * await shadowCastElement.componentOnReady();
+   *
+   * // Get the ShadowCastAnalysis created by the Shadow Cast component.
+   * const analysis = shadowCastElement.analysis;
+   *
+   * // Get the ShadowCastAnalysisView3D.
+   * const analysisView = await viewElement.whenAnalysisView(analysis);
+   *
+   * // Click in the Scene and get the shadow duration in that specific point.
+   * viewElement.addEventListener("arcgisViewClick", async (event) => {
+   *   const screenPoint = { x: event.detail.x, y: event.detail.y };
+   *   const duration = await analysisView.getDurationAtScreen(screenPoint);
+   *   console.log("Shadow duration (minutes):", duration);
+   * });
+   * ```
+   * Whenever the component is destroyed, the analysis is automatically removed from the collection.
+   *
+   * 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.
+   *
+   * ```js
+   * // Create the ShadowCastAnalysis.
+   * const analysis = new ShadowCastAnalysis();
+   *
+   * // Get the Scene component and the Shadow Cast component, and wait until both are ready.
+   * const viewElement = document.querySelector("arcgis-scene");
+   * await viewElement.viewOnReady();
+   * const shadowCastElement = document.querySelector("arcgis-shadow-cast");
+   * await shadowCastElement.componentOnReady();
+   *
+   * // Add the analysis to the analyses collection of the Scene component.
+   * viewElement.analyses.add(analysis);
+   *
+   * // Connect the analysis to the shadow cast component.
+   * shadowCastElement.analysis = analysis;
+   * ```
+   *
+   * @since 5.0
+   */
+  accessor analysis: ShadowCastAnalysis;
+  /**
+   * If true, the component will not be destroyed automatically when it is
+   * disconnected from the document. This is useful when you want to move the
+   * component to a different place on the page, or temporarily hide it. If this
+   * is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   */
+  accessor autoDestroyDisabled: boolean;
+  /**
+   * 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.
+   *
+   * _See also_
+   *
+   * * [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)
+   */
+  get date(): Date;
+  set date(value: Date | number | string);
+  /**
+   * 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](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](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/references/core/analysis/ShadowCastAnalysis/#endTimeOfDay)
+   */
+  accessor endTimeOfDay: number;
+  /**
+   * Indicates the heading level to use for the component title.
+   *
+   * @default 4
+   */
+  accessor headingLevel: HeadingLevel;
+  /**
+   * If true, the date picker will be hidden.
+   *
+   * @default false
+   */
+  accessor hideDatePicker: boolean;
+  /**
+   * 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;
+  /**
+   * If true, the time range slider will be hidden.
+   *
+   * @default false
+   */
+  accessor hideTimeRangeSlider: boolean;
+  /**
+   * If true, the timezone picker will be hidden.
+   *
+   * @default false
+   */
+  accessor hideTimezone: boolean;
+  /**
+   * 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;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "measure-building-height-shadow"
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: Icon["icon"] | undefined;
+  /** The component's default label. */
+  accessor label: string | undefined;
+  /**
+   * 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<{
+      componentLabel: string;
+      dateLabel: string;
+      discrete: {
+          optionLabel: string;
+          colorLabel: string;
+          intervalLabel: string;
+      };
+      minDuration: {
+          optionLabel: string;
+          colorLabel: string;
+          minDurationLabel: string;
+          discreteLabel: string;
+          discreteColorLabel: string;
+      };
+      totalDuration: {
+          optionLabel: string;
+          colorLabel: string;
+          modeLabel: string;
+          continuousLabel: string;
+          hourlyLabel: string;
+      };
+      timeInShadow: string;
+      timeRangeHeading: string;
+      timeRangeSliderLabel: string;
+      timezoneLabel: string;
+      visualizationLabel: string;
+  }> & T9nMeta<{
+      componentLabel: string;
+      dateLabel: string;
+      discrete: {
+          optionLabel: string;
+          colorLabel: string;
+          intervalLabel: string;
+      };
+      minDuration: {
+          optionLabel: string;
+          colorLabel: string;
+          minDurationLabel: string;
+          discreteLabel: string;
+          discreteColorLabel: string;
+      };
+      totalDuration: {
+          optionLabel: string;
+          colorLabel: string;
+          modeLabel: string;
+          continuousLabel: string;
+          hourlyLabel: string;
+      };
+      timeInShadow: string;
+      timeRangeHeading: string;
+      timeRangeSliderLabel: string;
+      timezoneLabel: string;
+      visualizationLabel: string;
+  }>;
+  /**
+   * 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](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](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](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](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](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;
+  /**
+   * Mode of analysis to use when computing and displaying the shadows. There are 3 types:
+   * - "discrete": Displays individual shadow snapshots at regular time intervals within the selected time range.
+   * - "min-duration": Displays shadows only in areas where accumulated shading exceeds a user‑defined minimum duration
+   * 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: 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.
+   *
+   * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+   */
+  accessor referenceElement: ArcgisReferenceElement | string | undefined;
+  /**
+   * 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/references/core/analysis/ShadowCastAnalysis/#startTimeOfDay)
+   */
+  accessor startTimeOfDay: number;
+  /**
+   * The component's state. The values mean the following:
+   *
+   * * `disabled` -  component is being created
+   * * `ready` - component is ready
+   */
+  get state(): "disabled" | "ready";
+  /**
+   * 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](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. */
+  accessor utcOffset: number | null | undefined;
+  /**
+   * The view associated with the component. 
+   *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-shadow-cast component will be associated with a map or scene component rather than using the `view` property.
+   */
+  accessor view: SceneView | undefined;
+  /**
+   * Specifies the size of the component.
+   *
+   * @default "m"
+   * @experimental
+   * @since 5.0
+   */
+  accessor visualScale: "l" | "m" | "s";
+  /** Permanently destroy the component. */
+  destroy(): Promise<void>;
+  /**
+   * Returns the time (in milliseconds) spent in shadow for a certain point on the screen.
+   *
+   * [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": {
+    date?: Date | number | string;
+  };
+  /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
+  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "state"; }>;
+  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
+  readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly "@eventTypes": {
+    arcgisPropertyChange: ArcgisShadowCast["arcgisPropertyChange"]["detail"];
+    arcgisReady: ArcgisShadowCast["arcgisReady"]["detail"];
+  };
+}