@arcgis/map-components 4.34.0-next.114 → 4.34.0-next.116

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-08-28T04:41:49",
+  "timestamp": "2025-08-30T04:38:34",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.114",
+    "version": "4.34.0-next.116",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -406,7 +406,7 @@
               "name": "unitOptions",
               "description": "List of available units and unit systems (imperial, metric) for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions)",
               "type": {
-                "text": "Array<\"metric\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\" | \"imperial\">",
+                "text": "Array<\"metric\" | \"imperial\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\">",
                 "references": [
                   {
                     "name": "Array",
@@ -1049,7 +1049,7 @@
               "name": "unitOptions",
               "description": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](#unit) values can only be a subset of this list.",
               "type": {
-                "text": "Array<\"metric\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\" | \"imperial\">",
+                "text": "Array<\"metric\" | \"imperial\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\">",
                 "references": [
                   {
                     "name": "Array",
@@ -8659,7 +8659,6 @@
           "customElement": true,
           "name": "ArcgisDaylight",
           "tagName": "arcgis-daylight",
-          "description": "The Daylight component can be used to manipulate the lighting conditions of a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n**Known limitations**\n\nDaylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [Environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)",
           "demos": [
             {
               "description": "Docs",
@@ -8726,7 +8725,7 @@
             {
               "kind": "field",
               "name": "currentSeason",
-              "description": "A season can be set instead of a date.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#currentSeason)",
+              "description": "A season can be set instead of a date.\nEach season uses a fixed date corresponding to the seasonal equinoxes and solstices.",
               "type": {
                 "text": "\"fall\" | \"spring\" | \"summer\" | \"winter\"",
                 "values": [
@@ -8768,12 +8767,13 @@
                 ]
               },
               "default": "\"date\"",
-              "attribute": "date-or-season"
+              "attribute": "date-or-season",
+              "reflects": true
             },
             {
               "kind": "field",
               "name": "dayPlaying",
-              "description": "Starts or pauses the daytime animation cycling through the minutes of the day.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#dayPlaying)",
+              "description": "Starts or pauses the daytime animation cycling through the minutes of the day.\nSet to `true` to start the animation and to `false` to pause it.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -8806,19 +8806,54 @@
               "signature": "(): Promise<void>",
               "async": true
             },
+            {
+              "kind": "field",
+              "name": "directShadowsEnabled",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "direct-shadows-enabled"
+            },
             {
               "kind": "field",
               "name": "headingLevel",
               "description": "Indicates the heading level to use for the component title.",
               "type": {
-                "text": "number",
+                "text": "1 | 2 | 3 | 4 | 5 | 6",
                 "values": [
                   {
+                    "value": "1",
+                    "type": "number"
+                  },
+                  {
+                    "value": "2",
+                    "type": "number"
+                  },
+                  {
+                    "value": "3",
+                    "type": "number"
+                  },
+                  {
+                    "value": "4",
+                    "type": "number"
+                  },
+                  {
+                    "value": "5",
+                    "type": "number"
+                  },
+                  {
+                    "value": "6",
                     "type": "number"
                   }
                 ]
               },
-              "default": "3",
+              "default": "2",
               "attribute": "heading-level"
             },
             {
@@ -8918,7 +8953,8 @@
                 ]
               },
               "default": "\"brightness\"",
-              "attribute": "icon"
+              "attribute": "icon",
+              "reflects": true
             },
             {
               "kind": "field",
@@ -8934,10 +8970,83 @@
               },
               "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).",
+              "type": {
+                "text": "Date",
+                "references": [
+                  {
+                    "name": "Date",
+                    "package": "typescript",
+                    "module": "lib/lib.es5.d.ts",
+                    "start": 0,
+                    "end": 4
+                  }
+                ]
+              }
+            },
+            {
+              "kind": "field",
+              "name": "playingState",
+              "type": {
+                "text": "\"day\" | \"none\" | \"year\"",
+                "values": [
+                  {
+                    "value": "day",
+                    "type": "string"
+                  },
+                  {
+                    "value": "none",
+                    "type": "string"
+                  },
+                  {
+                    "value": "year",
+                    "type": "string"
+                  }
+                ]
+              },
+              "attribute": "playing-state"
+            },
             {
               "kind": "field",
               "name": "playSpeedMultiplier",
-              "description": "Controls the speed of the daytime and date animation.",
+              "description": "Controls the daytime and date animation speed.",
               "type": {
                 "text": "number",
                 "values": [
@@ -8947,7 +9056,13 @@
                 ]
               },
               "default": "1.0",
-              "attribute": "play-speed-multiplier"
+              "attribute": "play-speed-multiplier",
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "// Plays the daylight animation at half of the default speed\ndaylightWidget.playSpeedMultiplier = 0.5;"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -9050,23 +9165,60 @@
             },
             {
               "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.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps)",
+              "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).",
               "type": {
-                "text": "Array<number> | number",
-                "references": [
+                "text": "boolean",
+                "values": [
                   {
-                    "name": "Array",
-                    "package": "typescript",
-                    "module": "lib/lib.es5.d.ts",
-                    "start": 0,
-                    "end": 5
+                    "type": "boolean"
                   }
-                ],
+                ]
+              },
+              "default": "false",
+              "attribute": "sunlighting-disabled"
+            },
+            {
+              "kind": "field",
+              "name": "supported",
+              "type": {
+                "text": "boolean",
                 "values": [
                   {
-                    "type": "Array<number>"
-                  },
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "readonly": true
+            },
+            {
+              "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).",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "attribute": "time-slider-position",
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "view.environment.lighting = new SunLighting({\n  date: new Date(\"2022-06-21T12:00:00\")\n});"
+                }
+              ]
+            },
+            {
+              "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.",
+              "type": {
+                "text": "number",
+                "values": [
                   {
                     "type": "number"
                   }
@@ -9075,10 +9227,24 @@
               "default": "5",
               "attribute": "time-slider-steps"
             },
+            {
+              "kind": "field",
+              "name": "utcOffset",
+              "description": "The difference in hours between UTC time and the time displayed in the widget.",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "attribute": "utc-offset"
+            },
             {
               "kind": "field",
               "name": "yearPlaying",
-              "description": "Starts or pauses the date animation cycling through the months of the year.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#yearPlaying)",
+              "description": "Starts or pauses the date animation cycling through the months of the year. Set to `true` to start the animation\nand to `false` to pause it.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -9108,7 +9274,7 @@
             },
             {
               "name": "current-season",
-              "description": "A season can be set instead of a date.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#currentSeason)",
+              "description": "A season can be set instead of a date.\nEach season uses a fixed date corresponding to the seasonal equinoxes and solstices.",
               "type": {
                 "text": "\"fall\" | \"spring\" | \"summer\" | \"winter\"",
                 "values": [
@@ -9153,7 +9319,7 @@
             },
             {
               "name": "day-playing",
-              "description": "Starts or pauses the daytime animation cycling through the minutes of the day.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#dayPlaying)",
+              "description": "Starts or pauses the daytime animation cycling through the minutes of the day.\nSet to `true` to start the animation and to `false` to pause it.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -9165,18 +9331,52 @@
               "default": "false",
               "fieldName": "dayPlaying"
             },
+            {
+              "name": "direct-shadows-enabled",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "directShadowsEnabled"
+            },
             {
               "name": "heading-level",
               "description": "Indicates the heading level to use for the component title.",
               "type": {
-                "text": "number",
+                "text": "1 | 2 | 3 | 4 | 5 | 6",
                 "values": [
                   {
+                    "value": "1",
+                    "type": "number"
+                  },
+                  {
+                    "value": "2",
+                    "type": "number"
+                  },
+                  {
+                    "value": "3",
+                    "type": "number"
+                  },
+                  {
+                    "value": "4",
+                    "type": "number"
+                  },
+                  {
+                    "value": "5",
+                    "type": "number"
+                  },
+                  {
+                    "value": "6",
                     "type": "number"
                   }
                 ]
               },
-              "default": "3",
+              "default": "2",
               "fieldName": "headingLevel"
             },
             {
@@ -9286,7 +9486,7 @@
             },
             {
               "name": "play-speed-multiplier",
-              "description": "Controls the speed of the daytime and date animation.",
+              "description": "Controls the daytime and date animation speed.",
               "type": {
                 "text": "number",
                 "values": [
@@ -9298,6 +9498,27 @@
               "default": "1.0",
               "fieldName": "playSpeedMultiplier"
             },
+            {
+              "name": "playing-state",
+              "type": {
+                "text": "\"day\" | \"none\" | \"year\"",
+                "values": [
+                  {
+                    "value": "day",
+                    "type": "string"
+                  },
+                  {
+                    "value": "none",
+                    "type": "string"
+                  },
+                  {
+                    "value": "year",
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "playingState"
+            },
             {
               "name": "position",
               "type": {
@@ -9357,9 +9578,36 @@
               },
               "fieldName": "referenceElement"
             },
+            {
+              "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).",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "sunlightingDisabled"
+            },
+            {
+              "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).",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "fieldName": "timeSliderPosition"
+            },
             {
               "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.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#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.",
               "type": {
                 "text": "number",
                 "values": [
@@ -9371,9 +9619,22 @@
               "default": "5",
               "fieldName": "timeSliderSteps"
             },
+            {
+              "name": "utc-offset",
+              "description": "The difference in hours between UTC time and the time displayed in the widget.",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "fieldName": "utcOffset"
+            },
             {
               "name": "year-playing",
-              "description": "Starts or pauses the date animation cycling through the months of the year.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#yearPlaying)",
+              "description": "Starts or pauses the date animation cycling through the months of the year. Set to `true` to start the animation\nand to `false` to pause it.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -15205,7 +15466,16 @@
               "name": "effectiveUnits",
               "description": "Units which have been selected according to the magnitude of the elevations and distances that are to be displayed\nin the component, according to the selected elevation and distance units or unit systems.",
               "type": {
-                "text": "{\n    distance: LengthUnit;\n    elevation: LengthUnit;\n}"
+                "text": "ElevationProfileEffectiveUnits",
+                "references": [
+                  {
+                    "name": "ElevationProfileEffectiveUnits",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "start": 0,
+                    "end": 30
+                  }
+                ]
               },
               "readonly": true
             },