@arcgis/map-components 5.1.0-next.104 → 5.1.0-next.107

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

@@ -1,20 +1,19 @@
 /// <reference path="../../index.d.ts" />
-import type ActionButton from "@arcgis/core/support/actions/ActionButton.js";
+import type FeaturesViewModel from "@arcgis/core/widgets/Features/FeaturesViewModel.js";
 import type Collection from "@arcgis/core/core/Collection.js";
-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 FeatureAbilities from "@arcgis/core/popup/support/FeatureAbilities.js";
-import type FeatureViewModel from "@arcgis/core/widgets/Feature/FeatureViewModel.js";
+import type Widget from "@arcgis/core/widgets/Widget.js";
 import type Map from "@arcgis/core/Map.js";
 import type SpatialReference from "@arcgis/core/geometry/SpatialReference.js";
-import type { ActionEvent, FetchFeaturesOptions } from "@arcgis/core/widgets/Popup/types.js";
-import type { ArcgisFeature } from "../arcgis-feature/customElement.js";
 import type { ArcgisReferenceElement, IconName, HeadingLevel } from "../types.js";
-import type { ScreenPoint } from "@arcgis/core/core/types.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { ArcgisFeature } from "../arcgis-feature/customElement.js";
+import type { ActionEvent, FetchFeaturesOptions, PopupAction, InitialDisplayOptions, State } from "@arcgis/core/widgets/Popup/types.js";
+import type { ScreenPoint } from "@arcgis/core/core/types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
-import type { PopupAction, InitialDisplayOptions, State } from "@arcgis/core/popup/types.js";
+import type { Abilities } from "@arcgis/core/widgets/Feature/types.js";
 import type { GoToOverride } from "@arcgis/core/widgets/support/types.js";
 import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
 
@@ -52,7 +51,7 @@ export abstract class ArcgisFeatures 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/widgets/Features/FeaturesViewModel/#waitingForResult) for results.
    *
    * @default false
    */
