@arcgis/map-components 5.0.0-next.87 → 5.0.0-next.88

package/dist/docs/vscode.html-custom-data.json

@@ -7280,7 +7280,7 @@
     },
     {
       "name": "arcgis-shadow-cast",
-      "description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.\n\nThe component calculates the cumulative shadows for a time range during a single day. The user can\nconfigure the time range and select a calendar date. This time range and calendar date are only used\nfor the shadow analysis and are not connected to the lighting in the scene.\nTo control the lighting in the scene, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.\nChanging the timezone in the component updates the visualization by interpreting the time range as being\nin that timezone. This behavior is different from the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,\nwhere selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.\n\nThe component provides three [modes](#mode): threshold, duration, and discrete mode.\n\nIn the **threshold** mode, only the areas that receive\nshadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive\nshadow for more than 4 hours within the time interval of 10AM to 4PM.\n\n[![threshold mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-threshold.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Total shadow duration** mode displays the duration of the cumulative shadow using opacity: areas that don't\nreceive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity\nof 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the\namount of time that location is in shadow, rounded to 15-minute intervals. In this mode, the visualization\ncan display shadow cast in a continuous way or in 1-hour intervals.\n\n[![duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-duration.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Discrete shadows** is a third mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the interval to 30 minutes will display\nshadows for 10AM, 10:30AM and 11:00AM.\n\n[![discrete mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-discrete.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nThe defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay),\n[endTimeOfDay](#endTimeOfDay), and [mode](#mode) properties.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* Terrain does not cast shadows and it is therefore not taken into account in this analysis.\nThis influences the results when the start time of the range is before sunrise or when the end time is after the sunset.\n* The component does not take into account the daylight savings.\nUse the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.\nIn case of an inaccurate timezone, users can set it manually using the timezone dropdown.\n\n**See also**\n\n- [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDurationAtScreen(point: __esri.Point): Promise<number>` - Returns the time (in milliseconds) spent in shadow for a certain point on the screen.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ShadowCast-ShadowCastAnalysisView3D.html#getDurationAtScreen)",
+      "description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.\n\nThe component calculates the cumulative shadows for a time range during a single day. The user can\nconfigure the time range and select a calendar date. This time range and calendar date are only used\nfor the shadow analysis and are not connected to the lighting in the scene.\nTo control the lighting in the scene, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.\nChanging the timezone in the component updates the visualization by interpreting the time range as being\nin that timezone. This behavior is different from the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,\nwhere selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.\n\nThe component provides three [modes](#mode): minimum duration, total duration, and discrete mode.\n\nIn the **minimum duration** mode, only the areas that receive\nshadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive\nshadow for more than 4 hours within the time interval of 10AM to 4PM.\n\n[![threshold mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-threshold.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Total shadow duration** mode displays the duration of the cumulative shadow using opacity: areas that don't\nreceive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity\nof 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the\namount of time that location is in shadow, rounded to 15-minute intervals. In this mode, the visualization\ncan display shadow cast in a continuous way or in 1-hour intervals.\n\n[![duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-duration.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Discrete shadows** is a third mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the interval to 30 minutes will display\nshadows for 10AM, 10:30AM and 11:00AM.\n\n[![discrete mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-discrete.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nThe defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay),\n[endTimeOfDay](#endTimeOfDay), and [mode](#mode) properties.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* Terrain does not cast shadows and it is therefore not taken into account in this analysis.\nThis influences the results when the start time of the range is before sunrise or when the end time is after the sunset.\n* The component does not take into account the daylight savings.\nUse the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.\nIn case of an inaccurate timezone, users can set it manually using the timezone dropdown.\n\n**See also**\n\n- [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDurationAtScreen(point: __esri.Point): Promise<number>` - Returns the time (in milliseconds) spent in shadow for a certain point on the screen.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ShadowCast-ShadowCastAnalysisView3D.html#getDurationAtScreen)",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -7297,18 +7297,6 @@
           "description": "Individual shadows are displayed at this time interval in \"discrete\" [mode](#mode), starting with the start time of\nday. The interval is expressed in milliseconds. If set to 0, we'll use the smallest possible interval, up to a\nmaximum of 255 samples.",
           "values": []
         },
