@arcgis/map-components 4.33.0-next.65 → 4.33.0-next.67

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-04-01T05:03:24",
+  "timestamp": "2025-04-03T05:15:34",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.65",
+    "version": "4.33.0-next.67",
     "typescriptVersion": "5.6.3"
   },
   "schemaVersion": "1.0.0",
@@ -2019,17 +2019,29 @@
               "name": "activeBasemap",
               "description": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).",
               "type": {
-                "text": "Basemap",
+                "text": "BasemapProperties | string",
                 "references": [
                   {
-                    "name": "Basemap",
+                    "name": "BasemapProperties",
                     "package": "@arcgis/core",
                     "module": "interfaces.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html",
                     "start": 0,
-                    "end": 7
+                    "end": 17
+                  }
+                ],
+                "values": [
+                  {
+                    "type": "BasemapProperties"
+                  },
+                  {
+                    "type": "string"
                   }
                 ]
+              },
+              "attribute": "active-basemap",
+              "getterType": {
+                "text": "typeof this.viewModel.activeBasemap"
               }
             },
             {
@@ -2340,6 +2352,19 @@
             }
           ],
           "attributes": [
+            {
+              "name": "active-basemap",
+              "description": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "activeBasemap"
+            },
             {
               "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.",
@@ -3919,17 +3944,29 @@
               "name": "nextBasemap",
               "description": "The next basemap for toggling.",
               "type": {
-                "text": "Basemap",
+                "text": "BasemapProperties | string",
                 "references": [
                   {
-                    "name": "Basemap",
+                    "name": "BasemapProperties",
                     "package": "@arcgis/core",
                     "module": "interfaces.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html",
                     "start": 0,
-                    "end": 7
+                    "end": 17
+                  }
+                ],
+                "values": [
+                  {
+                    "type": "BasemapProperties"
+                  },
+                  {
+                    "type": "string"
                   }
                 ]
+              },
+              "attribute": "next-basemap",
+              "getterType": {
+                "text": "typeof this.viewModel.nextBasemap"
               }
             },
             {
@@ -4135,6 +4172,19 @@
               },
               "fieldName": "label"
             },
