@arcgis/map-components 4.34.0-next.163 → 4.34.0-next.164

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-10-13T04:30:52",
+  "timestamp": "2025-10-14T04:31:13",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.163",
+    "version": "4.34.0-next.164",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -4984,6 +4984,12 @@
                   ]
                 }
               },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ],
               "signature": "(bookmark: __esri.Bookmark): Promise<void>"
             },
             {
@@ -5034,6 +5040,10 @@
                   "name": "see",
                   "text": "[Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)"
                 },
+                {
+                  "name": "since",
+                  "text": "4.34"
+                },
                 {
                   "name": "example",
                   "text": "```js\n// \"No bookmarks\" will render as an <h3>\nbookmarksElement.headingLevel = 3;\n```"
@@ -5144,7 +5154,13 @@
               "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -5820,7 +5836,7 @@
           "events": [
             {
               "name": "arcgisBookmarkEdit",
-              "description": "\nFires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.",
+              "description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.",
               "type": {
                 "text": "BookmarksBookmarkEditEvent",
                 "references": [
@@ -5834,6 +5850,10 @@
                 ]
               },
               "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                },
                 {
                   "name": "example",
                   "text": "```js\n// once an edit has been made, enable the \"Save Webmap\" button\n//    to allow the user to save their changes\nbookmarksElement.addEventListener(\"arcgisBookmarkEdit\", (event) => {\n   saveBtn.disabled = false;\n});\n```"
@@ -5856,6 +5876,10 @@
                 ]
               },
               "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                },
                 {
                   "name": "example",
                   "text": "```html\n<arcgis-expand expanded>\n <arcgis-bookmarks></arcgis-bookmarks>\n</arcgis-expand>\n```\n\n```js\nconst bookmarksElement = document.querySelector(\"arcgis-bookmarks\");\nconst expandElement = document.querySelector(\"arcgis-expand\");\n\n// collapses the associated Expand component\n// when a bookmark is selected\nbookmarksElement.addEventListener(\"arcgisBookmarkSelect\", (event) => {\n  expandElement.expanded = false;\n});\n```"
@@ -9486,7 +9510,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "direct-shadows-disabled"
+              "attribute": "direct-shadows-disabled",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -9666,6 +9696,12 @@
                 ]
               },
               "attribute": "local-date",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ],
               "getterType": {
                 "text": "Date"
               }
@@ -9690,7 +9726,13 @@
                   }
                 ]
               },
-              "attribute": "playing-state"
+              "attribute": "playing-state",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -9825,7 +9867,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "sunlighting-disabled"
+              "attribute": "sunlighting-disabled",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -9839,7 +9887,13 @@
                 ]
               },
               "default": "false",
-              "readonly": true
+              "readonly": true,
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -9858,6 +9912,10 @@
                 {
                   "name": "example",
                   "text": "viewElement.environment.lighting = new SunLighting({\n  date: new Date(\"2022-06-21T12:00:00\")\n});"
+                },
+                {
+                  "name": "since",
+                  "text": "4.34"
                 }
               ]
             },
@@ -9888,7 +9946,13 @@
                   }
                 ]
               },
-              "attribute": "utc-offset"
+              "attribute": "utc-offset",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -15209,7 +15273,13 @@
                     "end": 23
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "name": "arcgisSketchUpdate",
@@ -15225,7 +15295,13 @@
                     "end": 23
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             }
           ]
         }
