@arcgis/map-components 5.2.0-next.13 → 5.2.0-next.131

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

@@ -1,19 +1,16 @@
 /// <reference path="../../index.d.ts" />
-import type Features from "@arcgis/core/popup/Features.js";
-import type ActionButton from "@arcgis/core/support/actions/ActionButton.js";
-import type ActionToggle from "@arcgis/core/support/actions/ActionToggle.js";
 import type Graphic from "@arcgis/core/Graphic.js";
 import type Collection from "@arcgis/core/core/Collection.js";
 import type Point from "@arcgis/core/geometry/Point.js";
 import type { ArcgisReferenceElement, HeadingLevel } from "../types.js";
-import type { Alignment, DockOptions, PopupPositionResult, FetchFeaturesOptions } from "./types.js";
+import type { Alignment, DockOptions, OpenFeatureStreamOptions, PopupPositionResult } from "./types.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ActionEvent, PopupOpenOptions } from "@arcgis/core/widgets/Popup/types.js";
-import type { ScreenPoint } from "@arcgis/core/core/types.js";
-import type { ClickEvent } from "@arcgis/core/views/input/types.js";
+import type { ActionEvent } from "@arcgis/core/widgets/Popup/types.js";
+import type { ArcgisFeaturesNext } from "../arcgis-features-next/customElement.js";
 import type { ArcgisFeatureNext } from "../arcgis-feature-next/customElement.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { PopupAction, InitialDisplayOptions, State } from "@arcgis/core/popup/types.js";
+import type { FetchPopupFeaturesDiagnostics } from "@arcgis/core/views/PopupView.js";
 import type { GoToOverride } from "@arcgis/core/widgets/support/types.js";
 import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
 
@@ -128,6 +125,8 @@ import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.j
  * Custom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) on the
  * [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) property.
  *
