@arcgis/map-components 4.32.0-next.23 → 4.32.0-next.25

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2024-11-21T12:50:56",
+  "timestamp": "2024-11-23T12:50:47",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.32.0-next.23",
+    "version": "4.32.0-next.25",
     "typescriptVersion": "5.6.3"
   },
   "schemaVersion": "1.0.0",
@@ -31,7 +31,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisAreaMeasurement2dElement",
+          "pascalCaseName": "ArcgisAreaMeasurement2d",
           "importPath": "components/arcgis-area-measurement-2d",
           "members": [
             {
@@ -579,7 +579,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisAreaMeasurement3dElement",
+          "pascalCaseName": "ArcgisAreaMeasurement3d",
           "importPath": "components/arcgis-area-measurement-3d",
           "members": [
             {
@@ -1186,7 +1186,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisAttachmentsElement",
+          "pascalCaseName": "ArcgisAttachments",
           "importPath": "components/arcgis-attachments",
           "members": [
             {
@@ -1881,13 +1881,13 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisBasemapGalleryElement",
+          "pascalCaseName": "ArcgisBasemapGallery",
           "importPath": "components/arcgis-basemap-gallery",
           "members": [
             {
               "kind": "field",
               "name": "activeBasemap",
-              "description": "The map's {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap basemap}.\n\n{@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemap Read more...}",
+              "description": "The map's active basemap.",
               "type": {
                 "text": "Basemap",
                 "references": [
@@ -1971,6 +1971,7 @@
             {
               "kind": "field",
               "name": "disabled",
+              "description": "When `true`, sets the component to a disabled state so the user cannot interact with it.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -1986,6 +1987,7 @@
             {
               "kind": "field",
               "name": "headingLevel",
+              "description": "Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the BasemapGallery.",
               "type": {
                 "text": "1 | 2 | 3 | 4 | 5 | 6",
                 "values": [
@@ -2036,6 +2038,7 @@
             {
               "kind": "field",
               "name": "label",
+              "description": "The components default label.",
               "type": {
                 "text": "string",
                 "values": [
@@ -2130,7 +2133,7 @@
             {
               "kind": "field",
               "name": "source",
-              "description": "The source for basemaps that the widget will display.\n\n{@link https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#source Read more...}",
+              "description": "The source for basemaps that the component will display.",
               "type": {
                 "text": "LocalBasemapsSource | PortalBasemapsSource",
                 "references": [
@@ -2162,7 +2165,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The view model's state.",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"loading\" | \"ready\" | \"unsupported\"",
                 "values": [
@@ -2208,6 +2211,7 @@
             },
             {
               "name": "disabled",
+              "description": "When `true`, sets the component to a disabled state so the user cannot interact with it.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -2221,6 +2225,7 @@
             },
             {
               "name": "heading-level",
+              "description": "Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the BasemapGallery.",
               "type": {
                 "text": "1 | 2 | 3 | 4 | 5 | 6",
                 "values": [
@@ -2269,6 +2274,7 @@
             },
             {
               "name": "label",
+              "description": "The components default label.",
               "type": {
                 "text": "string",
                 "values": [
@@ -2340,7 +2346,7 @@
             },
             {
               "name": "state",
-              "description": "The view model's state.",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"loading\" | \"ready\" | \"unsupported\"",
                 "values": [
@@ -2417,7 +2423,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisBasemapLayerListElement",
+          "pascalCaseName": "ArcgisBasemapLayerList",
           "importPath": "components/arcgis-basemap-layer-list",
           "members": [
             {
@@ -3591,7 +3597,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisBasemapToggleElement",
+          "pascalCaseName": "ArcgisBasemapToggle",
           "importPath": "components/arcgis-basemap-toggle",
           "members": [
             {
@@ -4077,7 +4083,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisBookmarksElement",
+          "pascalCaseName": "ArcgisBookmarks",
           "importPath": "components/arcgis-bookmarks",
           "members": [
             {
@@ -4895,7 +4901,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisBuildingExplorerElement",
+          "pascalCaseName": "ArcgisBuildingExplorer",
           "importPath": "components/arcgis-building-explorer",
           "members": [
             {
@@ -5457,7 +5463,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisCatalogLayerListElement",
+          "pascalCaseName": "ArcgisCatalogLayerList",
           "importPath": "components/arcgis-catalog-layer-list",
           "members": [
             {
@@ -6386,7 +6392,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisCompassElement",
+          "pascalCaseName": "ArcgisCompass",
           "importPath": "components/arcgis-compass",
           "members": [
             {
@@ -6810,7 +6816,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisCoordinateConversionElement",
+          "pascalCaseName": "ArcgisCoordinateConversion",
           "importPath": "components/arcgis-coordinate-conversion",
           "members": [
             {
@@ -7666,7 +7672,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisDaylightElement",
+          "pascalCaseName": "ArcgisDaylight",
           "importPath": "components/arcgis-daylight",
           "members": [
             {
@@ -8403,7 +8409,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisDirectionalPadElement",
+          "pascalCaseName": "ArcgisDirectionalPad",
           "importPath": "components/arcgis-directional-pad",
           "members": [
             {
@@ -8859,7 +8865,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisDirectionsElement",
+          "pascalCaseName": "ArcgisDirections",
           "importPath": "components/arcgis-directions",
           "members": [
             {
@@ -9733,7 +9739,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisDirectlineMeasurement3dElement",
+          "pascalCaseName": "ArcgisDirectlineMeasurement3d",
           "importPath": "components/arcgis-directline-measurement-3d",
           "members": [
             {
@@ -10324,7 +10330,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisDistanceMeasurement2dElement",
+          "pascalCaseName": "ArcgisDistanceMeasurement2d",
           "importPath": "components/arcgis-distance-measurement-2d",
           "members": [
             {
@@ -10856,7 +10862,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisEditorElement",
+          "pascalCaseName": "ArcgisEditor",
           "importPath": "components/arcgis-editor",
           "members": [
             {
@@ -11943,7 +11949,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisElevationProfileElement",
+          "pascalCaseName": "ArcgisElevationProfile",
           "importPath": "components/arcgis-elevation-profile",
           "members": [
             {
@@ -12929,7 +12935,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisExpandElement",
+          "pascalCaseName": "ArcgisExpand",
           "importPath": "components/arcgis-expand",
           "members": [
             {
@@ -13823,7 +13829,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisFeatureElement",
+          "pascalCaseName": "ArcgisFeature",
           "importPath": "components/arcgis-feature",
           "members": [
             {
@@ -14642,7 +14648,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisFeatureFormElement",
+          "pascalCaseName": "ArcgisFeatureForm",
           "importPath": "components/arcgis-feature-form",
           "members": [
             {
@@ -15247,7 +15253,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisFeatureTableElement",
+          "pascalCaseName": "ArcgisFeatureTable",
           "importPath": "components/arcgis-feature-table",
           "members": [
             {
@@ -18058,7 +18064,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisFeatureTemplatesElement",
+          "pascalCaseName": "ArcgisFeatureTemplates",
           "importPath": "components/arcgis-feature-templates",
           "members": [
             {
@@ -18696,7 +18702,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisFeaturesElement",
+          "pascalCaseName": "ArcgisFeatures",
           "importPath": "components/arcgis-features",
           "members": [
             {
@@ -20020,7 +20026,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisFloorFilterElement",
+          "pascalCaseName": "ArcgisFloorFilter",
           "importPath": "components/arcgis-floor-filter",
           "members": [
             {
@@ -20525,7 +20531,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisFullscreenElement",
+          "pascalCaseName": "ArcgisFullscreen",
           "importPath": "components/arcgis-fullscreen",
           "members": [
             {
@@ -20941,7 +20947,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisHistogramElement",
+          "pascalCaseName": "ArcgisHistogram",
           "importPath": "components/arcgis-histogram",
           "members": [
             {
@@ -21505,7 +21511,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisHistogramRangeSliderElement",
+          "pascalCaseName": "ArcgisHistogramRangeSlider",
           "importPath": "components/arcgis-histogram-range-slider",
           "members": [
             {
@@ -22294,7 +22300,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisHomeElement",
+          "pascalCaseName": "ArcgisHome",
           "importPath": "components/arcgis-home",
           "members": [
             {
@@ -22820,7 +22826,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisLayerListElement",
+          "pascalCaseName": "ArcgisLayerList",
           "importPath": "components/arcgis-layer-list",
           "members": [
             {
@@ -23980,7 +23986,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisLegendElement",
+          "pascalCaseName": "ArcgisLegend",
           "importPath": "components/arcgis-legend",
           "members": [
             {
@@ -24588,7 +24594,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisLineOfSightElement",
+          "pascalCaseName": "ArcgisLineOfSight",
           "importPath": "components/arcgis-line-of-sight",
           "members": [
             {
@@ -25077,7 +25083,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisLocateElement",
+          "pascalCaseName": "ArcgisLocate",
           "importPath": "components/arcgis-locate",
           "members": [
             {
@@ -25716,7 +25722,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisMapElement",
+          "pascalCaseName": "ArcgisMap",
           "importPath": "components/arcgis-map",
           "members": [
             {
@@ -26254,7 +26260,7 @@
             {
               "kind": "field",
               "name": "highlightOptions",
-              "description": "Options for configuring the highlight.\n\n{@link https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#highlightOptions Read more...}",
+              "description": "Options for configuring the highlight.",
               "type": {
                 "text": "HighlightOptions",
                 "references": [
@@ -26269,6 +26275,23 @@
               },
               "deprecated": "Options for configuring the highlight. Use the highlight method on the\nappropriate esri/views/layers/LayerView to highlight a feature.\nThe layerView's `highlightOptions` will take precedence over the MapView's `highlightOptions` if both properties are set."
             },
+            {
+              "kind": "field",
+              "name": "highlights",
+              "description": "The highlights property is a collection of HighlightGroup objects that\nallow you to visually emphasize specific features on the map.",
+              "type": {
+                "text": "Collection<any>",
+                "references": [
+                  {
+                    "name": "Collection",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "start": 0,
+                    "end": 10
+                  }
+                ]
+              }
+            },
             {
               "kind": "method",
               "name": "hitTest",
@@ -27634,7 +27657,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisMeasurementElement",
+          "pascalCaseName": "ArcgisMeasurement",
           "importPath": "components/arcgis-measurement",
           "members": [
             {
@@ -28432,7 +28455,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisNavigationToggleElement",
+          "pascalCaseName": "ArcgisNavigationToggle",
           "importPath": "components/arcgis-navigation-toggle",
           "members": [
             {
@@ -28866,7 +28889,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisOrientedImageryViewerElement",
+          "pascalCaseName": "ArcgisOrientedImageryViewer",
           "importPath": "components/arcgis-oriented-imagery-viewer",
           "members": [
             {
@@ -29507,7 +29530,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisPlacementElement",
+          "pascalCaseName": "ArcgisPlacement",
           "importPath": "components/arcgis-placement",
           "members": [
             {
@@ -29727,7 +29750,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisPrintElement",
+          "pascalCaseName": "ArcgisPrint",
           "importPath": "components/arcgis-print",
           "members": [
             {
@@ -30446,7 +30469,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisScaleBarElement",
+          "pascalCaseName": "ArcgisScaleBar",
           "importPath": "components/arcgis-scale-bar",
           "members": [
             {
@@ -30865,7 +30888,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisScaleRangeSliderElement",
+          "pascalCaseName": "ArcgisScaleRangeSlider",
           "importPath": "components/arcgis-scale-range-slider",
           "members": [
             {
@@ -32121,7 +32144,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisSceneElement",
+          "pascalCaseName": "ArcgisScene",
           "importPath": "components/arcgis-scene",
           "members": [
             {
@@ -32854,7 +32877,7 @@
             {
               "kind": "field",
               "name": "highlightOptions",
-              "description": "Options for configuring the highlight. Use the highlight method on the\nappropriate esri/views/layers/LayerView to highlight a feature.\nThe layerView's `highlightOptions` will take precedence over the MapView's `highlightOptions` if both properties are set.",
+              "description": "Options for configuring the highlight.\n\n{@link https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions Read more...}",
               "type": {
                 "text": "HighlightOptions",
                 "references": [
@@ -32866,6 +32889,24 @@
                     "end": 16
                   }
                 ]
+              },
+              "deprecated": "Options for configuring the highlight. Use the highlight method on the\nappropriate esri/views/layers/LayerView to highlight a feature.\nThe layerView's `highlightOptions` will take precedence over the MapView's `highlightOptions` if both properties are set."
+            },
+            {
+              "kind": "field",
+              "name": "highlights",
+              "description": "The highlights property is a collection of HighlightGroup objects that\nallow you to visually emphasize specific features on the map.",
+              "type": {
+                "text": "Collection<any>",
+                "references": [
+                  {
+                    "name": "Collection",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "start": 0,
+                    "end": 10
+                  }
+                ]
               }
             },
             {
@@ -34336,7 +34377,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisSearchElement",
+          "pascalCaseName": "ArcgisSearch",
           "importPath": "components/arcgis-search",
           "members": [
             {
@@ -35739,7 +35780,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisShadowCastElement",
+          "pascalCaseName": "ArcgisShadowCast",
           "importPath": "components/arcgis-shadow-cast",
           "members": [
             {
@@ -36564,7 +36605,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisSketchElement",
+          "pascalCaseName": "ArcgisSketch",
           "importPath": "components/arcgis-sketch",
           "members": [
             {
@@ -38312,7 +38353,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisSliceElement",
+          "pascalCaseName": "ArcgisSlice",
           "importPath": "components/arcgis-slice",
           "members": [
             {
@@ -38896,7 +38937,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisSliderElement",
+          "pascalCaseName": "ArcgisSlider",
           "importPath": "components/arcgis-slider",
           "members": [
             {
@@ -40124,7 +40165,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisSwipeElement",
+          "pascalCaseName": "ArcgisSwipe",
           "importPath": "components/arcgis-swipe",
           "members": [
             {
@@ -40476,7 +40517,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisTableListElement",
+          "pascalCaseName": "ArcgisTableList",
           "importPath": "components/arcgis-table-list",
           "members": [
             {
@@ -41376,7 +41417,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisTimeSliderElement",
+          "pascalCaseName": "ArcgisTimeSlider",
           "importPath": "components/arcgis-time-slider",
           "members": [
             {
@@ -42318,7 +42359,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisTrackElement",
+          "pascalCaseName": "ArcgisTrack",
           "importPath": "components/arcgis-track",
           "members": [
             {
@@ -42954,7 +42995,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisUtilityNetworkAssociationsElement",
+          "pascalCaseName": "ArcgisUtilityNetworkAssociations",
           "importPath": "components/arcgis-utility-network-associations",
           "members": [
             {
@@ -43756,7 +43797,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisUtilityNetworkTraceElement",
+          "pascalCaseName": "ArcgisUtilityNetworkTrace",
           "importPath": "components/arcgis-utility-network-trace",
           "members": [
             {
@@ -44348,7 +44389,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisUtilityNetworkValidateTopologyElement",
+          "pascalCaseName": "ArcgisUtilityNetworkValidateTopology",
           "importPath": "components/arcgis-utility-network-validate-topology",
           "members": [
             {
@@ -44621,7 +44662,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisValuePickerElement",
+          "pascalCaseName": "ArcgisValuePicker",
           "importPath": "components/arcgis-value-picker",
           "members": [
             {
@@ -45501,7 +45542,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisVersionManagementElement",
+          "pascalCaseName": "ArcgisVersionManagement",
           "importPath": "components/arcgis-version-management",
           "members": [
             {
@@ -46055,7 +46096,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisWeatherElement",
+          "pascalCaseName": "ArcgisWeather",
           "importPath": "components/arcgis-weather",
           "members": [
             {
@@ -46485,7 +46526,7 @@
             "package": "@arcgis/lumina"
           },
           "encapsulation": "none",
-          "typeName": "HTMLArcgisZoomElement",
+          "pascalCaseName": "ArcgisZoom",
           "importPath": "components/arcgis-zoom",
           "members": [
             {