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

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-05-22T16:55:23",
+  "timestamp": "2025-05-31T04:47:40",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.0",
+    "version": "4.34.0-next.10",
     "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\"",
@@ -12038,7 +12043,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The Expand component acts as a clickable button for opening content.",
+      "docs": "The Expand component acts as a clickable button for displaying interactive content, most commonly other components.",
       "docsTags": [
         {
           "name": "superclass",
@@ -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",
@@ -21830,11 +21835,11 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "The esri/Viewpoint, or point of view, to zoom to when\ngoing home. The initial value is determined a few different ways:\n\nIf no esri/views/View is provided, the value is `null`.\nIf the esri/views/View is ready, but the esri/Viewpoint is not defined, the initial\nvalue of the esri/Viewpoint is determined when the esri/views/View became ready.\nIf the esri/views/View is ready and the esri/Viewpoint is defined by the user, the initial viewpoint value is the user-defined esri/Viewpoint.",
+          "docs": "The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nto go to when going \"home\".\nThe initial value is determined in a few different ways:\n\nIf no referenceElement is provided, the value is `null`.\nOnce the referenceElement is ready, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html).",
           "docsTags": [
             {
               "name": "example",
-              "text": "// Creates a viewpoint centered on the extent of a polygon geometry\nlet vp = new Viewpoint({\n  targetGeometry: geom.extent\n});\n\n// Sets the model's viewpoint to the Viewpoint based on a polygon geometry\nhome.viewpoint = vp;"
+              "text": "// Creates a viewpoint centered on the extent of a polygon geometry\n\n ```js\nlet vp = new Viewpoint({\n  targetGeometry: geom.extent\n});\n\n// Sets the model's viewpoint to the Viewpoint based on a polygon geometry\nhome.viewpoint = vp;\n```"
             }
           ],
           "default": "null",
@@ -21865,12 +21870,7 @@
           "signature": "cancelGo(): Promise<void>",
           "parameters": [],
           "docs": "This function provides the ability to interrupt and cancel the process\nof navigating the view back to the view's initial extent.",
-          "docsTags": [
-            {
-              "name": "since",
-              "text": "4.9"
-            }
-          ]
+          "docsTags": []
         },
         {
           "name": "componentOnReady",
@@ -21973,7 +21973,7 @@
           "docsTags": [
             {
               "name": "example",
-              "text": "home.addEventListener(\"go\", (event) => {\n  console.log(\"updating viewpoint\");\n});"
+              "text": "```js\nhome.addEventListener(\"arcgisGo\", (event) => {\n  console.log(\"updating viewpoint\");\n});\n```"
             }
           ]
         },
@@ -24423,7 +24423,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": [
             {
@@ -26004,10 +26004,6 @@
             {
               "name": "see",
               "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
-            },
-            {
-              "name": "since",
-              "text": "4.28"
             }
           ],
           "default": "\"nodes-link\"",
@@ -26417,7 +26413,7 @@
           "docsTags": [
             {
               "name": "example",
-              "text": "layoutswitcher.addEventListener(\"arcgisSwitchLayout\", (event) => {\n  console.log(\"Layout Switched\");\n});"
+              "text": "```js\nlayoutswitcher.addEventListener(\"arcgisSwitchLayout\", (event) => {\n  console.log(\"Layout Switched\");\n});\n```"
             }
           ]
         }
