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

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

@@ -69,112 +69,522 @@ declare const useMapView: (component: LitElement & Omit<Pick<MapView, "map" | "a
  * @slot [bottom-end] - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).
  */
 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. */
     readonly view: MapView;
+    /**
+     * Collection containing a flat list of all the created LayerViews
+     * related to the basemap, operational layers, and group layers in this view.
+     */
     readonly allLayerViews: __esri.ReadonlyCollection<__esri.LayerView>;
+    /**
+     * A collection of analyses associated with the view.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#analyses)
+     */
     analyses: Collection<__esri.Analysis>;
+    /**
+     * 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-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 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 | string;
+    /** Represents the view for a single basemap after it has been added to the map. */
     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.
+     */
     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. */
     constraints: __esri.View2DConstraints;
+    /**
+     * 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;
+    /**
+     * The extent represents the visible portion of a map within the view as an instance of esri/geometry/Extent.
+     * Setting the extent immediately changes the view without animation. To animate
+     * the view, see this component's goTo() method.
+     * When the view is rotated, the extent does not update to include the newly visible portions of the map.
+     */
     get extent(): __esri.MapView["extent"];
     set extent(newValue: __esri.MapView["extent"]);
+    /** A rejected view indicates a fatal error making it unable to display. */
     fatalError: nullish | __esri.Error;
+    /**
+     * Applies a display filter on the view for a specific set of floor levels.
+     * It can filter the map display on floor-aware layers by zero or more level IDs.
+     */
     floors: Collection<string>;
+    /** Gamepad input specific configuration settings. */
     get gamepad(): __esri.GamepadSettings;
+    /**
+     * Allows for adding graphics directly to the default graphics in the View.
+     *
+     * @example
+     * ```js
+     * // Adds a graphic to the View
+     * graphics.add(pointGraphic);
+     * ```
+     * @example
+     * ```js
+     * // Removes a graphic from the View
+     * graphics.remove(pointGraphic);
+     * ```
+     */
     graphics: Collection<__esri.Graphic>;
     /** Specifies the surface properties for the map. */
     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: Collection<__esri.HighlightOptions>;
+    /**
+     * copyDoc
+     *
+     * @deprecated since version 4.32. Use the [highlights](#highlights) property instead.
+     */
     highlightOptions: __esri.HighlightOptions;
+    /**
+     * 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.
+     *
+     * 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);
+    /**
+     * 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.
+     */
     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;
+    /**
+     * 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.
+     *
+     * @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: "bottom-left" | "bottom-right" | "top-left" | "top-right" | "center" | "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
+     * by its width.
+     */
     readonly resolution: number;
+    /**
+     * The clockwise rotation of due north in relation to the top of the view in degrees.
+     * The view may be rotated by directly setting
+     * the rotation or by using the following mouse event: `Right-click + Drag`.
+     * 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;
+    /**
+     * 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.
+     */
     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.
+     *
+     * @default null
+     */
     spatialReference: __esri.SpatialReference;
+    /**
+     * Indicates if the view's spatialReference can be changed after it is ready.
+     * The default is false indicating the view's spatialReference can be changed at runtime.
+     * When true, basemaps with spatial references that do not match the view'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 view spatialReference cannot be changed at runtime.
+     *
+     * @default false
+     */
     spatialReferenceLocked: boolean;
+    /**
+     * 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.
+     *
+     * @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;
+    /**
+     * The view's time extent. Time-aware layers display their temporal data that falls within
+     * 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;
+    /**
+     * 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.
+     */
     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.
+     * 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.
+     *
+     * Setting the zoom immediately changes the current view. For animating the view, see this component's 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);
+    /**
+     * @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>;
+    /**
+     * @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>;
+    /**
+     * @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>;
+    /**
+     * @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>;
+    /** Destroys the view, and any associated resources, including its map, popup, and UI elements. */
     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. */
     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
+     * from the PopupTemplate of input features.
+     */
     openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>;
+    /** Create a screenshot of the current view. */
     takeScreenshot(options?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>;
     toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point;
     toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish;
+    /** Call this method to clear any fatal errors resulting from a lost WebGL context. */
     tryFatalErrorRecovery(): Promise<void>;
+    /**
+     * `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>;
+    /**
+     * 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)
+     */
     whenAnalysisView(analysis: __esri.ElevationProfileAnalysis): Promise<__esri.ElevationProfileAnalysisView2D>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.PointCloudLayer): Promise<__esri.PointCloudLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.StreamLayer): Promise<__esri.StreamLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.WFSLayer): Promise<__esri.WFSLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.OGCFeatureLayer): Promise<__esri.OGCFeatureLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.FeatureLayer): Promise<__esri.FeatureLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.CSVLayer): Promise<__esri.CSVLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.GeoJSONLayer): Promise<__esri.GeoJSONLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.GeoRSSLayer): Promise<__esri.GeoRSSLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.GraphicsLayer): Promise<__esri.GraphicsLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.ImageryLayer): Promise<__esri.ImageryLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.KMLLayer): Promise<__esri.KMLLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.SceneLayer): Promise<__esri.SceneLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.DimensionLayer): Promise<__esri.DimensionLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.MediaLayer): Promise<__esri.MediaLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.ViewshedLayer): Promise<__esri.ViewshedLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.LineOfSightLayer): Promise<__esri.LineOfSightLayerView>;
