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

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-03-20T05:02:28",
+  "timestamp": "2025-03-21T05:02:22",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.51",
+    "version": "4.33.0-next.52",
     "typescriptVersion": "5.6.3"
   },
   "schemaVersion": "1.0.0",
@@ -48525,6 +48525,21 @@
           "pascalCaseName": "ArcgisUtilityNetworkTrace",
           "importPath": "components/arcgis-utility-network-trace",
           "members": [
+            {
+              "kind": "field",
+              "name": "autoDestroyDisabled",
+              "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\\` method when you are done to prevent\nmemory leaks.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "auto-destroy-disabled"
+            },
             {
               "kind": "method",
               "name": "checkCanTrace",
@@ -48599,6 +48614,7 @@
             {
               "kind": "field",
               "name": "defaultGraphicColor",
+              "description": "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)",
               "type": {
                 "text": "GraphicColor",
                 "references": [
@@ -48611,11 +48627,34 @@
                     "end": 12
                   }
                 ]
-              }
+              },
+              "default": "{\ncolor: [255, 255, 0, 0.6],\nhaloOpacity: 0.9,\nfillOpacity: 0.2,\nhex: \"#FFFF00\"\n}"
+            },
+            {
+              "kind": "method",
+              "name": "destroy",
+              "description": "Permanently destroy the component.",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "signature": "(): Promise<void>",
+              "async": true
             },
             {
               "kind": "field",
               "name": "disabled",
+              "description": "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)",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -48624,13 +48663,14 @@
                   }
                 ]
               },
-              "default": "false",
+              "default": "true",
               "attribute": "disabled",
               "reflects": true
             },
             {
               "kind": "field",
               "name": "enableResultArea",
+              "description": "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)",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -48645,6 +48685,7 @@
             {
               "kind": "field",
               "name": "flags",
+              "description": "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)",
               "type": {
                 "text": "Array<FlagProperty>",
                 "references": [
@@ -48664,11 +48705,13 @@
                     "end": 18
                   }
                 ]
-              }
+              },
+              "default": "[]"
             },
             {
               "kind": "field",
               "name": "gdbVersion",
+              "description": "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)",
               "type": {
                 "text": "string",
                 "values": [
@@ -48678,8 +48721,24 @@
                 ]
               },
               "default": "\"sde.DEFAULT\"",
+              "deprecated": "since version 4.31, gdbVersion will be removed and the gdbVersion of the [:esri/networks/UtilityNetwork](module) will be consumed directly.",
               "attribute": "gdb-version"
             },
+            {
+              "kind": "field",
+              "name": "icon",
+              "description": "Icon displayed in the component's button.\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"utility-network-trace\"",
+              "attribute": "icon"
+            },
             {
               "kind": "field",
               "name": "inputSettings",
@@ -48704,6 +48763,20 @@
                 ]
               }
             },
+            {
+              "kind": "field",
+              "name": "label",
+              "description": "The component's default label.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "attribute": "label"
+            },
             {
               "kind": "field",
               "name": "position",
@@ -48748,7 +48821,7 @@
                   }
                 ]
               },
-              "default": "\"bottom-left\"",
+              "default": "\"top-right\"",
               "attribute": "position"
             },
             {
@@ -48867,11 +48940,35 @@
               },
               "default": "false",
               "attribute": "show-selection-attributes-disabled"
+            },
+            {
+              "kind": "field",
+              "name": "state",
+              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#state)",
+              "type": {
+                "text": "\"loading\" | \"ready\"",
+                "values": [
+                  {
+                    "value": "loading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "ready",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"ready\"",
+              "readonly": true,
+              "attribute": "state",
+              "reflects": true,
+              "docsOnlyReadonly": true
             }
           ],
           "attributes": [
             {
-              "name": "disabled",
+              "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\\` method when you are done to prevent\nmemory leaks.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -48881,10 +48978,25 @@
                 ]
               },
               "default": "false",
+              "fieldName": "autoDestroyDisabled"
+            },
+            {
+              "name": "disabled",
+              "description": "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)",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "true",
               "fieldName": "disabled"
             },
             {
               "name": "enable-result-area",
+              "description": "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)",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -48898,6 +49010,7 @@
             },
             {
               "name": "gdb-version",
+              "description": "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)",
               "type": {
                 "text": "string",
                 "values": [
@@ -48907,7 +49020,35 @@
                 ]
               },
               "default": "\"sde.DEFAULT\"",
-              "fieldName": "gdbVersion"
+              "fieldName": "gdbVersion",
+              "deprecated": "since version 4.31, gdbVersion will be removed and the gdbVersion of the [:esri/networks/UtilityNetwork](module) will be consumed directly."
+            },
+            {
+              "name": "icon",
+              "description": "Icon displayed in the component's button.\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"utility-network-trace\"",
+              "fieldName": "icon"
+            },
+            {
+              "name": "label",
+              "description": "The component's default label.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "label"
             },
             {
               "name": "position",
@@ -48952,7 +49093,7 @@
                   }
                 ]
               },