+ * @slot [actions-start] - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the start of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the start of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as "Zoom to" and "Browse features"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).
+ * @slot [actions-end] - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the end of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the end of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as "Zoom to" and "Browse features"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).
  * @since 4.34
  * @beta
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)
@@ -144,7 +143,7 @@ export abstract class ArcgisPopup extends LitElement {
    */
   accessor actions: Collection<PopupAction>;
   /**
-   * Indicates if the component is active when it is visible and is not [waiting](https://developers.arcgis.com/javascript/latest/references/core/popup/Features/#waitingForResult).
+   * Indicates if the component is active when it is visible and is not [waiting](https://developers.arcgis.com/javascript/latest/references/core/popup/FeatureContentCollection/#waitingForResult).
    *
    * @default false
    */
@@ -177,6 +176,15 @@ export abstract class ArcgisPopup extends LitElement {
    * prevent memory leaks.
    *
    * @default false
+   * @example
+   * ```html
+   * <arcgis-popup auto-destroy-disabled></arcgis-popup>
+   * ```
+   *
+   * ```js
+   * popupElement.autoDestroyDisabled = true;
+   * ```
+   * 
    */
   accessor autoDestroyDisabled: boolean;
   /**
@@ -207,6 +215,12 @@ export abstract class ArcgisPopup extends LitElement {
    * @default false
    */
   accessor defaultPopupTemplateEnabled: boolean;
+  /**
+   * Diagnostics collected while fetching features from a view.
+   *
+   * @since 5.2
+   */
+  get diagnostics(): FetchPopupFeaturesDiagnostics | null | undefined;
   /**
    * Indicates whether the placement of the popup is docked to the side of the view.
    *
@@ -304,6 +318,12 @@ export abstract class ArcgisPopup extends LitElement {
    * ```
    */
   accessor features: Array<Graphic>;
+  /**
+   * Streams features into the component as they become available.
+   *
+   * @internal
+   */
+  accessor featureStream: AsyncGenerator<Graphic, any, any> | null | undefined;
   /**
    * When `true`, this prevents the popup from trapping focus when opened.
    * Preventing focus trapping can be used in scenarios where interactions are expected within the user interface, such as when the popup resides in a panel.
@@ -383,6 +403,13 @@ export abstract class ArcgisPopup extends LitElement {
    * @default false
    */
   accessor hideCollapseButton: boolean;
+  /**
+   * Indicates whether to hide relationship content when there are no relationship items to display.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor hideEmptyRelationshipContent: boolean;
   /**
    * Indicates whether to hide the group heading for a list of multiple features.
    *
@@ -405,6 +432,15 @@ export abstract class ArcgisPopup extends LitElement {
    * Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading).
    *
    * @default false
+   * @example
+   * ```html
+   * <arcgis-popup hide-heading></arcgis-popup>
+   * ```
+   *
+   * ```js
+   * popupElement.hideHeading = true;
+   * ```
+   * 
    */
   accessor hideHeading: boolean;
   /**
@@ -429,8 +465,7 @@ export abstract class ArcgisPopup extends LitElement {
   accessor includeDefaultActionsDisabled: boolean;
   /**
    * Indicates whether to initially display a list of features, or the content for one feature.
-   *
-   * @default "feature"
+   * By default, a list is displayed when the associated view has `focusRegionEnabled` enabled; otherwise, the content for one feature is displayed.
    */
   accessor initialDisplayMode: InitialDisplayOptions;
   /** The component's default label. */
@@ -467,7 +502,7 @@ export abstract class ArcgisPopup extends LitElement {
    */
   accessor location: Point | null | undefined;
   /** Overwrite localized strings for this component */
-  accessor messageOverrides: {
+  accessor messageOverrides: NonNullable<ArcgisFeaturesNext["messageOverrides"]> & {
       componentLabel?: string | undefined;
       zoom?: string | undefined;
       dock?: string | undefined;
@@ -511,15 +546,6 @@ export abstract class ArcgisPopup extends LitElement {
    * ```
    */
   accessor open: boolean;
-  /**
-   * An array of pending Promises that have not yet been fulfilled. If there are
-   * no pending promises, the value is `null`. When the pending promises are
-   * resolved they are removed from this array and the features they return
-   * are pushed into the [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) array.
-   *
-   * @deprecated since 5.1.
-   */
-  accessor promises: Array<Promise<Array<Graphic>>>;
   /**
    * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
    *
@@ -569,57 +595,52 @@ export abstract class ArcgisPopup extends LitElement {
    */
   accessor updateLocationEnabled: boolean;
   /**
-   * The view associated with the component. 
-   *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-popup component will be associated with a map or scene component rather than using the `view` property.
+   * The view associated with the component.
+   * > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-popup component will be associated with a map or scene component rather than using the `view` property.
    */
   accessor view: MapViewOrSceneView | null | undefined;
   /**
-   * Removes all [promises](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#promises), [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content),
-   * [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading) and [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) from the Popup.
+   * Removes all [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content),
+   * [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading), and [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) from the Popup.
    */
   clear(): Promise<void>;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
   /**
-   * Use this method to return feature(s) at a given screen location. These features are fetched from all of the [LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) in the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/). In order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled). This method allows a developer to control how the input location is handled. For example, you may want to fetch features on a `click` event or on a `pointer-move` event. This method automatically sets the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) based on the input event's screen coordinates.
+   * Selects the feature at the next index in relation to the selected feature.
    *
-   * @deprecated since 5.1. Use the `fetchPopupFeatures` method on the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#fetchPopupFeatures), [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#fetchPopupFeatures), or [Link Chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#fetchPopupFeatures) component to fetch features based on a screen location.
-   * @param screenPoint
-   * @param options
-   * @deprecated
-   * @see [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open)
-   */
-  fetchFeatures(screenPoint?: ScreenPoint, options?: FetchFeaturesOptions): Promise<void>;
-  /**
-   * @param event
-   * @internal
+   * @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeatureIndex)
    */
-  handleViewClick(event: ClickEvent): Promise<PopupOpenOptions>;
+  next(): Promise<void>;
   /**
-   * Selects the feature at the next index in relation to the selected feature.
+   * Opens the popup with a location and a feature stream. Promise batches are converted to a feature stream internally. While waiting, the popup remains at its current location and becomes active when the first feature is available.
+   * If both `featureStream` and `promises` are provided, `featureStream` is used.
+   * If the location is `null` or `undefined`, the first feature's geometry determines the popup location. If no features become available, the popup closes without changing its location.
    *
-   * @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeatureIndex)
+   * @param options - The feature source and location used to open the popup.
+   * @internal
+   * @example
+   * ```js
+   * const featureStream = viewElement.fetchPopupFeatures(event.detail.screenPoint);
+   * await popupComponent.openFeatureStream({
+   *   featureStream,
+   *   location: event.detail.mapPoint
+   * });
+   * ```
    */
-  next(): Promise<Features>;
+  openFeatureStream(options: OpenFeatureStreamOptions): Promise<void>;
   /**
    * Selects the feature at the previous index in relation to the selected feature.
    *
    * @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeatureIndex)
    */
-  previous(): Promise<Features>;
+  previous(): Promise<void>;
   /** Use this method to give focus to the component if the component is able to be focused. */
   setFocus(): Promise<void>;
-  /**
-   * Triggers the [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#event-arcgisTriggerAction) event and executes the [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions)
-   * at the specified index in the [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions) array.
-   *
-   * @param action
-   */
-  triggerAction(action: ActionButton | ActionToggle): Promise<void>;
   /** Emitted when the component's close button is clicked. */
   readonly arcgisClose: import("@arcgis/lumina").TargetedEvent<this, void>;
-  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "active" | "collapsed" | "currentAlignment" | "dockEnabled" | "effectiveHeading" | "featureCount" | "featureMenuOpen" | "features" | "promises" | "selectedDrillInFeature" | "selectedFeature" | "selectedFeatureComponent" | "selectedFeatureIndex" | "state" | "open"; }>;
-  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
+  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "active" | "collapsed" | "currentAlignment" | "dockEnabled" | "effectiveHeading" | "featureCount" | "featureMenuOpen" | "features" | "selectedDrillInFeature" | "selectedFeature" | "selectedFeatureComponent" | "selectedFeatureIndex" | "state" | "open"; }>;
+  /** Emitted when the component associated with a map or scene view is ready for user interaction. */
   readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
   /**
    * Fires after the user clicks on an action in the Popup component.