@arcgis/map-components 4.34.0-next.14 → 4.34.0-next.141

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

@@ -1,180 +1,376 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-/// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/lumina/controllers';
-import { default as Feature } from '@arcgis/core/widgets/Feature.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+/// <reference path="../../index.d.ts" />
+import { ArcgisFeatureRelationship } from '../arcgis-feature-relationship/customElement.js';
+import { default as FeatureViewModel } from '@arcgis/core/widgets/Feature/FeatureViewModel.js';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { HeadingLevel } from '../../support/heading';
+import { nil } from '@arcgis/toolkit/type';
+import { Use } from '@arcgis/lumina/controllers';
+import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+export type FlowItemType = "feature-association" | "feature-relationship" | "feature-utility-network-association-type" | "feature-utility-network-associations" | "feature";
+export type FlowItemComponent = HTMLArcgisFeatureElement | ArcgisFeatureRelationship["el"];
 
-declare const useFeatureWidget: (component: LitElement & Pick<Feature, "icon" | "label" | "viewModel" | "map" | "spatialReference" | "timeZone" | "headingLevel" | "graphic" | "defaultPopupTemplateEnabled" | "location"> & {
-    state?: unknown;
-    viewModel?: __esri.FeatureViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/components-utils').Nil | string;
-    label: import('@arcgis/components-utils').Nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    position: __esri.UIPosition;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => Feature;
+declare const useFeatureViewModel: (component: LitElement & Pick<FeatureViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<FeatureViewModel>) => FeatureViewModel;
 /**
- * The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This component is useful in instances where you want to display information about a feature but without the use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).
+ * The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).
+ * This component is useful in instances where you want to display information about a feature but without
+ * the use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).
+ *
+ * If wanting to show a feature's content with [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions), [related](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html), or [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate), etc., then use the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component.
+ *
+ * When Arcade expressions that use `$map` or [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) are defined in any popup template content or as expression elements,
+ * the [map](#map) and [spatialReference](#spatialReference) properties need to be defined in the Feature component.
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/)
+ *
+ * @see [Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)
+ * @see [Arcade - expression language](https://developers.arcgis.com/javascript/latest/arcade/)
+ * @since 4.28
  */
 export declare class ArcgisFeature extends LitElement {
+    viewModel: FeatureViewModel;
     /**
-     * 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-feature/#destroy) method when you are done to
-     * prevent memory leaks.
+     * The view associated with the component.
+     *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the ArcgisFeature component will be associated with a map or scene component rather than using the `view` property.
+     */
+    view?: __esri.MapView | __esri.SceneView | nullish;
+    /**
+     * A collection of flow items that are used to manage drill-in navigation.
      *
-     * @default false
+     * @since 4.34
      */
-    autoDestroyDisabled: boolean;
+    flowItems?: __esri.Collection<FlowItemComponent>;
     /**
-     * Enables automatic creation of a popup template for layers that have popups enabled but no
-     * popupTemplate defined.
+     * 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;
+    /** @deprecated since 4.34, use `slot` instead. */
+    position?: __esri.UIPosition;
+    /**
+     * 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/)
+     * @default "icon"
+     */
+    icon?: string;
+    /**
+     * Indicates whether the current graphic resides in a non-spatial table.
+     *
+     * @since 4.34
      * @default false
      */
-    defaultPopupTemplateEnabled: boolean;
+    readonly isFeatureFromTable: boolean;
     /**
      * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.
      *
+     * @autocast
+     * @see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content)
+     * @example
+     * ```js
+     * let graphic = new Graphic({
+     *   geometry: view.center,
+     *   attributes: {
+     *     name: "Spruce",
+     *     family: "Pinaceae",
+     *     count: 126
+     *   },
+     *   symbol: new SimpleMarkerSymbol({
+     *     style: "square",
+     *     color: "blue",
+     *     size: "8px"
+     *   }),
+     *   popupTemplate: {
+     *     content: [
+     *       {
+     *         // Set popup template content
+     *       }
+     *     ]
+     *   }
+     * });
+     * ```
      * @default null
      */
     graphic: nullish | __esri.Graphic;
     /**
-     * Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#title) of the feature widget.
+     * 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),
+     * [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),
+     * [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.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)).
+     *
+     * **Note:**
+     * 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 the 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 the heading level to use for the [heading](#heading) of the component.
+     * By default, the title is rendered
+     * as a level 2 heading (e.g. `<h2>Title of content</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)
+     * @example
+     * ```
+     * // feature title will render as an <h3>
+     * feature.headingLevel = 3;
+     * ```
      * @default 2
      */
-    headingLevel: number;
+    headingLevel: HeadingLevel;
+    /**
+     * The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.
+     * This property should be set if the component executes Arcade expressions that contain [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/).
+     *
+     * @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;
+    /**
+     * Dates and times displayed in the component will be displayed in this time zone. By default this time zone is
+     * inherited from [MapView.timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone). 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;
+    /**
+     * The title for the feature. This can be disabled by setting the [`hideHeading`](#hideHeading) property to `true`.
+     *
+     * @since 4.34
+     * @see [headingLevel](#headingLevel)
+     * @see [hideHeading](#hideHeading)
+     * @default null
+     */
+    readonly heading: string;
+    /**
+     * A map is required when the input [graphic](#graphic) has 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.
+     *
+     * @noautocast
+     * @see [Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)
+     * @see [Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)
+     * @example
+     * ```
+     * // 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;
+    /**
+     * Disables chart animation within the component.
+     *
+     * @since 4.34
+     * @default false
+     */
+    chartAnimationDisabled: boolean | undefined;
+    /**
+     * This property provides the ability to hide or show the component's [heading](#heading).
+     *
+     * @since 4.34
+     * @default false
+     */
+    hideHeading: boolean;
+    /**
+     * Indicates whether to hide the title associated with the feature.
+     *
+     * @deprecated since 4.34, use [`hideHeading`](#hideHeading) instead.
+     * @default false
+     */
+    get hideTitle(): boolean;
+    set hideTitle(value: boolean);
+    /**
+     * This property provides the ability to hide or show content within the component.
+     *
+     * @since 4.34
+     * @default false
+     */
+    hideContent: 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
+     */
+    hideAttachmentsContent: boolean;
     /**
      * Indicates whether to hide all [AttachmentsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html).
      *
+     * @deprecated since 4.34, use [`hideAttachmentsContent`](#hideAttachmentsContent) instead.
+     * @default false
+     */
+    get hideContentAttachments(): boolean;
+    set hideContentAttachments(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.
+     *
+     * @since 4.34
      * @default false
      */
-    hideContentAttachments: boolean | undefined;
+    hideCustomContent: 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
+     */
+    hideExpressionContent: boolean;
     /**
      * Indicates whether to hide all [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html).
      *
+     * @deprecated since 4.34, use [`hideExpressionContent`](#hideExpressionContent) instead.
+     * @default false
+     */
+    get hideContentExpression(): boolean;
+    set hideContentExpression(value: 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
      */
-    hideContentExpression: boolean | undefined;
+    hideFieldsContent: boolean;
     /**
      * Indicates whether to hide all [FieldsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html).
      *
+     * @deprecated since 4.34, use [`hideFieldsContent`](#hideFieldsContent) instead.
      * @default false
      */
-    hideContentFields: boolean | undefined;
+    get hideContentFields(): boolean;
+    set hideContentFields(value: boolean);
     /**
-     * Indicates whether to hide all [MediaContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html).
+     * 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
      */
-    hideContentMedia: boolean | undefined;
+    hideMediaContent: boolean;
     /**
-     * Indicates whether to hide all [TextContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html).
+     * Indicates whether to hide all [MediaContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html).
      *
+     * @deprecated since 4.34, use [`hideMediaContent`](#hideMediaContent) instead.
      * @default false
      */
-    hideContentText: boolean | undefined;
+    get hideContentMedia(): boolean;
+    set hideContentMedia(value: boolean);
     /**
-     * @deprecated since 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead.
+     * 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.
+     *
+     * @since 4.34
      * @default false
      */
-    hideLastEditInfo: boolean | undefined;
+    showRelationshipContent: boolean;
     /**
-     * Indicates whether to hide the [lastEditInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#lastEditInfo).
+     * 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
      */
-    hideLastEditedInfo: boolean | undefined;
+    hideTextContent: boolean;
     /**
-     * Indicates whether to hide the title associated with the feature.
+     * Indicates whether to hide all [TextContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html).
      *
+     * @deprecated since 4.34, use [`hideTextContent`](#hideTextContent) instead.
      * @default false
      */
-    hideTitle: boolean | undefined;
+    get hideContentText(): boolean;
+    set hideContentText(value: boolean);
     /**
-     * Icon which represents the widget.
+     * This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-UtilityNetworkContent.html) within the component.
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     * @default "polygon"
+     * @since 4.34
+     * @default false
      */
-    icon: string;
+    showUtilityNetworkContent: boolean;
     /**
-     * The widget's default label.
+     * This property provides the ability to hide or show the last edited info within the component.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#label)
+     * @default false
      */
-    label: string;
+    hideLastEditedInfo: boolean;
     /**
-     * The location of the graphic to be displayed.
+     * Indicates whether to hide the title associated with the feature.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#location)
+     * @deprecated since 4.33, use [`hideLastEditedInfo`](#hideLastEditedInfo) instead.
+     * @default false
+     */
+    get hideLastEditInfo(): boolean;
+    set hideLastEditInfo(value: 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-feature/#destroy) method when you are done to
+     * prevent memory leaks.
      *
-     * @default null
+     * @default false
      */
-    location: nullish | __esri.Point;
+    autoDestroyDisabled: boolean;
     /**
-     * A map is required when the input [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic) has 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.
+     * Overwrite localized strings for this component.
      *
-     * @default null
+     * @since 4.34
      */
-    map: __esri.Map | nullish;
-    /** @default "bottom-left" */
-    position: __esri.UIPosition;
-    referenceElement?: ArcgisReferenceElement | string;
+    messageOverrides?: typeof this.messages._overrides;
+    /** The component's default label. */
+    label?: string;
     /**
-     * The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.
+     * The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location of the map interaction used to trigger the opening of the component.
      *
      * @default null
      */
-    spatialReference: nullish | __esri.SpatialReference;
+    location: nullish | __esri.Point;
     /**
-     * The view model's state.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#state)
+     * The current state of the component.
      *
      * @default "disabled"
      */
     readonly state: "ready" | "loading" | "disabled" | "error";
-    /**
-     * Dates and times displayed in the widget will be displayed in this time zone.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#timeZone)
-     */
-    timeZone: string;
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
-    /** Paginates to the next [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos). */
+    /** Paginates to the next [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info. */
     nextMedia(contentElementIndex: number): Promise<void>;
-    /** Paginates to the previous [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos). */
+    /**
+     * Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info in the specified
+     * [media](esri-popup-content-MediaContent.html) content element.
+     */
     previousMedia(contentElementIndex: number): Promise<void>;
     /**
-     * Paginates to a specified [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos) object.
-     * For example, you may have [media content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos) which contains multiple mediaInfos.
-     * This method allows you to specify the index of the mediaInfos you wish to display.
+     * Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info object. For example,
+     * you may have [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) content which contains
+     * multiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`
+     * you wish to display.
+     *
+     * ::: esri-md class="warning"
+     * Prior to   version 4.17, this method was named `goToMedia`.
+     * :::
      */
     setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>;
+    /**
+     * Updates the geometry of the graphic.
+     *
+     * @since 4.34
+     */
+    updateGeometry(): 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";
+        name: "state" | "flowItems";
     }>;
-    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
+    private messages;
 }
 export {};