-              "default": "\"bottom-left\"",
+              "default": "\"top-right\"",
               "fieldName": "position"
             },
             {
@@ -49005,6 +49146,25 @@
               },
               "default": "false",
               "fieldName": "showSelectionAttributesDisabled"
+            },
+            {
+              "name": "state",
+              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#state)",
+              "type": {
+                "text": "\"loading\" | \"ready\"",
+                "values": [
+                  {
+                    "value": "loading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "ready",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"ready\"",
+              "fieldName": "state"
             }
           ],
           "events": [
@@ -49068,6 +49228,13 @@
                 ]
               }
             },
+            {
+              "name": "arcgisPropertyChange",
+              "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
+              "type": {
+                "text": "{ name: \"state\"; }"
+              }
+            },
             {
               "name": "arcgisReady",
               "description": "Emitted when the component associated with a map view is is ready to be interacted with.",
@@ -49392,24 +49559,6 @@
                   }
                 ]
               }
-            },
-            {
-              "kind": "field",
-              "name": "view",
-              "description": "The view from which the compnent will operate.",
-              "type": {
-                "text": "MapView",
-                "references": [
-                  {
-                    "name": "MapView",
-                    "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
-                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html",
-                    "start": 0,
-                    "end": 7
-                  }
-                ]
-              }
             }
           ],
           "attributes": [

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-03-20T05:02:28",
+  "timestamp": "2025-03-21T05:02:22",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.51",
+    "version": "4.33.0-next.52",
     "typescriptVersion": "5.6.3"
   },
   "components": [
@@ -41710,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",
@@ -41726,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
@@ -41743,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"
@@ -41765,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": [
@@ -41797,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
@@ -41814,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"
@@ -41852,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\"",
@@ -41865,7 +41933,7 @@
           "reflectToAttr": false,
           "docs": "",
           "docsTags": [],
-          "default": "\"bottom-left\"",
+          "default": "\"top-right\"",
           "values": [
             {
               "value": "bottom-leading",
@@ -42062,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": [
@@ -42142,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": [
@@ -42225,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",
@@ -42545,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": [

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

@@ -7277,18 +7277,36 @@
     },
     {
       "name": "arcgis-utility-network-trace",
-      "description": "UtilityNetworkTrace component provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. Input flags (starting points and barriers) can be set by clicking the view.\n\n> The UtilityNetworkTrace Component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisAddFlag**\n- **arcgisAddFlagComplete**\n- **arcgisAddFlagError**\n- **arcgisAddResultArea**\n- **arcgisReady** - Emitted when the component associated with a map view is is ready to be interacted with.\n- **arcgisRemoveResultArea**\n\n### Methods\n- `checkCanTrace(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `confirmReset(): Promise<void>`",
+      "description": "UtilityNetworkTrace component provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. Input flags (starting points and barriers) can be set by clicking the view.\n\n> The UtilityNetworkTrace Component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisAddFlag**\n- **arcgisAddFlagComplete**\n- **arcgisAddFlagError**\n- **arcgisAddResultArea**\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 view is is ready to be interacted with.\n- **arcgisRemoveResultArea**\n\n### Methods\n- `checkCanTrace(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `confirmReset(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.",
       "attributes": [
+        {
+          "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\\` method when you are done to prevent\nmemory leaks.",
+          "values": []
+        },
         {
           "name": "disabled",
+          "description": "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)",
           "values": []
         },
         {
           "name": "enable-result-area",
+          "description": "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)",
           "values": []
         },
         {
           "name": "gdb-version",
+          "description": "**Deprecated**: since version 4.31, gdbVersion will be removed and the gdbVersion of the [:esri/networks/UtilityNetwork](module) will be consumed directly.. 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)",
+          "values": []
+        },
+        {
+          "name": "icon",
+          "description": "Icon displayed in the component's button.\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.",
+          "values": []
+        },
+        {
+          "name": "label",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -7338,6 +7356,18 @@
         {
           "name": "show-selection-attributes-disabled",
           "values": []
+        },
+        {
+          "name": "state",
+          "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#state)",
+          "values": [
+            {
+              "name": "loading"
+            },
+            {
+              "name": "ready"
+            }
+          ]
         }
       ],
       "references": [