@@ -17954,7 +18030,13 @@
               "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -18195,6 +18277,12 @@
               "readonly": true,
               "attribute": "state",
               "reflects": true,
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ],
               "docsOnlyReadonly": true
             },
             {
@@ -18957,7 +19045,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "hide-attachments-content"
+              "attribute": "hide-attachments-content",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -19094,7 +19188,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "hide-expression-content"
+              "attribute": "hide-expression-content",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -19109,7 +19209,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "hide-fields-content"
+              "attribute": "hide-fields-content",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -19176,7 +19282,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "hide-media-content"
+              "attribute": "hide-media-content",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -19191,7 +19303,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "hide-text-content"
+              "attribute": "hide-text-content",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -19324,7 +19442,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Overwrite localized strings for this component.",
+              "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               },
@@ -19743,7 +19861,13 @@
                     "end": 16
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             }
           ],
           "attributes": [
@@ -25236,7 +25360,7 @@
           "customElement": true,
           "name": "ArcgisFeatures",
           "tagName": "arcgis-features",
-          "description": "The Features component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without having to be tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html),\nhowever unlike Popup, the Features component can be placed outside of the map or scene component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),\nthe [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features component, the same information that Popup provides is shown in a separate container from the map, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. If wanting to show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/) component.",
+          "description": "The Features component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without having to be tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component,\nhowever unlike Popup, the Features component can be placed outside of the map or scene component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features component, the same information that Popup provides is shown in a separate container from the map, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. If wanting to show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/) component.",
           "demos": [
             {
               "description": "Docs",
@@ -25503,7 +25627,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "default-popup-template-enabled"
+              "attribute": "default-popup-template-enabled",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "method",
@@ -25581,7 +25711,13 @@
                   }
                 ]
               },
-              "attribute": "feature-menu-title"
+              "attribute": "feature-menu-title",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -25836,6 +25972,10 @@
                   "name": "see",
                   "text": "[headingLevel](#headingLevel)"
                 },
+                {
+                  "name": "since",
+                  "text": "4.34"
+                },
                 {
                   "name": "example",
                   "text": "```js\n// This title will display in the component unless a selected feature's\n// PopupTemplate overrides it.\nfeaturesComponent.title = \"Population by zip codes in Southern California\";\n```"
@@ -25921,7 +26061,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "hide-feature-list-layer-title"
+              "attribute": "hide-feature-list-layer-title",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -25956,7 +26102,7 @@
             {
               "kind": "field",
               "name": "hideFlow",
-              "description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the widget if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
+              "description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the component if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -26052,7 +26198,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "include-default-actions-disabled"
+              "attribute": "include-default-actions-disabled",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -26130,7 +26282,13 @@
               "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "method",
@@ -26502,6 +26660,12 @@
                   ]
                 }
               },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ],
               "signature": "(): Promise<void>",
               "async": true
             },
@@ -26699,12 +26863,18 @@
                     "end": 17
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
               "name": "visible",
-              "description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the popup is visible and is not",
+              "description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the component is visible.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -26714,7 +26884,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "visible"
+              "attribute": "visible",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             }
           ],
           "attributes": [
@@ -26977,7 +27153,7 @@
             },
             {
               "name": "hide-flow",
-              "description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the widget if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
+              "description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the component if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -27210,7 +27386,7 @@
             },
             {
               "name": "visible",
-              "description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the popup is visible and is not",
+              "description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the component is visible.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -32726,10 +32902,16 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Overwrite localized strings for this component",
+              "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -34019,7 +34201,13 @@
                     "end": 19
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -34751,7 +34939,7 @@
             {
               "kind": "field",
               "name": "popupDisabled",
-              "description": "Controls whether the popup opens when users click on the view.",
+              "description": "Controls whether the popup opens automatically when users click on the view.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -35298,6 +35486,12 @@
                   ]
                 }
               },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ],
               "signature": "(analysis: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>",
               "async": true
             },
@@ -35447,7 +35641,7 @@
             },
             {
               "name": "popup-disabled",
-              "description": "Controls whether the popup opens when users click on the view.",
+              "description": "Controls whether the popup opens automatically when users click on the view.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -35611,7 +35805,13 @@
                     "end": 27
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "name": "arcgisViewAnalysisViewCreateError",
@@ -35627,7 +35827,13 @@
                     "end": 32
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "name": "arcgisViewAnalysisViewDestroy",
@@ -35643,7 +35849,13 @@
                     "end": 28
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "name": "arcgisViewChange",
@@ -37692,7 +37904,13 @@
                     "end": 19
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -38602,7 +38820,7 @@
             {
               "kind": "field",
               "name": "popupDisabled",
-              "description": "Controls whether the popup opens when users click on the view.",
+              "description": "Controls whether the popup opens automatically when users click on the view.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -39245,6 +39463,12 @@
                   ]
                 }
               },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ],
               "signature": "(analysis: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>",
               "async": true
             },
