@arcgis/map-components 5.0.0-next.30 → 5.0.0-next.32

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-10-22T15:49:25",
+  "timestamp": "2025-10-24T04:41:43",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "5.0.0-next.30",
+    "version": "5.0.0-next.32",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -9724,7 +9724,7 @@
             {
               "kind": "field",
               "name": "playSpeedMultiplier",
-              "description": "Controls the daytime and date animation speed.",
+              "description": "Controls the daytime animation speed.",
               "type": {
                 "text": "number",
                 "values": [
@@ -10195,7 +10195,7 @@
             },
             {
               "name": "play-speed-multiplier",
-              "description": "Controls the daytime and date animation speed.",
+              "description": "Controls the daytime animation speed.",
               "type": {
                 "text": "number",
                 "values": [
@@ -17464,34 +17464,44 @@
                   "name": "since",
                   "text": "4.34"
                 }
-              ],
-              "docsOnlyReadonly": true
+              ]
             },
             {
               "kind": "field",
               "name": "view",
               "description": "The view associated with the component. \n  > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Expand component will be associated with a map or scene component rather than using the `view` property.",
               "type": {
-                "text": "MapView | SceneView",
+                "text": "LinkChartView | MapView | SceneView",
                 "references": [
+                  {
+                    "name": "LinkChartView",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html",
+                    "start": 0,
+                    "end": 13
+                  },
                   {
                     "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
+                    "start": 16,
+                    "end": 23
                   },
                   {
                     "name": "SceneView",
                     "package": "@arcgis/core",
                     "module": "interfaces.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html",
-                    "start": 10,
-                    "end": 19
+                    "start": 26,
+                    "end": 35
                   }
                 ],
                 "values": [
+                  {
+                    "type": "LinkChartView"
+                  },
                   {
                     "type": "MapView"
                   },
@@ -29187,7 +29197,7 @@
               "name": "labelFormatFunction",
               "description": "A function used to format labels.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#labelFormatFunction)",
               "type": {
-                "text": "(value: number, type?: \"max\" | \"min\" | \"value\" | \"average\" | \"tick\" | undefined, index?: number | undefined) => string"
+                "text": "(value: number, type?: \"value\" | \"max\" | \"min\" | \"average\" | \"tick\" | undefined, index?: number | undefined) => string"
               }
             },
             {
@@ -34595,7 +34605,7 @@
               ],
               "return": {
                 "type": {
-                  "text": "Promise<ElevationProfileAnalysisView2D>",
+                  "text": "Promise<ElevationProfileAnalysisView2D | AreaMeasurementAnalysisView2D | DistanceMeasurementAnalysisView2D>",
                   "references": [
                     {
                       "name": "Promise",
@@ -34611,6 +34621,22 @@
                       "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-analysis-ElevationProfileAnalysisView2D.html",
                       "start": 8,
                       "end": 38
+                    },
+                    {
+                      "name": "AreaMeasurementAnalysisView2D",
+                      "package": "@arcgis/core",
+                      "module": "interfaces.d.ts",
+                      "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-analysis-AreaMeasurementAnalysisView2D.html",
+                      "start": 41,
+                      "end": 70
+                    },
+                    {
+                      "name": "DistanceMeasurementAnalysisView2D",
+                      "package": "@arcgis/core",
+                      "module": "interfaces.d.ts",
+                      "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-analysis-DistanceMeasurementAnalysisView2D.html",
+                      "start": 73,
+                      "end": 106
                     }
                   ]
                 }
@@ -38634,7 +38660,7 @@
               ],
               "return": {
                 "type": {
-                  "text": "Promise<ElevationProfileAnalysisView2D>",
+                  "text": "Promise<ElevationProfileAnalysisView2D | AreaMeasurementAnalysisView2D | DistanceMeasurementAnalysisView2D>",
                   "references": [
                     {
                       "name": "Promise",
@@ -38650,6 +38676,22 @@
                       "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-analysis-ElevationProfileAnalysisView2D.html",
                       "start": 8,
                       "end": 38
+                    },
+                    {
+                      "name": "AreaMeasurementAnalysisView2D",
+                      "package": "@arcgis/core",
+                      "module": "interfaces.d.ts",
+                      "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-analysis-AreaMeasurementAnalysisView2D.html",
+                      "start": 41,
+                      "end": 70
+                    },
+                    {
+                      "name": "DistanceMeasurementAnalysisView2D",
+                      "package": "@arcgis/core",
+                      "module": "interfaces.d.ts",
+                      "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-analysis-DistanceMeasurementAnalysisView2D.html",
+                      "start": 73,
+                      "end": 106
                     }
                   ]
                 }
@@ -47993,7 +48035,7 @@
               ],
               "return": {
                 "type": {
-                  "text": "Promise<AreaMeasurementAnalysisView3D | DimensionAnalysisView3D | DirectLineMeasurementAnalysisView3D | ElevationProfileAnalysisView3D | LineOfSightAnalysisView3D | SliceAnalysisView3D | ViewshedAnalysisView3D | VolumeMeasurementAnalysisView3D>",
+                  "text": "Promise<AreaMeasurementAnalysisView3D | DimensionAnalysisView3D | DirectLineMeasurementAnalysisView3D | ElevationProfileAnalysisView3D | LineOfSightAnalysisView3D | ShadowCastAnalysisView3D | SliceAnalysisView3D | ViewshedAnalysisView3D | VolumeMeasurementAnalysisView3D>",
                   "references": [
                     {
                       "name": "Promise",
@@ -48042,29 +48084,37 @@
                       "start": 137,
                       "end": 162
                     },
+                    {
+                      "name": "ShadowCastAnalysisView3D",
+                      "package": "@arcgis/core",
+                      "module": "interfaces.d.ts",
+                      "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ShadowCastAnalysisView3D.html",
+                      "start": 165,
+                      "end": 189
+                    },
                     {
                       "name": "SliceAnalysisView3D",
                       "package": "@arcgis/core",
                       "module": "interfaces.d.ts",
                       "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-SliceAnalysisView3D.html",
-                      "start": 165,
-                      "end": 184
+                      "start": 192,
+                      "end": 211
                     },
                     {
                       "name": "ViewshedAnalysisView3D",
                       "package": "@arcgis/core",
                       "module": "interfaces.d.ts",
                       "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ViewshedAnalysisView3D.html",
-                      "start": 187,
-                      "end": 209
+                      "start": 214,
+                      "end": 236
                     },
                     {
                       "name": "VolumeMeasurementAnalysisView3D",
                       "package": "@arcgis/core",
                       "module": "interfaces.d.ts",
                       "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurementAnalysisView3D.html",
-                      "start": 212,
-                      "end": 243
+                      "start": 239,
+                      "end": 270
                     }
                   ]
                 }
@@ -50673,15 +50723,15 @@
               "name": "discreteOptions",
               "description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"discrete\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DiscreteOptions.html)",
               "type": {
-                "text": "DiscreteOptions",
+                "text": "ShadowCastDiscreteOptions",
                 "references": [
                   {
-                    "name": "DiscreteOptions",
+                    "name": "ShadowCastDiscreteOptions",
                     "package": "@arcgis/core",
                     "module": "interfaces.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DiscreteOptions.html",
                     "start": 0,
-                    "end": 15
+                    "end": 25
                   }
                 ]
               }
@@ -50691,15 +50741,15 @@
               "name": "durationOptions",
               "description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"duration\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DurationOptions.html)",
               "type": {
-                "text": "DurationOptions",
+                "text": "ShadowCastDurationOptions",
                 "references": [
                   {
-                    "name": "DurationOptions",
+                    "name": "ShadowCastDurationOptions",
                     "package": "@arcgis/core",
                     "module": "interfaces.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DurationOptions.html",
                     "start": 0,
-                    "end": 15
+                    "end": 25
                   }
                 ]
               }
@@ -51132,15 +51182,15 @@
               "name": "thresholdOptions",
               "description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"threshold\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ThresholdOptions.html)",
               "type": {
-                "text": "ThresholdOptions",
+                "text": "ShadowCastThresholdOptions",
                 "references": [
                   {
-                    "name": "ThresholdOptions",
+                    "name": "ShadowCastThresholdOptions",
                     "package": "@arcgis/core",
                     "module": "interfaces.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ThresholdOptions.html",
                     "start": 0,
-                    "end": 16
+                    "end": 26
                   }
                 ]
               }
@@ -51718,7 +51768,7 @@
                   }
                 ]
               },
