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

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-05-23T04:41:14",
+  "timestamp": "2025-06-01T04:38:18",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.1",
+    "version": "4.34.0-next.11",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -14645,15 +14645,19 @@
           "customElement": true,
           "name": "ArcgisExpand",
           "tagName": "arcgis-expand",
-          "description": "The Expand component acts as a clickable button for opening content.",
+          "description": "The Expand component acts as a clickable button for displaying interactive content, most commonly other components.",
           "demos": [
             {
               "description": "Docs",
               "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/"
             },
             {
-              "description": "Demo",
-              "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--demo&singleStory=true"
+              "description": "Expand with Custom Content\nThe Expand component with custom content. The content must be wrapped in an [Placement](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-placement/) component.",
+              "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--custom-content&singleStory=true"
+            },
+            {
+              "description": "Expand with Component Content\nThe Expand component with the [Basemap Gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) component.",
+              "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--component-content&singleStory=true"
             }
           ],
           "superclass": {
@@ -25843,12 +25847,6 @@
                   ]
                 }
               },
-              "docsTags": [
-                {
-                  "name": "since",
-                  "text": "4.9"
-                }
-              ],
               "signature": "(): Promise<void>",
               "async": true
             },
@@ -26099,7 +26097,7 @@
             {
               "kind": "field",
               "name": "viewpoint",
-              "description": "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.",
+              "description": "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).",
               "type": {
                 "text": "Viewpoint",
                 "references": [
@@ -26117,7 +26115,7 @@
               "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```"
                 }
               ]
             }
@@ -26265,7 +26263,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```"
                 }
               ]
             },
@@ -30668,10 +30666,6 @@
                 {
                   "name": "see",
                   "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
-                },
-                {
-                  "name": "since",
-                  "text": "4.28"
                 }
               ]
             },
@@ -31152,7 +31146,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```"
                 }
               ]
             }
@@ -37608,7 +37602,7 @@
               "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-range-slider/"
             },
             {
-              "description": "Scale Range Slider",
+              "description": "Demo",
               "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-scale-range-slider--demo&singleStory=true"
             }
           ],
@@ -41064,6 +41058,17 @@
               "default": "true",
               "attribute": "auto-select"
             },
+            {
+              "kind": "method",
+              "name": "clear",
+              "description": "Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "signature": "(): void"
+            },
             {
               "kind": "method",
               "name": "componentOnReady",
@@ -41525,6 +41530,100 @@
               "readonly": true,
               "docsOnlyReadonly": true
             },
+            {
+              "kind": "method",
+              "name": "search",
+              "description": "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.",
+              "parameters": [
+                {
+                  "name": "searchItem",
+                  "optional": true,
+                  "type": {
+                    "text": "Array<number> | Graphic | Point | SuggestResult | null | string | undefined",
+                    "references": [
+                      {
+                        "name": "Array",
+                        "package": "typescript",
+                        "module": "lib/lib.es5.d.ts",
+                        "start": 0,
+                        "end": 5
+                      },
+                      {
+                        "name": "Graphic",
+                        "package": "@arcgis/core",
+                        "module": "interfaces.d.ts",
+                        "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html",
+                        "start": 16,
+                        "end": 23
+                      },
+                      {
+                        "name": "Point",
+                        "package": "@arcgis/core",
+                        "module": "interfaces.d.ts",
+                        "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html",
+                        "start": 26,
+                        "end": 31
+                      },
+                      {
+                        "name": "SuggestResult",
+                        "package": "@arcgis/core",
+                        "module": "interfaces.d.ts",
+                        "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-types.html#SuggestResult",
+                        "start": 34,
+                        "end": 47
+                      }
+                    ],
+                    "values": [
+                      {
+                        "type": "Array<number>"
+                      },
+                      {
+                        "type": "Graphic"
+                      },
+                      {
+                        "type": "Point"
+                      },
+                      {
+                        "type": "SuggestResult"
+                      },
+                      {
+                        "type": "null"
+                      },
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": "Promise<SearchResponse | null | undefined>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    },
+                    {
+                      "name": "SearchResponse",
+                      "package": "@arcgis/core",
+                      "module": "interfaces.d.ts",
+                      "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-types.html#SearchResponse",
+                      "start": 8,
+                      "end": 22
+                    }
+                  ]
+                }
+              },
+              "signature": "(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>",
+              "async": true
+            },
             {
               "kind": "field",
               "name": "searchAllEnabled",
@@ -41677,6 +41776,52 @@
               "reflects": true,
               "docsOnlyReadonly": true
             },
+            {
+              "kind": "method",
+              "name": "suggest",
+              "description": "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`.",
+              "parameters": [
+                {
+                  "name": "query",
+                  "optional": true,
+                  "type": {
+                    "text": "string | undefined",
+                    "values": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": "Promise<SuggestResponse | null | undefined>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    },
+                    {
+                      "name": "SuggestResponse",
+                      "package": "@arcgis/core",
+                      "module": "interfaces.d.ts",
+                      "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-types.html#SuggestResponse",
+                      "start": 8,
+                      "end": 23
+                    }
+                  ]
+                }
+              },
+              "signature": "(query?: string): Promise<__esri.SuggestResponse | Nil>",
+              "async": true
+            },
             {
               "kind": "field",
               "name": "suggestions",
@@ -55039,7 +55184,7 @@
           "customElement": true,
           "name": "ArcgisVideo",
           "tagName": "arcgis-video",
-          "description": "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```",
+          "description": "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```",
           "demos": [
             {
               "description": "Docs",
@@ -55138,20 +55283,6 @@
                 ]
               }
             },
-            {
-              "kind": "field",
-              "name": "layerUrl",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "attribute": "layer-url",
-              "reflects": true
-            },
             {
               "kind": "field",
               "name": "ready",
@@ -55201,18 +55332,6 @@
               },
               "default": "false",
               "fieldName": "autoDestroyDisabled"
-            },
-            {
-              "name": "layer-url",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "fieldName": "layerUrl"
             }
           ],
           "events": [
@@ -55327,6 +55446,34 @@
               "signature": "(): Promise<void>",
               "async": true
             },
+            {
+              "kind": "field",
+              "name": "followingMode",
+              "description": "Determines which telemetry elements to follow when the video layer is playing.",
+              "type": {
+                "text": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
+                "values": [
+                  {
+                    "value": "follow-both",
+                    "type": "string"
+                  },
+                  {
+                    "value": "follow-frame",
+                    "type": "string"
+                  },
+                  {
+                    "value": "follow-sensor",
+                    "type": "string"
+                  },
+                  {
+                    "value": "none",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"follow-both\"",
+              "attribute": "following-mode"
+            },
             {
               "kind": "field",
               "name": "hideHeader",
@@ -55415,7 +55562,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```"
                 }
               ]
             },
@@ -55582,6 +55729,33 @@
               "default": "false",
               "fieldName": "autoDestroyDisabled"
             },
+            {
+              "name": "following-mode",
+              "description": "Determines which telemetry elements to follow when the video layer is playing.",
+              "type": {
+                "text": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
+                "values": [
+                  {
+                    "value": "follow-both",
+                    "type": "string"
+                  },
+                  {
+                    "value": "follow-frame",
+                    "type": "string"
+                  },
+                  {
+                    "value": "follow-sensor",
+                    "type": "string"
+                  },
+                  {
+                    "value": "none",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"follow-both\"",
+              "fieldName": "followingMode"
+            },
             {
               "name": "hide-header",
               "description": "Indicates whether to display the video player's header information.",