@arcgis/map-components 5.1.0-next.12 → 5.1.0-next.120

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

@@ -33,9 +33,12 @@ import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.j
  * list of features to be displayed so the user can choose which feature content to display in the component. The component also respects
  * feature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate).
  *
- * The Features component should be used if needing to use the Popup functionality outside of the map or scene component. If wanting to show a single feature's content without
+ * The Features 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](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) component.
  *
+ * > [!WARNING]
+ * > In version 6.0, the implementation of [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) will be updated under the hood to that of [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/), and deprecated properties on this component will be removed. We encourage using the [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/) component and providing feedback.
+ *
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)
  * @since 4.28
  */
@@ -101,6 +104,14 @@ 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'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/#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 | undefined;
   /**
    * The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) available in the component.
    *
@@ -129,9 +140,9 @@ export abstract class ArcgisFeatures extends LitElement {
    */
   accessor featureNavigationTop: boolean;
   /**
-   * An array of features 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/#content) and [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#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/).
+   * 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/#content) and [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#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/#selectedFeature)).
+   * 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/#selectedFeature).
    *
    * This value is `null` if no features are associated with the component.
    *
@@ -270,7 +281,7 @@ export abstract class ArcgisFeatures extends LitElement {
    */
   accessor hideFieldsContent: boolean;
   /**
-   * Indicates whether to hide the heading in the component.
+   * Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading).
    *
    * @default false
    */
@@ -296,6 +307,13 @@ export abstract class ArcgisFeatures extends LitElement {
    * @since 5.0
    */
   accessor hideRelationshipContent: boolean;
+  /**
+   * Indicates whether to hide the *select feature* action when viewing associated and related features.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor hideSelectFeature: boolean;
   /**
    * Indicates whether to hide the spinner in the component.
    *
@@ -373,6 +391,8 @@ export abstract class ArcgisFeatures extends LitElement {
       componentLabel?: string | undefined;
       zoom?: string | undefined;
       browseClusteredFeatures?: string | undefined;
+      collapse?: string | undefined;
+      expand?: string | undefined;
       featuresList?: string | undefined;
       total?: string | undefined;
       pageText?: string | undefined;
@@ -389,12 +409,18 @@ export abstract class ArcgisFeatures extends LitElement {
       back?: string | undefined;
       errorMessage?: string | undefined;
       returnToInitialFeature?: string | undefined;
+      maxRecordCountHeading?: string | undefined;
+      maxRecordCountDescriptionWithLayerList?: string | undefined;
+      maxRecordCountDescriptionMultipleLayers?: string | undefined;
+      maxRecordCountDescriptionMaxZoomLevel?: string | undefined;
   };
   /** @internal */
   protected messages: Partial<{
       componentLabel: string;
       zoom: string;
       browseClusteredFeatures: string;
+      collapse: string;
+      expand: string;
       featuresList: string;
       total: string;
       pageText: string;
@@ -411,10 +437,16 @@ export abstract class ArcgisFeatures extends LitElement {
       back: string;
       errorMessage: string;
       returnToInitialFeature: string;
+      maxRecordCountHeading: string;
+      maxRecordCountDescriptionWithLayerList: string;
+      maxRecordCountDescriptionMultipleLayers: string;
+      maxRecordCountDescriptionMaxZoomLevel: string;
   }> & T9nMeta<{
       componentLabel: string;
       zoom: string;
       browseClusteredFeatures: string;
+      collapse: string;
+      expand: string;
       featuresList: string;
       total: string;
       pageText: string;
@@ -431,13 +463,17 @@ export abstract class ArcgisFeatures extends LitElement {
       back: string;
       errorMessage: string;
       returnToInitialFeature: string;
+      maxRecordCountHeading: string;
+      maxRecordCountDescriptionWithLayerList: string;
+      maxRecordCountDescriptionMultipleLayers: string;
+      maxRecordCountDescriptionMaxZoomLevel: 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.
    *
    * @default false
-   * @see [fetchFeatures()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#fetchFeatures)
-   * @see [active](https://developers.arcgis.com/javascript/latest/references/core/widgets/Features/FeaturesViewModel/#active)
+   * @see [active](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#active)
+   * @see [clear()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#clear)
    * @since 5.0
    * @example
    * ```js
@@ -467,11 +503,12 @@ export abstract class ArcgisFeatures extends LitElement {
   accessor referenceElement: ArcgisReferenceElement | string | undefined;
   /**
    * The feature that the component has drilled into.
-   * This feature is either associated with the selected feature in a [relationship](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) or [utility network](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) element.
+   * This feature is either associated with the selected feature in a [relationship](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/)
+   * or [utility network](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) element.
    *
    * @since 4.34
    */
-  get selectedDrillInFeature(): Graphic | null | undefined;
+  get selectedDrillInFeature(): Graphic | undefined;
   /**
    * The selected feature accessed by the Features component. The content displayed in the component is
    * determined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) assigned to this feature.
@@ -483,7 +520,7 @@ export abstract class ArcgisFeatures extends LitElement {
    *
    * @since 4.34
    */
-  get selectedFeatureComponent(): ArcgisFeature | null;
+  get selectedFeatureComponent(): ArcgisFeature | undefined;
   /**
    * Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) are set,
    * the first index is automatically selected.
@@ -526,7 +563,7 @@ export abstract class ArcgisFeatures extends LitElement {
    */
   accessor timeZone: string;
   /**
-   * 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.
+   * Indicates whether to update the component's location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex) changes.
    *
    * @default false
    * @since 5.0
@@ -545,7 +582,10 @@ export abstract class ArcgisFeatures extends LitElement {
    * @since 4.34
    */
   accessor view: MapViewOrSceneView | null | undefined;
-  /** @since 4.34 */
+  /**
+   * @deprecated since 5.1. Use properties directly on the component instead of accessing them through the `viewModel`. For example, instead of `viewModel.active`, use `active`.
+   * @since 4.34
+   */
   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
@@ -557,7 +597,7 @@ export abstract class ArcgisFeatures extends LitElement {
   /** 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-features/#location) based on the input event's screen coordinates.
+   * 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 based on the input event's screen coordinates.
    *
    * @param screenPoint
    * @param options
@@ -583,12 +623,18 @@ export abstract class ArcgisFeatures extends LitElement {
   /**
    * Selects the feature at the next index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).
    *
+   * > [!WARNING]
+   * > The return type of `FeaturesViewModel` on the `next()` method is deprecated. At 6.0, this method will return void. See [arcgis-features-next.next()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#next) for the updated usage.
+   *
    * @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex)
    */
   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).
    *
+   * > [!WARNING]
+   * > The return type of `FeaturesViewModel` on the `previous()` method is deprecated. At 6.0, this method will return void. See [arcgis-features-next.previous()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#previous) for the updated usage.
+   *
    * @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex)
    */
   previous(): Promise<FeaturesViewModel>;
@@ -608,7 +654,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" | "featureCount" | "featureMenuOpen" | "features" | "promises" | "selectedDrillInFeature" | "selectedFeature" | "selectedFeatureComponent" | "selectedFeatureIndex" | "state" | "open"; }>;
+  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 arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
   /**