@arcgis/map-components 4.33.0-next.50 → 4.33.0-next.52

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-03-19T05:03:18",
+  "timestamp": "2025-03-21T05:02:22",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.50",
+    "version": "4.33.0-next.52",
     "typescriptVersion": "5.6.3"
   },
   "components": [
@@ -23191,98 +23191,98 @@
           "docsTags": []
         },
         {
-          "name": "whenLayerView",
+          "name": "viewOnReady",
           "returns": {
-            "type": "Promise<LayerView>",
+            "type": "Promise<void>",
             "docs": ""
           },
           "complexType": {
-            "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>",
+            "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
             "parameters": [
               {
-                "name": "layer",
-                "type": "Layer",
+                "name": "callback",
+                "type": "((() => void)) | undefined",
+                "docs": ""
+              },
+              {
+                "name": "errback",
+                "type": "(((error: Error) => void)) | undefined",
                 "docs": ""
               }
             ],
-            "return": "Promise<LayerView>",
+            "return": "Promise<void>",
             "references": {
               "Promise": {
                 "location": "import",
                 "path": "typescript/lib/lib.es5.d.ts",
                 "id": "notImplemented"
               },
-              "LayerView": {
-                "location": "import",
-                "path": "@arcgis/core/interfaces.d.ts",
-                "id": "notImplemented"
-              },
-              "Layer": {
+              "Error": {
                 "location": "import",
-                "path": "@arcgis/core/interfaces.d.ts",
+                "path": "typescript/lib/lib.es5.d.ts",
                 "id": "notImplemented"
               }
             }
           },
-          "signature": "whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>",
+          "signature": "viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
           "parameters": [
             {
-              "name": "layer",
-              "type": "Layer",
+              "name": "callback",
+              "type": "((() => void)) | undefined",
+              "docs": ""
+            },
+            {
+              "name": "errback",
+              "type": "(((error: Error) => void)) | undefined",
               "docs": ""
             }
           ],
-          "docs": "Gets the LayerView created on the view for the given layer.",
+          "docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
           "docsTags": []
         },
         {
-          "name": "whenReady",
+          "name": "whenLayerView",
           "returns": {
-            "type": "Promise<void>",
+            "type": "Promise<LayerView>",
             "docs": ""
           },
           "complexType": {
-            "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+            "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>",
             "parameters": [
               {
-                "name": "callback",
-                "type": "((() => void)) | undefined",
-                "docs": ""
-              },
-              {
-                "name": "errback",
-                "type": "(((error: Error) => void)) | undefined",
+                "name": "layer",
+                "type": "Layer",
                 "docs": ""
               }
             ],
-            "return": "Promise<void>",
+            "return": "Promise<LayerView>",
             "references": {
               "Promise": {
                 "location": "import",
                 "path": "typescript/lib/lib.es5.d.ts",
                 "id": "notImplemented"
               },
-              "Error": {
+              "LayerView": {
                 "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              },
+              "Layer": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
                 "id": "notImplemented"
               }
             }
           },
-          "signature": "whenReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+          "signature": "whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>",
           "parameters": [
             {
-              "name": "callback",
-              "type": "((() => void)) | undefined",
-              "docs": ""
-            },
-            {
-              "name": "errback",
-              "type": "(((error: Error) => void)) | undefined",
+              "name": "layer",
+              "type": "Layer",
               "docs": ""
             }
           ],
-          "docs": "`whenReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
+          "docs": "Gets the LayerView created on the view for the given layer.",
           "docsTags": []
         }
       ],
@@ -26366,98 +26366,98 @@
           "docsTags": []
         },
         {
-          "name": "whenLayerView",
+          "name": "viewOnReady",
           "returns": {
-            "type": "Promise<LayerView>",
+            "type": "Promise<void>",
             "docs": ""
           },
           "complexType": {
-            "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>",
+            "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
             "parameters": [
               {
-                "name": "layer",
-                "type": "Layer",
+                "name": "callback",
+                "type": "((() => void)) | undefined",
+                "docs": ""
+              },
+              {
+                "name": "errback",
+                "type": "(((error: Error) => void)) | undefined",
                 "docs": ""
               }
             ],
-            "return": "Promise<LayerView>",
+            "return": "Promise<void>",
             "references": {
               "Promise": {
                 "location": "import",
                 "path": "typescript/lib/lib.es5.d.ts",
                 "id": "notImplemented"
               },
-              "LayerView": {
-                "location": "import",
-                "path": "@arcgis/core/interfaces.d.ts",
-                "id": "notImplemented"
-              },
-              "Layer": {
+              "Error": {
                 "location": "import",
-                "path": "@arcgis/core/interfaces.d.ts",
+                "path": "typescript/lib/lib.es5.d.ts",
                 "id": "notImplemented"
               }
             }
           },
-          "signature": "whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>",
+          "signature": "viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
           "parameters": [
             {
-              "name": "layer",
-              "type": "Layer",
+              "name": "callback",
+              "type": "((() => void)) | undefined",
+              "docs": ""
+            },
+            {
+              "name": "errback",
+              "type": "(((error: Error) => void)) | undefined",
               "docs": ""
             }
           ],
-          "docs": "Gets the LayerView created on the view for the given layer.",
+          "docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
           "docsTags": []
         },
         {
-          "name": "whenReady",
+          "name": "whenLayerView",
           "returns": {
-            "type": "Promise<void>",
+            "type": "Promise<LayerView>",
             "docs": ""
           },
           "complexType": {
-            "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+            "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>",
             "parameters": [
               {
-                "name": "callback",
-                "type": "((() => void)) | undefined",
-                "docs": ""
-              },
-              {
-                "name": "errback",
-                "type": "(((error: Error) => void)) | undefined",
+                "name": "layer",
+                "type": "Layer",
                 "docs": ""
               }
             ],
-            "return": "Promise<void>",
+            "return": "Promise<LayerView>",
             "references": {
               "Promise": {
                 "location": "import",
                 "path": "typescript/lib/lib.es5.d.ts",
                 "id": "notImplemented"
               },
-              "Error": {
+              "LayerView": {
                 "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              },
+              "Layer": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
                 "id": "notImplemented"
               }
             }
           },
-          "signature": "whenReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+          "signature": "whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>",
           "parameters": [
             {
-              "name": "callback",
-              "type": "((() => void)) | undefined",
-              "docs": ""
-            },
-            {
-              "name": "errback",
-              "type": "(((error: Error) => void)) | undefined",
+              "name": "layer",
+              "type": "Layer",
               "docs": ""
             }
           ],
-          "docs": "`whenReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
+          "docs": "Gets the LayerView created on the view for the given layer.",
           "docsTags": []
         }
       ],
@@ -31992,6 +31992,56 @@
           "docs": "Call this method to clear any fatal errors resulting from a lost WebGL context.",
           "docsTags": []
         },