+            {
+              "name": "next-basemap",
+              "description": "The next basemap for toggling.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "nextBasemap"
+            },
             {
               "name": "position",
               "type": {
@@ -14643,6 +14693,7 @@
             {
               "kind": "field",
               "name": "hideContentAttachments",
+              "description": "Indicates whether to hide all [AttachmentsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -14657,6 +14708,7 @@
             {
               "kind": "field",
               "name": "hideContentExpression",
+              "description": "Indicates whether to hide all [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -14671,6 +14723,7 @@
             {
               "kind": "field",
               "name": "hideContentFields",
+              "description": "Indicates whether to hide all [FieldsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -14685,6 +14738,7 @@
             {
               "kind": "field",
               "name": "hideContentMedia",
+              "description": "Indicates whether to hide all [MediaContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -14699,6 +14753,7 @@
             {
               "kind": "field",
               "name": "hideContentText",
+              "description": "Indicates whether to hide all [TextContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -14713,6 +14768,7 @@
             {
               "kind": "field",
               "name": "hideLastEditedInfo",
+              "description": "Indicates whether to hide the [lastEditInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#lastEditInfo).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -14736,12 +14792,13 @@
                 ]
               },
               "default": "false",
-              "deprecated": "since version 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead.",
+              "deprecated": "Deprecated since version 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead.",
               "attribute": "hide-last-edit-info"
             },
             {
               "kind": "field",
               "name": "hideTitle",
+              "description": "Indicates whether to hide the title associated with the feature.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -14823,6 +14880,7 @@
             {
               "kind": "method",
               "name": "nextMedia",
+              "description": "Paginates to the next [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos).",
               "parameters": [
                 {
                   "name": "contentElementIndex",
@@ -14903,6 +14961,7 @@
             {
               "kind": "method",
               "name": "previousMedia",
+              "description": "Paginates to the previous [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos).",
               "parameters": [
                 {
                   "name": "contentElementIndex",
@@ -14981,6 +15040,7 @@
             {
               "kind": "method",
               "name": "setActiveMedia",
+              "description": "Paginates to a specified [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos) object.\nFor example, you may have [media content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos) which contains multiple mediaInfos.\nThis method allows you to specify the index of the mediaInfos you wish to display.",
               "parameters": [
                 {
                   "name": "contentElementIndex",
@@ -15132,6 +15192,7 @@
             },
             {
               "name": "hide-content-attachments",
+              "description": "Indicates whether to hide all [AttachmentsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -15145,6 +15206,7 @@
             },
             {
               "name": "hide-content-expression",
+              "description": "Indicates whether to hide all [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -15158,6 +15220,7 @@
             },
             {
               "name": "hide-content-fields",
+              "description": "Indicates whether to hide all [FieldsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -15171,6 +15234,7 @@
             },
             {
               "name": "hide-content-media",
+              "description": "Indicates whether to hide all [MediaContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -15184,6 +15248,7 @@
             },
             {
               "name": "hide-content-text",
+              "description": "Indicates whether to hide all [TextContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -15207,10 +15272,11 @@
               },
               "default": "false",
               "fieldName": "hideLastEditInfo",
-              "deprecated": "since version 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead."
+              "deprecated": "Deprecated since version 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead."
             },
             {
               "name": "hide-last-edited-info",
+              "description": "Indicates whether to hide the [lastEditInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#lastEditInfo).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -15224,6 +15290,7 @@
             },
             {
               "name": "hide-title",
+              "description": "Indicates whether to hide the title associated with the feature.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -19795,6 +19862,7 @@
             {
               "kind": "method",
               "name": "close",
+              "description": "Closes the component.",
               "return": {
                 "type": {
                   "text": "Promise<void>",
@@ -20008,6 +20076,7 @@
             {
               "kind": "method",
               "name": "fetchFeatures",
+              "description": "Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [layer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html).\nIn order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis method allows a developer to control how the input location is handled.",
               "parameters": [
                 {
                   "name": "screenPoint",
@@ -20126,6 +20195,7 @@
             {
               "kind": "field",
               "name": "hideActionBar",
+              "description": "Indicates whether to hide the action bar that holds the feature's [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20140,6 +20210,7 @@
             {
               "kind": "field",
               "name": "hideCloseButton",
+              "description": "Indicates whether to hide the close button.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20154,6 +20225,7 @@
             {
               "kind": "field",
               "name": "hideFeatureMenuHeading",
+              "description": "Indicates whether to hide a heading and description on the widget feature menu list.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20168,6 +20240,7 @@
             {
               "kind": "field",
               "name": "hideFeatureNavigation",
+              "description": "Indicates whether to hide pagination for feature navigation.\nThis allows the user to scroll through various selected features using pagination arrows.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20182,6 +20255,7 @@
             {
               "kind": "field",
               "name": "hideFlow",
+              "description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if `false`.\nThe flow component will be omitted if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20196,6 +20270,7 @@
             {
               "kind": "field",
               "name": "hideHeading",
+              "description": "Indicates whether is hide the heading.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20210,6 +20285,7 @@
             {
               "kind": "field",
               "name": "hideSpinner",
+              "description": "Indicates whether to hide the loading spinner.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20336,6 +20412,7 @@
             {
               "kind": "method",
               "name": "open",
+              "description": "Opens Features with content defined either explicitly or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features.",
               "parameters": [
                 {
                   "name": "options",
@@ -20775,6 +20852,7 @@
             },
             {
               "name": "hide-action-bar",
+              "description": "Indicates whether to hide the action bar that holds the feature's [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20788,6 +20866,7 @@
             },
             {
               "name": "hide-close-button",
+              "description": "Indicates whether to hide the close button.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20801,6 +20880,7 @@
             },
             {
               "name": "hide-feature-menu-heading",
+              "description": "Indicates whether to hide a heading and description on the widget feature menu list.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20814,6 +20894,7 @@
             },
             {
               "name": "hide-feature-navigation",
+              "description": "Indicates whether to hide pagination for feature navigation.\nThis allows the user to scroll through various selected features using pagination arrows.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20827,6 +20908,7 @@
             },
             {
               "name": "hide-flow",
+              "description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if `false`.\nThe flow component will be omitted if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20840,6 +20922,7 @@
             },
             {
               "name": "hide-heading",
+              "description": "Indicates whether is hide the heading.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -20853,6 +20936,7 @@
             },
             {
               "name": "hide-spinner",
+              "description": "Indicates whether to hide the loading spinner.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -22806,7 +22890,7 @@
               "name": "excludedBarColor",
               "description": "Sets the color of the histogram bars that are excluded based on the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor)",
               "type": {
-                "text": "Color",
+                "text": "Color | ReadonlyArray<number> | string",
                 "references": [
                   {
                     "name": "Color",
@@ -22815,10 +22899,32 @@
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html",
                     "start": 0,
                     "end": 5
+                  },
+                  {
+                    "name": "ReadonlyArray",
+                    "package": "typescript",
+                    "module": "lib/lib.es5.d.ts",
+                    "start": 8,
+                    "end": 21
+                  }
+                ],
+                "values": [
+                  {
+                    "type": "Color"
+                  },
+                  {
+                    "type": "ReadonlyArray<number>"
+                  },
+                  {
+                    "type": "string"
                   }
                 ]
               },
-              "default": "\"#d7e5f0\""
+              "default": "\"#d7e5f0\"",
+              "attribute": "excluded-bar-color",
+              "getterType": {
+                "text": "typeof this.widget.excludedBarColor"
+              }
             },
             {
               "kind": "method",
@@ -22874,7 +22980,7 @@
               "name": "includedBarColor",
               "description": "Sets the color of the histogram bars that are included in the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor)",
               "type": {
-                "text": "Color",
+                "text": "Color | ReadonlyArray<number> | string",
                 "references": [
                   {
                     "name": "Color",
@@ -22883,10 +22989,32 @@
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html",
                     "start": 0,
                     "end": 5
+                  },
+                  {
+                    "name": "ReadonlyArray",
+                    "package": "typescript",
+                    "module": "lib/lib.es5.d.ts",
+                    "start": 8,
+                    "end": 21
+                  }
+                ],
+                "values": [
+                  {
+                    "type": "Color"
+                  },
+                  {
+                    "type": "ReadonlyArray<number>"
+                  },
+                  {
+                    "type": "string"
                   }
                 ]
               },
-              "default": "\"#599dd4\""
+              "default": "\"#599dd4\"",
+              "attribute": "included-bar-color",
+              "getterType": {
+                "text": "typeof this.widget.includedBarColor"
+              }
             },
             {
               "kind": "field",
@@ -23185,6 +23313,20 @@
               },
               "fieldName": "average"
             },
+            {
+              "name": "excluded-bar-color",
+              "description": "Sets the color of the histogram bars that are excluded based on the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor)",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"#d7e5f0\"",
+              "fieldName": "excludedBarColor"
+            },
             {
               "name": "icon",
               "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.",
@@ -23199,6 +23341,20 @@
               "default": "\"arrow-double-horizontal\"",
               "fieldName": "icon"
             },
+            {
+              "name": "included-bar-color",
+              "description": "Sets the color of the histogram bars that are included in the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor)",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"#599dd4\"",
+              "fieldName": "includedBarColor"
+            },
             {
               "name": "label",
               "description": "The component's default label.",
@@ -26519,7 +26675,10 @@
                   }
                 ]
               },
-              "attribute": "basemap"
+              "attribute": "basemap",
+              "getterType": {
+                "text": "typeof this._map.basemap"
+              }
             },
             {
               "kind": "field",
@@ -26575,7 +26734,9 @@
                 ]
               },
               "attribute": "center",
-              "getterTypeDiffers": true
+              "getterType": {
+                "text": "__esri.LinkChartView[\"center\"]"
+              }
             },
             {
               "kind": "method",
@@ -29688,7 +29849,10 @@
                   }
                 ]
               },
-              "attribute": "basemap"
+              "attribute": "basemap",
+              "getterType": {
+                "text": "typeof this._map.basemap"
+              }
             },
             {
               "kind": "field",
@@ -29744,7 +29908,9 @@
                 ]
               },
               "attribute": "center",
-              "getterTypeDiffers": true
+              "getterType": {
+                "text": "__esri.MapView[\"center\"]"
+              }
             },
             {
               "kind": "method",
@@ -30034,7 +30200,10 @@
                   }
                 ]
               },
-              "attribute": "ground"
+              "attribute": "ground",
+              "getterType": {
+                "text": "typeof this._map.ground"
+              }
             },
             {
               "kind": "field",
@@ -36079,7 +36248,10 @@
                   }
                 ]
               },
-              "attribute": "basemap"
+              "attribute": "basemap",
+              "getterType": {
+                "text": "typeof this._map.basemap"
+              }
             },
             {
               "kind": "field",
@@ -36232,7 +36404,9 @@
                 ]
               },
               "attribute": "center",
-              "getterTypeDiffers": true
+              "getterType": {
+                "text": "__esri.SceneView[\"center\"]"
+              }
             },
             {
               "kind": "field",
@@ -36557,7 +36731,10 @@
                   }
                 ]
               },
-              "attribute": "ground"
+              "attribute": "ground",
+              "getterType": {
+                "text": "typeof this._map.ground"
+              }
             },
             {
               "kind": "field",
@@ -47001,7 +47178,9 @@
               },
               "attribute": "expand-direction",
               "reflects": true,
-              "getterTypeDiffers": true
+              "getterType": {
+                "text": "ExpandDirection"
+              }
             },
             {
               "kind": "field",
@@ -47702,7 +47881,7 @@
                   }
                 ]
               },
-              "default": "true",
+              "default": "false",
               "attribute": "rotation-disabled"
             },
             {
@@ -47967,7 +48146,7 @@
                   }
                 ]
               },
-              "default": "true",
+              "default": "false",
               "fieldName": "rotationDisabled"
             },
             {