@arcgis/map-components 4.34.0-next.14 → 4.34.0-next.141

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

@@ -1,37 +1,49 @@
 /// <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 { LightingUnion, 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/).
+ *
+ * **Known limitations**
+ *
+ * Daylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ *
+ * **See also**
+ *
+ * - [Environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)
+ * - [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);
+    get lighting(): LightingUnion | nullish;
+    /** @default false */
+    get supported(): boolean;
+    /**
+     * Indicates whether date and time are used to determine position of the light source.
+     * When `false`, 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).
+     *
+     * @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
@@ -44,89 +56,134 @@ export declare class ArcgisDaylight extends LitElement {
     autoDestroyDisabled: boolean;
     /**
      * A season can be set instead of a date.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#currentSeason)
+     * Each season uses a fixed date corresponding to the seasonal equinoxes and solstices.
      */
-    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.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)
      *
      * @default "date"
      */
     dateOrSeason: "date" | "season";
     /**
      * Starts or pauses the daytime animation cycling through the minutes of the day.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#dayPlaying)
+     * Set to `true` to start the animation and to `false` to pause it.
      *
      * @default false
      */
-    dayPlaying: boolean;
+    get dayPlaying(): boolean;
+    set dayPlaying(playing: boolean);
+    /** @default false */
+    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
+     * daylightWidget.playSpeedMultiplier = 0.5;
+     * @default 1.0
      */
-    label: string;
+    playSpeedMultiplier: number;
+    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) 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 steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.
+     * Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb. All values are in minutes, where 0 is midnight and 23 * 60 + 59 is just before midnight the following day.
+     *
+     * If an array of numbers is passed to this property, the slider thumbs may only be moved to the times specified in the array.
+     *
+     * If a single number is set, then steps are set for the entire day at an interval of timeSliderSteps minutes. For example, if a value of 60 is set here, dragging the slider will allow selecting each of 24 hours of the day.
      *
      * @default 5
      */
-    timeSliderSteps: number | number[];
+    timeSliderSteps: number;
+    /** The difference in hours between UTC time and the time displayed in the widget. */
+    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)
+     * This property should only be set once the widget and the view are initialized, for example,
+     * from within an event handler. To initialize the view with a specific date and time, set a
+     * [SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) on the [SceneView.environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment).
+     *
+     * @example
+     * view.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).
+     *
+     * This property should only be set once the widget and the view are initialized, for example,
+     * from within an event handler. To initialize the view with a specific date and time, set a
+     * [SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) on the [SceneView.environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment).
+     */
+    get localDate(): Date;
+    set localDate(value: Date | number | string);
+    /**
+     * Starts or pauses the date animation cycling through the months of the year. Set 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 {};