npm - @arcgis/map-components - Versions diffs - 4.32.0-next.140 → 4.32.0-next.141 - Mend

@arcgis/map-components 4.32.0-next.140 → 4.32.0-next.141

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (309) hide show

package/dist/docs/api.json CHANGED Viewed

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-02-18T05:05:02",
+  "timestamp": "2025-02-19T05:09:58",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.32.0-next.140",
+    "version": "4.32.0-next.141",
     "typescriptVersion": "5.6.3"
   },
   "schemaVersion": "1.0.0",
@@ -1959,7 +1959,7 @@
             {
               "kind": "field",
               "name": "activeBasemap",
-              "description": "The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemap)",
+              "description": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).",
               "type": {
                 "text": "Basemap",
                 "references": [
@@ -3701,7 +3701,7 @@
           "customElement": true,
           "name": "ArcgisBasemapToggle",
           "tagName": "arcgis-basemap-toggle",
-          "description": "BasemapToggle component allows an end-user to switch between two basemaps. The toggled basemap is set inside the [view's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle.html#view) [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#map) object.",
+          "description": "Basemap Toggle component allows an end-user to switch between two basemaps.\n\nThe basemaps can have different spatial references.",
           "demos": [
             {
               "description": "Docs",
@@ -3723,7 +3723,7 @@
             {
               "kind": "field",
               "name": "activeBasemap",
-              "description": "The map's [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#activeBasemap)",
+              "description": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).",
               "type": {
                 "text": "Basemap",
                 "references": [
@@ -3810,7 +3810,7 @@
             {
               "kind": "field",
               "name": "icon",
-              "description": "Icon which represents the widget. It is typically used when the widget is controlled by another\none (e.g. in the Expand widget).",
+              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
               "type": {
                 "text": "string",
                 "values": [
@@ -3840,7 +3840,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Overwrite localized strings for this component",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    componentLabel?: string | undefined;\n    incompatibleSpatialReference?: string | undefined;\n}"
               }
@@ -3956,7 +3956,7 @@
             {
               "kind": "field",
               "name": "showTitle",
-              "description": "The visible elements that are displayed within the widget.",
+              "description": "Indicates if the Basemap title is displayed.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -3971,7 +3971,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"incompatible-next-basemap\" | \"loading\" | \"ready\"",
                 "values": [
@@ -4038,7 +4038,7 @@
             },
             {
               "name": "icon",
-              "description": "Icon which represents the widget. It is typically used when the widget is controlled by another\none (e.g. in the Expand widget).",
+              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
               "type": {
                 "text": "string",
                 "values": [
@@ -4123,7 +4123,7 @@
             },
             {
               "name": "show-title",
-              "description": "The visible elements that are displayed within the widget.",
+              "description": "Indicates if the Basemap title is displayed.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -4137,7 +4137,7 @@
             },
             {
               "name": "state",
-              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapToggle-BasemapToggleViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"incompatible-next-basemap\" | \"loading\" | \"ready\"",
                 "values": [
@@ -6676,6 +6676,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    componentLabel?: string | undefined;\n    reset?: string | undefined;\n}"
               }
@@ -6683,7 +6684,7 @@
             {
               "kind": "field",
               "name": "orientation",
-              "description": "The z axis orientation.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#orientation)",
+              "description": "The z axis orientation.",
               "type": {
                 "text": "Orientation",
                 "references": [
@@ -6814,7 +6815,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"compass\" | \"disabled\" | \"rotation\"",
                 "values": [
@@ -6939,7 +6940,7 @@
             },
             {
               "name": "state",
-              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"compass\" | \"disabled\" | \"rotation\"",
                 "values": [
@@ -8924,7 +8925,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The state of the view model.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"moving\" | \"ready\"",
                 "values": [
@@ -9130,7 +9131,7 @@
             },
             {
               "name": "state",
-              "description": "The state of the view model.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"moving\" | \"ready\"",
                 "values": [
@@ -21407,7 +21408,7 @@
             {
               "kind": "field",
               "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.",
+              "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": [
@@ -21437,7 +21438,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Overwrite localized strings for this component",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    componentLabel?: string | undefined;\n    enter?: string | undefined;\n    exit?: string | undefined;\n}"
               }
@@ -21535,7 +21536,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"active\" | \"disabled\" | \"feature-unsupported\" | \"ready\"",
                 "values": [
@@ -21581,7 +21582,7 @@
             },
             {
               "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.",
+              "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": [
@@ -21666,7 +21667,7 @@
             },
             {
               "name": "state",
-              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Fullscreen-FullscreenViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"active\" | \"disabled\" | \"feature-unsupported\" | \"ready\"",
                 "values": [
@@ -23106,7 +23107,7 @@
           "customElement": true,
           "name": "ArcgisHome",
           "tagName": "arcgis-home",
-          "description": "Home component enables switching the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to its initial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) or a previously defined viewpoint.",
+          "description": "Home component is a button that switches the view to its\ninitial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor a previously defined `viewpoint`.",
           "demos": [
             {
               "description": "Docs",
@@ -23251,7 +23252,7 @@
             {
               "kind": "field",
               "name": "icon",
-              "description": "Icon displayed in the widget's button.",
+              "description": "Icon displayed in the component's button.",
               "type": {
                 "text": "string",
                 "values": [
@@ -23267,10 +23268,6 @@
                 {
                   "name": "see",
                   "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
-                },
-                {
-                  "name": "since",
-                  "text": "4.28"
                 }
               ]
             },
@@ -23291,7 +23288,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Overwrite localized strings for this component",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    componentLabel?: string | undefined;\n    title?: string | undefined;\n    cancel?: string | undefined;\n}"
               }
@@ -23389,7 +23386,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"going-home\" | \"ready\"",
                 "values": [
@@ -23456,7 +23453,7 @@
             },
             {
               "name": "icon",
-              "description": "Icon displayed in the widget's button.",
+              "description": "Icon displayed in the component's button.",
               "type": {
                 "text": "string",
                 "values": [
@@ -23541,7 +23538,7 @@
             },
             {
               "name": "state",
-              "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"going-home\" | \"ready\"",
                 "values": [
@@ -28513,6 +28510,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    componentLabel?: string | undefined;\n    title?: string | undefined;\n    currentLocation?: string | undefined;\n    timestamp?: string | undefined;\n    latitude?: string | undefined;\n    longitude?: string | undefined;\n    accuracy?: string | undefined;\n    altitude?: string | undefined;\n    altitudeAccuracy?: string | undefined;\n    heading?: string | undefined;\n    speed?: string | undefined;\n    permissionError?: string | undefined;\n    timeoutError?: string | undefined;\n    positionUnavailable?: string | undefined;\n    cancel?: string | undefined;\n}"
               }
@@ -28640,7 +28638,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"locating\" | \"ready\"",
                 "values": [
@@ -28830,7 +28828,7 @@
             },
             {
               "name": "state",
-              "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"locating\" | \"ready\"",
                 "values": [
@@ -33993,7 +33991,7 @@
           "customElement": true,
           "name": "ArcgisScaleBar",
           "tagName": "arcgis-scale-bar",
-          "description": "The Scale Bar component displays a scale bar on the map or in a specified HTML node.",
+          "description": "The Scale Bar componenent displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known Limitations**\n\n- This component is not currently supported within an `arcgis-scene` component.",
           "demos": [
             {
               "description": "Docs",
@@ -34102,7 +34100,7 @@
             {
               "kind": "field",
               "name": "icon",
-              "description": "Icon displayed in the widget's button.",
+              "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.",
               "type": {
                 "text": "string",
                 "values": [
@@ -34132,6 +34130,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{ componentLabel?: string | undefined; }"
               }
@@ -34286,7 +34285,7 @@
             },
             {
               "name": "icon",
-              "description": "Icon displayed in the widget's button.",
+              "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.",
               "type": {
                 "text": "string",
                 "values": [
@@ -43695,7 +43694,7 @@
           "customElement": true,
           "name": "ArcgisSwipe",
           "tagName": "arcgis-swipe",
-          "description": "The Swipe component provides a tool to show a portion of a layer or layers on top of a map. Layers can be swiped vertically or horizontally to easily compare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n__Note:__ This component is not currently supported within an `arcgis-scene` component.",
+          "description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known Limitations**\n\n- This component is not currently supported within an `arcgis-scene` component.",
           "demos": [
             {
               "description": "Docs",
@@ -43853,7 +43852,7 @@
             {
               "kind": "field",
               "name": "icon",
-              "description": "Icon which represents the component. It is typically used when the component is controlled by another\none (e.g. in the Expand component).",
+              "description": "Icon which represents the component.",
               "type": {
                 "text": "string",
                 "values": [
@@ -43864,13 +43863,7 @@
               },
               "default": "\"compare\"",
               "attribute": "icon",
-              "reflects": true,
-              "docsTags": [
-                {
-                  "name": "see",
-                  "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
-                }
-              ]
+              "reflects": true
             },
             {
               "kind": "field",
@@ -43916,7 +43909,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Overwrite localized strings for this component",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    componentLabel?: string | undefined;\n    dragLabel?: string | undefined;\n}"
               }
@@ -44014,7 +44007,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The current state of the Swipe.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"ready\"",
                 "values": [
@@ -44154,7 +44147,7 @@
             },
             {
               "name": "icon",
-              "description": "Icon which represents the component. It is typically used when the component is controlled by another\none (e.g. in the Expand component).",
+              "description": "Icon which represents the component.",
               "type": {
                 "text": "string",
                 "values": [
@@ -44240,7 +44233,7 @@
             },
             {
               "name": "state",
-              "description": "The current state of the Swipe.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"ready\"",
                 "values": [
@@ -46192,7 +46185,7 @@
           "customElement": true,
           "name": "ArcgisTrack",
           "tagName": "arcgis-track",
-          "description": "Track component is a simple button that animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's location when clicked.",
+          "description": "Track component is a button that animates the map or scene to the user's location when clicked.\nThe view rotates based on device heading.\nThe default heading symbol will display when speed is greater than zero and the browser provides heading information.\n\n**Known Limitations**\n\n- The heading symbol is not currently supported within an `arcgis-scene` component.",
           "demos": [
             {
               "description": "Docs",
@@ -46382,6 +46375,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    componentLabel?: string | undefined;\n    startTracking?: string | undefined;\n    stopTracking?: string | undefined;\n    permissionError?: string | undefined;\n    timeoutError?: string | undefined;\n    positionUnavailable?: string | undefined;\n}"
               }
@@ -46532,7 +46526,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"ready\" | \"tracking\" | \"waiting\"",
                 "values": [
@@ -50063,6 +50057,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    label?: string | undefined;\n    actions?: {\n        cancelSave?: string | undefined;\n        deleteVersion?: string | undefined;\n        editVersion?: string | undefined;\n        newVersion?: string | undefined;\n        refreshVersions?: string | undefined;\n        saveVersion?: string | undefined;\n        searchVersions?: string | undefined;\n        switchToVersion?: string | undefined;\n    } | undefined;\n    accessLevels?: {\n        private?: string | undefined;\n        protected?: string | undefined;\n        public?: string | undefined;\n    } | undefined;\n    executionErrors?: {\n        invalidVersionName?: string | undefined;\n        noAdvancedEditingUserTypeExtension?: string | undefined;\n        noFeatureServiceFound?: string | undefined;\n        notValidEnterpriseVersion?: string | undefined;\n        noVersionManagementServiceFound?: string | undefined;\n    } | undefined;\n    headers?: {\n        currentVersion?: string | undefined;\n        manageVersions?: string | undefined;\n        filterVersions?: string | undefined;\n        versionProperties?: string | undefined;\n        invalidInitialVersion?: string | undefined;\n        invalidInitialFeatureService?: string | undefined;\n    } | undefined;\n    input?: {\n        versionAccess?: string | undefined;\n        versionDescription?: string | undefined;\n        versionName?: string | undefined;\n        versionOwner?: string | undefined;\n    } | undefined;\n    loadErrors?: {\n        invalidInitialVersion?: string | undefined;\n        invalidInitialFeatureService?: string | undefined;\n        noFeatureServices?: string | undefined;\n        noViewProperty?: string | undefined;\n    } | undefined;\n}"
               }
@@ -51032,7 +51027,7 @@
             {
               "kind": "field",
               "name": "icon",
-              "description": "Icon which represents the widget.",
+              "description": "Icon which represents the component.",
               "type": {
                 "text": "string",
                 "values": [
@@ -51083,7 +51078,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Overwrite localized strings for this component",
+              "description": "Replace localized message strings with your own strings.",
               "type": {
                 "text": "{\n    componentLabel?: string | undefined;\n    zoomIn?: string | undefined;\n    zoomOut?: string | undefined;\n}"
               }
@@ -51180,7 +51175,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"ready\"",
                 "values": [
@@ -51260,7 +51255,7 @@
             },
             {
               "name": "icon",
-              "description": "Icon which represents the widget.",
+              "description": "Icon which represents the component.",
               "type": {
                 "text": "string",
                 "values": [
@@ -51364,7 +51359,7 @@
             },
             {
               "name": "state",
-              "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Zoom-ZoomViewModel.html#state)",
+              "description": "The current state of the component.",
               "type": {
                 "text": "\"disabled\" | \"ready\"",
                 "values": [