@arcgis/map-components 4.34.0-next.157 → 4.34.0-next.159

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-10-06T04:31:15",
+  "timestamp": "2025-10-08T04:31:47",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.157",
+    "version": "4.34.0-next.159",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -9408,7 +9408,7 @@
             {
               "kind": "field",
               "name": "dateOrSeason",
-              "description": "Controls whether the component displays a date or a season picker.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)",
+              "description": "Controls whether the component displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed date corresponding to the equinoxes and solstices of 2014.",
               "type": {
                 "text": "\"date\" | \"season\"",
                 "values": [
@@ -9465,6 +9465,7 @@
             {
               "kind": "field",
               "name": "directShadowsDisabled",
+              "description": "Indicates whether to hide shadows cast by the sun.\n\n**See also**\n\n- [SunLighting.directShadowsEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#directShadowsEnabled)\n- [Scene's `environment`](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -9626,44 +9627,10 @@
               },
               "attribute": "label"
             },
-            {
-              "kind": "field",
-              "name": "lighting",
-              "type": {
-                "text": "SunLighting | VirtualLighting",
-                "references": [
-                  {
-                    "name": "SunLighting",
-                    "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
-                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html",
-                    "start": 0,
-                    "end": 11
-                  },
-                  {
-                    "name": "VirtualLighting",
-                    "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
-                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html",
-                    "start": 14,
-                    "end": 29
-                  }
-                ],
-                "values": [
-                  {
-                    "type": "SunLighting"
-                  },
-                  {
-                    "type": "VirtualLighting"
-                  }
-                ]
-              },
-              "readonly": true
-            },
             {
               "kind": "field",
               "name": "localDate",
-              "description": "The calendar date in the timezone given by [utcOffset](#utcOffset).\n\nThis property should only be set once the widget and the view are initialized, for example,\nfrom within an event handler. To initialize the view with a specific date and time, set a\n[SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) on the [SceneView.environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment).",
+              "description": "The calendar date in the timezone given by [utcOffset](#utcOffset).",
               "type": {
                 "text": "Date | number | string",
                 "references": [
@@ -9731,7 +9698,7 @@
               "docsTags": [
                 {
                   "name": "example",
-                  "text": "// Plays the daylight animation at half of the default speed\ndaylightWidget.playSpeedMultiplier = 0.5;"
+                  "text": "// Plays the daylight animation at half of the default speed\ndaylight.playSpeedMultiplier = 0.5;"
                 }
               ]
             },
@@ -9837,7 +9804,7 @@
             {
               "kind": "field",
               "name": "sunlightingDisabled",
-              "description": "Indicates whether date and time are used to determine position of the light source.\nWhen `false`, the light source is positioned relative to the camera, using [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html).",
+              "description": "Indicates whether date and time are used to determine position of the light source.\nWhen set, the light source is positioned relative to the camera, using [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -9866,7 +9833,7 @@
             {
               "kind": "field",
               "name": "timeSliderPosition",
-              "description": "Slider position for the time of day in the timezone\ngiven by [utcOffset](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.\n\nThis property should only be set once the widget and the view are initialized, for example,\nfrom within an event handler. To initialize the view with a specific date and time, set a\n[SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) on the [SceneView.environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment).",
+              "description": "Slider position for the time of day in the timezone\ngiven by [utcOffset](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.",
               "type": {
                 "text": "number",
                 "values": [
@@ -9886,7 +9853,7 @@
             {
               "kind": "field",
               "name": "timeSliderSteps",
-              "description": "Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.\nSets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb. All values are in minutes, where 0 is midnight and 23 * 60 + 59 is just before midnight the following day.\n\nIf an array of numbers is passed to this property, the slider thumbs may only be moved to the times specified in the array.\n\nIf a single number is set, then steps are set for the entire day at an interval of timeSliderSteps minutes. For example, if a value of 60 is set here, dragging the slider will allow selecting each of 24 hours of the day.",
+              "description": "Sets the interval, in minutes, with which the time slider increments or decrements as it is dragged or changed via the keyboard.\n\nFor example, if set to 60, the slider will allow selecting each hour of the day.",
               "type": {
                 "text": "number",
                 "values": [
@@ -9901,7 +9868,7 @@
             {
               "kind": "field",
               "name": "utcOffset",
-              "description": "The difference in hours between UTC time and the time displayed in the widget.",
+              "description": "The difference in hours between UTC time and the time displayed in the component.",
               "type": {
                 "text": "number",
                 "values": [
@@ -10015,7 +9982,7 @@
             },
             {
               "name": "date-or-season",
-              "description": "Controls whether the component displays a date or a season picker.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)",
+              "description": "Controls whether the component displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed date corresponding to the equinoxes and solstices of 2014.",
               "type": {
                 "text": "\"date\" | \"season\"",
                 "values": [
@@ -10048,6 +10015,7 @@
             },
             {
               "name": "direct-shadows-disabled",
+              "description": "Indicates whether to hide shadows cast by the sun.\n\n**See also**\n\n- [SunLighting.directShadowsEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#directShadowsEnabled)\n- [Scene's `environment`](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -10201,7 +10169,7 @@
             },
             {
               "name": "local-date",
-              "description": "The calendar date in the timezone given by [utcOffset](#utcOffset).\n\nThis property should only be set once the widget and the view are initialized, for example,\nfrom within an event handler. To initialize the view with a specific date and time, set a\n[SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) on the [SceneView.environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment).",
+              "description": "The calendar date in the timezone given by [utcOffset](#utcOffset).",
               "type": {
                 "text": "number | string",
                 "values": [
@@ -10311,7 +10279,7 @@
             },
             {
               "name": "sunlighting-disabled",
-              "description": "Indicates whether date and time are used to determine position of the light source.\nWhen `false`, the light source is positioned relative to the camera, using [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html).",
+              "description": "Indicates whether date and time are used to determine position of the light source.\nWhen set, the light source is positioned relative to the camera, using [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html).",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -10325,7 +10293,7 @@
             },
             {
               "name": "time-slider-position",
-              "description": "Slider position for the time of day in the timezone\ngiven by [utcOffset](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.\n\nThis property should only be set once the widget and the view are initialized, for example,\nfrom within an event handler. To initialize the view with a specific date and time, set a\n[SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) on the [SceneView.environment](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment).",
+              "description": "Slider position for the time of day in the timezone\ngiven by [utcOffset](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.",
               "type": {
                 "text": "number",
                 "values": [
@@ -10338,7 +10306,7 @@
             },
             {
               "name": "time-slider-steps",
-              "description": "Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.\nSets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb. All values are in minutes, where 0 is midnight and 23 * 60 + 59 is just before midnight the following day.\n\nIf an array of numbers is passed to this property, the slider thumbs may only be moved to the times specified in the array.\n\nIf a single number is set, then steps are set for the entire day at an interval of timeSliderSteps minutes. For example, if a value of 60 is set here, dragging the slider will allow selecting each of 24 hours of the day.",
+              "description": "Sets the interval, in minutes, with which the time slider increments or decrements as it is dragged or changed via the keyboard.\n\nFor example, if set to 60, the slider will allow selecting each hour of the day.",
               "type": {
                 "text": "number",
                 "values": [
@@ -10352,7 +10320,7 @@
             },
             {
               "name": "utc-offset",
-              "description": "The difference in hours between UTC time and the time displayed in the widget.",
+              "description": "The difference in hours between UTC time and the time displayed in the component.",
               "type": {
                 "text": "number",
                 "values": [
@@ -14725,7 +14693,7 @@
               "name": "state",
               "description": "The current state of the component.",
               "type": {
-                "text": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"creating-features\" | \"disabled\" | \"drawing-splitter-geometry\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-features\" | \"ready\" | \"reviewing-features\" | \"viewing-selection-list\"",
+                "text": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"choosing-key-feature\" | \"creating-features\" | \"disabled\" | \"drawing-splitter-geometry\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-features\" | \"ready\" | \"reviewing-features\" | \"viewing-selection-list\"",
                 "values": [
                   {
                     "value": "add-association-create-association",
@@ -14759,6 +14727,10 @@
                     "value": "awaiting-update-feature-candidate",
                     "type": "string"
                   },
+                  {
+                    "value": "choosing-key-feature",
+                    "type": "string"
+                  },
                   {
                     "value": "creating-features",
                     "type": "string"
@@ -15113,7 +15085,7 @@
               "name": "state",
               "description": "The current state of the component.",
               "type": {
-                "text": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"creating-features\" | \"disabled\" | \"drawing-splitter-geometry\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-features\" | \"ready\" | \"reviewing-features\" | \"viewing-selection-list\"",
+                "text": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"choosing-key-feature\" | \"creating-features\" | \"disabled\" | \"drawing-splitter-geometry\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-features\" | \"ready\" | \"reviewing-features\" | \"viewing-selection-list\"",
                 "values": [
                   {
                     "value": "add-association-create-association",
@@ -15147,6 +15119,10 @@
                     "value": "awaiting-update-feature-candidate",
                     "type": "string"
                   },
+                  {
+                    "value": "choosing-key-feature",
+                    "type": "string"
+                  },
                   {
                     "value": "creating-features",
                     "type": "string"
@@ -17971,7 +17947,7 @@
             {
               "kind": "field",
               "name": "mode",
-              "description": "The mode in which the component displays. These modes are listed below.\n\n| mode         | description |\n|--------------|-------------|\n| auto         | This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application. |\n| floating     | Use this mode if you wish to always display the component as floating regardless of browser size. |\n| drawer       | Use this mode if you wish to always display the component in a panel regardless of browser size. |",
+              "description": "The mode in which the component displays. These modes are listed below:\n\n- `auto`: This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application.\n- `floating`: Use this mode if you wish to always display the component as floating in a [Calcite Popover component](https://developers.arcgis.com/calcite-design-system/components/popover/) regardless of browser size.\n- `drawer`: Use this mode if you wish to always display the component in a [Calcite Sheet component](https://developers.arcgis.com/calcite-design-system/components/sheet/) regardless of browser size.",
               "type": {
                 "text": "\"auto\" | \"drawer\" | \"floating\"",
                 "values": [
@@ -17995,7 +17971,7 @@
             {
               "kind": "field",
               "name": "placement",
-              "description": "The placement used by the [calcite popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
+              "description": "The placement used by the [Calcite Popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
               "type": {
                 "text": "\"auto\" | \"auto-end\" | \"auto-start\" | \"bottom\" | \"bottom-end\" | \"bottom-start\" | \"leading\" | \"leading-end\" | \"leading-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\" | \"trailing\" | \"trailing-end\" | \"trailing-start\"",
                 "values": [
@@ -18428,7 +18404,7 @@
             },
             {
               "name": "mode",
-              "description": "The mode in which the component displays. These modes are listed below.\n\n| mode         | description |\n|--------------|-------------|\n| auto         | This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application. |\n| floating     | Use this mode if you wish to always display the component as floating regardless of browser size. |\n| drawer       | Use this mode if you wish to always display the component in a panel regardless of browser size. |",
+              "description": "The mode in which the component displays. These modes are listed below:\n\n- `auto`: This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application.\n- `floating`: Use this mode if you wish to always display the component as floating in a [Calcite Popover component](https://developers.arcgis.com/calcite-design-system/components/popover/) regardless of browser size.\n- `drawer`: Use this mode if you wish to always display the component in a [Calcite Sheet component](https://developers.arcgis.com/calcite-design-system/components/sheet/) regardless of browser size.",
               "type": {
                 "text": "\"auto\" | \"drawer\" | \"floating\"",
                 "values": [
@@ -18451,7 +18427,7 @@
             },
             {
               "name": "placement",
-              "description": "The placement used by the [calcite popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
+              "description": "The placement used by the [Calcite Popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
               "type": {
                 "text": "\"auto\" | \"auto-end\" | \"auto-start\" | \"bottom\" | \"bottom-end\" | \"bottom-start\" | \"leading\" | \"leading-end\" | \"leading-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\" | \"trailing\" | \"trailing-end\" | \"trailing-start\"",
                 "values": [
@@ -35605,7 +35581,7 @@
                 },
                 {
                   "name": "example",
-                  "text": "```js\n      viewElement.addEventListener(\"arcgisLoadError\", () => {\n        console.log(viewElement.loadErrorSources);\n      });\n     ```"
+                  "text": "```js\nviewElement.addEventListener(\"arcgisLoadError\", () => {\n  console.log(viewElement.loadErrorSources);\n});\n```"
                 }
               ]
             },
@@ -35970,7 +35946,7 @@
                 },
                 {
                   "name": "example",
-                  "text": "```js\n      viewElement.addEventListener(\"arcgisViewReadyError\", () => {\n        // handle error\n      });\n     ```"
+                  "text": "```js\nviewElement.addEventListener(\"arcgisViewReadyError\", () => {\n  // handle error\n});\n```"
                 }
               ]
             }
@@ -39579,7 +39555,7 @@
                 },
                 {
                   "name": "example",
-                  "text": "```js\n      viewElement.addEventListener(\"arcgisLoadError\", () => {\n        console.log(viewElement.loadErrorSources);\n      });\n     ```"
+                  "text": "```js\nviewElement.addEventListener(\"arcgisLoadError\", () => {\n  console.log(viewElement.loadErrorSources);\n});\n```"
                 }
               ]
             },
@@ -39944,7 +39920,7 @@
                 },
                 {
                   "name": "example",
-                  "text": "```js\n      viewElement.addEventListener(\"arcgisViewReadyError\", () => {\n        // handle error\n      });\n     ```"
+                  "text": "```js\nviewElement.addEventListener(\"arcgisViewReadyError\", () => {\n  // handle error\n});\n```"
                 }
               ]
             }
@@ -48924,7 +48900,7 @@
                 },
                 {
                   "name": "example",
-                  "text": "```js\n      viewElement.addEventListener(\"arcgisLoadError\", () => {\n        console.log(viewElement.loadErrorSources);\n      });\n     ```"
+                  "text": "```js\nviewElement.addEventListener(\"arcgisLoadError\", () => {\n  console.log(viewElement.loadErrorSources);\n});\n```"
                 }
               ]
             },
@@ -49289,7 +49265,7 @@
                 },
                 {
                   "name": "example",
-                  "text": "```js\n      viewElement.addEventListener(\"arcgisViewReadyError\", () => {\n        // handle error\n      });\n     ```"
+                  "text": "```js\nviewElement.addEventListener(\"arcgisViewReadyError\", () => {\n  // handle error\n});\n```"
                 }
               ]
             }
@@ -57755,6 +57731,28 @@
               "attribute": "expanded",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "icon",
+              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"time-zone\"",
+              "attribute": "icon",
+              "reflects": true,
+              "docsTags": [
+                {
+                  "name": "see",
+                  "text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
+                }
+              ]
+            },
             {
               "kind": "field",
               "name": "label",
@@ -57775,16 +57773,7 @@
               "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": "property",
-                  "text": "({ reflect: true })\nicon?: HTMLCalciteIconElement[\"icon\"] = \"time-zone\";\n\n/**"
-                },
-                {
-                  "name": "copyDoc"
-                }
-              ]
+              }
             },
             {
               "kind": "field",
@@ -57896,11 +57885,26 @@
                   }
                 ]
               },
-              "default": "\"disabled\"",
               "readonly": true,
               "attribute": "state",
-              "reflects": true,
-              "docsOnlyReadonly": true
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "view",
+              "type": {
+                "text": "MapView",
+                "references": [
+                  {
+                    "name": "MapView",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html",
+                    "start": 0,
+                    "end": 7
+                  }
+                ]
+              }
             }
           ],
           "attributes": [
@@ -57950,6 +57954,20 @@
               "default": "false",
               "fieldName": "expanded"
             },
+            {
+              "name": "icon",
+              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"time-zone\"",
+              "fieldName": "icon"
+            },
             {
               "name": "label",
               "description": "The component's default label.",
@@ -58037,7 +58055,6 @@
                   }
                 ]
               },
-              "default": "\"disabled\"",
               "fieldName": "state"
             }
           ],