@arcgis/map-components 4.34.0-next.165 → 4.34.0-next.166

package/dist/components/arcgis-coordinate-conversion/customElement.js

@@ -14,7 +14,7 @@ import L from "@arcgis/core/widgets/CoordinateConversion/CoordinateConversionVie
 import { g as C } from "../../chunks/globalCss.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.165 */
+v4.34.0-next.166 */
 const a = "arcgis-coordinate-conversion", r = {
   base: a,
   expandUp: `${a}__conversions-view--expand-up`,

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

@@ -7,42 +7,39 @@ 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';
 
-type ActivePlayingState = "day" | "year";
-type PlayingState = ActivePlayingState | "none";
 /**
  * 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
+ * To achieve 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,
+ * [virtual](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
+ * When illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)**
+ * and adjusting the time and date, the positions of the sun and stars are updated accordingly. This also updates the
+ * [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#date) property 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 using the [hideTimezone](#hideTimezone) property.
  *
- * By default, a calendar is displayed where the user can select the day, month and year.
+ * By default, a calendar is displayed to 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
+ * There are two play buttons: one corresponds to the time-of-day slider and animates the lighting
+ * over the course of a day, while the other corresponds to the date picker
+ * and animates the lighting over the course of a year (month by month). 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)
@@ -51,8 +48,9 @@ type PlayingState = ActivePlayingState | "none";
  *
  * ![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:
+ * Whenever the sun position option is unchecked, the scene applies the
+ * **[virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)** 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)
  *
@@ -60,41 +58,29 @@ type PlayingState = ActivePlayingState | "none";
  *
  * * 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/)
+ * * When using the [virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html),
+ * setting the time and date programmatically does not have an influence on the lighting conditions of the scene.
+ * * When using the [sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html),
+ * the time slider and time zone automatically react to the changes of the camera (e.g., position, rotation, pan, zoom) because the position of the simulated sun
+ * is updated to maintain a consistent solar time of day based on the camera's current longitude. This can be adjusted using the
+ * [cameraTrackingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled)
+ * property on [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/)
  *
+ * @see [Environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)
+ * @see [SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)
+ * @see [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)
+ * @see [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)
  * @since 4.28
  */
 export declare class ArcgisDaylight extends LitElement {
-    view?: LinkChartView | MapView | SceneView;
-    /** @since 4.34 */
-    get playingState(): PlayingState;
-    set playingState(value: PlayingState);
+    view?: SceneView;
     /**
      * @since 4.34
      * @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.
-     *
-     * @since 4.34
-     * @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
@@ -106,12 +92,10 @@ export declare class ArcgisDaylight extends LitElement {
      */
     autoDestroyDisabled: boolean;
     /**
-     * Sets the season that is used when the component displays a season picker.
+     * Sets the season that is used when the component displays the season picker.
      * Each season uses a fixed date corresponding to the seasonal equinoxes and solstices.
      *
-     * **See also**
-     *
-     * [dateOrSeason](#dateOrSeason)
+     * @see [dateOrSeason](#dateOrSeason)
      */
     get currentSeason(): Season;
     set currentSeason(season: Season);
@@ -129,19 +113,6 @@ export declare class ArcgisDaylight extends LitElement {
      */
     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)
-     *
-     * @since 4.34
-     * @default false
-     */
-    get directShadowsDisabled(): boolean;
-    set directShadowsDisabled(disabled: boolean);
     /**
      * Indicates the heading level to use for the component title.
      *
@@ -163,8 +134,7 @@ export declare class ArcgisDaylight extends LitElement {
     /**
      * 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?: HTMLCalciteIconElement["icon"];
@@ -174,8 +144,10 @@ export declare class ArcgisDaylight extends LitElement {
      * Controls the daytime and date animation speed.
      *
      * @example
+     * ```js
      * // Plays the daylight animation at half of the default speed
      * daylight.playSpeedMultiplier = 0.5;
+     * ```
      * @default 1.0
      */
     playSpeedMultiplier: number;
@@ -190,14 +162,28 @@ export declare class ArcgisDaylight extends LitElement {
     /**
      * 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.
-     *
+     * @example
+     * ```js
+     * // Set steps at an interval of 60. Then, the slider thumb snaps at each hour of the day.
+     * daylight.timeSliderSteps = 60;
+     * ```
      * @default 5
      */
-    timeSliderSteps: number;
+    timeSliderSteps: number[] | number;
     /**
      * The difference in hours between UTC time and the time displayed in the component.
      *
+     * @example
+     * ```js
+     * daylight.utcOffset = -8;
+     * ```
+     * @example
+     * ```js
+     * // Alternatively, the UTC offset can be set by configuring the `displayUTCOffset` property of `SunLighting`.
+     * viewElement.environment.lighting = new SunLighting({
+     *   displayUTCOffset: -8
+     * });
+     * ```
      * @since 4.34
      */
     get utcOffset(): nullish | number;
@@ -208,9 +194,18 @@ export declare class ArcgisDaylight extends LitElement {
      * of the day in minutes. Possible values range between 0 and 1440.
      *
      * @example
+     * ```js
+     * // Set the time to 4:00 PM (16:00) in the given timezone.
+     * daylight.timeSliderPosition = 16 * 60;
+     * ```
+     * @example
+     * ```js
+     * // Alternatively, the time can be set by configuring the `date` property of `SunLighting`.
+     * // Then, the time slider gets updated automatically.
      * viewElement.environment.lighting = new SunLighting({
-     *   date: new Date("2022-06-21T12:00:00")
+     *   date: new Date("2005-08-25T16:00:00")
      * });
+     * ```
      * @since 4.34
      */
     get timeSliderPosition(): nullish | number;
@@ -218,6 +213,17 @@ export declare class ArcgisDaylight extends LitElement {
     /**
      * The calendar date in the timezone given by [utcOffset](#utcOffset).
      *
+     * @example
+     * ```js
+     * daylight.localDate = new Date("2005-08-25");
+     * ```
+     * @example
+     * ```js
+     * // Alternatively, the date can be set by configuring the `date` property of `SunLighting`.
+     * viewElement.environment.lighting = new SunLighting({
+     *   date: new Date("2005-08-25T16:00:00")
+     * });
+     * ```
      * @since 4.34
      */
     get localDate(): Date;
@@ -250,4 +256,3 @@ export interface LocaleParts {
     extlang?: string;
     region?: string;
 }
-export {};