@arcgis/map-components 4.34.0-next.125 → 4.34.0-next.126

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

@@ -3986,7 +3986,7 @@
     },
     {
       "name": "arcgis-features",
-      "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.",
+      "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 a [ArcgisMap](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [ArcgisScene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis component looks and behaves similarly to the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html),\nhowever unlike Popup, the Features component can be placed outside of the map or scene component.\nFor example, when features are selected in the [ArcgisMap](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),\nthe [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) opens within the map 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 map, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\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 map or scene component. If wanting to show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [ArcgisFeature](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-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- **arcgisTriggerAction** - Fires after the user clicks on an action in the Features component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\nSee the example below for details of how this works.\n\n### Methods\n- `clear(): Promise<void>` - Removes [promises](#promises), [features](#features), [content](#content), and\n[heading](#heading) from the Features component.\n- `close(): Promise<void>` - This is a convenience method to 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.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](#selectedFeature).\n- `open(options?: __esri.FeaturesViewModelOpenOptions): Promise<void>` - Opens the Features component 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.\n- `previous(): Promise<FeaturesViewModel>` - Selects the feature at the previous index in relation to the [selected feature](#selectedFeature).\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 [`arcgisTriggerAction`](#arcgistriggeraction) event and executes the action\nat the specified index in the [actions](#actions) array.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -3995,22 +3995,22 @@
         },
         {
           "name": "collapsed",
-          "description": "Indicates whether the popup displays its content. If `true`, only the header displays.",
+          "description": "Indicates whether the component displays its content. If `true`, only the header displays.\nThis property is only honored if [`showCollapsed`](#showcollapsed) is `true`.",
           "values": []
         },
         {
           "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).",
+          "description": "The content of the Features component. When set directly on the component, 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": "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)",
+          "description": "This property enables multiple features in the component to display in a list rather than displaying the first selected feature.\nSetting this to `true` allows the user to scroll through the list of features.\nThis value will only be honored if [`initialDisplayMode`](#initialdisplaymode) is set to \"feature\".",
           "values": []
         },
         {
           "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)",
+          "description": "Sets the title to display on the component while viewing the feature menu.",
           "values": []
         },
         {
@@ -4020,7 +4020,7 @@
         },
         {
           "name": "features-per-page",
-          "description": "The number of features to fetch at one time.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featuresPerPage)",
+          "description": "The number of features to fetch at one time.",
           "values": []
         },
         {
@@ -4054,42 +4054,42 @@
         },
         {
           "name": "hide-action-bar",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "description": "Indicates whether to hide the action bar that holds the feature's [actions](#actions).",
           "values": []
         },
         {
           "name": "hide-close-button",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "description": "Indicates whether to hide the close button in the component.",
           "values": []
         },
         {
           "name": "hide-feature-list-layer-title",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "description": "Indicates whether to hide the group heading for a list of multiple features.",
           "values": []
         },
         {
           "name": "hide-feature-menu-heading",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "description": "Indicates whether to hide the feature menu heading and description in the component's feature menu list.",
           "values": []
         },
         {
           "name": "hide-feature-navigation",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "description": "Indicates whether to hide the feature pagination in the component.\nThis allows the user to scroll through various [selected features](#features) using pagination arrows.",
           "values": []
         },
         {
           "name": "hide-flow",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "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 set to `false`.\nThe flow component will be omitted from the widget if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
           "values": []
         },
         {
           "name": "hide-heading",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "description": "Indicates whether to hide the component's [heading](#heading).",
           "values": []
         },
         {
           "name": "hide-spinner",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "description": "Indicates whether to hide the component's loading spinner.",
           "values": []
         },
         {
@@ -4099,7 +4099,7 @@
         },
         {
           "name": "include-default-actions",
-          "description": "Indicates whether or not to include [defaultActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultActions).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#includeDefaultActions)",
+          "description": "Indicates whether to include the [defaultActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#includeDefaultActions) in the component.",
           "values": []
         },
         {
@@ -4121,6 +4121,7 @@
         },
         {
           "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"
@@ -4153,6 +4154,7 @@
         },
         {
           "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": []
         },
         {
@@ -4162,7 +4164,7 @@
         },
         {
           "name": "show-collapse-button",
-          "description": "This property provides the ability to turn individual elements of the component's display on/off.",
+          "description": "Indicates whether to show the collapse button in the component.",
           "values": []
         },
         {
@@ -4179,7 +4181,7 @@
         },
         {
           "name": "time-zone",
-          "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).",
+          "description": "Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited 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\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": []
         }
       ],
@@ -8709,6 +8711,70 @@
         }
       ]
     },
+    {
+      "name": "arcgis-utility-network-trace-analysis",
+      "description": "### Events\n- **arcgisPropertyChange**\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.",
+      "attributes": [
+        {
+          "name": "allow-editing-disabled",
+          "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-utility-network-trace-analysis/#destroy) method when you are done to\nprevent memory leaks.",
+          "values": []
+        },
+        {
+          "name": "closable",
+          "values": []
+        },
+        {
+          "name": "icon",
+          "values": []
+        },
+        {
+          "name": "label",
+          "values": []
+        },
+        {
+          "name": "mode",
+          "values": []
+        },
+        {
+          "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": "state",
+          "description": "The viewModel's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTraceAnalysis-UtilityNetworkTraceAnalysisViewModel.html#state)",
+          "values": [
+            {
+              "name": "disabled"
+            },
+            {
+              "name": "executing"
+            },
+            {
+              "name": "loading"
+            },
+            {
+              "name": "ready"
+            }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-analysis/"
+        },
+        {
+          "name": "Utility Network Trace Analysis",
+          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-utility-network-trace-analysis--demo&singleStory=true"
+        }
+      ]
+    },
     {
       "name": "arcgis-result-feature-list",
       "description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes trace result elements as input.\nIt displays the layers the elements are from, with a count of elements on each layer.\nA `UtilityNetwork` and list of layers is required to display feature layer names.\n--\n\n### Events\n- **arcgisPropertyChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",