@arcgis/map-components 4.34.0-next.133 → 4.34.0-next.135

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

@@ -12,188 +12,634 @@ import { default as ActionButton } from '@arcgis/core/support/actions/ActionButt
 declare const useFeaturesViewModel: (component: LitElement & Pick<FeaturesViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<FeaturesViewModel>) => FeaturesViewModel;
 
 /**
- * <a name="overview"></a>
- *
  * ## Overview
- * The Popup widget allows users to view content from feature attributes. Popups enhance web applications
+ * The Popup component allows users to view content from feature attributes. Popups enhance web applications
  * by providing users with a simple way to interact with and view attributes in a layer.
  * They play an important role in relaying information to the user, which improves the storytelling capabilities of the application.
  *
- * <a name="loading-the-popup"></a>
- *
- * ## Loading the Popup
- * At [version 4.27](../release-notes#popup-performance-improvements), the view's default popup is loaded on demand when [`popupEnabled`](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#popupEnabled) is set to `true` (which is the default), when the [`openPopup()`](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#openPopup) method is called,
- * or when some widgets need the popup, such as [Search](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html). Please see the read more section below for details on how to manually load the popup or take
- * advantage of the API lazy loading.
- *
- * >>> esri-read-more
- *
- * The Popup class can be loaded when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) is instantiated, however, this does not take advantage of the performance improvements of lazily loading the popup.
- * ```js
- * // Create a new MapView
- * const view = new MapView({
- * // set the popup property to a new instance of Popup
- *   popup: new Popup(...)
- * });
- * ```
- * To utilize the performance improvements and the API automatically lazy loading the popup:
- * - Set options/properties on the view's popup:
- *   ```js
- *   const view = MapView({
- *     popup: {
- *       dockEnabled: true,
- *       dockOptions: {
- *         position: true,
- *         ...
- *       }
- *     }
- *   });
- *   ```
- * - Use [`popupEnabled`](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#popupEnabled) to prevent the popup appearing when the user clicks the view.
- *   ```js
- *   // The popup doesn't show for features on selection, but will on Search results and when `openPopup()` is called.
- *   view.popupEnabled = false;
- *   ```
- * - Use [`openPopup()`](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#openPopup) instead of [`open()`](#open) and [`closePopup()`](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#closePopup) instead of [`close()`](#close).
- *   ```js
- *   // A deprecation warning is prompted if the popup isn't created
- *   // and calls view.openPopup() or view.closePopup() respectively under the hood.
- *   view.popup.open(...);
- *   view.popup.close(...);
- *
- *   // Opens or closes the popup on the View.
- *   view.openPopup(...);
- *   view.closePopup(...);
- *   ```
- * - Use [reactiveUtils](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html) to watch properties on the popup and its view model instead of the [`watch()`](#watch) method.
- *   ```js
- *   // This will throw an error that watch() is not a method
- *   // since the popup hasn't been created yet.
- *   view.popup.watch("selectedFeature", ...)
- *
- *   // Call reactiveUtils.watch() on popup properties with optional chaining.
- *   reactiveUtils.watch(() => view.popup?.selectedFeature, ...);
- *   ```
- * - Use the [`reactiveUtils.when()`](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#when) method to check when the popup instance is created. Once its created, then it's properties or methods can be accessed and called.
- *   ```js
- *   // This will throw an error that actions is not a property.
- *   view.popup.actions.push(...);
- *
- *   // Wait for the popup to load before accessing properties.
- *   reactiveUtils.when(() => view.popup?.actions, ()=>{
- *     view.popup.actions.push(...);
- *   });
- *   ```
- *
- * >>>
- *
- * <a name="popup-ui"></a>
- *
  * ## Popup UI
- * All [Views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) contain a default popup.
- * This popup can display generic content, which is set in its [title](#title)
+ * The [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components contain a default popup.
+ * This popup can display generic content, which is set in its [heading](#heading)
  * and [content](#content) properties.
  * When  content is set directly on the Popup instance it is not tied to a specific feature or layer.
  *
- * [![popup-basic-example](../assets/img/apiref/widgets/popup/popup-basic.png)](../sample-code/sandbox/?sample=intro-popup)
+ * [![popup-basic-example](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/popup/popup-basic.png)](../sample-code/sandbox/?sample=intro-popup)
  *
- * In the image above, the text "Marriage in New York County Census Tract 8" is the popup's `title`. The remaining text is
- * its `content`. A dock button ![popup-dock-btn](../assets/img/apiref/widgets/popup/popup-dock.png) may also be available in the
- * top right corner of the popup. This allows the user to dock the popup to one of the sides or corners of the view.
+ * In the image above, the text "Marriage in Nassau County Census Tract 5177.01" is the popup's [heading](#heading).
+ * The remaining text is the popup's [`content`](#content).
+ * A dock button is displayed in the top right corner of the popup allowing the user to dock the popup to one of the sides or corners of the view.
  * The options for docking may be set in the [dockOptions](#dockOptions) property.
+ * The popup may also be collapsed by clicking the collapse button (the down arrow icon) in the top right corner of the popup.
+ * When collapsed, only the heading of the popup displays.
+ * The popup may be closed by clicking the close button (the "x" icon) in the top right corner of the popup.
  *
- * Popups can also contain [actions](#actions) that act like buttons,
- * which execute a function defined by the developer when clicked.
- * By default, every popup has a "Zoom to" action ![popupTemplate-zoom-action](../assets/img/apiref/widgets/popup/popuptemplate-zoom-action.png)
- * that allows users to zoom to the selected feature. See the [actions](#actions)
- * property for information about adding custom actions to a popup.
- *
- * The Popup widget is tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html), whether it's docked or anchored to the selected feature.
- * If wanting to utilize the Popup functionality outside of the View, the [Features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html) widget can be used to display the same content
- * in its own container that's not tied to the View.
+ * Popups can also contain [actions](#actions) which execute a function defined by the developer when clicked.
+ * By default, every popup has a "Zoom to" action (as shown in the image above with the magnifying glass) that allows users to zoom to the selected feature.
+ * See the [actions](#actions) property for information about adding custom actions to a popup.
  *
- * <a name="popup-and-popuptemplate"></a>
+ * The Popup component is tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) component, whether it's docked or anchored to the selected feature.
+ * If wanting to utilize the Popup functionality outside of [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component can be used to display the same content
+ * in its own container.
  *
  * ## Popup and PopupTemplate
- * [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) is closely related to Popup, but is more specific to [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)
- * and [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). It allows you to define custom titles and content templates based on the source of the
+ * [PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)
+ * and [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Popup templates allow you to define custom titles and content templates based on the source of the
  * [selected feature](#selectedFeature). When a layer or a graphic has a defined
- * PopupTemplate, the popup will display the content
- * defined in the PopupTemplate when the feature is clicked. The content may contain field values from the attributes of the [selected feature](#selectedFeature).
+ * popup template, the popup will display the content defined in the popup template when the feature is clicked.
+ * The content may contain field values from the attributes of the [selected feature](#selectedFeature).
  *
  * Custom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) on the
- * [features](#features) property. For more information about Popup
- * and how it relates to [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) see the samples listed below.
+ * [features](#features) property.
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/)
  *
- * @since 4.0
+ * @since 4.34
+ * @beta
  * @see module :esri/PopupTemplate
- * @see module :esri/views/SceneView#popup
- * @see module :esri/views/View2D#popup
- * @see [Sample - Intro to popups](../sample-code/intro-popup/index.html)
- * @see [Sample - to PopupTemplate](../sample-code/intro-popuptemplate/index.html)
- * @see [Sample - Dock positions with popup](../sample-code/popup-docking-position/index.html)
- * @see [Sample - Popup actions](../sample-code/popup-actions/index.html)
- * @see [Sample - Custom popup actions per feature](../sample-code/popup-custom-action/index.html)
- * @see [Sample - Popup with edit action](../sample-code/popup-editaction/index.html)
- * @see [Sample - Popup with DOM node](../sample-code/popup-domnode/index.html)
  * @see [Guide - Esri Icon Font](../guide/esri-icon-font/index.html)
- * @see module :esri/widgets/Popup/PopupViewModel
  */
 export declare class ArcgisPopup extends LitElement {
-    referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action button](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.
+     * Each action may be executed by clicking the icon or image symbolizing them.
+     *
+     * By default, popups have a `Zoom To` action styled with a magnifying glass icon.
+     * When this icon is clicked, the view zooms in four LODs and centers on the selected feature.
+     * You may remove this default action by setting [includeDefaultActionsDisabled](#includeDefaultActionsDisabled) to `true`, or by setting the
+     * [`overwriteActions`](esri-PopupTemplate.html#overwriteActions) property to `true` in a [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.
+     *
+     * @autocast { "value": "Object[]", "typedCollection": true, "byTypeProperty": true }
+     * @see [arcgisTriggerAction](#arcgisTriggerAction)
+     * @see [Sample - Popup actions](../sample-code/popup-actions/index.html)
+     * @see [Sample - Custom popup actions per feature](../sample-code/popup-custom-action/index.html)
+     * @see [Sample - Popup with edit action](../sample-code/popup-editaction/index.html)
+     * @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 popup.
+     * popupComponent.actions.push(zoomOutAction);
+     * ```
+     */
     actions: __esri.Collection<ActionButton | __esri.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-Popup-PopupViewModel.html#waitingForResult).
+     *
+     * @default false
+     */
     readonly active: boolean;
+    /**
+     * Position of the popup in relation to the selected feature. The default behavior
+     * is to display above the feature and adjust if not enough room. If needing
+     * to explicitly control where the popup displays in relation to the feature, choose
+     * an option besides `auto`.
+     *
+     * @example
+     * ```js
+     * // Popup will display on the bottom-right of the selected feature regardless of where that feature is located
+     * popupComponent.alignment = "bottom-right";
+     * ```
+     * @default "auto"
+     */
     alignment: Alignment;
+    /**
+     * This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) changes.
+     *
+     * @default false
+     */
     autoCloseEnabled: boolean;
-    defaultPopupTemplateEnabled: boolean;
-    content: string | HTMLElement | nullish | __esri.Widget;
+    /**
+     * If true, the component will not be destroyed automatically when it is
+     * disconnected from the document. This is useful when you want to move the
+     * component to a different place on the page, or temporarily hide it. If this
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
+    autoDestroyDisabled: boolean;
+    /**
+     * Indicates whether the popup displays its content. If `true`, only the header displays.
+     *
+     * @default false
+     */
     readonly collapsed: boolean;
+    /**
+     * The content of the popup. When set directly on the Popup, 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
+     * @see [Sample - Popup Docking](../sample-code/popup-docking-position/index.html)
+     * @see [Sample - Popup with DOM node](../sample-code/popup-domnode/index.html)
+     * @example
+     * ```js
+     * // This sets generic instructions in the popup that will always be displayed
+     * // unless it is overridden by a PopupTemplate
+     * popupComponent.content = "Click a feature on the map to view its attributes";
+     * ```
+     */
+    content: string | HTMLElement | nullish | __esri.Widget;
+    /** Dock position in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) component. */
     get currentDockPosition(): nil | PopupPositionResult;
+    /**
+     * 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. (Supported for
+     * [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),
+     * [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),
+     * [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),
+     * [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),
+     * [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),
+     * [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),
+     * [StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html),
+     * [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), and
+     * [VoxelLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html)).
+     *
+     * **Note:**
+     * * Starting with version 4.12, [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content can no longer be set using a
+     * wildcard, e.g. `*`. Instead, set the `defaultPopupTemplateEnabled` property to `true`.
+     * * Starting with 4.16, the default popup has been improved to no longer display system
+     * [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html)
+     * that do not hold significant value, e.g. `Shape__Area` and `Shape__Length` are two fields that
+     * no longer display.
+     * * Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)
+     * rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) created by setting the `defaultPopupTemplateEnabled` property to `true`.
+     * For example, previously a date that may have appeared as `"December 30, 1997"` will now appear as `"12/30/1997 6:00 PM"`.
+     *
+     * @default false
+     */
+    defaultPopupTemplateEnabled: boolean;
+    /**
+     * Indicates whether the placement of the popup is docked to the side of the view.
+     *
+     * Docking the popup allows for a better user experience, particularly when opening
+     * popups in apps on mobile devices. When a popup is "dockEnabled" it means the popup no
+     * longer points to the [selected feature](#selectedFeature) or the [location](#location)
+     * assigned to it. Rather it is attached to a side, the top, or the bottom of the view.
+     *
+     * See [dockOptions](#dockOptions) to override default options related to docking the popup.
+     *
+     * @see [Sample - Popup docking](../sample-code/popup-docking-position/index.html)
+     * @example
+     * ```html
+     * <!-- Setting this property in HTML -->
+     * <arcgis-popup dock-enabled></arcgis-popup>
+     * ```
+     * @example
+     * ```js
+     * // Setting this property using JS.
+     * // The popup will automatically be dockEnabled when made visible
+     * popupComponent.dockEnabled = true;
+     * ```
+     * @default false
+     */
+    dockEnabled: boolean;
+    /**
+     * Docking the popup allows for a better user experience, particularly when opening
+     * popups in apps on mobile devices. When a popup is "dockEnabled" it means the popup no
+     * longer points to the [selected feature](#selectedFeature) or the [location](#location)
+     * assigned to it. Rather it is placed in one of the corners of the view or to the top or bottom
+     * of it. This property allows the developer to set various options for docking the popup.
+     *
+     * See the object specification table below to override default docking properties on the popup.
+     *
+     * @see [Sample - Popup docking](../sample-code/popup-docking-position/index.html)
+     * @example
+     * ```js
+     * popupComponent.dockOptions = {
+     *   // Disable the dock button so users cannot undock the popup
+     *   buttonEnabled: false,
+     *   // Dock the popup when the size of the view is less than or equal to 600x1000 pixels
+     *   breakpoint: {
+     *     width: 600,
+     *     height: 1000
+     *   }
+     * };
+     * ```
+     */
     get dockOptions(): DockOptions;
     set dockOptions(dockOptions: DockOptions);
-    dockEnabled: boolean;
+    /**
+     * The number of selected [features](#features) available to the popup.
+     *
+     * @default 0
+     */
     readonly featureCount: number;
+    /**
+     * This property enables showing a list of features.
+     * 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".
+     *
+     * @default false
+     */
     featureMenuOpen: boolean;
+    /**
+     * An array of features associated with the popup. 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 [title](#title)
+     * of the popup 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
+     * Popup is set based on the value of the [selected feature](#selectedFeature).
+     *
+     * This value is `null` if no features are associated with the popup.
+     *
+     * @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 popup instance. The content and title of
+     * // the popup 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];
+     * popupComponent.features = graphics;
+     * ```
+     */
     features: __esri.Graphic[];
+    /**
+     * 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.
+     *
+     * @example
+     * ```js
+     * popupComponent.goToOverride = (viewElement, goToParams)=>  {
+     *   goToParams.options = {
+     *     speedFactor: 2
+     *   };
+     *   return viewElement.goTo(goToParams.target, goToParams.options);
+     * };
+     * ```
+     */
     goToOverride: nullish | __esri.GoToOverride;
-    readonly state: "ready" | "disabled";
-    headingLevel: HeadingLevel;
-    highlightDisabled: boolean;
-    initialDisplayMode: "list" | "feature";
-    location: nullish | __esri.Point;
-    promises: Promise<__esri.Graphic[]>[];
-    readonly selectedFeature: nullish | __esri.Graphic;
-    get selectedDrillInFeature(): __esri.Graphic | nil;
-    selectedFeatureIndex: number;
-    get selectedFeatureComponent(): HTMLArcgisFeatureElement | null;
+    /**
+     * The title of the popup. This can be set generically on the popup 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.
+     *
+     * @see [headingLevel](#headingLevel)
+     * @example
+     * ```html
+     * <!-- This title will display in the popup unless a selected feature's
+     *     PopupTemplate overrides it -->
+     * <arcgis-popup heading="Population by zip codes in Southern California"></arcgis-popup>
+     * ```
+     * @example
+     * ```js
+     * // This title will display in the popup unless a selected feature's
+     * // PopupTemplate overrides it
+     * popupComponent.title = "Population by zip codes in Southern California";
+     * ```
+     */
     heading: string | nullish;
+    /**
+     * Indicates the heading level to use for the [heading](#heading) of the popup.
+     * 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.
+     *
+     * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
+     * @see [heading](#heading)
+     * @example
+     * ```html
+     * <!-- Render the popup heading as a level 3 heading -->
+     * <arcgis-popup heading="Popup title" heading-level="3"></arcgis-popup>
+     * ```
+     * @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 in the component.
+     *
+     * @default false
+     */
     hideCloseButton: boolean;
+    /**
+     * Indicates whether to hide the collapse button in the component.
+     *
+     * @default false
+     */
     hideCollapseButton: boolean;
+    /**
+     * Indicates whether to hide a heading and description on the component feature menu list.
+     *
+     * @default false
+     */
     hideFeatureMenuHeading: boolean;
+    /**
+     * Indicates whether pagination for feature navigation will be displayed. 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 in the feature menu.
+     *
+     * @default false
+     */
     hideFeatureListLayerTitle: boolean;
+    /**
+     * Indicates whether to hide the heading in the component.
+     *
+     * @default false
+     */
     hideHeading: boolean;
+    /**
+     * Indicates whether to hide the spinner in the component.
+     *
+     * @default false
+     */
     hideSpinner: boolean;
-    autoDestroyDisabled: boolean;
-    messageOverrides?: typeof this.messages._overrides;
+    /**
+     * Indicates if the selected feature will be highlighted.
+     * This is done using the [arcgis-map.highlights](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#highlights) or the [arcgis-scene.highlights](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#highlights).
+     *
+     * @default false
+     */
+    highlightDisabled: boolean;
+    /**
+     * 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 false
+     */
+    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;
+    /**
+     * Point used to position the popup. This is automatically set when viewing the
+     * popup by selecting a feature. If using the Popup to display content not related
+     * to features in the map, such as the results from a task, then you must set this
+     * property before making the popup [visible](#visible) to the user.
+     *
+     * @autocast { "byTypeProperty": false }
+     * @see [Intro to popups](../sample-code/intro-popup/index.html)
+     * @example
+     * ```js
+     * // Sets the location of the popup to the center of the view
+     * popupComponent.location = viewELement.center;
+     * // Displays the popup
+     * popupComponent.visible = true;
+     * ```
+     * @example
+     * ```js
+     * // Sets the location of the popup to a specific place (using autocast)
+     * // Note: using latitude/longitude only works if view is in Web Mercator or WGS84 spatial reference.
+     * popupComponent.location = {latitude: 34.0571, longitude: -117.1968};
+     * ```
+     * @example
+     * ```js
+     * // Sets the location of the popup to the location of a click on the view
+     * reactiveUtils.on(()=>viewElement, "arcgisViewClick", (event)=>{
+     *   popupComponent.location = event.detail.mapPoint;
+     *   // Displays the popup
+     *   popupComponent.visible = true;
+     * });
+     * ```
+     */
+    location: nullish | __esri.Point;
+    /** Overwrite localized strings for this component */
+    messageOverrides?: typeof this.messages._overrides;
+    /**
+     * 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[]>[];
+    /**
+     * 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.
+     *
+     * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+     */
+    referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * 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.
+     */
+    get selectedDrillInFeature(): __esri.Graphic | nil;
+    /**
+     * The selected feature accessed by the popup. The content of the Popup 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;
+    /**
+     * Returns a reference to the current [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/) that the Popup is using.
+     * This is useful if needing to get a reference to the component in order to make any changes to it.
+     */
+    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;
+    /**
+     * The current state of the component.
+     *
+     * @default "disabled"
+     */
+    readonly state: "ready" | "disabled";
+    /**
+     * Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.
+     * Use the property to check if the popup is visible and is not.
+     *
+     * @name visible
+     * @type {boolean}
+     * @default false
+     */
     visible: boolean;
+    /**
+     * Removes all [promises](#promises), [features](#features), [content](#content),
+     * [heading](#heading) and [location](#location) from the Popup.
+     */
     clear(): Promise<void>;
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
+    /**
+     * Use this method to return feature(s) at a given screen location.
+     * These features are fetched from all of the [LayerViews](https://developers.arcgis.com/javascript/latest/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) and have its [popupEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupEnabled).
+     *
+     * @example
+     * ```js
+     * // Example showing how to use fetchFeatures in an application
+     * // with the popup and feature components.
+     * const popupComponent = document.querySelector("arcgis-popup");
+     * const viewElement = document.querySelector("arcgis-map");
+     * const featureComponent = document.querySelector("arcgis-feature");
+     * // Get viewElement's click event
+     * reactiveUtils.on(()=>viewElement, "arcgisViewClick", (event)=>{
+     *   const { screenPoint } = event.detail;
+     *   // Call fetchFeatures on the popup and pass in the click event screenPoint
+     *   popupComponent.fetchFeatures(screenPoint).then((response) => {
+     *     // Access the response from fetchFeatures
+     *     response.allGraphicsPromise.then((graphics) => {
+     *       // Set the feature component's graphic to the returned graphic from fetchFeatures
+     *       featureComponent.graphic = graphics[0];
+     *     });
+     *   });
+     * });
+     * ```
+     */
     fetchFeatures(screenPoint: __esri.ScreenPoint, options?: FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>;
+    /**
+     * Selects the feature at the next index in relation to the selected feature.
+     *
+     * @see [selectedFeatureIndex](#selectedFeatureIndex)
+     */
     next(): Promise<FeaturesViewModel>;
+    /**
+     * Opens the popup at the given location 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. This method sets
+     * the popup's [visible](#visible) property to `true`. Users can alternatively open the popup
+     * by directly setting the [visible](#visible) property to `true`.
+     *
+     * ***Note:***
+     * The popup will only display if the [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/) size constraints in [dockOptions](#dockOptions) are met or the [location](#location)
+     * property is set to a geometry.
+     *
+     * @see [visible](#visible)
+     * @example
+     * ```js
+     * reactiveUtils.on(()=>viewElement, "arcgisViewClick", (event)=>{
+     *  const { mapPoint } = event.detail;
+     *   popupComponent.open({
+     *    location: mapPoint,  // location of the click on the view
+     *    title: "You clicked here",  // title displayed in the popup
+     *    content: "This is a point of interest"  // content displayed in the popup
+     *   });
+     * });
+     * ```
+     * @example
+     * ```js
+     * reactiveUtils.on(()=>viewElement, "arcgisViewClick", (event)=>{
+     *    const { mapPoint } = event.detail;
+     *    popupComponent.open({
+     *      location: mapPoint,  // location of the click on the view
+     *      fetchFeatures: true // display the content for the selected feature if a popupTemplate is defined.
+     *    });
+     *  });
+     * ```
+     * @example
+     * ```js
+     * popupComponent.open({
+     *   title: "You clicked here",  // title displayed in the popup
+     *   content: "This is a point of interest",  // content displayed in the popup
+     *   location: event.detail.mapPoint,
+     *   updateLocationEnabled: true  // updates the location of popup based on
+     *   // selected feature's geometry
+     * });
+     * ```
+     * @example
+     * ```js
+     * popupComponent.open({
+     *   features: graphics,  // array of graphics
+     *   featureMenuOpen: true, // selected features initially display in a list
+     *   location: graphics[0].geometry // location of the first graphic in the array of graphics
+     * });
+     * ```
+     */
     open(options?: __esri.FeaturesViewModelOpenOptions): Promise<void>;
+    /**
+     * Selects the feature at the previous index in relation to the selected feature.
+     *
+     * @see [selectedFeatureIndex](#selectedFeatureIndex)
+     */
     previous(): Promise<FeaturesViewModel>;
+    /** Use this method to give focus to the Widget if the widget is able to be focused. */
     setFocus(): Promise<void>;
+    /**
+     * Triggers the [arcgisTriggerAction](#arcgisTriggerAction) event and executes the [action](#actions)
+     * at the specified index in the [actions](#actions) array.
+     */
     triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>;
     readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "state" | "active" | "collapsed" | "featureCount" | "featureMenuOpen" | "features" | "promises" | "selectedDrillInFeature" | "selectedFeature" | "selectedFeatureComponent" | "selectedFeatureIndex" | "visible" | "currentAlignment" | "dockEnabled";
+        name: "state" | "active" | "collapsed" | "featureCount" | "visible" | "selectedFeature" | "featureMenuOpen" | "features" | "promises" | "selectedFeatureIndex" | "selectedDrillInFeature" | "selectedFeatureComponent" | "currentAlignment" | "dockEnabled";
     }>;
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
+    /** Emitted when the component's close button is clicked. */
     readonly arcgisClose: TargetedEvent<this, void>;
+    /**
+     * Fires after the user clicks on an action in the Popup 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 [open()](#open)
+     * @example
+     * ```js
+     * viewElement.addEventListener("arcgisViewClick", (event) => {
+     *   const { mapPoint } = event.detail;
+     *   popupComponent.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(()=> popupComponent, "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.PopupTriggerActionEvent>;
     private messages;
 }