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

package/dist/components/arcgis-features-next/customElement.d.ts

@@ -4,6 +4,7 @@ import type Collection from "@arcgis/core/core/Collection.js";
 import type ActionToggle from "@arcgis/core/support/actions/ActionToggle.js";
 import type Graphic from "@arcgis/core/Graphic.js";
 import type FeatureAbilities from "@arcgis/core/popup/support/FeatureAbilities.js";
+import type Point from "@arcgis/core/geometry/Point.js";
 import type Map from "@arcgis/core/Map.js";
 import type SpatialReference from "@arcgis/core/geometry/SpatialReference.js";
 import type { ActionEvent } from "@arcgis/core/widgets/Popup/types.js";
@@ -12,6 +13,7 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 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";
 
@@ -36,6 +38,14 @@ import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.j
  * The Features (next) component should be used if needing to use the Popup functionality outside of the map or scene component. To show a single feature's content without
  * actions, related records, clustering configuration, etc., then use the [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/) component.
  *
+ * @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-features-next/#actions).
+ *
+ * To display text on the action, use the `text-enabled` attribute of the Calcite [action](https://developers.arcgis.com/calcite-design-system/components/action/#api-reference-properties-textEnabled).
+ * @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-features-next/#actions).
+ *
+ * To display text on the action, use the `text-enabled` attribute of the Calcite [action](https://developers.arcgis.com/calcite-design-system/components/action/#api-reference-properties-textEnabled).
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)
  * @see [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/)
  * @see [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/)
@@ -54,7 +64,7 @@ export abstract class ArcgisFeaturesNext 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) for results.
+   * Indicates if the component is active when it is visible and is not [waiting](https://developers.arcgis.com/javascript/latest/references/core/popup/FeaturesModel/#waitingForResult) for results.
    *
    * @default false
    */
@@ -67,6 +77,15 @@ export abstract class ArcgisFeaturesNext extends LitElement {
    * prevent memory leaks.
    *
    * @default false
+   * @example
+   * ```html
+   * <arcgis-features-next auto-destroy-disabled></arcgis-features-next>
+   * ```
+   *
+   * ```js
+   * featuresNextElement.autoDestroyDisabled = true;
+   * ```
+   * 
    */
   accessor autoDestroyDisabled: boolean;
   /**
@@ -111,6 +130,12 @@ export abstract class ArcgisFeaturesNext extends LitElement {
    * @default false
    */
   accessor defaultPopupTemplateEnabled: boolean;
+  /**
+   * Diagnostics collected while fetching features from a view.
+   *
+   * @since 5.2
+   */
+  accessor diagnostics: FetchPopupFeaturesDiagnostics | null | undefined;
   /**
    * The heading currently displayed for the selected feature. This value resolves to the selected feature's [PopupTemplate title](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#title) when available, otherwise it falls back to the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading).
    *
@@ -143,7 +168,7 @@ export abstract class ArcgisFeaturesNext extends LitElement {
   accessor featureNavigationTop: boolean;
   /**
    * An array of graphics associated with the component. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#content) and [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading) of the component is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).
-   *       
+   *
    * When more than one graphic exists in this array, the current content of the component is set based on the value of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).
    *
    * This value is `null` if no features are associated with the component.
@@ -211,9 +236,19 @@ export abstract class ArcgisFeaturesNext extends LitElement {
    */
   accessor heading: string | null | undefined;
   /**
-   * Indicates the heading level to use for the headings in the component.
+   * Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.
    *
    * @default 2
+   * @see [HTML heading elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)
+   * @example
+   * ```html
+   * <arcgis-features-next heading-level="2"></arcgis-features-next>
+   * ```
+   *
+   * ```js
+   * featuresNextElement.headingLevel = 2;
+   * ```
+   * 
    */
   accessor headingLevel: HeadingLevel;
   /**
@@ -246,6 +281,13 @@ export abstract class ArcgisFeaturesNext extends LitElement {
    * @default false
    */
   accessor hideCustomContent: boolean | undefined;
+  /**
+   * 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 [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.
    *
@@ -280,6 +322,15 @@ export abstract class ArcgisFeaturesNext extends LitElement {
    * Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading).
    *
    * @default false
+   * @example
+   * ```html
+   * <arcgis-features-next hide-heading></arcgis-features-next>
+   * ```
+   *
+   * ```js
+   * featuresNextElement.hideHeading = true;
+   * ```
+   * 
    */
   accessor hideHeading: boolean;
   /**
@@ -349,12 +400,17 @@ export abstract class ArcgisFeaturesNext 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 `focusRegionVisible` enabled; otherwise, the content for one feature is displayed.
    */
   accessor initialDisplayMode: InitialDisplayOptions;
   /** The component's default label. */
   accessor label: string | undefined;
+  /**
+   * The [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) representing the location of the map interaction used to trigger the opening of the component.
+   *
+   * @since 5.2
+   */
+  accessor location: Point | null | undefined;
   /**
    * A map is required when the input [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) have a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use the `$map` profile variable to access data from layers within a map. Without a map, expressions that use `$map` will throw an error.
    *
@@ -375,9 +431,10 @@ export abstract class ArcgisFeaturesNext extends LitElement {
    *
    * _**Note**: Individual message keys may change between releases._
    */
-  accessor messageOverrides: {
+  accessor messageOverrides: NonNullable<ArcgisFeatureNext["messageOverrides"]> & {
       componentLabel?: string | undefined;
       zoom?: string | undefined;
+      zoomLabel?: string | undefined;
       browseAggregatedFeatures?: string | undefined;
       aggregatedFeatures?: string | undefined;
       aggregatedFeaturesPlaceholder?: string | undefined;
@@ -388,6 +445,7 @@ export abstract class ArcgisFeaturesNext extends LitElement {
       total?: string | undefined;
       pageText?: string | undefined;
       selectFeature?: string | undefined;
+      showAllFeatures?: string | undefined;
       down?: string | undefined;
       first?: string | undefined;
       last?: string | undefined;
@@ -398,17 +456,20 @@ export abstract class ArcgisFeaturesNext extends LitElement {
       untitled?: string | undefined;
       loading?: string | undefined;
       back?: string | undefined;
+      backLabel?: string | undefined;
       errorMessage?: string | undefined;
       returnToInitialFeature?: string | undefined;
       maxRecordCountHeading?: string | undefined;
       maxRecordCountDescriptionWithLayerList?: string | undefined;
+      maxRecordCountDescriptionRefineResults?: string | undefined;
       maxRecordCountDescriptionMultipleLayers?: string | undefined;
-      maxRecordCountDescriptionMaxZoomLevel?: string | undefined;
+      maxRecordCountDescriptionRefineResultsMaxZoomLevel?: string | undefined;
   };
   /** @internal */
   protected messages: Partial<{
       componentLabel: string;
       zoom: string;
+      zoomLabel: string;
       browseAggregatedFeatures: string;
       aggregatedFeatures: string;
       aggregatedFeaturesPlaceholder: string;
@@ -419,6 +480,7 @@ export abstract class ArcgisFeaturesNext extends LitElement {
       total: string;
       pageText: string;
       selectFeature: string;
+      showAllFeatures: string;
       down: string;
       first: string;
       last: string;
@@ -429,15 +491,18 @@ export abstract class ArcgisFeaturesNext extends LitElement {
       untitled: string;
       loading: string;
       back: string;
+      backLabel: string;
       errorMessage: string;
       returnToInitialFeature: string;
       maxRecordCountHeading: string;
       maxRecordCountDescriptionWithLayerList: string;
+      maxRecordCountDescriptionRefineResults: string;
       maxRecordCountDescriptionMultipleLayers: string;
-      maxRecordCountDescriptionMaxZoomLevel: string;
+      maxRecordCountDescriptionRefineResultsMaxZoomLevel: string;
   }> & T9nMeta<{
       componentLabel: string;
       zoom: string;
+      zoomLabel: string;
       browseAggregatedFeatures: string;
       aggregatedFeatures: string;
       aggregatedFeaturesPlaceholder: string;
@@ -448,6 +513,7 @@ export abstract class ArcgisFeaturesNext extends LitElement {
       total: string;
       pageText: string;
       selectFeature: string;
+      showAllFeatures: string;
       down: string;
       first: string;
       last: string;
@@ -458,12 +524,14 @@ export abstract class ArcgisFeaturesNext extends LitElement {
       untitled: string;
       loading: string;
       back: string;
+      backLabel: string;
       errorMessage: string;
       returnToInitialFeature: string;
       maxRecordCountHeading: string;
       maxRecordCountDescriptionWithLayerList: string;
+      maxRecordCountDescriptionRefineResults: string;
       maxRecordCountDescriptionMultipleLayers: string;
-      maxRecordCountDescriptionMaxZoomLevel: string;
+      maxRecordCountDescriptionRefineResultsMaxZoomLevel: string;
   }>;
   /**
    * Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.
@@ -543,12 +611,12 @@ export abstract class ArcgisFeaturesNext extends LitElement {
   get state(): State;
   /**
    * Dates and times displayed in the component will be displayed in this time zone. By default this time zone is
-   * inherited from [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property is set. When a MapView is not associated with the component
+   * inherited from the associated [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) or [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property is set. When a view is not associated with the component
    * then the property will fallback to the `system` time zone.
    *
    * **Possible Values**
    * - `system`: Dates and times will be displayed in the timezone of the device or browser.
-   * - `unknown`: Dates and time are not adjusted for any timezone.
+   * - `unknown`: Dates and times are not adjusted for any timezone.
    * - `Specified IANA timezone`: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
    *
    * @since 5.1
@@ -600,18 +668,11 @@ export abstract class ArcgisFeaturesNext extends LitElement {
    * @since 5.1
    */
   setFocus(): Promise<void>;
-  /**
-   * Triggers the [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#event-arcgisTriggerAction) event and executes the action
-   * at the specified index in the [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#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>;
   /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
-  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "active" | "collapsed" | "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" | "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 component.