@arcgis/map-components 5.0.0-next.3 → 5.0.0-next.30

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

@@ -1,17 +1,18 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
-import { default as Collection } from '@arcgis/core/core/Collection.js';
 import { default as MapView } from '@arcgis/core/views/MapView.js';
 import { default as WebMap } from '@arcgis/core/WebMap.js';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { Use } from '@arcgis/lumina/controllers';
 import { nil } from '@arcgis/toolkit/type';
+import { default as Collection } from '@arcgis/core/core/Collection.js';
+import { LoadErrorSource } from '../../controllers/useArcgisLoadError';
 
-declare const useWebMap: (component: LitElement & Omit<Pick<WebMap, "basemap" | "focusAreas" | "ground" | "ipsInfo" | "layers" | "presentation" | "tables" | "widgets" | "applicationProperties" | "authoringApp" | "authoringAppVersion" | "bookmarks" | "floorInfo" | "geotriggersInfo" | "initialViewProperties" | "portalItem" | "thumbnailUrl" | "utilityNetworks">, ("destroyed" | "initialized" | "declaredClass" | "set" | "watch" | "addHandles" | "removeHandles" | "hasHandles") | "basemap" | "ground" | "layers" | "presentation" | "tables" | "widgets" | "applicationProperties" | "authoringApp" | "authoringAppVersion" | "bookmarks" | "floorInfo" | "geotriggersInfo" | "initialViewProperties" | "portalItem" | "thumbnailUrl" | "utilityNetworks"> & {
+declare const useWebMap: (component: LitElement & Omit<Pick<WebMap, "basemap" | "focusAreas" | "ground" | "ipsInfo" | "layers" | "presentation" | "tables" | "widgets" | "applicationProperties" | "authoringApp" | "authoringAppVersion" | "bookmarks" | "floorInfo" | "geotriggersInfo" | "initialViewProperties" | "portalItem" | "thumbnailUrl" | "utilityNetworks">, "basemap" | "ground" | ("destroyed" | "initialized" | "declaredClass" | "set" | "watch" | "addHandles" | "removeHandles" | "hasHandles") | "layers" | "presentation" | "tables" | "widgets" | "applicationProperties" | "authoringApp" | "authoringAppVersion" | "bookmarks" | "floorInfo" | "geotriggersInfo" | "initialViewProperties" | "portalItem" | "thumbnailUrl" | "utilityNetworks"> & {
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
 }) => WebMap;
-declare const useMapView: (component: LitElement & Omit<Pick<MapView, "map" | "analyses" | "background" | "basemapView" | "center" | "constraints" | "extent" | "fatalError" | "graphics" | "highlights" | "highlightOptions" | "navigation" | "padding" | "popup" | "resizeAlign" | "rotation" | "scale" | "spatialReference" | "theme" | "timeExtent" | "timeZone" | "viewpoint" | "zoom" | "floors" | "spatialReferenceLocked" | "breakpoints" | "heightBreakpoint" | "popupEnabled" | "widthBreakpoint" | "container" | "ui" | "animation" | "displayFilterEnabled">, ("destroyed" | "initialized" | "declaredClass" | "set" | "watch" | "addHandles" | "removeHandles" | "hasHandles") | "breakpoints" | "heightBreakpoint" | "popupEnabled" | "widthBreakpoint" | "container" | "ui" | "animation" | "displayFilterEnabled"> & {
+declare const useMapView: (component: LitElement & Omit<Pick<MapView, "rotation" | "center" | "map" | "aria" | "analyses" | "background" | "basemapView" | "constraints" | "extent" | "fatalError" | "floors" | "graphics" | "highlights" | "highlightOptions" | "navigation" | "padding" | "popup" | "resizeAlign" | "scale" | "spatialReference" | "spatialReferenceLocked" | "theme" | "timeExtent" | "timeZone" | "viewpoint" | "zoom" | "ui" | "breakpoints" | "heightBreakpoint" | "popupEnabled" | "widthBreakpoint" | "animationsEnabled" | "container" | "animation" | "displayFilterEnabled">, "ui" | ("destroyed" | "initialized" | "declaredClass" | "set" | "watch" | "addHandles" | "removeHandles" | "hasHandles") | "breakpoints" | "heightBreakpoint" | "popupEnabled" | "widthBreakpoint" | "animationsEnabled" | "container" | "animation" | "displayFilterEnabled"> & {
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
 }) => MapView;
@@ -19,18 +20,49 @@ declare const useMapView: (component: LitElement & Omit<Pick<MapView, "map" | "a
  * The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the
  * [ArcGIS Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).
  *
- * The Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).
+ * #### Initializing the Map component
+ * The Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and
+ * and can be initialized in one of three ways:
+ *
+ * ##### 1. Using a WebMap
+ * Load a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) from [ArcGIS Online](https://www.arcgis.com/home/index.html)
+ * or an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) by specifying the [item-id](#itemId) attribute.
  *
  * ```html
  * <arcgis-map item-id="05e015c5f0314db9a487a9b46cb37eca"></arcgis-map>
  * ```
  *
- * Alternatively, the Map component can be initialized without a WebMap item.
+ * ##### 2. Setting Map component attributes directly
+ * Define the Map component using attributes like [basemap](#basemap), [center](#center), and [zoom](#zoom) directly.
  *
  * ```html
  * <arcgis-map basemap="satellite" center="-154.88, 19.46" zoom="15"></arcgis-map>
  * ```
  *
+ * ##### 3. Providing a Map instance
+ * Alternatively, you can provide your own [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) instance to the component.
+ * This allows full control over map configuration, including [basemap](#basemap), operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers)
+ * and [spatial reference](#spatialReference). See the [Select features by rectangle sample](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)
+ * for an example of this approach in action.
+ *
+ * ```html
+ * <arcgis-map></arcgis-map>
+ * <script type="module">
+ *  const viewElement = document.querySelector("arcgis-map");
+ *
+ *  // set the basemap of the map to states feature layer
+ *  // add national parks feature layer and a polygon graphics layer
+ *  viewElement.map = new Map({
+ *    basemap: new Basemap({ baseLayers: [states] }),
+ *    layers: [nationalParksLayer, polygonGraphicsLayer]
+ *  });
+ *
+ *  // set the spatial reference of the map to NAD 1983 Albers contiguous USA
+ *  viewElement.spatialReference = { wkid: 102003 };
+ * </script>
+ * ```
+ * #### Adding components and customizing the Map
+ *
  * Other components can be added and connected to the Map component.
  *
  * ```html
@@ -67,10 +99,59 @@ declare const useMapView: (component: LitElement & Omit<Pick<MapView, "map" | "a
  * @slot [top-end] - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).
  * @slot [bottom-start] - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).
  * @slot [bottom-end] - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).
+ * @slot [popup] - Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. When using this slot, the [`popup-disabled`](#popupDisabled) attribute must be set to `true`. Only the Popup component can be placed in this slot.
  */
 export declare class ArcgisMap extends LitElement {
-    /** The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance created and manged by the component. Accessible once the component is fully loaded. */
+    /**
+     * Fires when a ArcgisMap fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).
+     *
+     * @since 4.34
+     * @see [loadErrorSources](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#loadErrorSources)
+     * @example
+     * ```js
+     * viewElement.addEventListener("arcgisLoadError", () => {
+     *   console.log(viewElement.loadErrorSources);
+     * });
+     * ```
+     */
+    readonly arcgisLoadError: TargetedEvent<this>;
+    /**
+     * Fires if the view encounters a content or rendering error.
+     *
+     * @since 4.34
+     * @example
+     * ```js
+     * viewElement.addEventListener("arcgisViewReadyError", () => {
+     *   // handle error
+     * });
+     * ```
+     */
+    readonly arcgisViewReadyError: TargetedEvent<this>;
+    /** The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance created and managed by the component. Accessible once the component is fully loaded. */
     readonly view: MapView;
+    /**
+     * Indicates whether animations are disabled in the view. This includes animated symbols (animated
+     * [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html),
+     * [PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)
+     * from a GIF/animated PNG), animated renderers
+     * ([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),
+     * animated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),
+     * [VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and
+     * animations triggered by view navigation (for example,
+     * [goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)).
+     * Setting this property to `true` disables all animations in the view.
+     *
+     * @since 4.34
+     * @default false
+     */
+    animationsDisabled: boolean;
+    /**
+     * The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaLabelledByElements).
+     *
+     * @since 4.34
+     */
+    get aria(): __esri.MapView["aria"];
+    set aria(value: __esri.MapView["aria"]);
     /**
      * Collection containing a flat list of all the created LayerViews
      * related to the basemap, operational layers, and group layers in this view.
@@ -80,6 +161,8 @@ export declare class ArcgisMap extends LitElement {
      * A collection of analyses associated with the view.
      *
      * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#analyses)
+     *
+     * @since 4.34
      */
     analyses: Collection<__esri.Analysis>;
     /**
@@ -93,8 +176,7 @@ export declare class ArcgisMap extends LitElement {
      */
     autoDestroyDisabled: boolean;
     /**
-     * The background color of the MapView. If the view's map changes, the view's `background` is reset to the map's background,
-     * even if the user set it previously.
+     * The background color of the Map component.
      *
      * @default null
      */
@@ -114,27 +196,93 @@ export declare class ArcgisMap extends LitElement {
     basemapView: __esri.BasemapView;
     /**
      * Represents the view's center point; when setting the center, you may pass a
-     * esri/geometry/Point instance or a string representing
-     * a longitude/latitude pair (`"-100.4593, 36.9014"`).
-     * Setting the center immediately changes the current view.
-     * For animating the view, see this component's goTo() method.
+     * [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance, numbers representing
+     * a longitude/latitude pair (`[-100.4593, 36.9014]`), or a string attribute representing a longitude/latitude pair ("-100.4593, 36.9014").
+     * Setting the `center` immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.
+     *
+     * The returned [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object is always
+     * in the spatial reference of the view and may be modified internally.
+     * To persist the returned object, create a clone using [clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone) method.
+     *
+     * **Notes**
+     *
+     * * If the spatial reference of `center` set in the constructor does not match the [spatialReference](#spatialReference) of the view, then the
+     * [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) will be loaded dynamically.
+     * * At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) must be
+     * [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) when
+     * setting the `center` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is
+     * loaded prior to setting the center by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#isLoaded)
+     * method. If it is not yet loaded, you can call [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.
+     *
+     * @example
+     * ```html
+     * <arcgis-map zoom="4" center="-98, 39"></arcgis-map>
+     * ```
+     * @example
+     * ```js
+     * // Sets the initial center point of the map component to lon/lat coordinates
+     * // lon/lat will be projected to match the spatial reference of the view
+     * const viewElement = document.querySelector("arcgis-map");
+     * viewElement.center = [-98, 39]; // lon, lat
+     * ```
+     * @example
+     * ```js
+     * // Updates the view's center point to a pre-determined Point object
+     * let centerPoint = new Point({
+     *   x: 12804.24,
+     *   y: -1894032.09,
+     *   spatialReference: {
+     *     wkid: view.spatialReference  // wkid 2027
+     *   }
+     * });
+     * const viewElement = document.querySelector("arcgis-map");
+     * view.center = centerPoint;
+     * ```
+     * @example
+     * ```js
+     * // the point's spatialReference does not match the view's spatialReference
+     * // the projectOperator will be used to project the point to match
+     * // the view's spatialReference
+     * const centerPoint = new Point({
+     *   x: -8746995,
+     *   y: 4352308,
+     *   spatialReference: {
+     *     wkid: 8857
+     *   }
+     * });
+     * if (!projectOperator.isLoaded()) {
+     *   await projectOperator.load();
+     * }
+     * const viewElement = document.querySelector("arcgis-map");
+     * viewElement.center = centerPoint;
+     * ```
      */
     get center(): __esri.MapView["center"];
     set center(newValue: __esri.MapView["center"] | nil | number[] | string);
-    /** Specifies constraints to scale, zoom, and rotation that may be applied to the MapView. */
+    /** Specifies constraints to scale, zoom, and rotation that may be applied to the map. */
     constraints: __esri.View2DConstraints;
     /**
-     * Indicates whether layer's displayFilter are honored when rendering layers in the view.
+     * Indicates whether a layer's `displayFilterInfo` is honored when rendering layers in the view.
      * If `false`, display filters are ignored and all features are rendered.
      *
      * @default false
      */
     displayFilterDisabled: boolean;
     /**
-     * The extent represents the visible portion of a map within the view as an instance of esri/geometry/Extent.
+     * The extent represents the visible portion of a map within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).
      * Setting the extent immediately changes the view without animation. To animate
-     * the view, see this component's goTo() method.
+     * the view, see this component's [goTo()](#goTo) method.
      * When the view is rotated, the extent does not update to include the newly visible portions of the map.
+     *
+     * **Notes**
+     *
+     * * If the spatial reference of `extent` set does not match the [spatialReference](#spatialReference) of the view, then the
+     * [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) will be loaded dynamically.
+     * * At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html)
+     * must be [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) when
+     * setting the `extent` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is
+     * loaded prior to setting the extent by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#isLoaded)
+     * method. If it is not yet loaded, you can call the [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.
      */
     get extent(): __esri.MapView["extent"];
     set extent(newValue: __esri.MapView["extent"]);
@@ -166,8 +314,33 @@ export declare class ArcgisMap extends LitElement {
     get ground(): typeof this._map.ground;
     set ground(value: __esri.Ground | string);
     /**
-     * The highlights property is a collection of HighlightGroup objects that
-     * allow you to visually emphasize specific features on the map.
+     * Represents a collection of [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html)
+     * objects which can be used to highlight features throughout an application. Highlighting works by applying highlight options to one or
+     * more features. You can configure these options (such as color or opacity) to define how a feature will be visually
+     * emphasized.
+     *
+     * A maximum of six [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html)
+     * objects are supported in the collection, and they can be added, removed, and reordered freely. Their order in the collection determines priority, with the last
+     * object having the highest priority. If you apply more than one highlight to a feature, the one that is last within
+     * the collection will be applied. The [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html)
+     * object must be part of this collection in order to be applied to features.
+     *
+     * To highlight a feature, use the [highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight)
+     * method on the relevant [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) instance. To apply specific
+     * [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html), include the
+     * [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html#name) in the `highlight()` method's `options` parameter.
+     * If no `name` is provided, the feature will use the `default` highlight options.
+     *
+     * The table below shows the default highlight options in the View's highlights collection if the collection has not
+     * been modified:
+     *
+     * | Highlight options name | Description | Default settings |
+     * | ---------------------- | ----------- | ---------------- |
+     * | default                | The default highlight options. Used when `layerView.highlight()` is called without specifying any particular highlight options. | ` { name: "default", color: "cyan", haloOpacity: 1, fillOpacity: 0.25, shadowColor: "black", shadowOpacity: 0.4, shadowDifference: 0.2}` |
+     * | temporary              | The temporary highlight options, pre-configured for common use cases such as hovering over a feature in the view. | `{ name: "temporary", color: "yellow", haloOpacity: 1, fillOpacity: 0.25, shadowColor: "black", shadowOpacity: 0.4, shadowDifference: 0.2 }` |
+     *
+     * @see [Sample: Highlight features by geometry](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)
+     * @see [Sample: Highlight point features](https://developers.arcgis.com/javascript/latest/sample-code/highlight-point-features/)
      */
     highlights: Collection<__esri.HighlightOptions>;
     /**
@@ -177,7 +350,7 @@ export declare class ArcgisMap extends LitElement {
      */
     highlightOptions: __esri.HighlightOptions;
     /**
-     * Indication whether the view is being interacted with (for example when panning or by an interactive tool).
+     * Indicates whether the view is being interacted with (for example, when panning or via an interactive tool).
      *
      * @default false
      */
@@ -193,14 +366,14 @@ export declare class ArcgisMap extends LitElement {
     set itemId(newValue: nil | string);
     /**
      * A collection containing a hierarchical list of all the created
-     * esri/views/layers/LayerView LayerViews of the
-     * esri/Map#layers operational layers in the map.
+     * [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)s of the
+     * [operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map.
      */
     readonly layerViews: Collection<__esri.LayerView>;
     /** The magnifier allows for showing a portion of the view as a magnifier image on top of the view. */
     readonly magnifier: __esri.Magnifier;
-    /** An instance of a esri/Map object to display in the view. */
-    map: __esri.Map | nullish;
+    /** An instance of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) object to display in the view. */
+    map: nullish | __esri.Map;
     /**
      * Indication whether the view is being navigated (for example when panning).
      *
@@ -226,14 +399,22 @@ export declare class ArcgisMap extends LitElement {
      */
     popup: nullish | __esri.Popup;
     /**
-     * Controls whether the popup opens when users click on the view.
+     * Controls whether the popup opens automatically when users click on the view.
      *
      * @default false
      */
     popupDisabled: boolean;
     /**
-     * When `true`, this property indicates whether the view successfully satisfied all dependencies,
-     * signaling that the following conditions are met.
+     * When `true`, this property indicates whether the [view](#view) has successfully satisfied all dependencies, signaling that the following conditions are met:
+     *
+     * * The view has a [map](#map). If [map](#map)
+     * is a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html), then the map
+     * must be [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loaded).
+     * * The view has a [spatialReference](#spatialReference), a [center](#center), and a [scale](#scale).
+     * These also can be inferred by setting an [extent](#extent).
+     *
+     * When a view becomes ready it will resolve itself and invoke
+     * the callback defined in [viewOnReady()](#viewOnReady) where code can execute on a working view.
      *
      * @default false
      */
@@ -245,7 +426,7 @@ export declare class ArcgisMap extends LitElement {
      *
      * @default "center"
      */
-    resizeAlign: "bottom-left" | "bottom-right" | "top-left" | "top-right" | "center" | "left" | "right" | "top" | "bottom";
+    resizeAlign: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "left" | "right" | "top" | "bottom";
     /**
      * Represents the current value of one pixel in the unit of the view's spatialReference.
      * The value of resolution is calculated by dividing the view's extent width
@@ -265,20 +446,67 @@ export declare class ArcgisMap extends LitElement {
     rotation: number;
     /**
      * Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating
-     * the view, see this component's goTo() method.
+     * the view, see this component's [goTo()](#goTo) method.
      */
     get scale(): number;
     set scale(newValue: number);
     /**
-     * The spatial reference of the view.
-     * This indicates the projected or geographic coordinate system used
-     * to locate geographic features in the map.
-     *
+     * The spatial reference of the view. This indicates the projected or geographic coordinate system used to locate geographic features in the map.
+     * You can change the spatialReference of the view after it is initialized by either directly changing
+     * this property, or by changing the basemap from the [Basemap Gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/)
+     * and [Basemap Toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components.
+     * Set [spatialReferenceLocked](#spatialReferenceLocked) property to `true` to prevent users from changing the view's spatial reference at runtime.
+     *
+     * Prior to changing the spatial reference, check if the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html)
+     * is loaded by calling [projectOperator.isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#isLoaded) method.
+     * If it is not yet loaded, call [projectOperator.load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.
+     * If the `projectOperator` is not loaded, the view's [center](#center) will default to `[0, 0]` in the new spatial reference of the view and a console error will be thrown.
+     *
+     * **Notes**
+     *
+     * * [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) not compatible with the view's spatial reference
+     * are not displayed. In such case, the layer view's [suspended](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#suspended)
+     * property is `true` and [spatialReferenceSupported](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#spatialReferenceSupported)
+     * property is `false`.
+     * * When setting view's spatial reference, the [center](#center), [extent](#extent) or [viewpoint.targetGeometry](#viewpoint) properties are projected to the new spatial
+     * reference. The [scale](#scale) and [rotation](#rotation) properties are adjusted to keep the content of the map at the same size and orientation on screen.
+     * * To ensure [TileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) and
+     * [VectorTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html)
+     * are displayed in a [basemap](#basemap) correctly, the spatialReference of the view must be set match their
+     * [tileInfo's](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html) spatial reference.
+     * * Switching spatial reference with an [imageCoordinateSystem](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#imageCoordinateSystem)
+     * is not supported.
+     *
+     * @name spatialReference
+     * @instance
+     * @type {module:esri/geometry/SpatialReference}
+     * @autocast
+     * @see [spatialReferenceLocked](#spatialReferenceLocked)
+     * @example
+     * ```js
+     * const viewElement = document.querySelector("arcgis-map");
+     * // check if the projectOperator is loaded
+     * if (!projectOperator.isLoaded()) {
+     *   // load the projectOperator if it is not loaded
+     *   projectOperator.load().then(() => {
+     *    // change the spatial reference of the map component to equal earth projection
+     *     viewElement.spatialReference = new SpatialReference({
+     *       wkid: 54035 //equal earth projection
+     *     });
+     *   });
+     * } else {
+     *   // the projectOperator is already loaded.
+     *   // change the spatial reference of the view to equal earth projection
+     *   viewElement.spatialReference = new SpatialReference({
+     *     wkid: 54035 //equal earth projection
+     *   });
+     * }
+     * ```
      * @default null
      */
     spatialReference: __esri.SpatialReference;
     /**
-     * Indicates if the map's spatialReference can be changed after it is ready.
+     * Indicates if the map's [spatialReference](#spatialReference) can be changed after it is ready.
      * The default is `false`, indicating the map's spatialReference can be changed at runtime.
      * When true, basemaps with spatial references that do not match the map's spatial reference
      * will be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.
@@ -300,8 +528,7 @@ export declare class ArcgisMap extends LitElement {
      */
     readonly suspended: boolean;
     /**
-     * This property specifies the base colors used by some widgets
-     * and components to render graphics and labels.
+     * This property specifies the base colors used by some components to render graphics and labels.
      *
      * @default null
      */
@@ -333,7 +560,7 @@ export declare class ArcgisMap extends LitElement {
     /**
      * Represents the current view as a Viewpoint or point of observation on the view.
      * Setting the viewpoint immediately changes the current view. For animating
-     * the view, see this component's goTo() method.
+     * the view, see this component's [goTo()](#goTo) method.
      */
     get viewpoint(): __esri.Viewpoint;
     set viewpoint(newValue: __esri.Viewpoint);
@@ -343,20 +570,25 @@ export declare class ArcgisMap extends LitElement {
      *
      * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#visibleArea)
      */
-    readonly visibleArea: nullish | __esri.Polygon;
+    readonly visibleArea: __esri.Polygon | nullish;
     /**
-     * Represents the level of detail (LOD) at the center of the view.
-     * A zoom level (or scale) is a number that defines how large or small the contents of a map appear in a map view.
+     * Represents the level of detail (LOD) at the center of the map.
+     * A zoom level (or scale) is a number that defines how large or small the contents of a map appear in a Map component.
      * Zoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.
-     * A value of -1 means the view has no LODs.
-     * When setting the zoom value, the MapView converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.
-     * MapView can display maps with different projections at a full range of scales, and so use the scale property on this component rather than zoom level.
+     * A value of -1 means the map has no LODs.
+     * When setting the zoom value, the component converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.
      *
-     * Setting the zoom immediately changes the current view. For animating the view, see this component's goTo() method.
+     * Setting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.
      * Setting this property in conjunction with `center` is a convenient way to set the initial extent of the view.
      */
     get zoom(): number;
     set zoom(newValue: number);
+    /**
+     * An array of objects that encountered an error while loading the component or any of its dependencies (e.g., basemap, ground, layers, tables). You may inspect the errors by accessing each object's `loadError` property.
+     *
+     * @since 4.34
+     */
+    loadErrorSources?: LoadErrorSource[];
     /**
      * @deprecated
      * since 4.33, use `element.map.add(layer)` instead.
@@ -391,7 +623,74 @@ export declare class ArcgisMap extends LitElement {
     destroy(): Promise<void>;
     /** Sets the view to a given target. */
     goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>;
-    /** Returns hit test results from each layer that intersects the specified screen coordinates. */
+    /**
+     * Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult)
+     * from each layer that intersects the specified screen coordinates. The results are
+     * organized as an array of objects containing different [result types](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult).
+     *
+     * The following layer types will return all [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) if a hit is
+     * made on intersecting features: [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),
+     * [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html),
+     * [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),
+     * [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),
+     * [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html),
+     * [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),
+     * [KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),
+     * [MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),
+     * [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),
+     * [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html),
+     * [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html),
+     * [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html), and
+     * [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html).
+     *
+     * The [ParquetLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ParquetLayer.html) hit result returns only the topmost feature
+     * when the hit occurs on overlapping features in a ParquetLayer.
+     *
+     * The [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) hit test result contains an array of objects containing
+     * a [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit).
+     * The graphic returns attributes of a style layer. In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#origin)
+     * contains the style layer's [id](https://maplibre.org/maplibre-style-spec/layers/#id) and layer index within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978).
+     * Spatial information about the actual feature represented in the style layer is returned only if the style layer is a [symbol layer](https://maplibre.org/maplibre-style-spec/layers/#symbol).
+     * Otherwise, the graphic's geometry is `null`.
+     *
+     * The [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) hit test result contains all media elements if the hit is made on intersecting elements.
+     * The [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) hit test result contains all route elements if the hit is made on intersecting elements.
+     *
+     * If the [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) feature's symbol
+     * [style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#style) is set to `none`, the hitTest method will not
+     * return results when the fill is clicked. However, it will return results when the outline is clicked. To get results when clicking the fill, set the
+     * [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#color) to a transparent color instead.
+     *
+     * @example
+     * ```js
+     * viewElement.addEventListener("arcgisViewClick", (event) => {
+     *    viewElement.hitTest(event.detail).then((response) => {
+     *       const result = response.results[0];
+     *       if (result?.type === "graphic") {
+     *          const { longitude, latitude } = result.mapPoint;
+     *          console.log(`Hit graphic at (${longitude}, ${latitude})`, result.graphic);
+     *       } else {
+     *          console.log("Did not hit any graphic");
+     *       }
+     *    });
+     * });
+     * ```
+     * @example
+     * ```js
+     * // get screenpoint from view's click event
+     * viewElement.addEventListener("arcgisViewClick", async (event) => {
+     *   // Search for all media elements only on included mediaLayer at the clicked location
+     *   const response = await viewElement.hitTest(event.detail, {
+     *     include: {mediaLayer}
+     *   });
+     *   // if media elements are returned from the mediaLayer, do something with results
+     *   if (response.results.length){
+     *     // do something
+     *     console.log(response.results.length, "elements returned");
+     *   }
+     * });
+     * ```
+     */
     hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>;
     /**
      * Opens the popup at the given location with content defined either explicitly with content or driven
@@ -423,6 +722,8 @@ export declare class ArcgisMap extends LitElement {
      * Gets the analysis view created for the given analysis object.
      *
      * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)
+     *
+     * @since 4.34
      */
     whenAnalysisView(analysis: __esri.ElevationProfileAnalysis): Promise<__esri.ElevationProfileAnalysisView2D>;
     /**
@@ -531,62 +832,177 @@ export declare class ArcgisMap extends LitElement {
      * Fires when the view for an analysis is created.
      *
      * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#event-analysis-view-create)
+     *
+     * @since 4.34
      */
     readonly arcgisViewAnalysisViewCreate: TargetedEvent<this, __esri.ViewAnalysisViewCreateEvent>;
     /**
      * Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.
      *
      * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#event-analysis-view-create-error)
+     *
+     * @since 4.34
      */
     readonly arcgisViewAnalysisViewCreateError: TargetedEvent<this, __esri.ViewAnalysisViewCreateErrorEvent>;
     /**
      * Fires after an analysis view is destroyed.
      *
      * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#event-analysis-view-destroy)
+     *
+     * @since 4.34
      */
     readonly arcgisViewAnalysisViewDestroy: TargetedEvent<this, __esri.ViewAnalysisViewDestroyEvent>;
     /**
-     * This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.
-     * This event will also emit if stationary toggles from true to false.
+     * This event is triggered when view-related properties change, such as [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),
+     * [viewpoint](#viewpoint), or [stationary](#stationary).
+     * It reflects user interactions (e.g. panning or zooming) or programmatic updates to the view.
+     *
+     * @example
+     * ```js
+     * // get the number of features in a layer view whenever the view becomes stationary
+     * viewElement.addEventListener("arcgisViewChange", async (event) =>{
+     *   if (viewElement.stationary) {
+     *     // Returns number of features available for drawing in a given layer view
+     *     const count = await layerView.queryFeatureCount({
+     *       geometry: viewElement.extent
+     *     });
+     *     // use the features count
+     *   }
+     * });
+     * ```
      */
     readonly arcgisViewChange: TargetedEvent<this, void>;
-    /** Fires after a user clicks on the view. */
+    /**
+     * Fires after a user clicks on the view. This event emits slightly slower than an [arcgisViewImmediateClick](#arcgisViewImmediateClick)
+     * event to make sure that an [arcgisViewDoubleClick](#arcgisViewDoubleClick) event isn't triggered instead. The `arcgisViewImmediateClick`
+     * event can be used for responding to an `arcgisViewClick` event without delay.
+     *
+     * @example
+     * ```js
+     * // Listen for clicks on the view and perform a hit test on a feature layer
+     * viewElement.addEventListener("arcgisViewClick", (event) => {
+     *   // Return hit test results from the feature layer
+     *   // where it intersects the screen coordinates from the click event.
+     *   // The result is a polygon representing the state that was clicked.
+     *   viewElement.hitTest(event.detail).then((response) => {
+     *      if (response.results.length) {
+     *        const stateBoundaryPolygon = response.results.find((result) => {
+     *          return result.graphic.layer === stateBoundaryFeatureLayer;
+     *         }).graphic.geometry;
+     *
+     *         getPolygonCentroid(stateBoundaryPolygon);
+     *       }
+     *     });
+     * });
+     * ```
+     */
     readonly arcgisViewClick: TargetedEvent<this, __esri.ViewClickEvent>;
-    /** Fires after double-clicking on the view. */
+    /**
+     * Fires after double-clicking on the view.
+     *
+     * @example
+     * ```js
+     * viewElement.addEventListener("arcgisViewDoubleClick", async (event) => {
+     *   // Prevent the default zoom-in behavior on double-click
+     *   event.detail.stopPropagation();
+     * });
+     * ```
+     */
     readonly arcgisViewDoubleClick: TargetedEvent<this, __esri.ViewDoubleClickEvent>;
     /** Fires during a pointer drag on the view. */
     readonly arcgisViewDrag: TargetedEvent<this, __esri.ViewDragEvent>;
-    /** Fires during a pointer drag on the view. */
+    /** Fires after holding either a mouse button or a single finger on the view for a short amount of time. */
     readonly arcgisViewHold: TargetedEvent<this, __esri.ViewHoldEvent>;
-    /** Fires right after a user clicks on the view. */
+    /**
+     * Fires right after a user clicks on the view. In contrast to the [arcgisViewClick](#arcgisViewClick) event, the `arcgisViewImmediateClick`
+     * is emitted as soon as the user clicks on the view, and is not inhibited by a [arcgisViewDoubleClick](#arcgisViewDoubleClick) event.
+     * This event is useful for interactive experiences that require feedback without delay.
+     *
+     * @example
+     * ```js
+     * viewElement.addEventListener("arcgisViewImmediateClick", async (event) => {
+     *   // Prevent the default zoom-in behavior on arcgisViewImmediateClick
+     *   event.detail.stopPropagation();
+     * });
+     * ```
+     */
     readonly arcgisViewImmediateClick: TargetedEvent<this, __esri.ViewImmediateClickEvent>;
-    /** Is emitted after two consecutive immediate-click events. */
+    /**
+     * Fires after after two consecutive [arcgisViewImmediateClick](#arcgisViewImmediateClick) events. In contrast to [arcgisViewDoubleClick](#arcgisViewDoubleClick),
+     * an `arcgisViewImmediateDoubleClick` cannot be prevented by use of `stopPropagation()` on the [arcgisViewImmediateClick](#arcgisViewImmediateClick)
+     * event and can therefore be used to react to double-clicking independently of usage of the [arcgisViewImmediateClick](#arcgisViewImmediateClick) event.
+     */
     readonly arcgisViewImmediateDoubleClick: TargetedEvent<this, __esri.ViewImmediateDoubleClickEvent>;
-    /** Fires after a keyboard key is pressed. */
+    /**
+     * Fires after a keyboard key is pressed.
+     *
+     * @example
+     * ```js
+     * // Disable zooming with the keyboard
+     * // Stop event propagation when `+` and `-` keys are pressed.
+     * viewElement.addEventListener("arcgisViewKeyDown", function(event){
+     *   console.log("key-down", event);
+     *
+     *   const prohibitedKeys = ["+", "-"];
+     *   const keyPressed = event.detail.key;
+     *   if (prohibitedKeys.indexOf(keyPressed) !== -1) {
+     *     event.detail.stopPropagation();
+     *   }
+     * });
+     * ```
+     */
     readonly arcgisViewKeyDown: TargetedEvent<this, __esri.ViewKeyDownEvent>;
-    /** Fires after a keyboard key is pressed. */
+    /** Fires after a keyboard key is released. */
     readonly arcgisViewKeyUp: TargetedEvent<this, __esri.ViewKeyUpEvent>;
-    /** Fires after each layer in the map has a corresponding LayerView created and rendered in the view. */
+    /**
+     * Fires after each layer in the map has a corresponding
+     * [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)
+     * created and rendered in the view.
+     */
     readonly arcgisViewLayerviewCreate: TargetedEvent<this, __esri.ViewLayerviewCreateEvent>;
-    /** Fires when an error emits during the creation of a LayerView after a layer has been added to the map. */
+    /**
+     * Fires when an error occurs during the creation of a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)
+     * after a layer has been added to the map.
+     */
     readonly arcgisViewLayerviewCreateError: TargetedEvent<this, __esri.ViewLayerviewCreateErrorEvent>;
-    /** Fires after a LayerView is destroyed and is no longer rendered in the view. */
+    /**
+     * Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)
+     * is destroyed and is no longer rendered in the view.
+     */
     readonly arcgisViewLayerviewDestroy: TargetedEvent<this, __esri.ViewLayerviewDestroyEvent>;
-    /** Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view. */
+    /**
+     * Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.
+     *
+     * @example
+     * ```js
+     * viewElement.addEventListener("arcgisViewMouseWheel", async (event) => {
+     *   // Prevent the default zoom-in and zoom-out behavior on arcgisViewMouseWheel
+     *   event.detail.stopPropagation();
+     * });
+     * ```
+     */
     readonly arcgisViewMouseWheel: TargetedEvent<this, __esri.ViewMouseWheelEvent>;
-    /** Fires after a mouse button is pressed, or a finger touches the display. */
+    /**
+     * Fires after a mouse button is pressed, or a finger touches the display.
+     *
+     * @see [Sample: Access features with hitTest](https://developers.arcgis.com/javascript/latest/sample-code/map-component-hittest/)
+     */
     readonly arcgisViewPointerDown: TargetedEvent<this, __esri.ViewPointerDownEvent>;
     /** Fires after a mouse cursor enters the view, or a display touch begins. */
     readonly arcgisViewPointerEnter: TargetedEvent<this, __esri.ViewPointerEnterEvent>;
     /** Fires after a mouse cursor leaves the view, or a display touch ends. */
     readonly arcgisViewPointerLeave: TargetedEvent<this, __esri.ViewPointerLeaveEvent>;
-    /** Fires after the mouse or a finger on the display moves. */
+    /**
+     * Fires after the mouse or a finger on the display moves.
+     *
+     * @see [Sample: Access features with hitTest](https://developers.arcgis.com/javascript/latest/sample-code/map-component-hittest/)
+     */
     readonly arcgisViewPointerMove: TargetedEvent<this, __esri.ViewPointerMoveEvent>;
     /** Fires after a mouse button is released, or a display touch ends. */
     readonly arcgisViewPointerUp: TargetedEvent<this, __esri.ViewPointerUpEvent>;
     /**
-     * This event is for the `ready` property and will be emitted when the view is ready.
-     * This event will also emit if the `map` property is changed.
+     * This event is for the `ready` property and is emitted when the view is ready.
+     * Fires also when the [map](#map) is updated.
      */
     readonly arcgisViewReadyChange: TargetedEvent<this, void>;
     private _map: __esri.Map;