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

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

@@ -6,6 +6,7 @@ import { nil } from '@arcgis/toolkit/type';
 import { Use } from '@arcgis/lumina/controllers';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { HeadingLevel } from '../../support/heading';
+import { IconName } from '../../utils/action-utils';
 import { default as Collection } from '@arcgis/core/core/Collection.js';
 import { ArcgisFeature } from '../arcgis-feature/customElement.js';
 import { default as ActionButton } from '@arcgis/core/support/actions/ActionButton.js';
@@ -15,10 +16,10 @@ declare const useFeaturesViewModel: (component: LitElement & Pick<FeaturesViewMo
 /**
  * The Features component allows users to view a feature's popupTemplate content such as attributes,
  * actions, related records, etc., without having to be tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
- * This component looks and behaves similarly to the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html),
+ * This component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component,
  * however unlike Popup, the Features component can be placed outside of the map or scene component.
  * For example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),
- * the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) opens within the map whether it is docked
+ * the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) opens within the map whether it is docked
  * or anchored to the selected feature.
  * With the Features component, the same information that Popup provides is shown in a separate container from the map, such as
  * a HTML div within a Calcite Design System
@@ -37,6 +38,7 @@ declare const useFeaturesViewModel: (component: LitElement & Pick<FeaturesViewMo
  * @since 4.28
  */
 export declare class ArcgisFeatures extends LitElement {
+    /** @since 4.34 */
     viewModel: FeaturesViewModel;
     /**
      * [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects displayed in the action bar.
@@ -65,7 +67,7 @@ export declare class ArcgisFeatures extends LitElement {
      * featuresComponent.actions.push(zoomOutAction);
      * ```
      */
-    actions: Collection<ActionButton | ActionToggle>;
+    actions: Collection<import('@arcgis/core/widgets/Popup/types').PopupAction>;
     /**
      * 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.
      *
@@ -102,22 +104,31 @@ export declare class ArcgisFeatures extends LitElement {
      * // unless it is overridden by a PopupTemplate.
      * featuresComponent.content = "Click a feature on the map to view its attributes";
      * ```
+     * @see [Sample - Popup Docking](https://developers.arcgis.com/javascript/latest/sample-code/popup-docking-position/)
      */
-    content: string | HTMLElement | nullish | __esri.Widget;
+    content: string | HTMLElement | import('@arcgis/core/widgets/Widget').default<any> | null | undefined;
     /**
      * 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)
+     * 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), and
+     * [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).
      *
      * @default false
+     * @since 4.34
      */
     defaultPopupTemplateEnabled: boolean;
     /**
      * The number of selected [features](#features) available to the popup.
      *
-     * @since 4.34
      * @default 0
+     * @since 4.34
      */
     readonly featureCount: number;
     /**
@@ -125,18 +136,22 @@ export declare class ArcgisFeatures extends LitElement {
      * 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
+     * @since 4.34
      */
     featureMenuOpen: boolean;
-    /** Sets the title to display on the component while viewing the feature menu. */
-    featureMenuTitle: string | nullish;
+    /**
+     * Sets the title to display on the component while viewing the feature menu.
+     *
+     * @since 4.34
+     */
+    featureMenuTitle: string | null | undefined;
     /**
      * 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
+     * @since 4.34
      */
     featureNavigationTop: boolean;
     /**
@@ -170,7 +185,7 @@ export declare class ArcgisFeatures extends LitElement {
      * featuresComponent.features = graphics;
      * ```
      */
-    features: __esri.Graphic[];
+    features: import('@arcgis/core/Graphic').default[];
     /**
      * The number of features to fetch at one time.
      *
@@ -178,7 +193,7 @@ export declare class ArcgisFeatures extends LitElement {
      */
     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;
+    featureViewModelAbilities: import('@arcgis/core/widgets/Feature/types').Abilities | null | undefined;
     /**
      * 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.
      *
@@ -191,8 +206,11 @@ export declare class ArcgisFeatures extends LitElement {
      *   return map.goTo(goToParams.target, goToParams.options);
      * };
      * ```
+     * @since 4.8
+     * @see [MapView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)
+     * @see [SceneView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)
      */
-    goToOverride: nullish | __esri.GoToOverride;
+    goToOverride: import('@arcgis/core/widgets/support/types').GoToOverride | null | undefined;
     /**
      * The actions that are displayed in the header of the component.
      *
@@ -206,6 +224,7 @@ export declare class ArcgisFeatures extends LitElement {
      * corresponding template is used here.
      *
      * @see [headingLevel](#headingLevel)
+     * @since 4.34
      * @example
      * ```js
      * // This title will display in the component unless a selected feature's
@@ -213,14 +232,7 @@ export declare class ArcgisFeatures extends LitElement {
      * 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);
+    heading: string | null | undefined;
     /**
      * Indicates the heading level to use for the [heading](#heading) of the component.
      * By default, the heading is rendered
@@ -260,12 +272,13 @@ export declare class ArcgisFeatures extends LitElement {
      * Indicates whether to hide the group heading for a list of multiple features.
      *
      * @default false
+     * @since 4.34
      */
     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`.
+     * The flow component will be omitted from the component if set to `true`.
      * To place the component into an existing Calcite flow component, set this property to `false`.
      *
      * @default false
@@ -283,12 +296,97 @@ export declare class ArcgisFeatures extends LitElement {
      * @default false
      */
     hideSpinner: boolean;
+    /**
+     * This property provides the ability to hide or show content within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    hideContent: boolean;
+    /**
+     * Disables chart animation within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    get chartAnimationDisabled(): boolean;
+    set chartAnimationDisabled(value: boolean);
+    /**
+     * This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    get hideAttachmentsContent(): boolean;
+    set hideAttachmentsContent(value: boolean);
+    /**
+     * This property provides the ability to hide or show [custom content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html) within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    get hideCustomContent(): boolean;
+    set hideCustomContent(value: boolean);
+    /**
+     * This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    hideExpressionContent: boolean;
+    /**
+     * This property provides the ability to hide or show [fields content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html) within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    get hideFieldsContent(): boolean;
+    set hideFieldsContent(value: boolean);
+    /**
+     * This property provides the ability to hide or show [media content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    get hideMediaContent(): boolean;
+    set hideMediaContent(value: boolean);
+    /**
+     * This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html) within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    get hideRelationshipContent(): boolean;
+    set hideRelationshipContent(value: boolean);
+    /**
+     * This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html) within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    get hideTextContent(): boolean;
+    set hideTextContent(value: boolean);
+    /**
+     * This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html) within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    get hideUtilityNetworkContent(): boolean;
+    set hideUtilityNetworkContent(value: boolean);
+    /**
+     * This property provides the ability to hide or show the last edited info within the component.
+     *
+     * @default false
+     * @since 5.0
+     */
+    hideLastEditedInfo: 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
+     * @since 4.34
      */
     highlightDisabled: boolean;
     /**
@@ -297,12 +395,13 @@ export declare class ArcgisFeatures extends LitElement {
      *
      * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    icon?: string;
+    icon?: IconName;
     /**
      * 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
+     * @since 4.34
      */
     includeDefaultActionsDisabled: boolean;
     /**
@@ -310,7 +409,7 @@ export declare class ArcgisFeatures extends LitElement {
      *
      * @default "feature"
      */
-    initialDisplayMode: "list" | "feature";
+    initialDisplayMode: import('@arcgis/core/widgets/Popup/types').InitialDisplayOptions;
     /** The component's default label. */
     label?: string;
     /**
@@ -318,6 +417,7 @@ export declare class ArcgisFeatures extends LitElement {
      *
      * Alternatively, the [view](#view) property can be used to provide the map instance for this property.
      *
+     * @default null
      * @noautocast
      * @see [Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)
      * @see [Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)
@@ -326,17 +426,16 @@ export declare class ArcgisFeatures extends LitElement {
      * // The building footprints represent the buildings that intersect a clicked parcel
      * let buildingFootprints = Intersects($feature, FeatureSetByName($map, "Building Footprints"));
      * ```
-     * @default null
      */
-    map: nullish | __esri.Map;
+    map: import('@arcgis/core/Map').default | null | undefined;
     /**
      * Replace localized message strings with your own strings.
      *
      * _**Note**: Individual message keys may change between releases._
+     *
+     * @since 4.34
      */
     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.
      *
@@ -349,7 +448,7 @@ export declare class ArcgisFeatures extends LitElement {
      * resolved they are removed from this array and the features they return
      * are pushed into the [features](#features) array.
      */
-    promises: Promise<__esri.Graphic[]>[];
+    promises: Promise<import('@arcgis/core/Graphic').default[]>[];
     /**
      * 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.
@@ -361,7 +460,7 @@ export declare class ArcgisFeatures extends LitElement {
      * 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: __esri.Graphic | nullish;
+    readonly selectedFeature: import('@arcgis/core/Graphic').default | null;
     /**
      * 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.
@@ -386,18 +485,18 @@ export declare class ArcgisFeatures extends LitElement {
      *
      * Alternatively, the [view](#view) property can be used to provide the spatial reference instance for this property.
      *
+     * @default null
      * @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;
+    spatialReference: import('@arcgis/core/geometry/SpatialReference').default | null | undefined;
     /**
      * The current state of the component.
      *
      * @default "disabled"
      */
-    readonly state: "ready" | "disabled";
+    readonly state: import('@arcgis/core/widgets/Popup/types').State;
     /**
      * 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
@@ -407,6 +506,8 @@ export declare class ArcgisFeatures extends LitElement {
      * - `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).
+     *
+     * @since 4.30
      */
     timeZone: string;
     /**
@@ -421,22 +522,16 @@ export declare class ArcgisFeatures extends LitElement {
      *
      * @since 4.34
      */
-    view?: __esri.MapView | __esri.SceneView | nullish;
+    view?: import('@arcgis/core/views/MapViewOrSceneView').MapViewOrSceneView | null | undefined;
     /**
      * 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
+     * Use the property to check if the component is visible.
      *
      * @default false
+     * @since 4.34
+     * @see [active](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#active)
      */
     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.
@@ -453,6 +548,8 @@ export declare class ArcgisFeatures extends LitElement {
      * 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.
      *
+     * @param screenPoint
+     * @param options
      * @example
      * ```js
      * // Use reactiveUtils to watch the map's click event.
@@ -481,6 +578,7 @@ export declare class ArcgisFeatures extends LitElement {
      * 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.
      *
+     * @param options
      * @example
      * ```js
      * // Use reactiveUtils to watch the map component's click event.
@@ -532,16 +630,22 @@ export declare class ArcgisFeatures extends LitElement {
      * @see [selectedFeatureIndex](#selectedFeatureIndex)
      */
     previous(): Promise<FeaturesViewModel>;
-    /** Use this method to give focus to the Component if the component is able to be focused. */
+    /**
+     * Use this method to give focus to the Component if the component is able to be focused.
+     *
+     * @since 4.34
+     */
     setFocus(): Promise<void>;
     /**
      * Triggers the [`arcgisTriggerAction`](#arcgisTriggerAction) event and executes the action
      * at the specified index in the [actions](#actions) array.
+     *
+     * @param action
      */
     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" | "visible" | "selectedFeature" | "featureMenuOpen" | "features" | "promises" | "selectedFeatureIndex" | "selectedDrillInFeature" | "selectedFeatureComponent";
+        name: "active" | "state" | "collapsed" | "featureCount" | "featureMenuOpen" | "features" | "promises" | "selectedDrillInFeature" | "selectedFeature" | "selectedFeatureComponent" | "selectedFeatureIndex" | "visible";
     }>;
     /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
@@ -590,7 +694,13 @@ export declare class ArcgisFeatures extends LitElement {
      * });
      * ```
      */
-    readonly arcgisTriggerAction: TargetedEvent<this, __esri.FeaturesViewModelTriggerActionEvent>;
+    readonly arcgisTriggerAction: TargetedEvent<this, import('@arcgis/core/widgets/Popup/types').ActionEvent>;
     private messages;
+    "@eventTypes": {
+        "arcgisClose": ArcgisFeatures["arcgisClose"]["detail"];
+        "arcgisPropertyChange": ArcgisFeatures["arcgisPropertyChange"]["detail"];
+        "arcgisReady": ArcgisFeatures["arcgisReady"]["detail"];
+        "arcgisTriggerAction": ArcgisFeatures["arcgisTriggerAction"]["detail"];
+    };
 }
 export {};