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

package/dist/docs/api.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"
   },
   "schemaVersion": "1.0.0",
@@ -27185,6 +27185,68 @@
               },
               "readonly": true
             },
+            {
+              "kind": "method",
+              "name": "viewOnReady",
+              "description": "`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.",
+              "parameters": [
+                {
+                  "name": "callback",
+                  "optional": true,
+                  "type": {
+                    "text": "((() => void)) | undefined",
+                    "values": [
+                      {
+                        "type": "((() => void))"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                },
+                {
+                  "name": "errback",
+                  "optional": true,
+                  "type": {
+                    "text": "(((error: Error) => void)) | undefined",
+                    "references": [
+                      {
+                        "name": "Error",
+                        "package": "typescript",
+                        "module": "lib/lib.es5.d.ts",
+                        "start": 10,
+                        "end": 15
+                      }
+                    ],
+                    "values": [
+                      {
+                        "type": "(((error: Error) => void))"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+              "async": true
+            },
             {
               "kind": "field",
               "name": "viewpoint",
@@ -27250,68 +27312,6 @@
               "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>",
               "async": true
             },
-            {
-              "kind": "method",
-              "name": "whenReady",
-              "description": "`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.",
-              "parameters": [
-                {
-                  "name": "callback",
-                  "optional": true,
-                  "type": {
-                    "text": "((() => void)) | undefined",
-                    "values": [
-                      {
-                        "type": "((() => void))"
-                      },
-                      {
-                        "type": "undefined"
-                      }
-                    ]
-                  }
-                },
-                {
-                  "name": "errback",
-                  "optional": true,
-                  "type": {
-                    "text": "(((error: Error) => void)) | undefined",
-                    "references": [
-                      {
-                        "name": "Error",
-                        "package": "typescript",
-                        "module": "lib/lib.es5.d.ts",
-                        "start": 10,
-                        "end": 15
-                      }
-                    ],
-                    "values": [
-                      {
-                        "type": "(((error: Error) => void))"
-                      },
-                      {
-                        "type": "undefined"
-                      }
-                    ]
-                  }
-                }
-              ],
-              "return": {
-                "type": {
-                  "text": "Promise<void>",
-                  "references": [
-                    {
-                      "name": "Promise",
-                      "package": "typescript",
-                      "module": "lib/lib.es5.d.ts",
-                      "start": 0,
-                      "end": 7
-                    }
-                  ]
-                }
-              },
-              "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
-              "async": true
-            },
             {
               "kind": "field",
               "name": "zoom",
@@ -30588,6 +30588,68 @@
               },
               "readonly": true
             },
+            {
+              "kind": "method",
+              "name": "viewOnReady",
+              "description": "`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.",
+              "parameters": [
+                {
+                  "name": "callback",
+                  "optional": true,
+                  "type": {
+                    "text": "((() => void)) | undefined",
+                    "values": [
+                      {
+                        "type": "((() => void))"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                },
+                {
+                  "name": "errback",
+                  "optional": true,
+                  "type": {
+                    "text": "(((error: Error) => void)) | undefined",
+                    "references": [
+                      {
+                        "name": "Error",
+                        "package": "typescript",
+                        "module": "lib/lib.es5.d.ts",
+                        "start": 10,
+                        "end": 15
+                      }
+                    ],
+                    "values": [
+                      {
+                        "type": "(((error: Error) => void))"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+              "async": true
+            },
             {
               "kind": "field",
               "name": "viewpoint",
@@ -30653,68 +30715,6 @@
               "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>",
               "async": true
             },
-            {
-              "kind": "method",
-              "name": "whenReady",
-              "description": "`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.",
-              "parameters": [
-                {
-                  "name": "callback",
-                  "optional": true,
-                  "type": {
-                    "text": "((() => void)) | undefined",
-                    "values": [
-                      {
-                        "type": "((() => void))"
-                      },
-                      {
-                        "type": "undefined"
-                      }
-                    ]
-                  }
-                },
-                {
-                  "name": "errback",
-                  "optional": true,
-                  "type": {
-                    "text": "(((error: Error) => void)) | undefined",
-                    "references": [
-                      {
-                        "name": "Error",
-                        "package": "typescript",
-                        "module": "lib/lib.es5.d.ts",
-                        "start": 10,
-                        "end": 15
-                      }
-                    ],
-                    "values": [
-                      {
-                        "type": "(((error: Error) => void))"
-                      },
-                      {
-                        "type": "undefined"
-                      }
-                    ]
-                  }
-                }
-              ],
-              "return": {
-                "type": {
-                  "text": "Promise<void>",
-                  "references": [
-                    {
-                      "name": "Promise",
-                      "package": "typescript",
-                      "module": "lib/lib.es5.d.ts",
-                      "start": 0,
-                      "end": 7
-                    }
-                  ]
-                }
-              },
-              "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
-              "async": true
-            },
             {
               "kind": "field",
               "name": "zoom",
@@ -37074,6 +37074,68 @@
               "default": "\"global\"",
               "attribute": "viewing-mode"
             },
+            {
+              "kind": "method",
+              "name": "viewOnReady",
+              "description": "`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.",
+              "parameters": [
+                {
+                  "name": "callback",
+                  "optional": true,
+                  "type": {
+                    "text": "((() => void)) | undefined",
+                    "values": [
+                      {
+                        "type": "((() => void))"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                },
+                {
+                  "name": "errback",
+                  "optional": true,
+                  "type": {
+                    "text": "(((error: Error) => void)) | undefined",
+                    "references": [
+                      {
+                        "name": "Error",
+                        "package": "typescript",
+                        "module": "lib/lib.es5.d.ts",
+                        "start": 10,
+                        "end": 15
+                      }
+                    ],
+                    "values": [
+                      {
+                        "type": "(((error: Error) => void))"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
+              "async": true
+            },
             {
               "kind": "field",
               "name": "viewpoint",
@@ -37286,68 +37348,6 @@
               "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>",
               "async": true
             },
-            {
-              "kind": "method",
-              "name": "whenReady",
-              "description": "`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.",
-              "parameters": [
-                {
-                  "name": "callback",
-                  "optional": true,
-                  "type": {
-                    "text": "((() => void)) | undefined",
-                    "values": [
-                      {
-                        "type": "((() => void))"
-                      },
-                      {
-                        "type": "undefined"
-                      }
-                    ]
-                  }
-                },
-                {
-                  "name": "errback",
-                  "optional": true,
-                  "type": {
-                    "text": "(((error: Error) => void)) | undefined",
-                    "references": [
-                      {
-                        "name": "Error",
-                        "package": "typescript",
-                        "module": "lib/lib.es5.d.ts",
-                        "start": 10,
-                        "end": 15
-                      }
-                    ],
-                    "values": [
-                      {
-                        "type": "(((error: Error) => void))"
-                      },
-                      {
-                        "type": "undefined"
-                      }
-                    ]
-                  }
-                }
-              ],
-              "return": {
-                "type": {
-                  "text": "Promise<void>",
-                  "references": [
-                    {
-                      "name": "Promise",
-                      "package": "typescript",
-                      "module": "lib/lib.es5.d.ts",
-                      "start": 0,
-                      "end": 7
-                    }
-                  ]
-                }
-              },
-              "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
-              "async": true
-            },
             {
               "kind": "field",
               "name": "zoom",
@@ -46850,6 +46850,21 @@
               },
               "attribute": "reference-element"
             },
+            {
+              "kind": "field",
+              "name": "rotationDisabled",
+              "description": "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)",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "true",
+              "attribute": "rotation-disabled"
+            },
             {
               "kind": "field",
               "name": "scale",
@@ -47101,6 +47116,20 @@
               },
               "fieldName": "referenceElement"
             },
+            {
+              "name": "rotation-disabled",
+              "description": "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)",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "true",
+              "fieldName": "rotationDisabled"
+            },
             {
               "name": "scale",
               "description": "Indicates the scale to set on the view when navigating to the position of the geolocated\nresult, after a location is returned from the [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#event-track) event.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#scale)",
@@ -48496,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",
@@ -48570,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": [
@@ -48582,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": [
@@ -48595,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": [
@@ -48616,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": [
@@ -48635,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": [
@@ -48649,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",
@@ -48675,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",
@@ -48719,7 +48821,7 @@
                   }
                 ]
               },
-              "default": "\"bottom-left\"",
+              "default": "\"top-right\"",
               "attribute": "position"
             },
             {
@@ -48838,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": [
@@ -48852,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": [
@@ -48869,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": [
@@ -48878,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",
@@ -48923,7 +49093,7 @@
                   }
                 ]
               },
-              "default": "\"bottom-left\"",
+              "default": "\"top-right\"",
               "fieldName": "position"
             },
             {
@@ -48976,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": [
@@ -49039,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.",
@@ -49363,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": [