@arcgis/map-components 4.34.0-next.0 → 4.34.0-next.1

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-05-22T16:55:23",
+  "timestamp": "2025-05-23T04:41:14",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.0",
+    "version": "4.34.0-next.1",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -3230,7 +3230,12 @@
           "attr": "icon",
           "reflectToAttr": false,
           "docs": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "see",
+              "text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
+            }
+          ],
           "default": "\"layer-basemap\"",
           "values": [
             {
@@ -7564,11 +7569,11 @@
           "mutable": true,
           "attr": "icon",
           "reflectToAttr": false,
-          "docs": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
+          "docs": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
           "docsTags": [
             {
               "name": "see",
-              "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
+              "text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
             }
           ],
           "default": "\"move\"",
@@ -19862,7 +19867,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in 2D/arcgis-map.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.",
+      "docs": "The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in a 2D Map component.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.",
       "docsTags": [
         {
           "name": "superclass",
@@ -24423,7 +24428,7 @@
           "mutable": true,
           "attr": "item-id",
           "reflectToAttr": true,
-          "docs": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-linkchart` component loads.",
+          "docs": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Link Chart component loads.",
           "docsTags": [],
           "values": [
             {
@@ -26433,7 +26438,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The Locate component animates the `arcgis-map` or `arcgis-scene` to the user's current location.",
+      "docs": "The Locate component animates the Map or Scene to the user's current location.",
       "docsTags": [
         {
           "name": "superclass",
@@ -27451,7 +27456,7 @@
           "mutable": true,
           "attr": "item-id",
           "reflectToAttr": true,
-          "docs": "The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-map` component loads.",
+          "docs": "The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Map component loads.",
           "docsTags": [],
           "values": [
             {
@@ -29790,11 +29795,11 @@
           "mutable": true,
           "attr": "icon",
           "reflectToAttr": false,
-          "docs": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
+          "docs": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
           "docsTags": [
             {
               "name": "see",
-              "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
+              "text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
             }
           ],
           "values": [
@@ -31691,7 +31696,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The Scale Bar component 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.",
+      "docs": "The Scale Bar component 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 a Scene component.",
       "docsTags": [
         {
           "name": "superclass",
@@ -36276,7 +36281,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The `SearchResultRenderer` renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.",
+      "docs": "The Search Result Renderer renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.",
       "docsTags": [
         {
           "name": "superclass",
@@ -40670,7 +40675,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "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.",
+      "docs": "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 a Scene component.",
       "docsTags": [
         {
           "name": "superclass",
@@ -40808,8 +40813,13 @@
           "mutable": true,
           "attr": "icon",
           "reflectToAttr": false,
-          "docs": "Icon which represents the component.",
-          "docsTags": [],
+          "docs": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
+          "docsTags": [
+            {
+              "name": "see",
+              "text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
+            }
+          ],
           "default": "\"compare\"",
           "values": [
             {
@@ -43176,7 +43186,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The 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.",
+      "docs": "The 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 a Scene component.",
       "docsTags": [
         {
           "name": "superclass",
@@ -46729,7 +46739,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The VersionManagement Component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`",
+      "docs": "The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The Version Management component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`",
       "docsTags": [
         {
           "name": "superclass",

package/dist/docs/vscode.html-custom-data.json

@@ -1642,7 +1642,7 @@
         },
         {
           "name": "icon",
-          "description": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
+          "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
           "values": []
         },
         {
@@ -3890,7 +3890,7 @@
     },
     {
       "name": "arcgis-grid-controls",
-      "description": "The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in 2D/arcgis-map.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `trySetDisplayEnabled(enabled: boolean): void` - Call this to turn the grid on/off.",
+      "description": "The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in a 2D Map component.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `trySetDisplayEnabled(enabled: boolean): void` - Call this to turn the grid on/off.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -4741,7 +4741,7 @@
         },
         {
           "name": "item-id",
-          "description": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-linkchart` component loads.",
+          "description": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Link Chart component loads.",
           "values": []
         },
         {
@@ -4925,7 +4925,7 @@
     },
     {
       "name": "arcgis-locate",
-      "description": "The Locate component animates the `arcgis-map` or `arcgis-scene` to the user's current location.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
+      "description": "The Locate component animates the Map or Scene to the user's current location.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -5055,7 +5055,7 @@
         },
         {
           "name": "item-id",
-          "description": "The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-map` component loads.",
+          "description": "The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Map component loads.",
           "values": []
         },
         {
@@ -5334,7 +5334,7 @@
       "attributes": [
         {
           "name": "icon",
-          "description": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
+          "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
           "values": []
         },
         {
@@ -5757,7 +5757,7 @@
     },
     {
       "name": "arcgis-scale-bar",
-      "description": "The Scale Bar component 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.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
+      "description": "The Scale Bar component 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 a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -6270,7 +6270,7 @@
     },
     {
       "name": "arcgis-search-result-renderer",
-      "description": "The `SearchResultRenderer` renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
+      "description": "The Search Result Renderer renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -7002,7 +7002,7 @@
     },
     {
       "name": "arcgis-swipe",
-      "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.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the 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 a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -7038,7 +7038,7 @@
         },
         {
           "name": "icon",
-          "description": "Icon which represents the component.",
+          "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
           "values": []
         },
         {
@@ -7511,7 +7511,7 @@
     },
     {
       "name": "arcgis-track",
-      "description": "The 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.\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
+      "description": "The 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 a Scene component.\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -8171,7 +8171,7 @@
     },
     {
       "name": "arcgis-version-management",
-      "description": "The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The VersionManagement Component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisVersioningStateChanged**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
+      "description": "The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The Version Management component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisVersioningStateChanged**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
       "attributes": [
         {
           "name": "allow-editing-disabled",

package/dist/docs/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@arcgis/map-components",
-  "version": "4.34.0-next.0",
+  "version": "4.34.0-next.1",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -2961,7 +2961,7 @@
             },
             {
               "name": "icon",
-              "description": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
+              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
               "default": "\"move\"",
               "value": {
                 "type": "string"
@@ -3068,7 +3068,7 @@
               },
               {
                 "name": "icon",
-                "description": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
+                "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
                 "type": "string"
               },
               {
@@ -7077,7 +7077,7 @@
         },
         {
           "name": "arcgis-grid-controls",
-          "description": "The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in 2D/arcgis-map.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `trySetDisplayEnabled(enabled: boolean): void` - Call this to turn the grid on/off.",
+          "description": "The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in a 2D Map component.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `trySetDisplayEnabled(enabled: boolean): void` - Call this to turn the grid on/off.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-grid-controls/",
           "attributes": [
             {
@@ -8712,7 +8712,7 @@
             },
             {
               "name": "item-id",
-              "description": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-linkchart` component loads.",
+              "description": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Link Chart component loads.",
               "value": {
                 "type": "string"
               }
@@ -8948,7 +8948,7 @@
               },
               {
                 "name": "itemId",
-                "description": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-linkchart` component loads.",
+                "description": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Link Chart component loads.",
                 "type": "string"
               },
               {
@@ -9351,7 +9351,7 @@
         },
         {
           "name": "arcgis-locate",
-          "description": "The Locate component animates the `arcgis-map` or `arcgis-scene` to the user's current location.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
+          "description": "The Locate component animates the Map or Scene to the user's current location.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/",
           "attributes": [
             {
@@ -9584,7 +9584,7 @@
             },
             {
               "name": "item-id",
-              "description": "The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-map` component loads.",
+              "description": "The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Map component loads.",
               "value": {
                 "type": "string"
               }
@@ -9845,7 +9845,7 @@
               },
               {
                 "name": "itemId",
-                "description": "The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-map` component loads.",
+                "description": "The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the Map component loads.",
                 "type": "string"
               },
               {
@@ -10274,7 +10274,7 @@
           "attributes": [
             {
               "name": "icon",
-              "description": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
+              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
               "value": {
                 "type": "string"
               }
@@ -10359,7 +10359,7 @@
             "properties": [
               {
                 "name": "icon",
-                "description": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
+                "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
                 "type": "string"
               },
               {
@@ -11033,7 +11033,7 @@
         },
         {
           "name": "arcgis-scale-bar",
-          "description": "The Scale Bar component 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.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
+          "description": "The Scale Bar component 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 a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/",
           "attributes": [
             {
@@ -12437,7 +12437,7 @@
         },
         {
           "name": "arcgis-search-result-renderer",
-          "description": "The `SearchResultRenderer` renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
+          "description": "The Search Result Renderer renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search-result-renderer/",
           "attributes": [
             {
@@ -13980,7 +13980,7 @@
         },
         {
           "name": "arcgis-swipe",
-          "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.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the 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 a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/",
           "attributes": [
             {
@@ -14028,7 +14028,7 @@
             },
             {
               "name": "icon",
-              "description": "Icon which represents the component.",
+              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
               "default": "\"compare\"",
               "value": {
                 "type": "string"
@@ -14126,7 +14126,7 @@
               },
               {
                 "name": "icon",
-                "description": "Icon which represents the component.",
+                "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
                 "type": "string"
               },
               {
@@ -14942,7 +14942,7 @@
         },
         {
           "name": "arcgis-track",
-          "description": "The 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.\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
+          "description": "The 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 a Scene component.\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/",
           "attributes": [
             {
@@ -16348,7 +16348,7 @@
         },
         {
           "name": "arcgis-version-management",
-          "description": "The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The VersionManagement Component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisVersioningStateChanged**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
+          "description": "The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The Version Management component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisVersioningStateChanged**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-version-management/",
           "attributes": [
             {

package/dist/index.js

@@ -1,7 +1,7 @@
 import { s, g as t } from "./chunks/runtime.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.0 */
+v4.34.0-next.1 */
 const a = s, A = t;
 export {
   A as getArcgisAssetPath,

package/dist/loader.js

@@ -2,7 +2,7 @@ import { r as e } from "./chunks/runtime.js";
 import { makeDefineCustomElements as t } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.0 */
+v4.34.0-next.1 */
 const a = t(e, {
   "arcgis-area-measurement-2d": [() => import("./components/arcgis-area-measurement-2d/customElement.js"), "autoDestroyDisabled,icon,label,position,referenceElement,snappingOptions:,state,unit,unitOptions:;clear,destroy,start"],
   "arcgis-area-measurement-3d": [() => import("./components/arcgis-area-measurement-3d/customElement.js"), "analysis:,autoDestroyDisabled,icon,label,position,referenceElement,state,unit,unitOptions:;clear,destroy,start"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/map-components",
-  "version": "4.34.0-next.0",
+  "version": "4.34.0-next.1",
   "description": "ArcGIS Map Components",
   "keywords": [
     "ArcGIS",
@@ -42,12 +42,12 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/components-utils": "4.34.0-next.0",
-    "@arcgis/lumina": "4.34.0-next.0",
+    "@arcgis/components-utils": "4.34.0-next.1",
+    "@arcgis/lumina": "4.34.0-next.1",
     "tslib": "^2.8.1"
   },
   "peerDependencies": {
-    "@arcgis/core": ">=4.33.0-next <4.34",
+    "@arcgis/core": ">=4.34.0-next <4.35",
     "@esri/calcite-components": "^3.2.0"
   },
   "css.customData": [