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

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

@@ -143,56 +143,505 @@ declare const useFeaturesViewModel: (component: LitElement & Pick<FeaturesViewMo
  */
 export declare class ArcgisPopup extends LitElement {
     referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * [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](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 ![popupTemplate-zoom-action](../assets/img/apiref/widgets/popup/popuptemplate-zoom-action.png).
+     * 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 [includeDefaultActions](#includeDefaultActions) to `false`, 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 [trigger-action](#event-trigger-action) 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) classes.
+     *
+     * @autocast { "value": "Object[]", "typedCollection": true, "byTypeProperty": true }
+     * @see [trigger-action](#event-trigger-action)
+     * @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
+     * // 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.
+     * view.popup.actions.push(zoomOutAction);
+     */
     actions: __esri.Collection<ActionButton | __esri.ActionToggle>;
+    /**
+     * Indicates if the widget is active when it is visible and is not [waiting](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup-PopupViewModel.html#waitingForResult).
+     *
+     * @since 4.30
+     * @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`.
+     *
+     * @since 4.8
+     * @example
+     * // Popup will display on the bottom-right of the selected feature regardless of where that feature is located
+     * view.popup.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.
+     *
+     * @since 4.5
+     * @default false
+     */
     autoCloseEnabled: boolean;
+    /**
+     * 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)).
+     *
+     * ::: esri-md class="warning"
+     * * 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"`.
+     * :::
+     *
+     * @since 4.11
+     * @default false
+     */
     defaultPopupTemplateEnabled: 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
+     * // This sets generic instructions in the popup that will always be displayed
+     * // unless it is overridden by a PopupTemplate
+     * view.popup.content = "Click a feature on the map to view its attributes";
+     */
     content: string | HTMLElement | nullish | __esri.Widget;
+    /**
+     * Indicates whether the popup displays its content. If `true`, only the header displays.
+     *
+     * @since 4.5
+     * @default false
+     */
     readonly collapsed: boolean;
+    /** Dock position in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). */
     get currentDockPosition(): nil | PopupPositionResult;
+    /**
+     * 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
+     * view.popup.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);
+    /**
+     * 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
+     * // The popup will automatically be dockEnabled when made visible
+     * view.popup.dockEnabled = true;
+     * @default false
+     */
     dockEnabled: boolean;
+    /**
+     * The number of selected [features](#features) available to the popup.
+     *
+     * @default 0
+     */
     readonly featureCount: number;
+    /**
+     * This property enables showing the list of features.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureMenuOpen)
+     *
+     * @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
+     * // 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];
+     * view.popup.features = graphics;
+     */
     features: __esri.Graphic[];
+    /**
+     * 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.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#goToOverride)
+     */
     goToOverride: nullish | __esri.GoToOverride;
+    /**
+     * The current state of the component.
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "disabled";
+    /**
+     * Indicates the heading level to use for the [title](#title) of the popup.
+     * By default, the title is rendered
+     * as a level 2 heading (e.g. `<h2>Popup title</h2>`). Depending on the widget's placement
+     * in your app, you may need to adjust this heading for proper semantics. This is
+     * important for meeting accessibility standards.
+     *
+     * @since 4.20
+     * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
+     * @example
+     * // popup title will render as an <h3>
+     * popup.headingLevel = 3;
+     * @default 2
+     */
     headingLevel: HeadingLevel;
+    /**
+     * Highlight the selected popup feature using the [highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlights)
+     * set on the [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or the [highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlights)
+     * set on the [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+     *
+     * @default false
+     */
     highlightDisabled: boolean;
+    /**
+     * Indicates whether to initially display a list of features, or the content for one feature.
+     *
+     * @since 4.32
+     * @default "feature"
+     */
     initialDisplayMode: "list" | "feature";
+    /**
+     * 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
+     * // Sets the location of the popup to the center of the view
+     * view.popup.location = view.center;
+     * // Displays the popup
+     * view.popup.visible = true;
+     * @example
+     * // 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.
+     * view.popup.location = {latitude: 34.0571, longitude: -117.1968};
+     * @example
+     * // Sets the location of the popup to the location of a click on the view
+     * reactiveUtils.on(()=>view, "click", (event)=>{
+     *   view.popup.location = event.mapPoint;
+     *   // Displays the popup
+     *   view.popup.visible = true;
+     * });
+     */
     location: nullish | __esri.Point;
+    /**
+     * 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 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;
+    /**
+     * The feature that the widget 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](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html).
+     *
+     * @since 4.32
+     */
     get selectedDrillInFeature(): __esri.Graphic | nil;
+    /**
+     * Index of the feature that is [selected](#selectedFeature). When [features](#features) are set,
+     * the first index is automatically selected.
+     */
     selectedFeatureIndex: number;
+    /**
+     * Returns a reference to the current [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) that the Popup is using.
+     * This is useful if needing to get a reference to the widget in order to make any changes to it.
+     *
+     * @since 4.7
+     */
     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
+     * // This title will display in the popup unless a selected feature's
+     * // PopupTemplate overrides it
+     * view.popup.title = "Population by zip codes in Southern California";
+     */
     heading: string | nullish;
+    /**
+     * This property provides the ability to turn individual elements of the component's display on/off.
+     *
+     * @default false
+     */
     hideActionBar: boolean;
+    /**
+     * This property provides the ability to turn individual elements of the component's display on/off.
+     *
+     * @default false
+     */
     hideCloseButton: boolean;
+    /**
+     * This property provides the ability to turn individual elements of the component's display on/off.
+     *
+     * @default false
+     */
     hideCollapseButton: boolean;
+    /**
+     * This property provides the ability to turn individual elements of the component's display on/off.
+     *
+     * @default false
+     */
     hideFeatureMenuHeading: boolean;
+    /**
+     * This property provides the ability to turn individual elements of the component's display on/off.
+     *
+     * @default false
+     */
     hideFeatureNavigation: boolean;
+    /**
+     * This property provides the ability to turn individual elements of the component's display on/off.
+     *
+     * @default false
+     */
     hideFeatureListLayerTitle: boolean;
+    /**
+     * This property provides the ability to turn individual elements of the component's display on/off.
+     *
+     * @default false
+     */
     hideHeading: boolean;
+    /**
+     * This property provides the ability to turn individual elements of the component's display on/off.
+     *
+     * @default false
+     */
     hideSpinner: boolean;
+    /**
+     * 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;
+    /** Overwrite localized strings for this component */
     messageOverrides?: typeof this.messages._overrides;
+    /** The widget's default label. */
     label?: string;
+    /**
+     * 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 popup is visible and is not
+     *
+     * @name visible
+     * @instance
+     * @type {boolean}
+     * @default false
+     */
     visible: boolean;
+    /**
+     * Removes [promises](#promises), [features](#features), [content](#content),
+     * [title](#title) 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).
+     * These features can then be used within a custom [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html)
+     * or [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html) widget experience.
+     * One example could be a custom side panel that displays feature-specific information based on
+     * an end user's click location. This method allows a developer the ability to
+     * control how the input location is handled, and then subsequently, what to do with the results.
+     *
+     * @example
+     * // Add Feature widget to UI
+     * view.ui.add(featureWidget, "top-right");
+     *
+     * // Get view's click event
+     * reactiveUtils.on(()=>view, "click", (event)=>{
+     *   // Call fetchFeatures and pass in the click event screenPoint
+     *   view.popup.fetchFeatures(event.screenPoint).then((response) => {
+     *     // Access the response from fetchFeatures
+     *     response.allGraphicsPromise.then((graphics) => {
+     *       // Set the feature widget's graphic to the returned graphic from fetchFeatures
+     *       featureWidget.graphic = graphics[0];
+     *     });
+     *   });
+     * });
+     * @since 4.15
+     * @see [Sample - Feature widget - Query graphics from multiple layers](../sample-code/widgets-feature-multiplelayers/index.html)
+     */
     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`.
+     *
+     * ::: esri-md class="warning"
+     * The popup will only display if
+     * the view's size constraints in [dockOptions](#dockOptions) are met or the [location](#location)
+     * property is set to a geometry.
+     * :::
+     *
+     * @see [Intro to popups](../sample-code/intro-popup/index.html)
+     * @see [Popup.visible](#visible)
+     * @see [Sample - Query with `rest/query`](../sample-code/query/index.html)
+     * @see [Sample - Popup with DOM node](../sample-code/popup-domnode/index.html)
+     * @example
+     * reactiveUtils.on(()=>view, "click", (event)=>{
+     *   view.popup.open({
+     *    location: event.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
+     * reactiveUtils.on(()=>view, "click", (event)=>{
+     *    view.popup.open({
+     *      location: event.mapPoint,  // location of the click on the view
+     *      fetchFeatures: true // display the content for the selected feature if a popupTemplate is defined.
+     *    });
+     *  });
+     * @example
+     * view.popup.open({
+     *   title: "You clicked here",  // title displayed in the popup
+     *   content: "This is a point of interest",  // content displayed in the popup
+     *   location: event.mapPoint,
+     *   updateLocationEnabled: true  // updates the location of popup based on
+     *   // selected feature's geometry
+     * });
+     * @example
+     * view.popup.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.
+     *
+     * @since 4.6
+     */
     setFocus(): Promise<void>;
+    /**
+     * Triggers the [trigger-action](#event-trigger-action) 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>;
     readonly arcgisTriggerAction: TargetedEvent<this, __esri.PopupTriggerActionEvent>;
     private messages;