@arcgis/map-components 4.34.0-next.16 → 4.34.0-next.160

package/dist/components/arcgis-daylight/customElement.d.ts

@@ -1,37 +1,95 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-/// <reference types="../../index.d.ts" />
+/// <reference path="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { default as Daylight } from '@arcgis/core/widgets/Daylight.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { PublicLitElement as LitElement, JsxNode, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { HeadingLevel } from '../../support/heading';
+import { Season } from './daylight-utils';
+import { useView } from '../../controllers/useView';
+import { default as SceneView } from '@arcgis/core/views/SceneView';
+import { default as LinkChartView } from '@arcgis/core/views/LinkChartView';
+import { default as MapView } from '@arcgis/core/views/MapView';
+import { PropertyValues } from 'lit';
 
-declare const useDaylightWidget: (component: LitElement & Pick<Daylight, "icon" | "label" | "viewModel" | "headingLevel" | "dateOrSeason" | "playSpeedMultiplier" | "timeSliderSteps"> & {
-    state?: unknown;
-    viewModel?: __esri.DaylightViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/components-utils').Nil | string;
-    label: import('@arcgis/components-utils').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;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => Daylight;
+type ActivePlayingState = "day" | "year";
+type PlayingState = ActivePlayingState | "none";
 /**
- * The Daylight component can be used to manipulate the lighting conditions of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ * The Daylight component can be used to manipulate the lighting conditions of a
+ * [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).
+ * For this, the component modifies the `lighting` property of the
+ * [environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) of the Scene component.
+ *
+ * To illuminate the scene, one can either use a configuration of date and time to position the
+ * [sun](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) or switch to the
+ * [virtual mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html) mode,
+ * where the light source is relative to the camera.
+ *
+ * When **lighting the scene with the sun** and adjusting the time and date, the position of the sun
+ * and the stars get updated accordingly, changing the light and the shadows in the scene. This sets the `date` and `directShadowsEnabled` properties of
+ * [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).
+ *
+ * [![daylight-default](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-default.png)](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)
+ *
+ * The component has an option to select the timezone. When the user makes any adjustments here, a new time
+ * in the chosen timezone is calculated and displayed in the slider. The timezone selector can be disabled
+ * by using `hide-timezone` attribute or setting `hideTimezone` property to `true`.
+ *
+ * By default, a calendar is displayed where the user can select the day, month and year.
+ * With the [dateOrSeason](#dateOrSeason) property, the calendar can be replaced with
+ * a dropdown menu where a season can be selected instead:
+ *
+ * ![daylight-seasons](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-seasons.png)
+ *
+ * There are two play buttons, one corresponds to the daytime slider and it animates the time as
+ * it cycles through the minutes of the day. The second button corresponds to the date picker
+ * and it animates the time as it cycles through the months of the year. The speed of the animation can
+ * be set using the [playSpeedMultiplier](#playSpeedMultiplier) property.
+ *
+ * ![daylight-animation](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-animation.gif)
+ *
+ * Except for the daytime slider, all the elements in the Daylight component can be hidden:
+ *
+ * ![daylight-no-elements](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-no-elements.png)
+ *
+ * Whenever the sun position option is unchecked, the scene applies the **virtual light source** relative to the camera.
+ * With this, the component's time slider, timezone and date picker get automatically disabled:
+ *
+ * ![daylight-virtual](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-virtual.png)
+ *
+ * **Things to consider**
+ *
+ * * Daylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ * * The Daylight component uses UTC time and does not account for the daylight savings times in different countries and regions of the world.
+ * * When the [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)
+ * is of the type `virtual`, setting the time and date does not have an influence on the lighting conditions of the scene.
+ *
+ * **See also**
+ *
+ * - [Environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)
+ * - [SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)
+ * - [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)
+ * - [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/)
+ *
+ * @since 4.28
  */
 export declare class ArcgisDaylight extends LitElement {
+    view?: LinkChartView | MapView | SceneView;
+    get playingState(): PlayingState;
+    set playingState(value: PlayingState);
+    /** @default false */
+    get supported(): boolean;
+    /**
+     * When set, the light source is positioned relative to the camera, using
+     * [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html).
+     * Otherwise, [date and time](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)
+     * are used to determine position of the light source.
+     *
+     * @default false
+     */
+    get sunlightingDisabled(): boolean;
+    set sunlightingDisabled(disabled: boolean);
     /**
      * 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
@@ -43,90 +101,138 @@ export declare class ArcgisDaylight extends LitElement {
      */
     autoDestroyDisabled: boolean;
     /**
-     * A season can be set instead of a date.
+     * Sets the season that is used when the component displays a season picker.
+     * Each season uses a fixed date corresponding to the seasonal equinoxes and solstices.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#currentSeason)
+     * **See also**
+     *
+     * [dateOrSeason](#dateOrSeason)
      */
-    currentSeason: "spring" | "summer" | "fall" | "winter";
+    get currentSeason(): Season;
+    set currentSeason(season: Season);
     /**
-     * Controls whether the widget displays a date or a season picker.
+     * Controls whether the component displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed date corresponding to the equinoxes and solstices of 2014.
      *
      * @default "date"
      */
     dateOrSeason: "date" | "season";
     /**
      * Starts or pauses the daytime animation cycling through the minutes of the day.
+     * Set the property to `true` to start the animation and to `false` to pause it.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#dayPlaying)
+     * @default false
+     */
+    get dayPlaying(): boolean;
+    set dayPlaying(playing: boolean);
+    /**
+     * Indicates whether to hide shadows cast by the sun.
+     *
+     * **See also**
+     *
+     * - [SunLighting.directShadowsEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#directShadowsEnabled)
+     * - [Scene's `environment`](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)
      *
      * @default false
      */
-    dayPlaying: boolean;
+    get directShadowsDisabled(): boolean;
+    set directShadowsDisabled(disabled: boolean);
     /**
-     * Indicates the heading level to use for the widget title.
+     * Indicates the heading level to use for the component title.
      *
-     * @default 3
+     * @default 2
      */
-    headingLevel: number;
+    headingLevel: HeadingLevel;
     /** @default false */
-    hideDatePicker: boolean | undefined;
+    hideDatePicker: boolean;
     /** @default false */
-    hideHeader: boolean | undefined;
+    hideHeader: boolean;
     /** @default false */
-    hidePlayButtons: boolean | undefined;
+    hidePlayButtons: boolean;
     /** @default false */
-    hideShadowsToggle: boolean | undefined;
+    hideShadowsToggle: boolean;
     /** @default false */
-    hideSunLightingToggle: boolean | undefined;
+    hideSunLightingToggle: boolean;
     /** @default false */
-    hideTimezone: boolean | undefined;
+    hideTimezone: boolean;
     /**
-     * Icon which represents the widget.
+     * Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
+     *
+     * See also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      * @default "brightness"
      */
-    icon: string;
+    icon?: HTMLCalciteIconElement["icon"];
+    /** The component's default label. */
+    label?: string;
     /**
-     * The widget's default label.
+     * Controls the daytime and date animation speed.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#label)
+     * @example
+     * // Plays the daylight animation at half of the default speed
+     * daylight.playSpeedMultiplier = 0.5;
+     * @default 1.0
      */
-    label: string;
+    playSpeedMultiplier: number;
+    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
+    position?: __esri.UIPosition;
     /**
-     * Controls the speed of the daytime and date animation.
+     * 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.
      *
-     * @default 1.0
+     * @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)
      */
-    playSpeedMultiplier: number;
-    /** @default "bottom-left" */
-    position: __esri.UIPosition;
     referenceElement?: ArcgisReferenceElement | string;
     /**
-     * Sets steps, or intervals, on the time slider to restrict the times
-     * of the day that can be selected when dragging the thumb.
+     * Sets the interval, in minutes, with which the time slider increments or decrements as it is dragged or changed via the keyboard.
+     *
+     * For example, if set to 60, the slider will allow selecting each hour of the day.
      *
      * @default 5
      */
-    timeSliderSteps: number | number[];
+    timeSliderSteps: number;
+    /** The difference in hours between UTC time and the time displayed in the component. */
+    get utcOffset(): nullish | number;
+    set utcOffset(value: nullish | number);
     /**
-     * Starts or pauses the date animation cycling through the months of the year.
+     * Slider position for the time of day in the timezone
+     * given by [utcOffset](#utcOffset). The position represents the time
+     * of the day in minutes. Possible values range between 0 and 1440.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#yearPlaying)
+     * @example
+     * viewElement.environment.lighting = new SunLighting({
+     *   date: new Date("2022-06-21T12:00:00")
+     * });
+     */
+    get timeSliderPosition(): nullish | number;
+    set timeSliderPosition(value: nullish | number);
+    /** The calendar date in the timezone given by [utcOffset](#utcOffset). */
+    get localDate(): Date;
+    set localDate(value: Date | number | string);
+    /**
+     * Starts or pauses the date animation cycling through the months of the year.
+     * Set the property to `true` to start the animation and to `false` to pause it.
      *
      * @default false
      */
-    yearPlaying: boolean;
+    get yearPlaying(): boolean;
+    set yearPlaying(playing: boolean);
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
-    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
     /**
-     * Fires when the user changes the date or time in the widget by interacting with the slider, the date picker, the
+     * Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the
      * season selector or the play buttons.
      *
      * @since 4.33
      */
     readonly arcgisUserDateTimeChange: TargetedEvent<this, void>;
+    readonly _setterTypes: {
+        localDate?: Date | number | string;
+    };
+}
+export interface LocaleParts {
+    language: string;
+    extlang?: string;
+    region?: string;
 }
 export {};