@arcgis/map-components 5.0.0-next.12 → 5.0.0-next.120

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

@@ -1,31 +1,13 @@
 /// <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 { default as ShadowCast } from '@arcgis/core/widgets/ShadowCast.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+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';
 
-declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, "label" | "viewModel" | "icon" | "headingLevel"> & {
-    state?: unknown;
-    viewModel?: __esri.ShadowCastViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/toolkit/type').nil | string;
-    label: import('@arcgis/toolkit/type').nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    position?: __esri.UIPosition;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | nullish;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => ShadowCast;
+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/).
  * This type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.
@@ -38,9 +20,9 @@ declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, "la
  * 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.
  *
- * The component provides three [visualization modes](#visualizationType): threshold, duration, and discrete mode.
+ * The component provides three [modes](#mode): minimum duration, total duration, and discrete mode.
  *
- * In the **threshold** mode, only the areas that receive
+ * 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.
  *
@@ -54,13 +36,14 @@ declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, "la
  *
  * [![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/)
  *
- * **Discrete shadows** is a third visualization mode which displays individual shadows at a given time interval.
- * For example, setting the time range to 10AM-11AM and the visualization time interval to 30 minutes will display
+ * **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 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/)
  *
- * The defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay), [endTimeOfDay](#endTimeOfDay), and [visualizationType](#visualizationType) properties.
+ * The defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay),
+ * [endTimeOfDay](#endTimeOfDay), and [mode](#mode) properties.
  *
  * **Known limitations**
  *
@@ -81,11 +64,40 @@ declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, "la
  * @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 ArcgisShadowCast component will be associated with a map or scene component rather than using the `view` property.
+     *   > **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?: __esri.SceneView | nullish;
+    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
@@ -107,65 +119,148 @@ export declare class ArcgisShadowCast extends LitElement {
     get date(): Date;
     set date(value: Date | number | string);
     /**
-     * The configuration used when the component's [visualizationType](#visualizationType)
-     * is set to "discrete".
+     * 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-widgets-ShadowCast-DiscreteOptions.html)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#endTimeOfDay)
      */
-    discreteOptions: __esri.DiscreteOptions;
+    endTimeOfDay: number;
     /**
-     * The configuration used when the component's [visualizationType](#visualizationType)
-     * is set to "duration".
+     * Indicates the heading level to use for the component title.
      *
-     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DurationOptions.html)
+     * @default 4
      */
-    durationOptions: __esri.DurationOptions;
+    headingLevel: HeadingLevel;
     /**
-     * Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.
+     * If true, the time range slider will be hidden.
      *
-     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)
+     * @default false
+     */
+    hideTimeRangeSlider: boolean;
+    /**
+     * If true, the timezone picker will be hidden.
      *
-     * @default 16 * 3600 * 1000
+     * @default false
      */
-    endTimeOfDay: number;
+    hideTimezone: boolean;
     /**
-     * Indicates the heading level to use for the titles "Time range" and "Visualization".
+     * If true, the date picker will be hidden.
      *
-     * @default 4
+     * @default false
      */
-    headingLevel: number;
-    /** @default false */
-    hideColorPicker: boolean;
-    /** @default false */
     hideDatePicker: boolean;
-    /** @default false */
-    hideTimeRangeSlider: boolean;
-    /** @default false */
-    hideTimezone: boolean;
-    /** @default false */
-    hideTooltip: boolean;
-    /** @default false */
+    /**
+     * If true, the tooltip which displays the amount of shadow at a certain location will be hidden.
+     *
+     * @default false
+     */
+    hideShadowDurationTooltip: boolean;
+    /**
+     * Indicates whether the component's visualization is hidden in the view.
+     *
+     * @default false
+     */
+    hideVisualization: boolean;
+    /**
+     * If true, the visualization options will be hidden.
+     *
+     * @default false
+     */
     hideVisualizationOptions: boolean;
-    /** @default false */
-    hideThresholdContext: boolean;
-    /** @default false */
-    hideThresholdContextColor: boolean;
-    /** @default false */
-    hideThresholdContextTimeInterval: boolean;
-    /** @default false */
-    hideThresholdContextToggle: 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).
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      * @default "measure-building-height-shadow"
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    icon: string;
+    icon?: HTMLCalciteIconElement["icon"];
     /** The component's default label. */
-    label: string;
-    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead. */
-    position?: __esri.UIPosition;
+    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;
     /**
      * 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.
      *
@@ -175,9 +270,7 @@ export declare class ArcgisShadowCast extends LitElement {
     /**
      * 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-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)
-     *
-     * @default 10 * 3600 * 1000
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#startTimeOfDay)
      */
     startTimeOfDay: number;
     /**
@@ -185,40 +278,77 @@ export declare class ArcgisShadowCast extends LitElement {
      *
      * * `disabled` -  component is being created
      * * `ready` - component is ready
-     *
-     * @default "disabled"
      */
-    readonly state: "ready" | "disabled";
+    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;
     /**
-     * The configuration used when the component's [visualizationType](#visualizationType)
-     * is set to "threshold".
+     * 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.
      *
-     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ThresholdOptions.html)
+     * @default 0
      */
-    thresholdOptions: __esri.ThresholdOptions;
-    /** The difference in hours between UTC time and the times displayed in the component. */
-    utcOffset: number;
+    minMinDuration: number;
+    /** Maximum allowed value for the [minDuration](#minDuration) property, in milliseconds. */
+    maxMinDuration: number;
     /**
-     * Type of visualization to use when showing the shadows. There are 3 types of visualization:
-     * * `threshold` - only displays areas that receive shadows for a period longer than a given threshold value
-     * * `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals
-     * * `discrete` - displays individual shadows cast at a given time interval
+     * 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 "threshold"
+     * @default false
+     */
+    minDurationContextEnabled: boolean;
+    /**
+     * The color used when showing additional context in "min-duration" [mode](#mode) when
+     * [minDurationContextEnabled](#contextEnabled) is true.
      */
-    visualizationType: "duration" | "discrete" | "threshold";
+    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-widgets-ShadowCast-ShadowCastViewModel.html#getDuration)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ShadowCast-ShadowCastAnalysisView3D.html#getDurationAtScreen)
+     *
+     * @param point
      */
-    getDuration(point: __esri.Point): Promise<number>;
-    /** Starts the component. While running, it will automatically perform shadow accumulation. */
-    start(): Promise<void>;
-    /** Stops the component. */
-    stop(): Promise<void>;
+    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";
@@ -228,5 +358,9 @@ export declare class ArcgisShadowCast extends LitElement {
     readonly _setterTypes: {
         date?: Date | number | string;
     };
+    "@eventTypes": {
+        "arcgisPropertyChange": ArcgisShadowCast["arcgisPropertyChange"]["detail"];
+        "arcgisReady": ArcgisShadowCast["arcgisReady"]["detail"];
+    };
 }
 export {};