@@ -73,7 +72,7 @@ export abstract class ArcgisFeatures extends LitElement {
    * @default false
    * @since 5.0
    */
-  accessor chartAnimationDisabled: boolean | undefined;
+  accessor chartAnimationDisabled: boolean;
   /**
    * Indicates whether the component displays its content. If `true`, only the header displays.
    * This property is only honored if [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#showCollapseButton) is `true`.
@@ -91,7 +90,7 @@ export abstract class ArcgisFeatures extends LitElement {
    * component.content = "Click a feature on the map to view its attributes";
    * ```
    */
-  accessor content: string | HTMLElement | null | undefined;
+  accessor content: string | HTMLElement | Widget<any> | null | undefined;
   /**
    * Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.
    *
@@ -102,22 +101,12 @@ export abstract class ArcgisFeatures extends LitElement {
    * @since 4.34
    */
   accessor defaultPopupTemplateEnabled: boolean;
-  /**
-   * The heading currently displayed for the selected feature. This value resolves to the [selected feature item's heading](https://developers.arcgis.com/javascript/latest/references/core/popup/Features/#effectiveHeading) when available, otherwise it falls back to the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading).
-   *
-   * @since 5.1
-   * @see [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading)
-   * @see [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature)
-   */
-  get effectiveHeading(): string | null | undefined;
   /**
    * The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) available in the component.
    *
    * @since 4.34
    */
   accessor featureCount: number;
-  /** Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/references/core/widgets/Feature/FeatureViewModel/#Abilities) that can be used when querying and displaying content. */
-  accessor featureItemAbilities: FeatureAbilities | null | undefined;
   /**
    * This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#initialDisplayMode) is set to "feature".
    *
@@ -130,7 +119,7 @@ export abstract class ArcgisFeatures extends LitElement {
    *
    * @since 4.34
    */
-  accessor featureMenuTitle: string | undefined;
+  accessor featureMenuTitle: string | null | undefined;
   /**
    * Indicates whether the feature navigation arrows are displayed at the top of the component.
    * By default, the navigation arrows are displayed at the bottom of the component.
@@ -169,12 +158,8 @@ export abstract class ArcgisFeatures extends LitElement {
    * @default 20
    */
   accessor featuresPerPage: number;
-  /**
-   * Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/references/core/widgets/Feature/FeatureViewModel/#Abilities) that can be used when querying and displaying content.
-   *
-   * @deprecated since 5.1. Use [featureItemAbilities](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#featureItemAbilities) instead to set abilities on a per feature basis.
-   */
-  accessor featureViewModelAbilities: FeatureViewModel["abilities"] | null | undefined;
+  /** Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/references/core/widgets/Feature/FeatureViewModel/#Abilities) that can be used when querying and displaying content. */
+  accessor featureViewModelAbilities: Abilities | null | undefined;
   /**
    * This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.
    *
@@ -230,7 +215,7 @@ export abstract class ArcgisFeatures extends LitElement {
    * @default false
    * @since 5.0
    */
-  accessor hideAttachmentsContent: boolean | undefined;
+  accessor hideAttachmentsContent: boolean;
   /**
    * Indicates whether to hide the close button in the component.
    *
@@ -250,7 +235,7 @@ export abstract class ArcgisFeatures extends LitElement {
    * @default false
    * @since 5.0
    */
-  accessor hideCustomContent: boolean | undefined;
+  accessor hideCustomContent: boolean;
   /**
    * This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.
    *
@@ -283,7 +268,7 @@ export abstract class ArcgisFeatures extends LitElement {
    * @default false
    * @since 5.0
    */
-  accessor hideFieldsContent: boolean | undefined;
+  accessor hideFieldsContent: boolean;
   /**
    * Indicates whether to hide the heading in the component.
    *
@@ -303,14 +288,14 @@ export abstract class ArcgisFeatures extends LitElement {
    * @default false
    * @since 5.0
    */
-  accessor hideMediaContent: boolean | undefined;
+  accessor hideMediaContent: boolean;
   /**
    * This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.
    *
    * @default false
    * @since 5.0
    */
-  accessor hideRelationshipContent: boolean | undefined;
+  accessor hideRelationshipContent: boolean;
   /**
    * Indicates whether to hide the *select feature* action when viewing associated and related features.
    *
@@ -330,14 +315,14 @@ export abstract class ArcgisFeatures extends LitElement {
    * @default false
    * @since 5.0
    */
-  accessor hideTextContent: boolean | undefined;
+  accessor hideTextContent: boolean;
   /**
    * This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.
    *
    * @default false
    * @since 5.0
    */
-  accessor hideUtilityNetworkContent: boolean | undefined;
+  accessor hideUtilityNetworkContent: boolean;
   /**
    * Indicates whether to highlight the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature) in the associated
    * [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.
@@ -394,12 +379,9 @@ export abstract class ArcgisFeatures extends LitElement {
   accessor messageOverrides: {
       componentLabel?: string | undefined;
       zoom?: string | undefined;
-      browseAggregatedFeatures?: string | undefined;
-      aggregatedFeatures?: string | undefined;
-      aggregatedFeaturesPlaceholder?: string | undefined;
+      browseClusteredFeatures?: string | undefined;
       collapse?: string | undefined;
       expand?: string | undefined;
-      noAggregatedFeatures?: string | undefined;
       featuresList?: string | undefined;
       total?: string | undefined;
       pageText?: string | undefined;
@@ -421,12 +403,9 @@ export abstract class ArcgisFeatures extends LitElement {
   protected messages: Partial<{
       componentLabel: string;
       zoom: string;
-      browseAggregatedFeatures: string;
-      aggregatedFeatures: string;
-      aggregatedFeaturesPlaceholder: string;
+      browseClusteredFeatures: string;
       collapse: string;
       expand: string;
-      noAggregatedFeatures: string;
       featuresList: string;
       total: string;
       pageText: string;
@@ -446,12 +425,9 @@ export abstract class ArcgisFeatures extends LitElement {
   }> & T9nMeta<{
       componentLabel: string;
       zoom: string;
-      browseAggregatedFeatures: string;
-      aggregatedFeatures: string;
-      aggregatedFeaturesPlaceholder: string;
+      browseClusteredFeatures: string;
       collapse: string;
       expand: string;
-      noAggregatedFeatures: string;
       featuresList: string;
       total: string;
       pageText: string;
@@ -568,7 +544,7 @@ export abstract class ArcgisFeatures extends LitElement {
    */
   accessor timeZone: string;
   /**
-   * Indicates whether to update the feature location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex) changes.
+   * Indicates whether to update the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#location) when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex) changes.
    *
    * @default false
    * @since 5.0
@@ -588,7 +564,7 @@ export abstract class ArcgisFeatures extends LitElement {
    */
   accessor view: MapViewOrSceneView | null | undefined;
   /** @since 4.34 */
-  accessor viewModel: Features;
+  accessor viewModel: FeaturesViewModel;
   /**
    * Removes [promises](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#promises), [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#content), and
    * [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading) from the Features component.
@@ -627,13 +603,13 @@ export abstract class ArcgisFeatures extends LitElement {
    *
    * @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex)
    */
-  next(): Promise<Features>;
+  next(): Promise<FeaturesViewModel>;
   /**
    * Selects the feature at the previous index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).
    *
    * @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex)
    */
-  previous(): Promise<Features>;
+  previous(): Promise<FeaturesViewModel>;
   /**
    * Use this method to give focus to the Component if the component is able to be focused.
    *
@@ -650,7 +626,7 @@ export abstract class ArcgisFeatures extends LitElement {
   /** 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"; }>;
+  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "active" | "collapsed" | "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 arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
   /**