@arcgis/map-components 4.34.0-next.133 → 4.34.0-next.135

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

@@ -9,6 +9,7 @@ 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";
@@ -33,40 +34,156 @@ export declare class ArcgisDaylight extends LitElement {
     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
+     * 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-daylight/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
     autoDestroyDisabled: boolean;
+    /**
+     * A season can be set instead of a date.
+     * Each season uses a fixed date corresponding to the seasonal equinoxes and solstices.
+     */
     get currentSeason(): Season;
     set currentSeason(season: Season);
+    /**
+     * 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.
+     * Set to `true` to start the animation and to `false` to pause it.
+     *
+     * @default false
+     */
     get dayPlaying(): boolean;
     set dayPlaying(playing: boolean);
-    get localDate(): Date;
-    set localDate(value: Date);
-    get directShadowsEnabled(): boolean;
-    set directShadowsEnabled(enabled: boolean);
+    /** @default false */
+    get directShadowsDisabled(): boolean;
+    set directShadowsDisabled(disabled: boolean);
+    /**
+     * Indicates the heading level to use for the component title.
+     *
+     * @default 2
+     */
     headingLevel: HeadingLevel;
+    /** @default false */
     hideDatePicker: boolean;
+    /** @default false */
     hideHeader: boolean;
+    /** @default false */
     hidePlayButtons: boolean;
+    /** @default false */
     hideShadowsToggle: boolean;
+    /** @default false */
     hideSunLightingToggle: boolean;
+    /** @default false */
     hideTimezone: boolean;
+    /**
+     * 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/)
+     *
+     * @default "brightness"
+     */
     icon?: HTMLCalciteIconElement["icon"];
+    /** The component's default label. */
     label?: string;
+    /**
+     * Controls the daytime and date animation speed.
+     *
+     * @example
+     * // Plays the daylight animation at half of the default speed
+     * daylightWidget.playSpeedMultiplier = 0.5;
+     * @default 1.0
+     */
     playSpeedMultiplier: number;
+    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) 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;
+    /**
+     * 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;
-    get timeSliderPosition(): number;
-    set timeSliderPosition(value: number);
-    get utcOffset(): number;
-    set utcOffset(value: number);
+    /** The difference in hours between UTC time and the time displayed in the widget. */
+    get utcOffset(): nullish | number;
+    set utcOffset(value: nullish | number);
+    /**
+     * 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.
+     *
+     * 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
+     */
     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 ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
+    /**
+     * 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 {};