-        {
-          "name": "duration-mode",
-          "description": "Mode in which the cumulative shadow duration should be displayed in \"total-duration\" [mode](#mode): as a continuous\nsurface or as an hourly aggregation of values.",
-          "values": [
-            {
-              "name": "continuous"
-            },
-            {
-              "name": "hourly"
-            }
-          ]
-        },
         {
           "name": "end-time-of-day",
           "description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#endTimeOfDay)",
@@ -7359,68 +7347,68 @@
           "values": []
         },
         {
-          "name": "hide-duration-color-picker",
-          "description": "If true, the color picker will be hidden in the duration mode options.",
+          "name": "hide-min-duration-color-picker",
+          "description": "If true, the color picker will be hidden in the minimum duration mode options.",
           "values": []
         },
         {
-          "name": "hide-duration-mode-select",
-          "description": "If true, the mode selector will be hidden in the duration mode options.",
+          "name": "hide-min-duration-context-color-picker",
+          "description": "If true, the color picker will be hidden in the context options in minimum duration mode.",
           "values": []
         },
         {
-          "name": "hide-duration-options",
-          "description": "If true, the visualization options will be hidden in duration mode.",
+          "name": "hide-min-duration-context-interval",
+          "description": "If true, the interval selector will be hidden in the context options in minimum duration mode.",
           "values": []
         },
         {
-          "name": "hide-shadow-duration-tooltip",
-          "description": "If true, the tooltip which displays the amount of shadow at a certain location will be hidden.",
+          "name": "hide-min-duration-context-options",
+          "description": "If true, the context options will be hidden in the minimum duration mode options.",
           "values": []
         },
         {
-          "name": "hide-threshold-color-picker",
-          "description": "If true, the color picker will be hidden in the threshold mode options.",
+          "name": "hide-min-duration-context-toggle",
+          "description": "If true, the toggle used to show or hide the context options will be hidden.",
           "values": []
         },
         {
-          "name": "hide-threshold-context-color-picker",
-          "description": "If true, the color picker will be hidden in the context options in threshold mode.",
+          "name": "hide-min-duration-options",
+          "description": "If true, the visualization options will be hidden in minimum duration mode.",
           "values": []
         },
         {
-          "name": "hide-threshold-context-interval",
-          "description": "If true, the interval selector will be hidden in the context options in threshold mode.",
+          "name": "hide-min-duration-slider",
+          "description": "If true, the minimum duration slider will be hidden in the minimum duration mode options.",
           "values": []
         },
         {
-          "name": "hide-threshold-context-options",
-          "description": "If true, the context options will be hidden in the threshold mode options.",
+          "name": "hide-shadow-duration-tooltip",
+          "description": "If true, the tooltip which displays the amount of shadow at a certain location will be hidden.",
           "values": []
         },
         {
-          "name": "hide-threshold-context-toggle",
-          "description": "If true, the toggle used to show or hide the context options will be hidden.",
+          "name": "hide-time-range-slider",
+          "description": "If true, the time range slider will be hidden.",
           "values": []
         },
         {
-          "name": "hide-threshold-options",
-          "description": "If true, the visualization options will be hidden in threshold mode.",
+          "name": "hide-timezone",
+          "description": "If true, the timezone picker will be hidden.",
           "values": []
         },
         {
-          "name": "hide-threshold-slider",
-          "description": "If true, the threshold slider will be hidden in the threshold mode options.",
+          "name": "hide-total-duration-color-picker",
+          "description": "If true, the color picker will be hidden in the total duration mode options.",
           "values": []
         },
         {
-          "name": "hide-time-range-slider",
-          "description": "If true, the time range slider will be hidden.",
+          "name": "hide-total-duration-mode-select",
+          "description": "If true, the mode selector will be hidden in the total duration mode options.",
           "values": []
         },
         {
-          "name": "hide-timezone",
-          "description": "If true, the timezone picker will be hidden.",
+          "name": "hide-total-duration-options",
+          "description": "If true, the visualization options will be hidden in the total duration mode.",
           "values": []
         },
         {
@@ -7444,18 +7432,33 @@
           "values": []
         },
         {
-          "name": "max-threshold",
-          "description": "Maximum allowed value for the [threshold](#threshold) property, in milliseconds.",
+          "name": "max-min-duration",
+          "description": "Maximum allowed value for the [minDuration](#minDuration) property, in milliseconds.",
           "values": []
         },
         {
-          "name": "min-threshold",
-          "description": "Minimum allowed value for the [threshold](#threshold) property, in milliseconds.",
+          "name": "min-duration",
+          "description": "The minimum duration (in milliseconds) used in \"min-duration\" [mode](#mode) to determine which shadow areas are displayed.",
+          "values": []
+        },
+        {
+          "name": "min-duration-context-enabled",
+          "description": "Whether to enable additional context showing discrete shadows at the same time as displaying shadows above a\nminimum duration when in the \"min-duration\" [mode](#mode). The [minDurationContextColor](#minDurationContextColor)\nand [minDurationContextInterval](#minDurationContextInterval) properties are used to configure the visualization of the\ndiscrete shadows when context is enabled.",
+          "values": []
+        },
+        {
+          "name": "min-duration-context-interval",
+          "description": "The interval in milliseconds used when showing additional context in \"min-duration\" [mode](#mode) when\n[minDurationContextEnabled](#contextEnabled) is true.",
+          "values": []
+        },
+        {
+          "name": "min-min-duration",
+          "description": "Minimum allowed value for the [minDuration](#minDuration) property, in milliseconds.",
           "values": []
         },
         {
           "name": "mode",
-          "description": "Mode of analysis to use when computing and displaying the shadows. There are 3 types:\n- \"discrete\" mode displays individual shadows cast at a given time interval.\n- \"total-duration\" displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals.\n- \"min-duration\" only displays areas that receive shadows for a period longer than a given threshold value.",
+          "description": "Mode of analysis to use when computing and displaying the shadows. There are 3 types:\n- \"discrete\" mode displays individual shadows cast at a given time interval.\n- \"total-duration\" displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals.\n- \"min-duration\" only displays areas that receive shadows for a period longer than a given minimum duration.",
           "values": [
             {
               "name": "discrete"
@@ -7524,19 +7527,16 @@
           ]
         },
         {
-          "name": "threshold",
-          "description": "The threshold (in milliseconds) used in \"min-duration\" [mode](#mode) to determine which areas are displayed.",
-          "values": []
-        },
-        {
-          "name": "threshold-context-enabled",
-          "description": "Whether to enable additional context showing discrete shadows at the same time as displaying the threshold when\nin \"min-duration\" [mode](#mode). The [thresholdContextColor](#thresholdContextColor) and\n[thresholdContextInterval](#thresholdContextInterval) properties are used to configure the visualization of the\ndiscrete shadows when context is enabled.",
-          "values": []
-        },
-        {
-          "name": "threshold-context-interval",
-          "description": "The interval in milliseconds used when showing additional context in \"min-duration\" [mode](#mode) when\n[thresholdContextEnabled](#contextEnabled) is true.",
-          "values": []
+          "name": "total-duration-mode",
+          "description": "Mode in which the cumulative shadow duration should be displayed in \"total-duration\" [mode](#mode): as a continuous\nsurface or as an hourly aggregation of values.",
+          "values": [
+            {
+              "name": "continuous"
+            },
+            {
+              "name": "hourly"
+            }
+          ]
         },
         {
           "name": "utc-offset",