@arcgis/map-components 4.34.0-next.98 → 4.34.0

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

@@ -1,53 +1,74 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
-import { Use } from '@arcgis/lumina/controllers';
-import { default as Features } from '@arcgis/core/widgets/Features.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { default as FeaturesViewModel } from '@arcgis/core/widgets/Features/FeaturesViewModel.js';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { nil } from '@arcgis/toolkit/type';
+import { Use } from '@arcgis/lumina/controllers';
+import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { HeadingLevel } from '../../support/heading';
+import { default as Collection } from '@arcgis/core/core/Collection.js';
+import { ArcgisFeature } from '../arcgis-feature/customElement.js';
+import { default as ActionButton } from '@arcgis/core/support/actions/ActionButton.js';
+import { default as ActionToggle } from '@arcgis/core/support/actions/ActionToggle.js';
 
-declare const useFeaturesWidget: (component: LitElement & Pick<Features, "map" | "icon" | "label" | "spatialReference" | "timeZone" | "content" | "viewModel" | "headingLevel" | "collapsed" | "goToOverride" | "featureNavigationTop" | "features" | "headerActions" | "initialDisplayMode" | "promises" | "selectedFeatureIndex"> & {
-    state?: unknown;
-    viewModel?: __esri.FeaturesViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/toolkit/type').nil | string;
-    label: import('@arcgis/toolkit/type').nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    position?: __esri.UIPosition;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => Features;
+declare const useFeaturesViewModel: (component: LitElement & Pick<FeaturesViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<FeaturesViewModel>) => FeaturesViewModel;
 /**
- * The Features component allows users to view a feature's popupTemplate content such as attributes, actions, related records, etc., without having to be tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).
+ * The Features component allows users to view a feature's popupTemplate content such as attributes,
+ * actions, related records, etc., without having to be tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ * This component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component,
+ * however unlike Popup, the Features component can be placed outside of the map or scene component.
+ * For example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),
+ * the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) opens within the map whether it is docked
+ * or anchored to the selected feature.
+ * With the Features component, the same information that Popup provides is shown in a separate container from the map, such as
+ * a HTML div within a Calcite Design System
+ * [Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).
+ *
+ * If multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the
+ * 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/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#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
+ * actions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/) component.
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/)
+ *
+ * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html)
+ * @since 4.28
  */
 export declare class ArcgisFeatures extends LitElement {
-    /**
-     * Emitted when the component's close button is clicked.
-     *
-     * @since 4.33
-     */
-    readonly arcgisClose: TargetedEvent<this>;
-    /**
-     * [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions)
-     */
-    actions: __esri.Collection<__esri.ActionButton | __esri.ActionToggle>;
-    /**
-     * Indicates if the widget is active when it is visible and is not [waiting for results](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#waitingForResult).
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#active)
+    /** @since 4.34 */
+    viewModel: FeaturesViewModel;
+    /**
+     * [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects displayed in the action bar.
+     * Each action may be executed by clicking the icon or image symbolizing them.
+     * By default, every component has a `Zoom To` action styled with a magnifying glass icon.
+     * When this icon is clicked, the map zooms in four LODs and centers on the selected feature.
+     * This default action can be removed by setting [`includeDefaultActionsDisabled`](#includeDefaultActionsDisabled) to `true`, or by setting the [overwriteActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#overwriteActions) property to `true` in the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).
+     * The order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html).
+     * The [`arcgisTriggerAction`](#arcgisTriggerAction) event fires each time an action is clicked.
+     * Actions are defined with the properties listed in the [ActionButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [ActionToggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) class.
+     *
+     * @see [arcgisTriggerAction](#arcgisTriggerAction)
+     * @example
+     * ```js
+     * // Defines an action button to zoom out from the selected feature
+     * const zoomOutAction = {
+     *   type: "button",
+     *   // This text is displayed as a tooltip
+     *   title: "Zoom out",
+     *   // The ID by which to reference the action in the event handler
+     *   id: "zoom-out",
+     *   // Sets the icon used to style the action button
+     *   icon: "magnifying-glass-minus"
+     * };
+     * // Adds the custom action to the Features component's actions collection.
+     * featuresComponent.actions.push(zoomOutAction);
+     * ```
+     */
+    actions: Collection<ActionButton | ActionToggle>;
+    /**
+     * Indicates if the component is active when it is visible and is not [waiting](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#waitingForResult) for results.
      *
      * @default false
      */
@@ -63,163 +84,270 @@ export declare class ArcgisFeatures extends LitElement {
      */
     autoDestroyDisabled: boolean;
     /**
-     * Indicates whether a component is closed. When `true`, the component will be hidden.
+     * Indicates whether the component displays its content. If `true`, only the header displays.
+     * This property is only honored if [`showCollapsed`](#showCollapsed) is `true`.
      *
-     * @since 4.33
      * @default false
      */
-    closed: boolean;
+    collapsed: boolean;
+    /**
+     * The content of the Features component. When set directly on the component, this content is
+     * static and cannot use fields to set content templates. To set a template
+     * for the content based on field or attribute names, see
+     * [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content).
+     *
+     * @noautocast
+     * @example
+     * ```js
+     * // This sets generic instructions in the component that will always be displayed
+     * // unless it is overridden by a PopupTemplate.
+     * featuresComponent.content = "Click a feature on the map to view its attributes";
+     * ```
+     */
+    content: string | HTMLElement | nullish | __esri.Widget;
     /**
-     * Indicates whether the popup displays its content.
+     * Enables automatic creation of a popup template for layers that have popups enabled but no
+     * popupTemplate defined.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultPopupTemplateEnabled)
      *
+     * @since 4.34
      * @default false
      */
-    collapsed: boolean;
+    defaultPopupTemplateEnabled: boolean;
     /**
-     * The content of the Features widget.
+     * The number of selected [features](#features) available to the popup.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#content)
+     * @since 4.34
+     * @default 0
      */
-    content: string | HTMLElement | nullish | __esri.Widget;
+    readonly featureCount: number;
     /**
-     * Indicates whether the feature navigation arrows are displayed at the top of the widget.
+     * 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`](#initialDisplayMode) is set to "feature".
      *
+     * @since 4.34
      * @default false
      */
-    featureNavigationTop: boolean;
+    featureMenuOpen: boolean;
     /**
-     * Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) that can be used when querying and displaying content.
+     * Sets the title to display on the component while viewing the feature menu.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureViewModelAbilities)
+     * @since 4.34
      */
-    featureViewModelAbilities: nullish | __esri.Abilities;
+    featureMenuTitle: string | nullish;
     /**
-     * An array of features associated with the Features widget.
+     * 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.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features)
+     * @since 4.34
+     * @default false
+     */
+    featureNavigationTop: boolean;
+    /**
+     * An array of features associated with the Features component. Each graphic in this array must
+     * have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) set. They may share the same
+     * [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) or have unique
+     * [PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) depending on their attributes.
+     * The [content](#content) and [heading](#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/api-reference/esri-PopupTemplate.html).
+     *
+     * When more than one graphic exists in this array, the current content of the
+     * component is set based on the value of the [selected feature](#selectedFeature).
+     *
+     * This value is `null` if no features are associated with the component.
+     *
+     * @noautocast
+     * @example
+     * ```js
+     * // When setting the features property, the graphics pushed to this property
+     * // must have a PopupTemplate set.
+     * let g1 = new Graphic();
+     * g1.popupTemplate = new PopupTemplate({
+     *   title: "Results title",
+     *   content: "Results: {ATTRIBUTE_NAME}"
+     * });
+     * // Set the graphics as an array to the Features component instance. The content and title of
+     * // the component will be set depending on the PopupTemplate of the graphics.
+     * // Each graphic may share the same PopupTemplate or have a unique PopupTemplate
+     * let graphics = [g1, g2, g3, g4, g5];
+     * featuresComponent.features = graphics;
+     * ```
      */
     features: __esri.Graphic[];
     /**
      * The number of features to fetch at one time.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featuresPerPage)
-     *
      * @default 20
      */
     featuresPerPage: number;
+    /** Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) that can be used when querying and displaying content. */
+    featureViewModelAbilities: nullish | __esri.Abilities;
     /**
-     * The title of the Features widget.
+     * This function provides the ability to override either the [arcgis-map.goTo](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#goTo) or [arcgis-scene.goTo](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) methods.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title)
+     * @example
+     * ```js
+     * features.goToOverride = (map, goToParams)=>  {
+     *   goToParams.options = {
+     *     duration: updatedDuration
+     *   };
+     *   return map.goTo(goToParams.target, goToParams.options);
+     * };
+     * ```
      */
-    featuresTitle: string | nullish;
+    goToOverride: nullish | __esri.GoToOverride;
     /**
-     * This function provides the ability to override either the
-     * [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or
-     * [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.
+     * The actions that are displayed in the header of the component.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#goToOverride)
+     * @autocast { typedCollection: true }
      */
-    goToOverride: nullish | __esri.GoToOverride;
+    headerActions: Collection<ActionButton | ActionToggle>;
     /**
-     * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) of the widget.
+     * The title of the Features component. This can be set to any string value no
+     * matter the features that are selected. If the [selected feature](#selectedFeature)
+     * has a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), then the title set in the
+     * corresponding template is used here.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#headingLevel)
+     * @see [headingLevel](#headingLevel)
+     * @since 4.34
+     * @example
+     * ```js
+     * // This title will display in the component unless a selected feature's
+     * // PopupTemplate overrides it.
+     * featuresComponent.title = "Population by zip codes in Southern California";
+     * ```
      */
-    headingLevel: number;
+    heading: string | nullish;
     /**
-     * The actions that are displayed in the header of the widget.
+     * The title of the Features component.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#headerActions)
+     * @deprecated since 4.34, use [`heading`](#heading) instead.
      */
-    headerActions: __esri.Collection<__esri.ActionBase>;
+    get featuresTitle(): nil | string;
+    set featuresTitle(value: nil | string);
     /**
-     * Indicates whether to hide the action bar that holds the feature's [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions).
+     * Indicates the heading level to use for the [heading](#heading) of the component.
+     * By default, the heading is rendered
+     * as a level 2 heading (e.g. `<h2>Popup title</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
+     */
+    headingLevel: HeadingLevel;
+    /**
+     * Indicates whether to hide the action bar that holds the feature's [actions](#actions).
      *
      * @default false
      */
     hideActionBar: boolean;
     /**
-     * Indicates whether to hide the close button.
+     * Indicates whether to hide the close button in the component.
      *
      * @default false
      */
     hideCloseButton: boolean;
     /**
-     * Indicates whether to hide a heading and description on the widget feature menu list.
+     * Indicates whether to hide the feature menu heading and description in the component's feature menu list.
      *
      * @default false
      */
     hideFeatureMenuHeading: boolean;
     /**
-     * Indicates whether to hide pagination for feature navigation.
-     * This allows the user to scroll through various selected features using pagination arrows.
+     * Indicates whether to hide the feature pagination in the component.
+     * This allows the user to scroll through various [selected features](#features) using pagination arrows.
      *
      * @default false
      */
     hideFeatureNavigation: boolean;
+    /**
+     * Indicates whether to hide the group heading for a list of multiple features.
+     *
+     * @since 4.34
+     * @default false
+     */
+    hideFeatureListLayerTitle: boolean;
     /**
      * Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.
-     * The component will be displayed within its original flow component if `false`.
-     * The flow component will be omitted if set to `true`.
+     * The component will be displayed within its original flow component if set to `false`.
+     * The flow component will be omitted from the component if set to `true`.
      * To place the component into an existing Calcite flow component, set this property to `false`.
      *
      * @default false
      */
     hideFlow: boolean;
     /**
-     * Indicates whether is hide the heading.
+     * Indicates whether to hide the component's [heading](#heading).
      *
      * @default false
      */
     hideHeading: boolean;
     /**
-     * Indicates whether to hide the loading spinner.
+     * Indicates whether to hide the component's loading spinner.
      *
      * @default false
      */
     hideSpinner: boolean;
     /**
-     * Icon which represents the widget.
+     * Indicates whether to highlight the [selected feature](#selectedFeature) in the associated
+     * [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     * @default null
+     * @since 4.34
+     * @default false
      */
-    icon: string | nullish;
+    highlightDisabled: boolean;
     /**
-     * Indicates whether or not to include [defaultActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultActions).
+     * Icon which represents the component.
+     * Typically used when the component is controlled by another component (e.g. by the Expand component).
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#includeDefaultActions)
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     */
+    icon?: string;
+    /**
+     * Indicates whether to include the default actions in the component.
+     * In order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.
      *
-     * @default true
+     * @since 4.34
+     * @default false
      */
-    includeDefaultActions: boolean;
+    includeDefaultActionsDisabled: boolean;
     /**
      * Indicates whether to initially display a list of features, or the content for one feature.
      *
      * @default "feature"
      */
     initialDisplayMode: "list" | "feature";
+    /** The component's default label. */
+    label?: string;
     /**
-     * The widget's default label.
+     * A map is required when the input [features](#features) have a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) 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.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#label)
-     */
-    label: string;
-    /**
-     * A map is required when the input [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features) have a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use the `$map` profile variable to access data from layers within a map.
+     * Alternatively, the [view](#view) property can be used to provide the map instance for this property.
      *
+     * @noautocast
+     * @see [Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)
+     * @see [Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)
+     * @example
+     * ```js
+     * // The building footprints represent the buildings that intersect a clicked parcel
+     * let buildingFootprints = Intersects($feature, FeatureSetByName($map, "Building Footprints"));
+     * ```
      * @default null
      */
     map: __esri.Map | nullish;
-    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead. */
-    position?: __esri.UIPosition;
     /**
-     * An array of pending Promises that have not yet been fulfilled.
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#promises)
+     * @since 4.34
      */
-    promises: Promise<any>[];
+    messageOverrides?: typeof this.messages._overrides;
+    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
+    position?: __esri.UIPosition;
     /**
      * 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.
      *
@@ -227,63 +355,258 @@ export declare class ArcgisFeatures extends LitElement {
      */
     referenceElement?: ArcgisReferenceElement | string;
     /**
-     * The selected feature accessed by the Features widget.
+     * 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](#features) array.
+     */
+    promises: Promise<__esri.Graphic[]>[];
+    /**
+     * 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/api-reference/esri-popup-content-RelationshipContent.html) or [utility network](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html) element.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeature)
+     * @since 4.34
+     */
+    get selectedDrillInFeature(): __esri.Graphic | nil;
+    /**
+     * 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/api-reference/esri-PopupTemplate.html) assigned to this feature.
      */
     readonly selectedFeature: nullish | __esri.Graphic;
     /**
-     * Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeature).
+     * Returns a reference to the current [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/) component.
+     * This is useful if needing to get a reference to the Feature component in order to make any changes to it.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeatureIndex)
+     * @since 4.34
+     */
+    get selectedFeatureComponent(): HTMLArcgisFeatureElement | null;
+    /**
+     * Index of the feature that is [selected](#selectedFeature). When [features](#features) are set,
+     * the first index is automatically selected.
      */
     selectedFeatureIndex: number;
-    /** @default false */
+    /**
+     * Indicates whether to show the collapse button in the component.
+     *
+     * @default false
+     */
     showCollapseButton: boolean;
     /**
      * The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.
+     * This property should be set if the Features component executes Arcade expressions that contain [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/).
+     *
+     * Alternatively, the [view](#view) property can be used to provide the spatial reference instance for this property.
      *
+     * @autocast
+     * @see [Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)
+     * @see [Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)
      * @default null
      */
     spatialReference: nullish | __esri.SpatialReference;
     /**
-     * The view model's state.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#state)
+     * The current state of the component.
      *
      * @default "disabled"
      */
     readonly state: "ready" | "disabled";
     /**
-     * Dates and times displayed in the widget will be displayed in this time zone.
+     * 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/arcgis-map/#timeZone) if the [view](#view) property is set. When a MapView is not associated with the component
+     * then the property will fallback to the `system` time zone.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#timeZone)
+     * **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.
+     * - `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).
      */
     timeZone: string;
+    /**
+     * A reference to the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+     * The Features component requires a `view` to be set if:
+     * - The [features](#features) have a popupTemplate containing Arcade expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) or reference the `$map` profile variable (i.e. access data from layers within a map). Alternatively, set the [`map`](#map) property.
+     * - Content is displayed from the popup template of an [aggregate feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#isAggregate) (i.e. a [cluster](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html) or [bin](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html)).
+     * - Values from `date` and `timestamp-offset` fields should respect the view's [time zone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeZone).
+     * Alternatively, set the [`timeZone`](#timeZone) property.
+     * - Using the [fetchFeatures](#fetchFeatures) method or the `fetchFeatures` option in the [`open`](#open) method.
+     * - Using the `Zoom to` default action. If the `view` is not specified, set the [includeDefaultActionsDisabled](#includeDefaultActionsDisabled) property to `true` to remove this default action.
+     *
+     * @since 4.34
+     */
+    view?: __esri.MapView | __esri.SceneView | nullish;
+    /**
+     * Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.
+     * Use the property to check if the component is visible.
+     *
+     * @since 4.34
+     * @default false
+     */
+    visible: boolean;
+    /**
+     * Indicates whether a component is closed. When `true`, the component will be hidden.
+     *
+     * @deprecated since 4.34, use [`visible`](#visible) instead.
+     * @default false
+     */
+    get closed(): boolean;
+    set closed(value: boolean);
+    /**
+     * Removes [promises](#promises), [features](#features), [content](#content), and
+     * [heading](#heading) from the Features component.
+     */
     clear(): Promise<void>;
-    /** Closes the component. */
+    /** A convenience method to close the component. */
     close(): 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 [layer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html).
-     * In order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).
-     * This method allows a developer to control how the input location is handled.
-     */
-    fetchFeatures(screenPoint: __esri.FeaturesFetchFeaturesScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>;
-    next(): Promise<__esri.FeaturesViewModel>;
-    /** Opens Features with content defined either explicitly or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. */
-    open(options?: __esri.FeaturesOpenOptions): Promise<void>;
-    previous(): Promise<__esri.FeaturesViewModel>;
-    triggerAction(actionIndex: number): Promise<void>;
+     * These features are fetched from all of the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)
+     * in the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). In order to use this, a layer must already have an
+     * associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This method allows a developer to
+     * control how the input location is handled.
+     *
+     * @example
+     * ```js
+     * // Use reactiveUtils to watch the map's click event.
+     * reactiveUtils.on(() => map, "arcgisViewClick",
+     * (event) => {
+     *   // Call fetchFeatures and pass in the click event screenPoint
+     *   featuresComponent.fetchFeatures(event.screenPoint).then((response) => {
+     *     // Access the response from fetchFeatures
+     *     response.allGraphicsPromise.then((graphics) => {
+     *     // If there are no graphics in the click event, then make sure
+     *     // the Features component is not showing.
+     *       if(graphics.length === 0){
+     *         featuresComponent.visible = false;
+     *       }
+     *       // If graphics do exist, set the Features component features property to the returned
+     *       // graphics from fetchFeatures.
+     *       else{
+     *         featuresComponent.features = graphics;
+     *       }
+     *     });
+     *   });
+     * ```
+     */
+    fetchFeatures(screenPoint: __esri.ScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>;
+    /**
+     * Opens the Features component with content defined either explicitly with `content`
+     * or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features.
+     *
+     * @example
+     * ```js
+     * // Use reactiveUtils to watch the map component's click event.
+     * reactiveUtils.on(() => viewElement, "arcgisViewClick", (event) => {
+     *   const { mapPoint } = event.detail;
+     *   featuresComponent.open({
+     *     // Title and content displayed in the component
+     *     title: `Click location: (${mapPoint.x},${mapPoint.y})`,
+     *     content: "This is the default content displayed on click."
+     *   });
+     * });
+     * ```
+     * @example
+     * ```js
+     * // The Features component must have a reference element set on the component along with the
+     * // location property to fetch features.
+     * // Use reactiveUtils to watch the map component's click event.
+     * reactiveUtils.on(() => viewElement, "arcgisViewClick", (event) => {
+     *   const { mapPoint } = event.detail;
+     *   featuresComponent.open({
+     *     location: mapPoint,
+     *     // Display the content for the selected feature(s) if a popupTemplate is defined.
+     *     fetchFeatures: true
+     *   });
+     * });
+     * ```
+     * @example
+     * ```js
+     * // Open the Features component with a specified array of graphics that already
+     * // have a PopupTemplate set and display the feature menu when it opens.
+     * featuresComponent.open({
+     *   // array of graphics
+     *   features: graphics,
+     *   // selected features initially display in a list
+     *   featureMenuOpen: true
+     * });
+     * ```
+     */
+    open(options?: __esri.FeaturesViewModelOpenOptions): Promise<void>;
+    /**
+     * Selects the feature at the next index in relation to the [selected feature](#selectedFeature).
+     *
+     * @see [selectedFeatureIndex](#selectedFeatureIndex)
+     */
+    next(): Promise<FeaturesViewModel>;
+    /**
+     * Selects the feature at the previous index in relation to the [selected feature](#selectedFeature).
+     *
+     * @see [selectedFeatureIndex](#selectedFeatureIndex)
+     */
+    previous(): Promise<FeaturesViewModel>;
+    /**
+     * Use this method to give focus to the Component if the component is able to be focused.
+     *
+     * @since 4.34
+     */
+    setFocus(): Promise<void>;
+    /**
+     * Triggers the [`arcgisTriggerAction`](#arcgisTriggerAction) event and executes the action
+     * at the specified index in the [actions](#actions) array.
+     */
+    triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "state" | "selectedFeature" | "selectedFeatureIndex";
+        name: "state" | "active" | "collapsed" | "featureCount" | "visible" | "selectedFeature" | "featureMenuOpen" | "features" | "promises" | "selectedFeatureIndex" | "selectedDrillInFeature" | "selectedFeatureComponent";
     }>;
     /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
-    /** Emitted when an action is triggered on the component. */
-    readonly arcgisTriggerAction: TargetedEvent<this, __esri.FeaturesTriggerActionEvent>;
+    /** Emitted when the component's close button is clicked. */
+    readonly arcgisClose: TargetedEvent<this, void>;
+    /**
+     * Fires after the user clicks on an action in the Features component.
+     * This event may be used to define a custom function to execute when particular actions are clicked.
+     *
+     * @see [actions](#actions)
+     * @see [PopupTemplate.actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions)
+     * @see [Features.open()](#open)
+     * @example
+     * ```js
+     * viewElement.addEventListener("arcgisViewClick", (event) => {
+     *   const { mapPoint } = event.detail;
+     *   featuresComponent.open({
+     *     location: mapPoint,
+     *     fetchFeatures: true,
+     *     actions: [{
+     *       // This text is displayed as a tooltip
+     *       title: "Zoom out",
+     *       // The ID used to reference this action in the event handler
+     *       id: "zoom-out",
+     *       // Sets the icon font used to style the action button
+     *       icon: "magnifying-glass-minus"
+     *     },
+     *     {
+     *       title: "Delete Feature",
+     *       id: "delete-feature-action",
+     *       icon: "trash"
+     *     }]
+     *   });
+     * });
+     *
+     * // Fires each time an action is clicked
+     * reactiveUtils.on(()=> featuresComponent, "arcgisTriggerAction", (event)=>{
+     *   // If the zoom-out action is clicked, execute the following code
+     *   if(event.detail.action.id === "zoom-out"){
+     *     // Zoom out two levels (LODs)
+     *     viewElement.goTo({
+     *       center: viewElement.center,
+     *       zoom: viewElement.zoom - 2
+     *     });
+     *   }
+     * });
+     * ```
+     */
+    readonly arcgisTriggerAction: TargetedEvent<this, __esri.FeaturesViewModelTriggerActionEvent>;
+    private messages;
 }
 export {};