@@ -26433,7 +26429,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 +27447,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 +29786,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 +31687,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",
@@ -36036,6 +36032,23 @@
         }
       ],
       "methods": [
+        {
+          "name": "clear",
+          "returns": {
+            "type": "void",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): void",
+            "parameters": [],
+            "return": "void",
+            "references": {}
+          },
+          "signature": "clear(): void",
+          "parameters": [],
+          "docs": "Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.",
+          "docsTags": []
+        },
         {
           "name": "componentOnReady",
           "returns": {
@@ -36091,6 +36104,66 @@
           "docs": "Permanently destroy the component.",
           "docsTags": []
         },
+        {
+          "name": "search",
+          "returns": {
+            "type": "Promise<SearchResponse | null | undefined>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>",
+            "parameters": [
+              {
+                "name": "searchItem",
+                "type": "Array<number> | Graphic | Point | SuggestResult | null | string | undefined",
+                "docs": ""
+              }
+            ],
+            "return": "Promise<SearchResponse | null | undefined>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              },
+              "SearchResponse": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              },
+              "Array": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              },
+              "Graphic": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              },
+              "Point": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              },
+              "SuggestResult": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>",
+          "parameters": [
+            {
+              "name": "searchItem",
+              "type": "Array<number> | Graphic | Point | SuggestResult | null | string | undefined",
+              "docs": ""
+            }
+          ],
+          "docs": "Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and\nreturns any applicable results.",
+          "docsTags": []
+        },
         {
           "name": "setFocus",
           "returns": {
@@ -36113,6 +36186,46 @@
           "parameters": [],
           "docs": "Brings focus to the component's text input.",
           "docsTags": []
+        },
+        {
+          "name": "suggest",
+          "returns": {
+            "type": "Promise<SuggestResponse | null | undefined>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(query?: string): Promise<__esri.SuggestResponse | Nil>",
+            "parameters": [
+              {
+                "name": "query",
+                "type": "string | undefined",
+                "docs": ""
+              }
+            ],
+            "return": "Promise<SuggestResponse | null | undefined>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              },
+              "SuggestResponse": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "suggest(query?: string): Promise<__esri.SuggestResponse | Nil>",
+          "parameters": [
+            {
+              "name": "query",
+              "type": "string | undefined",
+              "docs": ""
+            }
+          ],
+          "docs": "Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.",
+          "docsTags": []
         }
       ],
       "events": [
@@ -36276,7 +36389,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 +40783,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 +40921,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 +43294,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 +46847,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",
@@ -47210,7 +47328,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid url or layer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n\n**Example**\n\n```html\n<arcgis-video layer-url=\"YOUR_VIDEO_LAYER_URL\"></arcgis-video>\n```",
+      "docs": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n\n**Example**\n\n```html\n<arcgis-video></arcgis-video>\n```\n\n```js\nconst VideoLayer = await $arcgis.import(\"@arcgis/core/layers/VideoLayer.js\");\nconst videoElement = document.querySelector(\"arcgis-video\");\n\nconst videoLayer = new VideoLayer({\n  url: \"YOUR_VIDEO_LAYER_URL\",\n});\n\nawait videoLayer.load();\nif (videoLayer.loaded) {\n  videoElement.layer = videoLayer;\n}\n```",
       "docsTags": [
         {
           "name": "superclass",
@@ -47266,27 +47384,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "layerUrl",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "layer-url",
-          "reflectToAttr": true,
-          "docs": "",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "ready",
           "type": "boolean",
@@ -47459,6 +47556,41 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "followingMode",
+          "type": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
+          "complexType": {
+            "original": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
+            "resolved": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "following-mode",
+          "reflectToAttr": false,
+          "docs": "Determines which telemetry elements to follow when the video layer is playing.",
+          "docsTags": [],
+          "default": "\"follow-both\"",
+          "values": [
+            {
+              "value": "follow-both",
+              "type": "string"
+            },
+            {
+              "value": "follow-frame",
+              "type": "string"
+            },
+            {
+              "value": "follow-sensor",
+              "type": "string"
+            },
+            {
+              "value": "none",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "hideHeader",
           "type": "boolean",
@@ -47564,7 +47696,7 @@
             },
             {
               "name": "example",
-              "text": "// Create a new Video Player with a VideoLayer\nvideoPlayer.layer = videoLayer;"
+              "text": "```js\n// Create a new Video Player with a VideoLayer\nvideoPlayer.layer = videoLayer;\n```"
             }
           ],
           "default": "null",