+        {
+          "name": "viewOnReady",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+            "parameters": [
+              {
+                "name": "callback",
+                "type": "((() => void)) | undefined",
+                "docs": ""
+              },
+              {
+                "name": "errback",
+                "type": "(((error: Error) => void)) | undefined",
+                "docs": ""
+              }
+            ],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              },
+              "Error": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+          "parameters": [
+            {
+              "name": "callback",
+              "type": "((() => void)) | undefined",
+              "docs": ""
+            },
+            {
+              "name": "errback",
+              "type": "(((error: Error) => void)) | undefined",
+              "docs": ""
+            }
+          ],
+          "docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
+          "docsTags": []
+        },
         {
           "name": "whenAnalysisView",
           "returns": {
@@ -32131,56 +32181,6 @@
           ],
           "docs": "Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
           "docsTags": []
-        },
-        {
-          "name": "whenReady",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
-            "parameters": [
-              {
-                "name": "callback",
-                "type": "((() => void)) | undefined",
-                "docs": ""
-              },
-              {
-                "name": "errback",
-                "type": "(((error: Error) => void)) | undefined",
-                "docs": ""
-              }
-            ],
-            "return": "Promise<void>",
-            "references": {
-              "Promise": {
-                "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
-                "id": "notImplemented"
-              },
-              "Error": {
-                "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "signature": "whenReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
-          "parameters": [
-            {
-              "name": "callback",
-              "type": "((() => void)) | undefined",
-              "docs": ""
-            },
-            {
-              "name": "errback",
-              "type": "(((error: Error) => void)) | undefined",
-              "docs": ""
-            }
-          ],
-          "docs": "`whenReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
-          "docsTags": []
         }
       ],
       "events": [
@@ -40355,6 +40355,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "rotationDisabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "rotation-disabled",
+          "reflectToAttr": false,
+          "docs": "Indicates whether the component will automatically rotate to the device heading based on\nthe Geolocation APIs [`GeolocationCoordinates.heading`](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationCoordinates/heading)\nproperty.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#rotationEnabled)",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "scale",
           "type": "number",
@@ -41688,6 +41710,28 @@
       "dependencies": [],
       "dependencyGraph": {},
       "props": [
+        {
+          "name": "autoDestroyDisabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "auto-destroy-disabled",
+          "reflectToAttr": false,
+          "docs": "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\\` method when you are done to prevent\nmemory leaks.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "defaultGraphicColor",
           "type": "GraphicColor",
@@ -41704,8 +41748,9 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "",
+          "docs": "The default color to assign the aggregated geometry of a trace result.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#defaultGraphicColor)",
           "docsTags": [],
+          "default": "{\ncolor: [255, 255, 0, 0.6],\nhaloOpacity: 0.9,\nfillOpacity: 0.2,\nhex: \"#FFFF00\"\n}",
           "values": [],
           "optional": true,
           "required": false
@@ -41721,9 +41766,9 @@
           "mutable": true,
           "attr": "disabled",
           "reflectToAttr": true,
-          "docs": "",
+          "docs": "When true, the widget is visually withdrawn and cannot be interacted with.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#disabled)",
           "docsTags": [],
-          "default": "false",
+          "default": "true",
           "values": [
             {
               "type": "boolean"
@@ -41743,7 +41788,7 @@
           "mutable": true,
           "attr": "enable-result-area",
           "reflectToAttr": false,
-          "docs": "",
+          "docs": "When `true`, provides the ability to show the convex hull or buffer.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#enableResultArea)",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -41775,8 +41820,9 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "",
+          "docs": "An array of map points to load into the widget to lookup flags.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#flags)",
           "docsTags": [],
+          "default": "[]",
           "values": [],
           "optional": true,
           "required": false
@@ -41792,9 +41838,32 @@
           "mutable": true,
           "attr": "gdb-version",
           "reflectToAttr": false,
-          "docs": "",
+          "docs": "The Geodatabase version to pass into the trace.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace.html#gdbVersion)",
           "docsTags": [],
           "default": "\"sde.DEFAULT\"",
+          "deprecation": "since version 4.31, gdbVersion will be removed and the gdbVersion of the [:esri/networks/UtilityNetwork](module) will be consumed directly.",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "icon",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "icon",
+          "reflectToAttr": false,
+          "docs": "Icon displayed in the component's button.\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.",
+          "docsTags": [],
+          "default": "\"utility-network-trace\"",
           "values": [
             {
               "type": "string"
@@ -41830,6 +41899,27 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "label",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "label",
+          "reflectToAttr": false,
+          "docs": "The component's default label.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "position",
           "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
@@ -41843,7 +41933,7 @@
           "reflectToAttr": false,
           "docs": "",
           "docsTags": [],
-          "default": "\"bottom-left\"",
+          "default": "\"top-right\"",
           "values": [
             {
               "value": "bottom-leading",
@@ -42040,6 +42130,38 @@
           ],
           "optional": true,
           "required": false
+        },
+        {
+          "name": "state",
+          "type": "\"loading\" | \"ready\"",
+          "complexType": {
+            "original": "\"loading\" | \"ready\"",
+            "resolved": "\"loading\" | \"ready\"",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "state",
+          "reflectToAttr": true,
+          "docs": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#state)",
+          "docsTags": [
+            {
+              "name": "readonly",
+              "text": ""
+            }
+          ],
+          "default": "\"ready\"",
+          "values": [
+            {
+              "value": "loading",
+              "type": "string"
+            },
+            {
+              "value": "ready",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
         }
       ],
       "methods": [
@@ -42120,6 +42242,29 @@
           "parameters": [],
           "docs": "",
           "docsTags": []
+        },
+        {
+          "name": "destroy",
+          "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": "destroy(): Promise<void>",
+          "parameters": [],
+          "docs": "Permanently destroy the component.",
+          "docsTags": []
         }
       ],
       "events": [
@@ -42203,6 +42348,20 @@
           "docs": "",
           "docsTags": []
         },
+        {
+          "event": "arcgisPropertyChange",
+          "detail": "{ name: \"state\"; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{ name: \"state\"; }",
+            "resolved": "{ name: \"state\"; }",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
+          "docsTags": []
+        },
         {
           "event": "arcgisReady",
           "detail": "undefined",
@@ -42523,28 +42682,6 @@
           "values": [],
           "optional": true,
           "required": false
-        },
-        {
-          "name": "view",
-          "type": "MapView",
-          "complexType": {
-            "original": "MapView",
-            "resolved": "MapView",
-            "references": {
-              "MapView": {
-                "location": "import",
-                "path": "@arcgis/core/interfaces.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "The view from which the compnent will operate.",
-          "docsTags": [],
-          "values": [],
-          "optional": true,
-          "required": false
         }
       ],
       "methods": [