+    /**
+     * Gets the LayerView created on the view for the given layer.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)
+     */
     whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>;
+    /**
+     * 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)
+     */
     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)
+     */
     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)
+     */
     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.
+     */
     readonly arcgisViewChange: TargetedEvent<this, void>;
+    /** Fires after a user clicks on the view. */
     readonly arcgisViewClick: TargetedEvent<this, __esri.ViewClickEvent>;
+    /** Fires after double-clicking on the view. */
     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. */
     readonly arcgisViewHold: TargetedEvent<this, __esri.ViewHoldEvent>;
+    /** Fires right after a user clicks on the view. */
     readonly arcgisViewImmediateClick: TargetedEvent<this, __esri.ViewImmediateClickEvent>;
+    /** Is emitted after two consecutive immediate-click events. */
     readonly arcgisViewImmediateDoubleClick: TargetedEvent<this, __esri.ViewImmediateDoubleClickEvent>;
+    /** Fires after a keyboard key is pressed. */
     readonly arcgisViewKeyDown: TargetedEvent<this, __esri.ViewKeyDownEvent>;
+    /** Fires after a keyboard key is pressed. */
     readonly arcgisViewKeyUp: TargetedEvent<this, __esri.ViewKeyUpEvent>;
+    /** Fires after each layer in the map has a corresponding LayerView 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. */
     readonly arcgisViewLayerviewCreateError: TargetedEvent<this, __esri.ViewLayerviewCreateErrorEvent>;
+    /** Fires after a LayerView 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. */
     readonly arcgisViewMouseWheel: TargetedEvent<this, __esri.ViewMouseWheelEvent>;
+    /** Fires after a mouse button is pressed, or a finger touches the display. */
     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. */
     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.