@@ -39407,7 +39631,7 @@
             },
             {
               "name": "popup-disabled",
-              "description": "Controls whether the popup opens when users click on the view.",
+              "description": "Controls whether the popup opens automatically when users click on the view.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -39585,7 +39809,13 @@
                     "end": 27
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "name": "arcgisViewAnalysisViewCreateError",
@@ -39601,7 +39831,13 @@
                     "end": 32
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "name": "arcgisViewAnalysisViewDestroy",
@@ -39617,7 +39853,13 @@
                     "end": 28
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "name": "arcgisViewChange",
@@ -42432,7 +42674,7 @@
           "customElement": true,
           "name": "ArcgisPopup",
           "tagName": "arcgis-popup",
-          "description": "## Overview\nThe Popup component allows users to view content from feature attributes. Popups enhance web applications\nby providing users with a simple way to interact with and view attributes in a layer.\nThey play an important role in relaying information to the user, which improves the storytelling capabilities of the application.\n\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), and [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components currently use the [Popup widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) by default.\nTo enable the Popup component, first disable the popup widget via the `popup-disabled` attribute on Map, Scene, or LinkChart, then add the Popup component.\nOnce added, there are two ways to open the Popup component: automatically when features are clicked, or manually by calling the popup component's [open()](#open) method.\n\n### Automatically open Popup when features are clicked\nThe Popup component can be opened automatically to display the selected feature's popup template when features in the Map, Scene, or Link Chart are clicked.\nTo configure this, add the Popup component to the `popup` slot of the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n```\n### Manually open Popup\nThe Popup component can also be opened manually by adding it to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/)'s default slot.\nFirst, set the `popup-disabled` attribute to `true` on the Map, Scene, or Link Chart, then call the popup component's [open()](#open) method and pass in a location.\nWhen the Map, Scene, or Link Chart is clicked, the Popup component will open with specified content at the clicked location.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n  <arcgis-popup></arcgis-popup>\n</arcgis-map>\n<script>\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst popupComponent = document.querySelector(\"arcgis-popup\");\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n  const { mapPoint } = event.detail;\n  popupComponent.open({\n    location: mapPoint,\n    heading: \"You clicked here\",\n    content: \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3)\n  });\n});\n</script>\n```\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](#heading)\nand [content](#content) properties.\nWhen  content is set directly on the Popup instance it is not tied to a specific feature or layer.\n\n![popup-basic-example](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/popup/popup-basic.png)\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](#heading).\nThe remaining text is the popup's [content](#content).\nA dock button is displayed in the top right corner of the popup allowing the user to dock the popup to one of the sides or corners of the view.\nThe options for docking may be set in the [dockOptions](#dockOptions) property.\nThe popup may also be collapsed by clicking the collapse button (the down arrow icon) in the top right corner of the popup.\nWhen collapsed, only the heading of the popup displays.\nThe popup may be closed by clicking the close button (the \"x\" icon) in the top right corner of the popup.\n\nPopups can also contain [actions](#actions) which execute a function defined by the developer when clicked.\nBy default, every popup has a \"Zoom to\" action (as shown in the image above with the magnifying glass) that allows users to zoom to the selected feature.\nSee the [actions](#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) component, whether it's docked or anchored to the selected feature.\nIf wanting to utilize the Popup functionality outside of [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component can be used to display the same content\nin its own container.\n\n## Popup and PopupTemplate\n[PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)\nand [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Popup templates allow you to define custom titles and content templates based on the source of the\n[selected feature](#selectedFeature). When a layer or a graphic has a defined\npopup template, the popup will display the content defined in the popup template when the feature is clicked.\nThe content may contain field values from the attributes of the [selected feature](#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) on the\n[features](#features) property.",
+          "description": "## Overview\nThe Popup component allows users to view content from feature attributes. Popups enhance web applications\nby providing users with a simple way to interact with and view attributes in a layer.\nThey play an important role in relaying information to the user, which improves the storytelling capabilities of the application.\n\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), and [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components currently use the [Popup widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) by default.\nTo use the Popup component, add it to the [arcgis-map.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#popup), [arcgis-scene.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup), or [arcgis-link-chart.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#popup) component using the `popup` slot.\nThe Popup component will be opened automatically to display the selected feature's popup template when features in the Map, Scene, or Link Chart are clicked.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\">\n  <!-- Add the popup component to the popup slot. -->\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n```\nThe Popup component can also be opened manually at a specific location with custom content specified in the method parameters using the `open()` method.\nTo prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true`.\n\n```html\n<!-- Set popup-disabled attribute -->\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n  <!-- Add the popup component to the popup slot. -->\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n<script>\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst popupComponent = document.querySelector(\"arcgis-popup\");\n// Listen for clicks on the view and open the popup at the clicked location with custom content.\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n  const { mapPoint } = event.detail;\n  popupComponent.open({\n    location: mapPoint,\n    heading: \"You clicked here\",\n    content: \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3)\n  });\n});\n</script>\n```\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](#heading)\nand [content](#content) properties.\nWhen  content is set directly on the Popup instance it is not tied to a specific feature or layer.\n\n![popup-basic-example](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/popup/popup-basic.png)\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](#heading).\nThe remaining text is the popup's [content](#content).\nA dock button is displayed in the top right corner of the popup allowing the user to dock the popup to one of the sides or corners of the view.\nThe options for docking may be set in the [dockOptions](#dockOptions) property.\nThe popup may also be collapsed by clicking the collapse button (the down arrow icon) in the top right corner of the popup.\nWhen collapsed, only the heading of the popup displays.\nThe popup may be closed by clicking the close button (the \"x\" icon) in the top right corner of the popup.\n\nPopups can also contain [actions](#actions) which execute a function defined by the developer when clicked.\nBy default, every popup has a \"Zoom to\" action (as shown in the image above with the magnifying glass) that allows users to zoom to the selected feature.\nSee the [actions](#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) component, whether it's docked or anchored to the selected feature.\nIf wanting to utilize the Popup functionality outside of [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component can be used to display the same content\nin its own container.\n\n## Popup and PopupTemplate\n[PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)\nand [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Popup templates allow you to define custom titles and content templates based on the source of the\n[selected feature](#selectedFeature). When a layer or a graphic has a defined\npopup template, the popup will display the content defined in the popup template when the feature is clicked.\nThe content may contain field values from the attributes of the [selected feature](#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) on the\n[features](#features) property.",
           "demos": [
             {
               "description": "Docs",
@@ -43686,7 +43928,7 @@
             {
               "kind": "method",
               "name": "setFocus",
-              "description": "Use this method to give focus to the Widget if the widget is able to be focused.",
+              "description": "Use this method to give focus to the component if the component is able to be focused.",
               "return": {
                 "type": {
                   "text": "Promise<void>",
@@ -43819,7 +44061,7 @@
             {
               "kind": "field",
               "name": "visible",
-              "description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible and is not.",
+              "description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -44248,7 +44490,7 @@
             },
             {
               "name": "visible",
-              "description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible and is not.",
+              "description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -46225,7 +46467,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "show-world-value"
+              "attribute": "show-world-value",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -47943,7 +48191,7 @@
             {
               "kind": "field",
               "name": "popupDisabled",
-              "description": "Controls whether the popup opens when users click on the view.",
+              "description": "Controls whether the popup opens automatically when users click on the view.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -48800,7 +49048,7 @@
             },
             {
               "name": "popup-disabled",
-              "description": "Controls whether the popup opens when users click on the view.",
+              "description": "Controls whether the popup opens automatically when users click on the view.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -55823,7 +56071,13 @@
                     "type": "WebMap"
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -57759,6 +58013,10 @@
               "attribute": "icon",
               "reflects": true,
               "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                },
                 {
                   "name": "see",
                   "text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
@@ -60727,7 +60985,13 @@
                   }
                 ]
               },
-              "readonly": true
+              "readonly": true,
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.34"
+                }
+              ]
             },
             {
               "kind": "field",