@arcgis/map-components 5.0.0-next.6 → 5.0.0-next.7

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-10-01T04:36:32",
+  "timestamp": "2025-10-02T04:40:58",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "5.0.0-next.6",
+    "version": "5.0.0-next.7",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -31866,7 +31866,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "The background color of the MapView. If the view's map changes, the view's `background` is reset to the map's background,\neven if the user set it previously.",
+          "docs": "The background color of the Map component.",
           "docsTags": [],
           "default": "null",
           "values": [],
@@ -31947,7 +31947,7 @@
           "mutable": true,
           "attr": "center",
           "reflectToAttr": false,
-          "docs": "Represents the view's center point; when setting the center, you may pass a\nesri/geometry/Point instance or a string representing\na longitude/latitude pair (`\"-100.4593, 36.9014\"`).\nSetting the center immediately changes the current view.\nFor animating the view, see this component's goTo() method.",
+          "docs": "Represents the view's center point; when setting the center, you may pass a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance or a string representing\na longitude/latitude pair (`\"-100.4593, 36.9014\"`).\nSetting the center immediately changes the current view.\nFor animating the view, see this component's [goTo()](#goTo) method.",
           "docsTags": [],
           "values": [
             {
@@ -31979,7 +31979,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "Specifies constraints to scale, zoom, and rotation that may be applied to the MapView.",
+          "docs": "Specifies constraints to scale, zoom, and rotation that may be applied to the map.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -31996,7 +31996,7 @@
           "mutable": true,
           "attr": "display-filter-disabled",
           "reflectToAttr": false,
-          "docs": "Indicates whether layer's displayFilter are honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.",
+          "docs": "Indicates whether a layer's `displayFilter` is honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -32023,7 +32023,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "The extent represents the visible portion of a map within the view as an instance of esri/geometry/Extent.\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's goTo() method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.",
+          "docs": "The extent represents the visible portion of a map within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](#goTo) method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -32210,7 +32210,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "The highlights property is a collection of HighlightGroup objects that\nallow you to visually emphasize specific features on the map.",
+          "docs": "The highlights property is a collection of [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html) objects that\nallow you to visually emphasize specific features on the map. See [MapView.highlights](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#highlights) for more information.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -32226,7 +32226,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "Indication whether the view is being interacted with (for example when panning or by an interactive tool).",
+          "docs": "Indicates whether the view is being interacted with (for example, when panning or via an interactive tool).",
           "docsTags": [
             {
               "name": "readonly",
@@ -32306,7 +32306,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "A collection containing a hierarchical list of all the created\nesri/views/layers/LayerView LayerViews of the\nesri/Map#layers operational layers in the map.",
+          "docs": "A collection containing a hierarchical list of all the created\n[LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)s of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map.",
           "docsTags": [
             {
               "name": "readonly",
@@ -32412,7 +32412,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "An instance of a esri/Map object to display in the view.",
+          "docs": "An instance of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) object to display in the view.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -32548,7 +32548,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "When `true`, this property indicates whether the view successfully satisfied all dependencies,\nsignaling that the following conditions are met.",
+          "docs": "When `true`, this property indicates whether the [view](#view) has successfully satisfied all dependencies, signaling that the following conditions are met:\n\n* The view has a [map](#map). If [map](#map)\nis a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html), then the map\nmust be [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loaded).\n* The view has a [spatialReference](#spatialReference), a [center](#center), and a [scale](#scale).\nThese also can be inferred by setting an [extent](#extent).\n\nWhen a view becomes ready it will resolve itself and invoke\nthe callback defined in [viewOnReady()](#viewOnReady) where code can execute on a working view.",
           "docsTags": [
             {
               "name": "readonly",
@@ -32677,7 +32677,7 @@
           "mutable": true,
           "attr": "scale",
           "reflectToAttr": false,
-          "docs": "Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's goTo() method.",
+          "docs": "Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.",
           "docsTags": [],
           "values": [
             {
@@ -32721,7 +32721,7 @@
           "mutable": true,
           "attr": "spatial-reference-locked",
           "reflectToAttr": false,
-          "docs": "Indicates if the map's spatialReference can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.",
+          "docs": "Indicates if the map's [spatialReference](#spatialReference) can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.",
           "docsTags": [
             {
               "name": "since",
@@ -32806,7 +32806,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "This property specifies the base colors used by some widgets\nand components to render graphics and labels.",
+          "docs": "This property specifies the base colors used by some components to render graphics and labels.",
           "docsTags": [],
           "default": "null",
           "values": [],
@@ -32900,7 +32900,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance created and manged by the component. Accessible once the component is fully loaded.",
+          "docs": "The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance created and managed by the component. Accessible once the component is fully loaded.",
           "docsTags": [
             {
               "name": "readonly",
@@ -32927,7 +32927,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "Represents the current view as a Viewpoint or point of observation on the view.\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's goTo() method.",
+          "docs": "Represents the current view as a Viewpoint or point of observation on the view.\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](#goTo) method.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -32971,7 +32971,7 @@
           "mutable": true,
           "attr": "zoom",
           "reflectToAttr": false,
-          "docs": "Represents the level of detail (LOD) at the center of the view.\nA zoom level (or scale) is a number that defines how large or small the contents of a map appear in a map view.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the view has no LODs.\nWhen setting the zoom value, the MapView converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\nMapView can display maps with different projections at a full range of scales, and so use the scale property on this component rather than zoom level.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's goTo() method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.",
+          "docs": "Represents the level of detail (LOD) at the center of the map.\nA zoom level (or scale) is a number that defines how large or small the contents of a map appear in a Map component.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the map has no LODs.\nWhen setting the zoom value, the component converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.",
           "docsTags": [],
           "values": [
             {
@@ -37551,37 +37551,42 @@
         {
           "name": "handleViewClick",
           "returns": {
-            "type": "Promise<void>",
+            "type": "Promise<FeaturesViewModelOpenOptions>",
             "docs": ""
           },
           "complexType": {
-            "signature": "(event: Event): Promise<void>",
+            "signature": "(event: __esri.ViewClickEvent): Promise<__esri.FeaturesViewModelOpenOptions>",
             "parameters": [
               {
                 "name": "event",
-                "type": "Event",
+                "type": "ViewClickEvent",
                 "docs": ""
               }
             ],
-            "return": "Promise<void>",
+            "return": "Promise<FeaturesViewModelOpenOptions>",
             "references": {
               "Promise": {
                 "location": "import",
                 "path": "typescript/lib/lib.es5.d.ts",
                 "id": "notImplemented"
               },
-              "Event": {
+              "FeaturesViewModelOpenOptions": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              },
+              "ViewClickEvent": {
                 "location": "import",
-                "path": "typescript/lib/lib.dom.d.ts",
+                "path": "@arcgis/core/interfaces.d.ts",
                 "id": "notImplemented"
               }
             }
           },
-          "signature": "handleViewClick(event: Event): Promise<void>",
+          "signature": "handleViewClick(event: __esri.ViewClickEvent): Promise<__esri.FeaturesViewModelOpenOptions>",
           "parameters": [
             {
               "name": "event",
-              "type": "Event",
+              "type": "ViewClickEvent",
               "docs": ""
             }
           ],
@@ -53132,6 +53137,38 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "traceLocations",
+          "type": "Array<TraceLocation>",
+          "complexType": {
+            "original": "Array<TraceLocation>",
+            "resolved": "Array<TraceLocation>",
+            "references": {
+              "Array": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              },
+              "TraceLocation": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "readonly",
+              "text": ""
+            }
+          ],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "view",
           "type": "MapView | undefined",
@@ -53235,6 +53272,311 @@
       "parts": [],
       "listeners": []
     },
+    {
+      "filePath": "src/components/utility-network-trace-analysis/components/utility-network-trace-location/utility-network-trace-location.tsx",
+      "tag": "arcgis-utility-network-trace-location",
+      "overview": "",
+      "readme": "",
+      "usage": {},
+      "docs": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select locations on the map to use as trace inputs.",
+      "docsTags": [
+        {
+          "name": "since",
+          "text": "4.34"
+        },
+        {
+          "name": "internal"
+        },
+        {
+          "name": "superclass",
+          "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+        }
+      ],
+      "encapsulation": "shadow",
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {},
+      "props": [
+        {
+          "name": "filterLayers",
+          "type": "Collection<Layer>",
+          "complexType": {
+            "original": "Collection<Layer>",
+            "resolved": "Collection<Layer>",
+            "references": {
+              "Collection": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              },
+              "Layer": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "flagLayer",
+          "type": "GraphicsLayer",
+          "complexType": {
+            "original": "GraphicsLayer",
+            "resolved": "GraphicsLayer",
+            "references": {
+              "GraphicsLayer": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "sketchViewModel",
+          "type": "SketchViewModel",
+          "complexType": {
+            "original": "SketchViewModel",
+            "resolved": "SketchViewModel",
+            "references": {
+              "SketchViewModel": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "traceLocations",
+          "type": "Collection<FlagProperty>",
+          "complexType": {
+            "original": "Collection<FlagProperty>",
+            "resolved": "Collection<FlagProperty>",
+            "references": {
+              "Collection": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              },
+              "FlagProperty": {
+                "location": "local",
+                "path": "dist/components/arcgis-utility-network-trace-location/customElement.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "traceLocationType",
+          "type": "\"barrier\" | \"starting-point\" | \"stopping-point\"",
+          "complexType": {
+            "original": "\"barrier\" | \"starting-point\" | \"stopping-point\"",
+            "resolved": "\"barrier\" | \"starting-point\" | \"stopping-point\"",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "trace-location-type",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "\"starting-point\"",
+          "values": [
+            {
+              "value": "barrier",
+              "type": "string"
+            },
+            {
+              "value": "starting-point",
+              "type": "string"
+            },
+            {
+              "value": "stopping-point",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "utilityNetwork",
+          "type": "UtilityNetwork | undefined",
+          "complexType": {
+            "original": "UtilityNetwork | undefined",
+            "resolved": "UtilityNetwork | undefined",
+            "references": {
+              "UtilityNetwork": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "required",
+              "text": "The utility network to perform the trace on."
+            }
+          ],
+          "values": [
+            {
+              "type": "UtilityNetwork"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "view",
+          "type": "MapView | undefined",
+          "complexType": {
+            "original": "MapView | undefined",
+            "resolved": "MapView | undefined",
+            "references": {
+              "MapView": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "required"
+            }
+          ],
+          "values": [
+            {
+              "type": "MapView"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": false,
+          "required": true
+        }
+      ],
+      "methods": [
+        {
+          "name": "componentOnReady",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): Promise<void>",
+            "parameters": [],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "componentOnReady(): Promise<void>",
+          "parameters": [],
+          "docs": "Create a promise that resolves once component is fully loaded.",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": "```js\nconst arcgisUtilityNetworkTraceLocation = document.querySelector(\"arcgis-utility-network-trace-location\");\ndocument.body.append(arcgisUtilityNetworkTraceLocation);\nawait arcgisUtilityNetworkTraceLocation.componentOnReady();\nconsole.log(\"arcgis-utility-network-trace-location is ready to go!\");\n```"
+            },
+            {
+              "name": "inheritedFrom",
+              "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+            }
+          ]
+        }
+      ],
+      "events": [
+        {
+          "event": "arcgisTraceLocationChange",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        },
+        {
+          "event": "arcgisTraceLocationSelectEnd",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        },
+        {
+          "event": "arcgisTraceLocationSelectStart",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "listeners": []
+    },
     {
       "filePath": "src/components/utility-network-trace-analysis/components/utility-network-trace-results/utility-network-trace-results.tsx",
       "tag": "arcgis-utility-network-trace-results",