@arcgis/map-components 4.33.0-next.118 → 4.33.0-next.119

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-05-08T04:55:37",
+  "timestamp": "2025-05-09T04:55:29",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.118",
+    "version": "4.33.0-next.119",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -2247,6 +2247,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "closed",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "closed",
+          "reflectToAttr": false,
+          "docs": "Indicates whether a component is visible.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "collapsed",
           "type": "boolean",
@@ -3611,6 +3633,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "closed",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "closed",
+          "reflectToAttr": false,
+          "docs": "Indicates whether a component is visible.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "defaultCreateOptions",
           "type": "BookmarkOptions",
@@ -4869,6 +4913,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "closed",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "closed",
+          "reflectToAttr": false,
+          "docs": "Indicates whether a component is visible.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "collapsed",
           "type": "boolean",
@@ -7322,6 +7388,25 @@
           "composed": true,
           "docs": "Emitted when the component associated with a map or scene view is is ready to be interacted with.",
           "docsTags": []
+        },
+        {
+          "event": "arcgisUserDateTimeChange",
+          "detail": "undefined",
+          "bubbles": true,
+          "complexType": {
+            "original": "undefined",
+            "resolved": "undefined",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Fires when the user changes the date or time in the widget by interacting with the slider, the date picker, the\nseason selector or the play buttons.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.33"
+            }
+          ]
         }
       ],
       "styles": [],
@@ -11541,7 +11626,7 @@
           "docs": "Disables focus trapping within the expand widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)",
           "docsTags": [],
           "default": "false",
