@arcgis/map-components 4.34.0-next.110 → 4.34.0-next.111

package/dist/docs/vscode.html-custom-data.json

@@ -2932,7 +2932,7 @@
     },
     {
       "name": "arcgis-feature",
-      "description": "The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis component is useful in instances where you want to display information about a feature but without\nthe use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\n\nIf 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 [ArcgisFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component.\n\nWhen 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,\nthe [map](#map) and [spatialReference](#spatialReference) properties need to be defined in the Feature component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info in the specified\n[media](esri-popup-content-MediaContent.html) content element.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.\n\n::: esri-md class=\"warning\"\nPrior to   version 4.17, this method was named `goToMedia`.\n:::",
+      "description": "The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis component is useful in instances where you want to display information about a feature but without\nthe use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\n\nIf 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 [ArcgisFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component.\n\nWhen 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,\nthe [map](#map) and [spatialReference](#spatialReference) properties need to be defined in the Feature component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info in the specified\n[media](esri-popup-content-MediaContent.html) content element.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.\n\n::: esri-md class=\"warning\"\nPrior to   version 4.17, this method was named `goToMedia`.\n:::\n- `updateGeometry(): Promise<void>`",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -3700,36 +3700,36 @@
     },
     {
       "name": "arcgis-features",
-      "description": "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 the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `clear(): Promise<void>`\n- `close(): Promise<void>` - Closes the component.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.FeaturesFetchFeaturesScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [layer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html).\nIn order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis method allows a developer to control how the input location is handled.\n- `next(): Promise<__esri.FeaturesViewModel>`\n- `open(options?: __esri.FeaturesOpenOptions): Promise<void>` - Opens Features with content defined either explicitly or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features.\n- `previous(): Promise<__esri.FeaturesViewModel>`\n- `triggerAction(actionIndex: number): Promise<void>`",
+      "description": "The Features component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without having to be tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).\nThis component looks and behaves similarly to the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-components-Popup.html) component,\nhowever unlike Popup, the Features component can be placed outside of the view.\nFor example, when features are selected in the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html),\nthe [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-components-Popup.html) component opens within the View whether it is docked\nor anchored to the selected feature.\nWith the Features component, the same information that popup provides is shown in a separate container from the view, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\n[![features-component-image](../assets/img/apiref/components/features-component.png)](../sample-code/sandbox/?sample=components-features)\n\nIn the image above, a Calcite shell panel displays the Features component along with a MapView in a separate div.\nA generic `title` and `content` property can be set directly on the Features component or\neach individual layer's [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) can be displayed (e.g.\nthe Olympic National Park feature's PopupTemplate that contains text, media, and relationship elements).\nThe action bar, shown below the title in the image above, displays [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) that can be defined either on the component level within the [open()](#open) method,\nwith the [FeaturesViewModel.actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-components-Features-FeaturesViewModel.html#actions) property, or in the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of the layer.\nIf multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the View. If wanting to show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [Feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-components-Feature.html) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction**\n\n### Methods\n- `clear(): Promise<void>` - Removes [promises](#promises), [features](#features), [content](#content), and\n[title](#title) from the Features component.\n- `close(): Promise<void>` - This is a convenience method to closes the component. Users can alternatively close the component\nby directly setting the [visible](#visible) property to `false`.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.ScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nin 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\nassociated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This method allows a developer to\ncontrol how the input location is handled.\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the selected feature.\n- `open(options?: __esri.FeaturesViewModelOpenOptions): Promise<void>` - Opens the Features component in its [container](#container) with content defined either explicitly with `content`\nor driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. This method sets\nthe Feature component's [visible](#visible) property to `true`. Users can alternatively show the Features component\nby directly setting the [visible](#visible) property to `true`.\n- `previous(): Promise<FeaturesViewModel>` - Selects the feature at the previous index in relation to the selected feature.\n- `setFocus(): Promise<void>` - Use this method to give focus to the Component if the component is able to be focused.\n- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>` - Triggers the [trigger-action](#event-trigger-action) event and executes the [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-components-Features-FeaturesViewModel.html#actions)\nat the specified index in the [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-components-Features-FeaturesViewModel.html#actions) array.",
       "attributes": [
         {
-          "name": "active",
-          "description": "Indicates if the widget is active when it is visible and is not [waiting for results](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#waitingForResult).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#active)",
+          "name": "auto-destroy-disabled",
+          "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis 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\nprevent memory leaks.",
           "values": []
         },
         {
-          "name": "auto-destroy-disabled",
-          "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis 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\nprevent memory leaks.",
+          "name": "collapsed",
+          "description": "Indicates whether the popup displays its content. If `true`, only the header displays.",
           "values": []
         },
         {
-          "name": "closed",
-          "description": "Indicates whether a component is closed. When `true`, the component will be hidden.",
+          "name": "content",
+          "description": "The content of the Features component. When set directly on the Popup, this content is\nstatic and cannot use fields to set content templates. To set a template\nfor the content based on field or attribute names, see\n[PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content).",
           "values": []
         },
         {
-          "name": "collapsed",
-          "description": "Indicates whether the popup displays its content.",
+          "name": "feature-menu-open",
+          "description": "This property enables showing the list of features.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureMenuOpen)",
           "values": []
         },
         {
-          "name": "content",
-          "description": "The content of the Features widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#content)",
+          "name": "feature-menu-title",
+          "description": "The title to display on the widget while viewing the feature menu.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureMenuTitle)",
           "values": []
         },
         {
           "name": "feature-navigation-top",
-          "description": "Indicates whether the feature navigation arrows are displayed at the top of the widget.",
+          "description": "Indicates whether the feature navigation arrows are displayed at the top of the component.\nBy default, the navigation arrows are displayed at the bottom of the component.",
           "values": []
         },
         {
@@ -3738,53 +3738,77 @@
           "values": []
         },
         {
-          "name": "features-title",
-          "description": "The title of the Features widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title)",
+          "name": "heading",
+          "description": "The title of the Features component. This can be set to any string value no\nmatter the features that are selected. If the [selected feature](#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), then the title set in the\ncorresponding template is used here.",
           "values": []
         },
         {
           "name": "heading-level",
-          "description": "Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#headingLevel)",
-          "values": []
+          "description": "Indicates the heading level to use for the [title](#title) of the component.\nBy default, the title is rendered\nas a level 2 heading (e.g. `<h2>Popup title</h2>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
+          "values": [
+            {
+              "name": "1"
+            },
+            {
+              "name": "2"
+            },
+            {
+              "name": "3"
+            },
+            {
+              "name": "4"
+            },
+            {
+              "name": "5"
+            },
+            {
+              "name": "6"
+            }
+          ]
         },
         {
           "name": "hide-action-bar",
-          "description": "Indicates whether to hide the action bar that holds the feature's [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions).",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
           "values": []
         },
         {
           "name": "hide-close-button",
-          "description": "Indicates whether to hide the close button.",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "values": []
+        },
+        {
+          "name": "hide-feature-list-layer-title",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
           "values": []
         },
         {
           "name": "hide-feature-menu-heading",
-          "description": "Indicates whether to hide a heading and description on the widget feature menu list.",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
           "values": []
         },
         {
           "name": "hide-feature-navigation",
-          "description": "Indicates whether to hide pagination for feature navigation.\nThis allows the user to scroll through various selected features using pagination arrows.",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
           "values": []
         },
         {
           "name": "hide-flow",
-          "description": "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.\nThe component will be displayed within its original flow component if `false`.\nThe flow component will be omitted if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
           "values": []
         },
         {
           "name": "hide-heading",
-          "description": "Indicates whether is hide the heading.",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
           "values": []
         },
         {
           "name": "hide-spinner",
-          "description": "Indicates whether to hide the loading spinner.",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
           "values": []
         },
         {
           "name": "icon",
-          "description": "Icon which represents the widget.",
+          "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
           "values": []
         },
         {
@@ -3806,12 +3830,11 @@
         },
         {
           "name": "label",
-          "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
           "name": "position",
-          "description": "**Deprecated**: since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead.. ",
           "values": [
             {
               "name": "bottom-leading"
@@ -3844,16 +3867,16 @@
         },
         {
           "name": "reference-element",
-          "description": "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.",
           "values": []
         },
         {
           "name": "selected-feature-index",
-          "description": "Index of the feature that is [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeature).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeatureIndex)",
+          "description": "Index of the feature that is [selected](#selectedFeature). When [features](#features) are set,\nthe first index is automatically selected.",
           "values": []
         },
         {
           "name": "show-collapse-button",
+          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
           "values": []
         },
         {
@@ -3870,7 +3893,7 @@
         },
         {
           "name": "time-zone",
-          "description": "Dates and times displayed in the widget will be displayed in this time zone.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#timeZone)",
+          "description": "Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from [MapView.timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone) if the [view](#view) property is set. When a MapView is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nsystem  | Dates and times will be displayed in the timezone of the device or browser.\nunknown | Dates and time are not adjusted for any timezone.\nSpecified 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).",
           "values": []
         }
       ],