@arcgis/map-components 4.33.0-next.16 → 4.33.0-next.160

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

@@ -1,39 +1,63 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
+import { Use } from '@arcgis/lumina/controllers';
 import { Nil } from '@arcgis/components-utils';
 import { default as MapView } from '@arcgis/core/views/MapView.js';
 import { default as WebMap } from '@arcgis/core/WebMap.js';
-import { PublicLitElement as LitElement, ToElement, TargetedEvent } from '@arcgis/lumina';
+import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 
-declare const useWebMap: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<WebMap, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+declare const useWebMap: (component: LitElement & Omit<Pick<WebMap, "basemap" | "focusAreas" | "ground" | "ipsInfo" | "layers" | "bookmarks" | "tables" | "presentation" | "widgets" | "applicationProperties" | "authoringApp" | "authoringAppVersion" | "floorInfo" | "geotriggersInfo" | "initialViewProperties" | "portalItem" | "thumbnailUrl" | "utilityNetworks">, "basemap" | "ground" | ("destroyed" | "initialized" | "declaredClass" | "set" | "watch" | "addHandles" | "removeHandles" | "hasHandles") | "layers" | "bookmarks" | "tables" | "presentation" | "widgets" | "applicationProperties" | "authoringApp" | "authoringAppVersion" | "floorInfo" | "geotriggersInfo" | "initialViewProperties" | "portalItem" | "thumbnailUrl" | "utilityNetworks"> & {
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.WebMapProperties | undefined): __esri.WebMapProperties | Promise<__esri.WebMapProperties | undefined> | undefined;
-} | undefined) => WebMap;
-declare const useMapView: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<MapView, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+}) => WebMap;
+declare const useMapView: (component: LitElement & Omit<Pick<MapView, "container" | "map" | "background" | "basemapView" | "center" | "constraints" | "extent" | "fatalError" | "graphics" | "highlights" | "navigation" | "padding" | "popup" | "resizeAlign" | "rotation" | "scale" | "spatialReference" | "theme" | "timeExtent" | "timeZone" | "viewpoint" | "zoom" | "floors" | "highlightOptions" | "breakpoints" | "heightBreakpoint" | "popupEnabled" | "spatialReferenceLocked" | "widthBreakpoint" | "ui" | "animation" | "displayFilterEnabled">, "container" | ("destroyed" | "initialized" | "declaredClass" | "set" | "watch" | "addHandles" | "removeHandles" | "hasHandles") | "breakpoints" | "heightBreakpoint" | "popupEnabled" | "spatialReferenceLocked" | "widthBreakpoint" | "ui" | "animation" | "displayFilterEnabled"> & {
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.MapViewProperties | undefined): __esri.MapViewProperties | Promise<__esri.MapViewProperties | undefined> | undefined;
-} | undefined) => MapView;
-/** Loads a WebMap from [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) into a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+}) => MapView;
+/**
+ * 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).
+ *
+ * ```html
+ * <arcgis-map item-id="05e015c5f0314db9a487a9b46cb37eca"></arcgis-map>
+ * ```
+ *
+ * Alternatively, the Map component can be initialized without a WebMap item.
+ *
+ * ```html
+ * <arcgis-map basemap="satellite" center="-154.88, 19.46" zoom="15"></arcgis-map>
+ * ```
+ *
+ * Other components can be added and connected to the Map component.
+ *
+ * ```html
+ * <arcgis-map item-id="05e015c5f0314db9a487a9b46cb37eca">
+ *  <arcgis-zoom position="top-left"></arcgis-zoom>
+ *  <arcgis-legend position="bottom-left"></arcgis-legend>
+ * </arcgis-map>
+ * ```
+ *
+ * The Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/) of the ArcGIS Maps SDK for JavaScript.
+ *
+ * ```js
+ * const viewElement = document.querySelector("arcgis-map");
+ * viewElement.addEventListener("arcgisViewReadyChange", () => {
+ *  const layer = new GraphicsLayer({ title: "My Layer" });
+ *  viewElement.map.add(layer);
+ * });
+ * ```
+ *
+ * See also:
+ * - [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)
+ * - [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)
+ * - [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)
  */
 export declare class ArcgisMap extends LitElement {
-    /** Internal view of the component. */
+    /** 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. */
     readonly view: MapView;
     /**
      * Collection containing a flat list of all the created LayerViews
@@ -44,21 +68,30 @@ export declare class ArcgisMap extends LitElement {
      * 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\` method when you are done to prevent
-     * memory leaks.
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     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.
+     *
+     * @default null
      */
     background: nullish | __esri.ColorBackground;
     /**
      * Specifies a basemap for the map. The basemap is a set of layers that give
-     * geographic context to the MapView or SceneView and the other operational layers
+     * geographic context to the view and the other operational layers
      * in the map.
+     * It can either be set using a basemap ID string ([see values](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)),
+     * [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)
+     * or [BasemapStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html).
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)
      */
-    basemap: __esri.Basemap | nullish | string;
+    basemap?: __esri.Basemap | string;
     /** Represents the view for a single basemap after it has been added to the map. */
     basemapView: __esri.BasemapView;
     /**
@@ -75,6 +108,8 @@ export declare class ArcgisMap extends LitElement {
     /**
      * Indicates whether layer's displayFilter are honored when rendering layers in the view.
      * If `false`, display filters are ignored and all features are rendered.
+     *
+     * @default false
      */
     displayFilterDisabled: boolean;
     /**
@@ -92,46 +127,54 @@ export declare class ArcgisMap extends LitElement {
      * It can filter the map display on floor-aware layers by zero or more level IDs.
      */
     floors: __esri.Collection<string>;
-    /** Gamepad input specific configuration settings.. */
+    /** Gamepad input specific configuration settings. */
     get gamepad(): __esri.GamepadSettings;
     /**
      * Allows for adding graphics directly to the default graphics in the View.
-     * Example:
-     * ```
+     *
+     * @example
+     * ```js
      * // Adds a graphic to the View
      * graphics.add(pointGraphic);
      * ```
-     * Example:
-     * ```
+     * @example
+     * ```js
      * // Removes a graphic from the View
      * graphics.remove(pointGraphic);
      * ```
      */
     graphics: __esri.Collection<__esri.Graphic>;
     /** Specifies the surface properties for the map. */
-    ground: __esri.Ground | string;
+    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.
      */
     highlights: __esri.Collection<__esri.HighlightOptions>;
     /**
+     * Options for configuring the highlight.
+     *
      * @deprecated
+     * since 4.33, use {@link ArcgisMap#highlights } instead.
      *
      * Options for configuring the highlight. Use the highlight method on the
      * appropriate esri/views/layers/LayerView to highlight a feature.
      * The layerView's `highlightOptions` will take precedence over the MapView's `highlightOptions` if both properties are set.
      */
     highlightOptions: __esri.HighlightOptions;
-    /** Indication whether the view is being interacted with (for example when panning or by an interactive tool). */
-    get interacting(): boolean;
     /**
-     * Contains indoor positioning system information for the map.
+     * Indication whether the view is being interacted with (for example when panning or by an interactive tool).
+     *
+     * @default false
      */
+    get interacting(): boolean;
+    /** Contains indoor positioning system information for the map. */
     ipsInfo: nullish | __esri.IPSInfo;
-    /** The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.
+    /**
+     * The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.
      *
-     * To configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-map` component loads.
+     * To configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Map component loads.
      */
     get itemId(): Nil | string;
     set itemId(newValue: Nil | string);
@@ -144,26 +187,50 @@ export declare class ArcgisMap extends LitElement {
     /** 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;
-    /** Indication whether the view is being navigated (for example when panning). */
+    map: __esri.Map | nullish;
+    /**
+     * Indication whether the view is being navigated (for example when panning).
+     *
+     * @default false
+     */
     get navigating(): boolean;
     /** Options to configure the navigation behavior of the View. */
     navigation: __esri.Navigation;
+    /**
+     * Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center),
+     * and [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent), etc.
+     *
+     * @default {left: 0, top: 0, right: 0, bottom: 0}
+     */
     padding: __esri.ViewPadding;
+    /**
+     * A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) object that displays general content or attributes from
+     * [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#map).
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#popup)
+     */
     popup: nullish | __esri.Popup;
-    /** Controls whether the popup opens when users click on the view. */
+    /**
+     * Controls whether the popup opens 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.
+     *
+     * @default false
      */
     readonly ready: boolean;
     /**
      * Defines which anchor stays still while resizing the browser window. The default, `center`,
      * ensures the view's center point remains constantly visible as the window size changes. The other
      * options allow  the respective portion of the view to remain visible when the window's size is changed.
+     *
+     * @default "center"
      */
-    resizeAlign: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right";
+    resizeAlign: "center" | "bottom-left" | "bottom-right" | "top-left" | "top-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
@@ -177,6 +244,8 @@ export declare class ArcgisMap extends LitElement {
      * Map rotation may be disabled by setting the `rotationEnabled` property
      * in [constraints](#constraints) to `false`. See the code snippet below for
      * an example of this.
+     *
+     * @default 0
      */
     rotation: number;
     /**
@@ -189,15 +258,27 @@ export declare class ArcgisMap extends LitElement {
      * The spatial reference of the view.
      * This indicates the projected or geographic coordinate system used
      * to locate geographic features in the map.
+     *
+     * @default null
      */
     spatialReference: __esri.SpatialReference;
-    /** Indication whether the view is animating, being navigated with or resizing. */
+    /**
+     * Indication whether the view is animating, being navigated with or resizing.
+     *
+     * @default false
+     */
     get stationary(): boolean;
-    /** Indicates if the view is visible on the page. */
+    /**
+     * Indicates if the view is visible on the page.
+     *
+     * @default true
+     */
     readonly suspended: boolean;
     /**
      * This property specifies the base colors used by some widgets
      * and components to render graphics and labels.
+     *
+     * @default null
      */
     theme: nullish | __esri.Theme;
     /**
@@ -205,17 +286,23 @@ export declare class ArcgisMap extends LitElement {
      * the view's time extent. Setting the view's time extent is similar to setting the spatial
      * extent because once the time extent is set, the
      * view updates automatically to conform to the change.
+     *
+     * @default null
      */
     timeExtent: nullish | __esri.TimeExtent;
     /**
      * Defines the time zone of the view.
      * The time zone property determines how dates and times are represented to the user,
      * but the underlying data is unchanged.
+     *
+     * @default "system"
      */
     timeZone: string;
     /**
      * Indicates whether the view is being updated by additional data requests to the network,
      * or by processing received data.
+     *
+     * @default false
      */
     readonly updating: boolean;
     /**
@@ -225,6 +312,13 @@ export declare class ArcgisMap extends LitElement {
      */
     get viewpoint(): __esri.Viewpoint;
     set viewpoint(newValue: __esri.Viewpoint);
+    /**
+     * The visibleArea represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as
+     * an instance of a [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html).
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#visibleArea)
+     */
+    readonly visibleArea: nullish | __esri.Polygon;
     /**
      * 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.
@@ -238,13 +332,33 @@ export declare class ArcgisMap extends LitElement {
      */
     get zoom(): number;
     set zoom(newValue: number);
-    /** Adds a layer to the map layers collection. */
+    /**
+     * @deprecated
+     * since 4.33, use `element.map.add(layer)` instead.
+     *
+     * Adds a layer to the map layers collection.
+     */
     addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>;
-    /** Adds a layer or array of layers to the map layers collection. */
+    /**
+     * @deprecated
+     * since 4.33, use `element.map.addMany([layer])` instead.
+     *
+     * Adds a layer or array of layers to the map layers collection.
+     */
     addLayers(layers: __esri.Layer[], index?: number): Promise<void>;
-    /** Adds a table to the map tables collection. */
+    /**
+     * @deprecated
+     * since 4.33, use `element.map.tables.add(table)` instead.
+     *
+     * Adds a table to the map tables collection.
+     */
     addTable(table: __esri.FeatureLayer): Promise<void>;
-    /** Adds a table or array of tables to the map tables collection. */
+    /**
+     * @deprecated
+     * since 4.33, use `element.map.tables.addMany([table])` instead.
+     *
+     * Adds a table or array of tables to the map tables collection.
+     */
     addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>;
     /** Closes the popup. */
     closePopup(): Promise<void>;
@@ -267,6 +381,21 @@ export declare class ArcgisMap extends LitElement {
     tryFatalErrorRecovery(): Promise<void>;
     /** Gets the LayerView created on the view for the given layer. */
     whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>;
+    /**
+     * `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#view) is created and ready.
+     * This method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.
+     *
+     * @since 4.33
+     * @see [Watch for changes - waiting for components or views to be ready](https://developers.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)
+     * @example
+     * ```js
+     * const viewElement = document.querySelector("arcgis-map");
+     * await viewElement.viewOnReady();
+     * // The view is now ready to be used.
+     * viewElement.map.add(new FeatureLayer({...}));
+     * ```
+     */
+    viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>;
     /**
      * 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.
@@ -311,8 +440,10 @@ export declare class ArcgisMap extends LitElement {
      * This event will also emit if the `map` property is changed.
      */
     readonly arcgisViewReadyChange: TargetedEvent<this, void>;
+    private _map: __esri.Map;
     readonly _setterTypes: {
         center?: __esri.MapView["center"] | Nil | number[] | string;
+        ground?: __esri.Ground | string;
     };
 }
 export {};