-          "deprecation": "**Deprecated** since 4.33. Use [`focusTrapDisabled`](#focusTrapDisabled) instead.",
+          "deprecation": "since 4.33. Use [`focusTrapDisabled`](#focusTrapDisabled) instead.",
           "values": [
             {
               "type": "boolean"
@@ -12249,7 +12334,7 @@
           "docs": "",
           "docsTags": [],
           "default": "false",
-          "deprecation": "**Deprecated** since 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead.",
+          "deprecation": "since 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead.",
           "values": [
             {
               "type": "boolean"
@@ -16669,6 +16754,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "closed",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "closed",
+          "reflectToAttr": false,
+          "docs": "Indicates whether a component is visible.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "collapsed",
           "type": "boolean",
@@ -20766,6 +20873,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "closed",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "closed",
+          "reflectToAttr": false,
+          "docs": "Indicates whether a component is visible.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "collapsed",
           "type": "boolean",
@@ -22271,7 +22400,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "The line of sight analysis object being created or modified by the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#analysis)",
+          "docs": "",
           "docsTags": [
             {
               "name": "readonly",
@@ -22314,8 +22443,8 @@
           },
           "mutable": true,
           "attr": "icon",
-          "reflectToAttr": false,
-          "docs": "Icon which represents the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#icon)",
+          "reflectToAttr": true,
+          "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",
@@ -22342,7 +22471,7 @@
           "mutable": true,
           "attr": "label",
           "reflectToAttr": false,
-          "docs": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.html#label)",
+          "docs": "The component's default label.",
           "docsTags": [],
           "values": [
             {
@@ -22462,16 +22591,14 @@
             "references": {}
           },
           "mutable": true,
-          "attr": "state",
-          "reflectToAttr": true,
-          "docs": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight-LineOfSightViewModel.html#state)",
+          "reflectToAttr": false,
+          "docs": "",
           "docsTags": [
             {
               "name": "readonly",
               "text": ""
             }
           ],
-          "default": "\"disabled\"",
           "values": [
             {
               "value": "created",
@@ -22492,6 +22619,32 @@
           ],
           "optional": true,
           "required": false
+        },
+        {
+          "name": "supported",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "readonly",
+              "text": ""
+            }
+          ],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
         }
       ],
       "methods": [
@@ -23689,7 +23842,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection."
+          "deprecation": "since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection."
         },
         {
           "name": "addLayers",
@@ -23745,7 +23898,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection."
+          "deprecation": "since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection."
         },
         {
           "name": "closePopup",
@@ -26670,7 +26823,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection."
+          "deprecation": "since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection."
         },
         {
           "name": "addLayers",
@@ -26726,7 +26879,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection."
+          "deprecation": "since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection."
         },
         {
           "name": "addTable",
@@ -26767,7 +26920,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection."
+          "deprecation": "since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection."
         },
         {
           "name": "addTables",
@@ -26823,7 +26976,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection."
+          "deprecation": "since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection."
         },
         {
           "name": "closePopup",
@@ -32478,7 +32631,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection."
+          "deprecation": "since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection."
         },
         {
           "name": "addLayers",
@@ -32534,7 +32687,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection."
+          "deprecation": "since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection."
         },
         {
           "name": "addTable",
@@ -32575,7 +32728,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection."
+          "deprecation": "since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection."
         },
         {
           "name": "addTables",
@@ -32631,7 +32784,7 @@
           ],
           "docs": "",
           "docsTags": [],
-          "deprecation": "**Deprecated** since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection."
+          "deprecation": "since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection."
         },
         {
           "name": "closePopup",
@@ -34390,11 +34543,11 @@
           "docsTags": [
             {
               "name": "see",
-              "text": "[Event: select-result](#event-select-result)"
+              "text": "[arcgisSelectResult](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/#arcgisSelectResult)"
             },
             {
               "name": "see",
-              "text": "[select()](#select)"
+              "text": "[select()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#select)"
             },
             {
               "name": "readonly",
@@ -39640,6 +39793,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "closed",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "closed",
+          "reflectToAttr": false,
+          "docs": "Indicates whether a component is visible.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "collapsed",
           "type": "boolean",
@@ -42950,7 +43125,7 @@
           "docs": "",
           "docsTags": [],
           "default": "false",
-          "deprecation": "**Deprecated** since 4.32. Use hideConnectivityAssociationsSettingsArrowsToggle instead",
+          "deprecation": "since 4.32. Use hideConnectivityAssociationsSettingsArrowsToggle instead",
           "values": [
             {
               "type": "boolean"
@@ -42973,7 +43148,7 @@
           "docs": "",
           "docsTags": [],
           "default": "false",
-          "deprecation": "**Deprecated** since 4.32. Use hideConnectivityAssociationsSettingsCapSelect instead",
+          "deprecation": "since 4.32. Use hideConnectivityAssociationsSettingsCapSelect instead",
           "values": [
             {
               "type": "boolean"
@@ -42996,7 +43171,7 @@
           "docs": "",
           "docsTags": [],
           "default": "true",
-          "deprecation": "**Deprecated** since 4.32. Use hideConnectivityAssociationsSettingsColorPicker instead",
+          "deprecation": "since 4.32. Use hideConnectivityAssociationsSettingsColorPicker instead",
           "values": [
             {
               "type": "boolean"
@@ -43019,7 +43194,7 @@
           "docs": "",
           "docsTags": [],
           "default": "true",
-          "deprecation": "**Deprecated** since 4.32. Use hideConnectivityAssociationsSettingsStylePicker instead",
+          "deprecation": "since 4.32. Use hideConnectivityAssociationsSettingsStylePicker instead",
           "values": [
             {
               "type": "boolean"
@@ -43042,7 +43217,7 @@
           "docs": "",
           "docsTags": [],
           "default": "true",
-          "deprecation": "**Deprecated** since 4.32. Use hideConnectivityAssociationsSettingsWidthInput instead",
+          "deprecation": "since 4.32. Use hideConnectivityAssociationsSettingsWidthInput instead",
           "values": [
             {
               "type": "boolean"
@@ -43065,7 +43240,7 @@
           "docs": "",
           "docsTags": [],
           "default": "false",
-          "deprecation": "**Deprecated** since 4.32. Use hideMaxAllowableAssociationsSlider instead",
+          "deprecation": "since 4.32. Use hideMaxAllowableAssociationsSlider instead",
           "values": [
             {
               "type": "boolean"
@@ -43088,7 +43263,7 @@
           "docs": "",
           "docsTags": [],
           "default": "false",
-          "deprecation": "**Deprecated** since 4.32. Use hideStructuralAttachmentAssociationsSettingsArrowsToggle instead",
+          "deprecation": "since 4.32. Use hideStructuralAttachmentAssociationsSettingsArrowsToggle instead",
           "values": [
             {
               "type": "boolean"
@@ -43111,7 +43286,7 @@
           "docs": "",
           "docsTags": [],
           "default": "false",
-          "deprecation": "**Deprecated** since 4.32. Use hideStructuralAttachmentAssociationsSettingsCapSelect instead",
+          "deprecation": "since 4.32. Use hideStructuralAttachmentAssociationsSettingsCapSelect instead",
           "values": [
             {
               "type": "boolean"
@@ -43134,7 +43309,7 @@
           "docs": "",
           "docsTags": [],
           "default": "true",
-          "deprecation": "**Deprecated** since 4.32. Use hideStructuralAttachmentAssociationsSettingsColorPicker instead",
+          "deprecation": "since 4.32. Use hideStructuralAttachmentAssociationsSettingsColorPicker instead",
           "values": [
             {
               "type": "boolean"
@@ -43157,7 +43332,7 @@
           "docs": "",
           "docsTags": [],
           "default": "true",
-          "deprecation": "**Deprecated** since 4.32. Use hideStructuralAttachmentAssociationsSettingsStylePicker instead",
+          "deprecation": "since 4.32. Use hideStructuralAttachmentAssociationsSettingsStylePicker instead",
           "values": [
             {
               "type": "boolean"
@@ -43180,7 +43355,7 @@
           "docs": "",
           "docsTags": [],
           "default": "true",
-          "deprecation": "**Deprecated** since 4.32. Use hideStructuralAttachmentAssociationsSettingsWidthInput instead",
+          "deprecation": "since 4.32. Use hideStructuralAttachmentAssociationsSettingsWidthInput instead",
           "values": [
             {
               "type": "boolean"
@@ -45635,7 +45810,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.",
+      "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```",
       "docsTags": [
         {
           "name": "superclass",
@@ -45850,7 +46025,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known Limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.",
+      "docs": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known Limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[![](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/video-player-video-preview.png)](https://mediaspace.esri.com/media/1_ctc3psfr)\n\n**Example**\n\n```html\n<arcgis-map>\n  <arcgis-video-player></arcgis-video-player>\n</arcgis-map>\n```\n\n```js\nconst [Map, VideoLayer] = await $arcgis.import([\n  \"@arcgis/core/Map.js\",\n  \"@arcgis/core/layers/VideoLayer.js\",\n]);\n\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst videoPlayerElement = document.querySelector(\"arcgis-video-player\");\n\nconst videoLayer = new VideoLayer({\n  url: \"YOUR_VIDEO_LAYER_URL\",\n});\n\nviewElement.map = new Map({\n  basemap: \"topo-vector\",\n  layers: [videoLayer],\n});\nawait viewElement.viewOnReady();\n\nawait videoLayer.load();\nif (videoLayer.loaded) {\n  videoPlayerElement.layer = videoLayer;\n}\n\nawait viewElement.whenLayerView(videoLayer);\nviewElement.goTo(videoLayer.fullExtent);\n```",
       "docsTags": [
         {
           "name": "superclass",
@@ -46875,13 +47050,9 @@
           "mutable": true,
           "attr": "state",
           "reflectToAttr": true,
-          "docs": "",
-          "docsTags": [
-            {
-              "name": "readonly",
-              "text": ""
-            }
-          ],
+          "docs": "The current state of the component.",
+          "docsTags": [],
+          "default": "\"disabled\"",
           "values": [
             {
               "value": "disabled",