+     */
     readonly arcgisViewReadyChange: TargetedEvent<this, void>;
     private _map: __esri.Map;
     readonly _setterTypes: {

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

@@ -1,20 +1,20 @@
-import { c as p } from "../../chunks/runtime.js";
+import { c } from "../../chunks/runtime.js";
 import { html as a } from "lit";
 import l from "@arcgis/core/core/Collection.js";
 import { watch as s } from "@arcgis/core/core/reactiveUtils.js";
 import v from "@arcgis/core/views/MapView.js";
 import m from "@arcgis/core/WebMap.js";
 import { LitElement as d, createEvent as r, safeClassMap as h } from "@arcgis/lumina";
-import { useDirection as g } from "@arcgis/lumina/controllers";
-import { makeAccessorController as c, reEmitEvent as e, reCreateAccessor as y } from "@arcgis/lumina/controllers/accessor";
+import { makeAccessorController as p, reEmitEvent as e, reCreateAccessor as g } from "@arcgis/lumina/controllers/accessor";
 import { createRef as n, ref as o } from "lit/directives/ref.js";
 import { s as u } from "../../chunks/esri-main.js";
-import { s as f, C as w, a as V } from "../../chunks/slots.js";
-import { c as b, i as C } from "../../chunks/component-utils.js";
+import { s as y, C as w } from "../../chunks/slots.js";
+import { c as f, i as V } from "../../chunks/component-utils.js";
+import { U as b } from "../../chunks/uiController.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.133 */
-const E = c(
+v4.34.0-next.135 */
+const C = p(
   m,
   /**
    * Since omitProps is only needed for typing, not runtime, `{} as { ... }` is
@@ -25,10 +25,10 @@ const E = c(
    * in an externalized package.
    */
   {}
-), k = c(v, {});
-class A extends d {
+), E = p(v, {});
+class _ extends d {
   constructor() {
-    super(), this._containerRef = n(), this._direction = g(), this._mapRef = n(), this.extraContent = new l(), this._map = E(this), this.view = k(this), this.allLayerViews = this.view.allLayerViews, this.analyses = this.view.analyses, this.autoDestroyDisabled = !1, this.background = this.view.background, this.basemap = this._map.basemap, this.basemapView = this.view.basemapView, this.constraints = this.view.constraints, this.displayFilterDisabled = this.view.displayFilterEnabled, this.fatalError = this.view.fatalError, this.floors = this.view.floors, this.graphics = this.view.graphics, this.ground = this._map.ground, this.highlights = this.view.highlights, this.highlightOptions = this.view.highlightOptions, this.ipsInfo = this._map.ipsInfo, this.layerViews = this.view.layerViews, this.magnifier = this.view.magnifier, this.map = this.view.map, this.navigation = this.view.navigation, this.padding = this.view.padding, this.popup = this.view.popup, this.popupDisabled = this.view.popupEnabled, this.ready = this.view.ready, this.resizeAlign = this.view.resizeAlign, this.resolution = this.view.resolution, this.rotation = this.view.rotation, this.spatialReference = this.view.spatialReference, this.spatialReferenceLocked = this.view.spatialReferenceLocked, this.suspended = this.view.suspended, this.theme = this.view.theme, this.timeExtent = this.view.timeExtent, this.timeZone = this.view.timeZone, this.updating = this.view.updating, this.visibleArea = this.view.visibleArea, this.arcgisViewAnalysisViewCreate = e(() => this.view, "analysis-view-create"), this.arcgisViewAnalysisViewCreateError = e(() => this.view, "analysis-view-create-error"), this.arcgisViewAnalysisViewDestroy = e(() => this.view, "analysis-view-destroy"), this.arcgisViewChange = r(), this.arcgisViewClick = e(() => this.view, "click"), this.arcgisViewDoubleClick = e(() => this.view, "double-click"), this.arcgisViewDrag = e(() => this.view, "drag"), this.arcgisViewHold = e(() => this.view, "hold"), this.arcgisViewImmediateClick = e(() => this.view, "immediate-click"), this.arcgisViewImmediateDoubleClick = e(() => this.view, "immediate-double-click"), this.arcgisViewKeyDown = e(() => this.view, "key-down"), this.arcgisViewKeyUp = e(() => this.view, "key-up"), this.arcgisViewLayerviewCreate = e(() => this.view, "layerview-create"), this.arcgisViewLayerviewCreateError = e(() => this.view, "layerview-create-error"), this.arcgisViewLayerviewDestroy = e(() => this.view, "layerview-destroy"), this.arcgisViewMouseWheel = e(() => this.view, "mouse-wheel"), this.arcgisViewPointerDown = e(() => this.view, "pointer-down"), this.arcgisViewPointerEnter = e(() => this.view, "pointer-enter"), this.arcgisViewPointerLeave = e(() => this.view, "pointer-leave"), this.arcgisViewPointerMove = e(() => this.view, "pointer-move"), this.arcgisViewPointerUp = e(() => this.view, "pointer-up"), this.arcgisViewReadyChange = r(), this.view.ui = {
+    super(), this._containerRef = n(), this._mapRef = n(), this._uiController = new b(this), this.extraContent = new l(), this._map = C(this), this.view = E(this), this.allLayerViews = this.view.allLayerViews, this.analyses = this.view.analyses, this.autoDestroyDisabled = !1, this.background = this.view.background, this.basemap = this._map.basemap, this.basemapView = this.view.basemapView, this.constraints = this.view.constraints, this.displayFilterDisabled = this.view.displayFilterEnabled, this.fatalError = this.view.fatalError, this.floors = this.view.floors, this.graphics = this.view.graphics, this.ground = this._map.ground, this.highlights = this.view.highlights, this.highlightOptions = this.view.highlightOptions, this.ipsInfo = this._map.ipsInfo, this.layerViews = this.view.layerViews, this.magnifier = this.view.magnifier, this.map = this.view.map, this.navigation = this.view.navigation, this.padding = this.view.padding, this.popup = this.view.popup, this.popupDisabled = this.view.popupEnabled, this.ready = this.view.ready, this.resizeAlign = this.view.resizeAlign, this.resolution = this.view.resolution, this.rotation = this.view.rotation, this.spatialReference = this.view.spatialReference, this.spatialReferenceLocked = this.view.spatialReferenceLocked, this.suspended = this.view.suspended, this.theme = this.view.theme, this.timeExtent = this.view.timeExtent, this.timeZone = this.view.timeZone, this.updating = this.view.updating, this.visibleArea = this.view.visibleArea, this.arcgisViewAnalysisViewCreate = e(() => this.view, "analysis-view-create"), this.arcgisViewAnalysisViewCreateError = e(() => this.view, "analysis-view-create-error"), this.arcgisViewAnalysisViewDestroy = e(() => this.view, "analysis-view-destroy"), this.arcgisViewChange = r(), this.arcgisViewClick = e(() => this.view, "click"), this.arcgisViewDoubleClick = e(() => this.view, "double-click"), this.arcgisViewDrag = e(() => this.view, "drag"), this.arcgisViewHold = e(() => this.view, "hold"), this.arcgisViewImmediateClick = e(() => this.view, "immediate-click"), this.arcgisViewImmediateDoubleClick = e(() => this.view, "immediate-double-click"), this.arcgisViewKeyDown = e(() => this.view, "key-down"), this.arcgisViewKeyUp = e(() => this.view, "key-up"), this.arcgisViewLayerviewCreate = e(() => this.view, "layerview-create"), this.arcgisViewLayerviewCreateError = e(() => this.view, "layerview-create-error"), this.arcgisViewLayerviewDestroy = e(() => this.view, "layerview-destroy"), this.arcgisViewMouseWheel = e(() => this.view, "mouse-wheel"), this.arcgisViewPointerDown = e(() => this.view, "pointer-down"), this.arcgisViewPointerEnter = e(() => this.view, "pointer-enter"), this.arcgisViewPointerLeave = e(() => this.view, "pointer-leave"), this.arcgisViewPointerMove = e(() => this.view, "pointer-move"), this.arcgisViewPointerUp = e(() => this.view, "pointer-up"), this.arcgisViewReadyChange = r(), this.view.ui = {
       components: ["attribution"]
     };
   }
@@ -36,13 +36,13 @@ class A extends d {
     this.properties = { _map: 16, view: 32, allLayerViews: 0, analyses: 0, autoDestroyDisabled: 5, background: 0, basemap: 1, basemapView: 0, center: 1, constraints: 0, displayFilterDisabled: 5, extent: 0, fatalError: 0, floors: 0, focusAreas: 0, gamepad: 32, graphics: 0, ground: 1, highlights: 0, highlightOptions: 0, interacting: 32, ipsInfo: 0, itemId: 3, layerViews: 0, magnifier: 0, map: 0, navigating: 32, navigation: 0, padding: 0, popup: 0, popupDisabled: 5, ready: 4, resizeAlign: 1, resolution: 8, rotation: 9, scale: 9, spatialReference: 0, spatialReferenceLocked: 5, stationary: 32, suspended: 7, theme: 0, timeExtent: 0, timeZone: 1, updating: 4, viewpoint: 0, visibleArea: 0, zoom: 9 };
   }
   static {
-    this.styles = [u, f];
+    this.styles = [u, y];
   }
   get center() {
     return this.view.center;
   }
   set center(i) {
-    const t = b(i, this.view);
+    const t = f(i, this.view);
     t && (this.view.center = t);
   }
   get extent() {
@@ -70,7 +70,7 @@ class A extends d {
     return this._map.portalItem?.id;
   }
   set itemId(i) {
-    y(this._map, this), this._map.portalItem = { id: i }, this.view.map = this._map;
+    g(this._map, this), this._map.portalItem = { id: i }, this.view.map = this._map;
   }
   get navigating() {
     return this.view.navigating;
@@ -88,7 +88,7 @@ class A extends d {
     return this.view.viewpoint;
   }
   set viewpoint(i) {
-    C(this.viewpoint, i) && (this.view.viewpoint = i);
+    V(this.viewpoint, i) && (this.view.viewpoint = i);
   }
   get zoom() {
     return this.view.zoom;
@@ -109,6 +109,10 @@ class A extends d {
     this.map?.tables.addMany(i, t);
   }
   async closePopup() {
+    if (this.popupDisabled) {
+      this._uiController.closePopup();
+      return;
+    }
     this.view.closePopup();
   }
   async destroy() {
@@ -121,6 +125,10 @@ class A extends d {
     return await this.view.hitTest(i, t);
   }
   async openPopup(i) {
+    if (this.popupDisabled) {
+      this._uiController.openPopup(i);
+      return;
+    }
     await this.view.openPopup(i);
   }
   async takeScreenshot(i) {
@@ -158,10 +166,10 @@ class A extends d {
     return a`<div class=${h(w.base)} ${o(this._mapRef)}></div>`;
   }
   render() {
-    return a`<section class=${h(w.containerUI)} ${o(this._containerRef)}>${V(this._direction)}${this.extraContent}</section>${this.renderMain()}`;
+    return a`<section class=${h(w.containerUI)} ${o(this._containerRef)}>${this._uiController.render()}${this.extraContent}</section>${this.renderMain()}`;
   }
 }
-p("arcgis-map", A);
+c("arcgis-map", _);
 export {
-  A as ArcgisMap
+  _ as ArcgisMap
 };