@arcgis/map-components 4.34.0-next.3 → 4.34.0-next.31

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

@@ -8,7 +8,47 @@ import { WeatherViewModel } from './WeatherViewModel.js';
 
 declare const useViewModel: (component: LitElement & Pick<WeatherViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<WeatherViewModel>) => WeatherViewModel;
 /**
- * The Weather component provides an interface for easily selecting and configuring the weather effects in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ * The Weather component allows easy selection and configuration of weather effects in a
+ * [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ * The available weather types are:
+ * [sunny](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html),
+ * [cloudy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html),
+ * [rainy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html),
+ * [snowy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html), and
+ * [foggy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html).
+ *
+ * To set the weather programmatically, apply the desired weather type to the
+ * [environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) property of the Scene component.
+ *
+ * ```js
+ * // Access the Scene component.
+ * const viewElement = document.querySelector("arcgis-scene");
+ * await viewElement.viewOnReady();
+ * // Specify the weather settings.
+ * viewElement.environment.weather = {
+ *    type: "rainy", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })
+ *    cloudCover: 0.7,
+ *    precipitation: 0.3
+ * };
+ * ```
+ *
+ * To determine if the weather visualization is available, check the boolean value of `viewElement.environment.weatherAvailable`. The weather is only available:
+ *    * in `global` [viewing mode](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode),
+ *    * when `atmosphereEnabled` property on [environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) is `true`,
+ *    * at lower altitudes, near the ground.
+ *
+ * **Known limitations**
+ *
+ * Weather is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ *
+ * **See also**
+ *
+ * - [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)
+ * - [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)
+ * - [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)
+ * - [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)
+ * - [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)
+ * - [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-weather/)
  */
@@ -54,13 +94,22 @@ export declare class ArcgisWeather extends LitElement {
      * @default "Weather"
      */
     label: string | undefined;
-    /** Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases. */
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
     messageOverrides?: typeof this.messages._overrides;
     /** @default "bottom-left" */
     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;
     /** The current state of the component. */
-    state: "ready" | "disabled" | "error";
+    readonly state: "ready" | "disabled" | "error";
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */

package/dist/components/arcgis-weather/customElement.js

@@ -18,7 +18,7 @@ import $ from "@arcgis/core/views/3d/environment/SnowyWeather.js";
 import C from "@arcgis/core/views/3d/environment/SunnyWeather.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.3 */
+v4.34.0-next.31 */
 const c = "arcgis-weather", d = {
   base: c,
   content: `${c}__content`,
@@ -172,7 +172,7 @@ class q extends x {
     super(...arguments), this.viewModel = F(this), this.messages = E(), this.autoDestroyDisabled = !1, this.headingLevel = 4, this.hideHeader = !1, this.icon = "partly-cloudy", this.label = this.messages.componentLabel, this.position = "bottom-left", this.state = this.viewModel.state, this.arcgisPropertyChange = W()("state"), this.arcgisReady = S();
   }
   static {
-    this.properties = { autoDestroyDisabled: 5, headingLevel: 9, hideHeader: 5, icon: 1, label: 1, messageOverrides: 0, position: 1, referenceElement: 1, state: 3 };
+    this.properties = { autoDestroyDisabled: 5, headingLevel: 9, hideHeader: 5, icon: 1, label: 1, messageOverrides: 0, position: 1, referenceElement: 1, state: 35 };
   }
   static {
     this.shadowRootOptions = B;

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

@@ -39,10 +39,19 @@ export declare class ArcgisZoom extends LitElement {
      * @default "vertical"
      */
     layout: Layout;
-    /** Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases. */
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
     messageOverrides?: typeof this.messages._overrides;
     /** @default "top-left" */
     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;
     /**
      * The current state of the component.

package/dist/components/arcgis-zoom/customElement.js

@@ -10,7 +10,7 @@ import { u as O } from "../../chunks/useView.js";
 import { css as Z } from "@lit/reactive-element/css-tag.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.3 */
+v4.34.0-next.31 */
 const a = {
   base: "arcgis-zoom",
   horizontalLayout: "arcgis-zoom--horizontal",

package/dist/controllers/Handles.d.ts

@@ -1,7 +1,7 @@
 import { IHandle, Nil } from '@arcgis/components-utils';
 export declare class Handles<T = string, H extends IHandle = IHandle> {
     /**
-     * A handle to a [highlight](https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight) call result.
+     * A handle to a [highlight](https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight) call result.
      * The handle can be used to remove the installed highlight.
      *
      * @typedef module:esri/core/Handles~Handle
@@ -36,7 +36,7 @@ export declare class Handles<T = string, H extends IHandle = IHandle> {
      * @param {module:esri/core/Accessor~WatchHandle | module:esri/core/Accessor~WatchHandle[] | module:esri/core/Collection<module:esri/core/Accessor~WatchHandle>} handles - An array or collection handles to group.
      * @param {*} [groupKey]
      *    Key identifying the group to which the handles should be added. All the handles in the group
-     *    can later be removed with [Handles.remove()](https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#remove). If no
+     *    can later be removed with [Handles.remove()](https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-core-Handles.html#remove). If no
      *    key is provided the handles are added to a default group.
      *
      * @example

package/dist/controllers/useHandles.d.ts

@@ -40,7 +40,7 @@ declare class HandleManager extends Controller {
      *    Handles marked for removal once the object is destroyed.
      * @param {*} [groupKey]
      *    Key identifying the group to which the handles should be added. All the handles in the group
-     *    can later be removed with [Accessor.removeHandles()](https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#removeHandles).
+     *    can later be removed with [Accessor.removeHandles()](https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#removeHandles).
      *    If no key is provided the handles are added to a default group.
      */
     addHandles<T>(handleOrHandles: SafeHandle | SafeHandle[], groupKey?: GroupKey<T>): void;
@@ -85,9 +85,9 @@ declare class HandleManager extends Controller {
 }
 /**
  * useHandles() implements the following methods from JS API's Accessor class:
- * addHandles - https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#addHandles
- * hasHandles - https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#hasHandles
- * removeHandles - https://next.sites.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#removeHandles
+ * addHandles - https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#addHandles
+ * hasHandles - https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#hasHandles
+ * removeHandles - https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#removeHandles
  * removeAllHandles - (hidden from the JS API's JSDoc)
  *
  * Except, to adapt these to web-components, you have an option of picking