-              "default": "[\"point\", \"polyline\", \"freehandPolyline\", \"polygon\", \"freehandPolygon\", \"rectangle\", \"circle\",]"
+              "default": "[\"point\", \"polyline\", \"freehandPolyline\", \"polygon\", \"freehandPolygon\", \"rectangle\", \"circle\"]"
             },
             {
               "kind": "method",
@@ -51798,12 +51848,24 @@
                 {
                   "name": "tool",
                   "type": {
-                    "text": "\"circle\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\"",
+                    "text": "\"circle\" | \"freehandPolygon\" | \"freehandPolyline\" | \"multipoint\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\"",
                     "values": [
                       {
                         "value": "circle",
                         "type": "string"
                       },
+                      {
+                        "value": "freehandPolygon",
+                        "type": "string"
+                      },
+                      {
+                        "value": "freehandPolyline",
+                        "type": "string"
+                      },
+                      {
+                        "value": "multipoint",
+                        "type": "string"
+                      },
                       {
                         "value": "point",
                         "type": "string"
@@ -51862,7 +51924,7 @@
                   ]
                 }
               },
-              "signature": "(tool: \"circle\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\", createOptions?: __esri.SketchViewModelCreateCreateOptions): Promise<void>",
+              "signature": "(tool: \"circle\" | \"freehandPolygon\" | \"freehandPolyline\" | \"multipoint\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\", createOptions?: __esri.SketchViewModelCreateCreateOptions): Promise<void>",
               "async": true
             },
             {
@@ -52033,6 +52095,21 @@
               "default": "false",
               "attribute": "hide-create-tools-circle"
             },
+            {
+              "kind": "field",
+              "name": "hideCreateToolsMultipoint",
+              "description": "Indicates whether to display the multipoint tool. Regardless of setting, multipoint is not available when working with a scene view.\n\nThe multipoint tool is excluded from `availableCreateTools` by default. Even if this property is false,\nmultipoint will not be available until it is added to `availableCreateTools`.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "true",
+              "attribute": "hide-create-tools-multipoint"
+            },
             {
               "kind": "field",
               "name": "hideCreateToolsPoint",
@@ -53134,6 +53211,20 @@
               "default": "false",
               "fieldName": "hideCreateToolsCircle"
             },
+            {
+              "name": "hide-create-tools-multipoint",
+              "description": "Indicates whether to display the multipoint tool. Regardless of setting, multipoint is not available when working with a scene view.\n\nThe multipoint tool is excluded from `availableCreateTools` by default. Even if this property is false,\nmultipoint will not be available until it is added to `availableCreateTools`.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "true",
+              "fieldName": "hideCreateToolsMultipoint"
+            },
             {
               "name": "hide-create-tools-point",
               "type": {
@@ -54410,6 +54501,14 @@
             {
               "name": "since",
               "text": "4.31"
+            },
+            {
+              "name": "see",
+              "text": "[Sample - Swipe component]https://developers.arcgis.com/javascript/latest/sample-code/swipe/)"
+            },
+            {
+              "name": "see",
+              "text": "[Sample - Swipe component with scroll](https://developers.arcgis.com/javascript/latest/sample-code/swipe-scroll/)"
             }
           ],
           "superclass": {
@@ -61427,20 +61526,7 @@
             },
             {
               "kind": "field",
-              "name": "selectedSubnetworkName",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "attribute": "selected-subnetwork-name"
-            },
-            {
-              "kind": "field",
-              "name": "selectedTraceConfiguration",
+              "name": "selectedNamedTraceConfiguration",
               "type": {
                 "text": "NamedTraceConfiguration",
                 "references": [
@@ -61497,6 +61583,25 @@
               },
               "readonly": true
             },
+            {
+              "kind": "field",
+              "name": "unTraceConfiguration",
+              "description": "A clone of the utility network trace configuration associated with\nthe selected named trace configuration. Updates on this object are\nused to reflect the user's changes to the named trace configuration.",
+              "type": {
+                "text": "UNTraceConfiguration",
+                "references": [
+                  {
+                    "name": "UNTraceConfiguration",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-support-UNTraceConfiguration.html",
+                    "start": 0,
+                    "end": 20
+                  }
+                ]
+              },
+              "readonly": true
+            },
             {
               "kind": "field",
               "name": "view",
@@ -61540,18 +61645,6 @@
                 ]
               },
               "fieldName": "referenceElement"
-            },
-            {
-              "name": "selected-subnetwork-name",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "fieldName": "selectedSubnetworkName"
             }
           ],
           "events": [