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

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

@@ -39,65 +39,561 @@ declare const useFeaturesViewModel: (component: LitElement & Pick<FeaturesViewMo
  */
 export declare class ArcgisFeatures extends LitElement {
     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 [`includeDefaultActions`](#includeDefaultActions) to `false`, 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
+     */
     readonly active: 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-features/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
     autoDestroyDisabled: boolean;
+    /**
+     * Indicates whether the component displays its content. If `true`, only the header displays.
+     * This property is only honored if [`showCollapsed`](#showCollapsed) is `true`.
+     *
+     * @default false
+     */
     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;
+    /**
+     * 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)
+     *
+     * @default false
+     */
     defaultPopupTemplateEnabled: boolean;
+    /**
+     * The number of selected [features](#features) available to the popup.
+     *
+     * @since 4.34
+     * @default 0
+     */
     readonly featureCount: number;
+    /**
+     * 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
+     */
     featureMenuOpen: boolean;
+    /** Sets the title to display on the component while viewing the feature menu. */
     featureMenuTitle: string | nullish;
+    /**
+     * 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.
+     *
+     * @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.
+     *
+     * @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;
+    /**
+     * 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
+     * features.goToOverride = (map, goToParams)=>  {
+     *   goToParams.options = {
+     *     duration: updatedDuration
+     *   };
+     *   return map.goTo(goToParams.target, goToParams.options);
+     * };
+     * ```
+     */
     goToOverride: nullish | __esri.GoToOverride;
+    /**
+     * The actions that are displayed in the header of the component.
+     *
+     * @autocast { typedCollection: true }
+     */
     headerActions: Collection<ActionButton | ActionToggle>;
+    /**
+     * 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.
+     *
+     * @see [headingLevel](#headingLevel)
+     * @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";
+     * ```
+     */
     heading: string | nullish;
+    /**
+     * The title of the Features component.
+     *
+     * @deprecated since 4.34, use [`heading`](#heading) instead.
+     */
+    get featuresTitle(): nil | string;
+    set featuresTitle(value: nil | string);
+    /**
+     * 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 in the component.
+     *
+     * @default false
+     */
     hideCloseButton: boolean;
-    showCollapseButton: boolean;
+    /**
+     * 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 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.
+     *
+     * @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 set to `false`.
+     * The flow component will be omitted from the widget 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 to hide the component's [heading](#heading).
+     *
+     * @default false
+     */
     hideHeading: boolean;
+    /**
+     * Indicates whether to hide the component's loading spinner.
+     *
+     * @default false
+     */
     hideSpinner: boolean;
+    /**
+     * 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.
+     *
+     * @since 4.34
+     * @default false
+     */
+    highlightDisabled: boolean;
+    /**
+     * Icon which represents the component.
+     * Typically used when the component is controlled by another component (e.g. by the Expand component).
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     */
     icon?: string;
+    /**
+     * Indicates whether to include the [defaultActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#includeDefaultActions) in the component.
+     *
+     * @default true
+     */
     includeDefaultActions: 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;
+    /**
+     * 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.
+     *
+     * 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;
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
     messageOverrides?: typeof this.messages._overrides;
+    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) 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.
+     *
+     * @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;
+    /**
+     * 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.
+     *
+     * @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;
+    /**
+     * 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.
+     *
+     * @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;
+    /**
+     * 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 current state of the component.
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "disabled";
+    /**
+     * 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.
+     *
+     * **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;
-    highlightDisabled: boolean;
+    /**
+     * 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 [includeDefaultActions](#includeDefaultActions) property to `false` 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 popup is visible and is not
+     *
+     * @name visible
+     * @instance
+     * @type {boolean}
+     * @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>;
+    /** 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](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. */
     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" | "active" | "collapsed" | "featureCount" | "featureMenuOpen" | "features" | "promises" | "selectedDrillInFeature" | "selectedFeature" | "selectedFeatureComponent" | "selectedFeatureIndex" | "visible";
+        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 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;
 }

package/dist/components/arcgis-features/customElement.js

@@ -17,7 +17,7 @@ import { renderingSanitizer as T } from "@arcgis/core/applications/Components/sa
 import { createRef as M, ref as w } from "lit-html/directives/ref.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.133 */
+v4.34.0-next.134 */
 const d = "arcgis-features", o = {
   // Features
   base: d,
@@ -64,10 +64,10 @@ class J extends S {
     }), this._featureMenuIntersectionObserverNode = null, this._rootFlowItemNode = M(), this._featureMenuViewportNode = M(), this._actionBarMenuNode = M(), this._flowContainerNode = M(), this.messages = P(), this._selectedFeatureComponent = M(), this._cancelOpenRelatedFeature = () => {
       const { _openRelatedFeatureAbortController: e } = this;
       e && e.abort(), this._openRelatedFeatureAbortController = null;
-    }, this._openRelatedFeatureAbortController = null, this.flowItems = new I(), this.viewModel = q(this), this.actions = this.viewModel.actions, this.active = this.viewModel.active, this.autoDestroyDisabled = !1, this.collapsed = !1, this.content = this.viewModel.content, this.defaultPopupTemplateEnabled = this.viewModel.defaultPopupTemplateEnabled, this.featureCount = this.viewModel.featureCount, this.featureMenuOpen = this.viewModel.featureMenuOpen, this.featureMenuTitle = this.viewModel.featureMenuTitle, this.featureNavigationTop = !1, this.features = this.viewModel.features, this.featuresPerPage = this.viewModel.featuresPerPage, this.featureViewModelAbilities = this.viewModel.featureViewModelAbilities, this.goToOverride = this.viewModel.goToOverride, this.headerActions = new I(), this.heading = this.viewModel.title, this.headingLevel = 2, this.hideActionBar = !1, this.hideCloseButton = !1, this.showCollapseButton = !1, this.hideFeatureMenuHeading = !1, this.hideFeatureNavigation = !1, this.hideFeatureListLayerTitle = !1, this.hideFlow = !1, this.hideHeading = !1, this.hideSpinner = !1, this.includeDefaultActions = this.viewModel.includeDefaultActions, this.initialDisplayMode = this.viewModel.initialDisplayMode, this.location = this.viewModel.location, this.map = this.viewModel.map, this.promises = this.viewModel.promises, this.responsiveActionsEnabled = !1, this.selectedFeature = this.viewModel.selectedFeature, this.selectedFeatureIndex = this.viewModel.selectedFeatureIndex, this.spatialReference = this.viewModel.spatialReference, this.state = this.viewModel.state, this.timeZone = this.viewModel.timeZone, this.updateLocationEnabled = this.viewModel.updateLocationEnabled, this.highlightDisabled = this.viewModel.highlightEnabled, this.view = this.viewModel.view, this.visible = this.viewModel.visible, this.arcgisPropertyChange = V()("active", "collapsed", "featureCount", "featureMenuOpen", "features", "promises", "selectedDrillInFeature", "selectedFeature", "selectedFeatureComponent", "selectedFeatureIndex", "state", "visible"), this.arcgisReady = y(), this.arcgisClose = y(), this.arcgisTriggerAction = y();
+    }, this._openRelatedFeatureAbortController = null, this.flowItems = new I(), this.viewModel = q(this), this.actions = this.viewModel.actions, this.active = this.viewModel.active, this.autoDestroyDisabled = !1, this.collapsed = !1, this.content = this.viewModel.content, this.defaultPopupTemplateEnabled = this.viewModel.defaultPopupTemplateEnabled, this.featureCount = this.viewModel.featureCount, this.featureMenuOpen = this.viewModel.featureMenuOpen, this.featureMenuTitle = this.viewModel.featureMenuTitle, this.featureNavigationTop = !1, this.features = this.viewModel.features, this.featuresPerPage = this.viewModel.featuresPerPage, this.featureViewModelAbilities = this.viewModel.featureViewModelAbilities, this.goToOverride = this.viewModel.goToOverride, this.headerActions = new I(), this.heading = this.viewModel.title, this.headingLevel = 2, this.hideActionBar = !1, this.hideCloseButton = !1, this.hideFeatureMenuHeading = !1, this.hideFeatureNavigation = !1, this.hideFeatureListLayerTitle = !1, this.hideFlow = !1, this.hideHeading = !1, this.hideSpinner = !1, this.highlightDisabled = this.viewModel.highlightEnabled, this.includeDefaultActions = this.viewModel.includeDefaultActions, this.initialDisplayMode = this.viewModel.initialDisplayMode, this.location = this.viewModel.location, this.map = this.viewModel.map, this.promises = this.viewModel.promises, this.responsiveActionsEnabled = !1, this.selectedFeature = this.viewModel.selectedFeature, this.selectedFeatureIndex = this.viewModel.selectedFeatureIndex, this.showCollapseButton = !1, this.spatialReference = this.viewModel.spatialReference, this.state = this.viewModel.state, this.timeZone = this.viewModel.timeZone, this.updateLocationEnabled = this.viewModel.updateLocationEnabled, this.view = this.viewModel.view, this.visible = this.viewModel.visible, this.arcgisPropertyChange = V()("active", "collapsed", "featureCount", "featureMenuOpen", "features", "promises", "selectedDrillInFeature", "selectedFeature", "selectedFeatureComponent", "selectedFeatureIndex", "state", "visible"), this.arcgisReady = y(), this.arcgisClose = y(), this.arcgisTriggerAction = y();
   }
   static {
-    this.properties = { _openRelatedFeatureAbortController: 16, flowItems: 16, _hideActionText: 16, _featureNavigationVisible: 16, _isCollapsed: 16, _collapseEnabled: 16, viewModel: 0, actions: 0, active: 0, autoDestroyDisabled: 5, collapsed: 5, content: 1, defaultPopupTemplateEnabled: 5, featureCount: 0, featureMenuOpen: 5, featureMenuTitle: 1, featureNavigationTop: 5, features: 0, featuresPerPage: 9, featureViewModelAbilities: 0, goToOverride: 0, headerActions: 0, heading: 1, headingLevel: 9, hideActionBar: 5, hideCloseButton: 5, showCollapseButton: 5, hideFeatureMenuHeading: 5, hideFeatureNavigation: 5, hideFeatureListLayerTitle: 5, hideFlow: 5, hideHeading: 5, hideSpinner: 5, icon: 1, includeDefaultActions: 5, initialDisplayMode: 1, label: 1, location: 0, map: 0, messageOverrides: 0, position: 1, referenceElement: 1, promises: 0, responsiveActionsEnabled: 5, selectedDrillInFeature: 32, selectedFeature: 0, selectedFeatureComponent: 32, selectedFeatureIndex: 9, spatialReference: 0, state: 3, timeZone: 1, updateLocationEnabled: 5, highlightDisabled: 5, view: 0, visible: 5 };
+    this.properties = { _openRelatedFeatureAbortController: 16, flowItems: 16, _hideActionText: 16, _featureNavigationVisible: 16, _isCollapsed: 16, _collapseEnabled: 16, viewModel: 0, actions: 0, active: 0, autoDestroyDisabled: 5, collapsed: 5, content: 1, defaultPopupTemplateEnabled: 5, featureCount: 0, featureMenuOpen: 5, featureMenuTitle: 1, featureNavigationTop: 5, features: 0, featuresPerPage: 9, featureViewModelAbilities: 0, goToOverride: 0, headerActions: 0, heading: 1, featuresTitle: 1, headingLevel: 9, hideActionBar: 5, hideCloseButton: 5, hideFeatureMenuHeading: 5, hideFeatureNavigation: 5, hideFeatureListLayerTitle: 5, hideFlow: 5, hideHeading: 5, hideSpinner: 5, highlightDisabled: 5, icon: 1, includeDefaultActions: 5, initialDisplayMode: 1, label: 1, location: 0, map: 0, messageOverrides: 0, position: 1, referenceElement: 1, promises: 0, responsiveActionsEnabled: 5, selectedDrillInFeature: 32, selectedFeature: 0, selectedFeatureComponent: 32, selectedFeatureIndex: 9, showCollapseButton: 5, spatialReference: 0, state: 3, timeZone: 1, updateLocationEnabled: 5, view: 0, visible: 5, closed: 5 };
   }
   static {
     this.styles = U;
@@ -87,6 +87,12 @@ class J extends S {
   get _collapseEnabled() {
     return this.showCollapseButton && (this.initialDisplayMode === "list" || !!(this.heading || this.viewModel.selectedFeatureViewModel?.title) && !!(this.content || this.viewModel.selectedFeatureViewModel?.content));
   }
+  get featuresTitle() {
+    return this.heading;
+  }
+  set featuresTitle(e) {
+    this.heading = e;
+  }
   get selectedDrillInFeature() {
     const e = Array.from(this.flowItems).at(-1);
     return e && "graphic" in e ? e.graphic ?? null : null;
@@ -94,6 +100,12 @@ class J extends S {
   get selectedFeatureComponent() {
     return this._selectedFeatureComponent.value ?? null;
   }
+  get closed() {
+    return !this.visible;
+  }
+  set closed(e) {
+    this.visible = !e;
+  }
   async clear() {
     return this.viewModel.clear();
   }