@arcgis/map-components 5.0.0-next.42 → 5.0.0-next.44

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

@@ -1568,7 +1568,7 @@
     },
     {
       "name": "arcgis-daylight",
-      "description": "The Daylight component can be used to manipulate the lighting conditions of a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) of the Scene component.\n\nTo illuminate the scene, one can either use a configuration of date and time to position the\n[sun](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)**\nand adjusting the time and date, the positions of the sun and stars are updated accordingly. This also updates the\n[date](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#date) property of\n[environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n\n[![daylight-default](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-default.png)](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n\nThe component has an option to select the timezone. When the user makes any adjustments here, a new time\nin the chosen timezone is calculated and displayed in the slider. The timezone selector can be disabled\nby using the [hideTimezone](#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](#dateOrSeason) property, the calendar can be replaced with\na dropdown menu where a season can be selected instead:\n\n![daylight-seasons](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-seasons.png)\n\nThere are two play buttons: one corresponds to the time-of-day slider and animates the lighting\nover the course of a day, while the other corresponds to the date picker\nand animates the lighting over the course of a year (month by month). The speed of the animation can\nbe set using the [playSpeedMultiplier](#playSpeedMultiplier) property.\n\n![daylight-animation](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-animation.gif)\n\nExcept for the daytime slider, all the elements in the Daylight component can be hidden:\n\n![daylight-no-elements](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-no-elements.png)\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)** source relative to the camera.\nWith this, the component's time slider, timezone, and date picker get automatically disabled:\n\n![daylight-virtual](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-virtual.png)\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* The Daylight component uses UTC time and does not account for the daylight savings times in different countries and regions of the world.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html),\nsetting the time and date programmatically does not have an influence on the lighting conditions of the scene.\n* When using the [sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html),\nthe time slider and time zone automatically react to the changes of the camera (e.g., position, rotation, pan, zoom) because the position of the simulated sun\nis updated to maintain a consistent solar time of day based on the camera's current longitude. This can be adjusted using the\n[cameraTrackingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled)\nproperty on [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\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.",
+      "description": "The Daylight component can be used to manipulate the lighting conditions of a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) of the Scene component.\n\nTo illuminate the scene, one can either use a configuration of date and time to position the\n[sun](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)**\nand adjusting the time and date, the positions of the sun and stars are updated accordingly. This also updates the\n[date](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#date) property of\n[environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n\n[![daylight-default](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-default.png)](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n\nThe component has an option to select the timezone. When the user makes any adjustments here, a new time\nin the chosen timezone is calculated and displayed in the slider. The timezone selector can be disabled\nby using the [hideTimezone](#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](#dateOrSeason) property, the calendar can be replaced with\na dropdown menu where a season can be selected instead:\n\n![daylight-seasons](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-seasons.png)\n\nThere are two play buttons: one corresponds to the time-of-day slider and animates the lighting\nover the course of a day, while the other corresponds to the date picker\nand animates the lighting over the course of a year (month by month). The speed of the time-of-day animation can\nbe set using the [playSpeedMultiplier](#playSpeedMultiplier) property.\n\n![daylight-animation](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-animation.gif)\n\nExcept for the daytime slider, all the elements in the Daylight component can be hidden:\n\n![daylight-no-elements](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-no-elements.png)\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)** source relative to the camera.\nWith this, the component's time slider, timezone, and date picker get automatically disabled:\n\n![daylight-virtual](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-virtual.png)\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* The Daylight component uses UTC time and does not account for the daylight savings times in different countries and regions of the world.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html),\nsetting the time and date programmatically does not have an influence on the lighting conditions of the scene.\n* When using the [sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html),\nthe time slider and time zone automatically react to the changes of the camera (e.g., position, rotation, pan, zoom) because the position of the simulated sun\nis updated to maintain a consistent solar time of day based on the camera's current longitude. This can be adjusted using the\n[cameraTrackingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled)\nproperty on [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\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.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -2510,47 +2510,146 @@
     },
     {
       "name": "arcgis-elevation-profile",
-      "description": "The Elevation Profile component is used to generate and display an elevation profile from an\n[input line](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#input).\n\n**See also**\n\n- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)\n-\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\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- `select(): Promise<void>` - Starts an interactive operation to pick a polyline feature in the view to use as the input for the elevation\nprofile analysis. The operation will finish when the user presses the escape key.\nTo cancel the operation, call the `stop()` method.\n- `start(): Promise<void>` - Starts an interactive operation which allows the user to sketch a new path in the view.\nTo cancel the operation, call the `stop()` method.\n- `stop(): Promise<void>` - Stops any ongoing interactive operation.",
+      "description": "The Elevation Profile component manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html) and displays its elevation profiles.\n\n[![elevation profile poster](https://developers.arcgis.com/javascript/latest/assets/img/components/elevation-profile/elevation_profile_poster.png)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nThe component can visualize multiple profile lines, depending on whether it is used in a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) component or a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component and on the available elevation source data:\n\n* [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineGround.html): represents a profile line that uses elevation from [Map.ground](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#ground) of the connected Map or Scene component. The profile recomputes automatically when ground layers are added, removed, or their visibility changes.\n* [**ElevationProfileLineInput**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html): represents a profile line that reads elevation from the analysis geometry itself; typically used for polylines with z values. If the line lacks z values but is displayed with a non-draped elevation mode, a profile is still computed. If `elevationInfo` is set to `on-the-ground`, elevation comes from the Ground (when ground layers are present). An elevation offset can be applied. In a Map this requires client-side graphics that already contain z values.\n* [**ElevationProfileLineQuery**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) or ant object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation).\n* [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html): represents a profile line that derives elevation from the `Scene` and all its volumetric objects (e.g. SceneLayer, IntegratedMeshLayer).\n\nYou can choose to display one or several profile lines in the chart, by setting them in the [profiles](#profiles) property.\n\nHovering over the chart shows an overlaid tooltip with elevation values of all profiles, and displays colored dot markers at the matching positions.\n\n[![elevation profile chart gif](https://developers.arcgis.com/javascript/latest/assets/img/components/elevation-profile/elevation_profile_chart_gif.gif)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nCheckboxes in the legend allow hiding individual profiles. Chart units can be set via the settings menu to metric, imperial or a specific unit.\n\nScrolling the chart zooms in to a specific part of the profile chart. When zoomed in, click the minus button to reset the zoom. On touch devices, pinch to zoom in and out.\n\nHow distance values are computed depends on the map's spatial reference:\n\n* In geographic coordinate systems (GCS) and in Web Mercator, distances are computed geodetically.\n* In projected coordinate systems (PCS), apart from Web Mercator, distances are computed in a Euclidean manner (in their respective PCS).\n\n**See also**\n\n- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n- [Sample - Elevation Profile analysis](https://developers.arcgis.com/javascript/latest/sample-code/analysis-elevation-profile/)\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- `clear(): Promise<void>` - Clear the current elevation profile. If an interactive operation is in progress, it will also be stopped.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `select(): Promise<void>` - Start an interactive operation to pick an existing polyline feature in the view to use as the input for the\nelevation profile. The operation ends when the user presses the <kbd>Escape</kbd> key.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#stop) method.\n- `start(): Promise<void>` - Start an interactive operation that lets the user sketch a new path in the view along which the elevation profile\nwill be generated. The operation completes when the user double-clicks, presses the <kbd>Escape</kbd> key or clicks\nthe Done button in the UI.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#stop) method.\n- `stop(): Promise<void>` - Stop any ongoing interactive operation (for example, selecting or sketching a profile line). This can be used to\nprogrammatically cancel operations started by [start()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#start) or\n[select()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#select).",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
           "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#destroy) method when you are done to\nprevent memory leaks.",
           "values": []
         },
+        {
+          "name": "distance-unit",
+          "description": "The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display distance values\nin the chart, results and legend.",
+          "values": [
+            {
+              "name": "centimeters"
+            },
+            {
+              "name": "decimeters"
+            },
+            {
+              "name": "feet"
+            },
+            {
+              "name": "imperial"
+            },
+            {
+              "name": "inches"
+            },
+            {
+              "name": "kilometers"
+            },
+            {
+              "name": "meters"
+            },
+            {
+              "name": "metric"
+            },
+            {
+              "name": "miles"
+            },
+            {
+              "name": "millimeters"
+            },
+            {
+              "name": "nautical-miles"
+            },
+            {
+              "name": "us-feet"
+            },
+            {
+              "name": "yards"
+            }
+          ]
+        },
+        {
+          "name": "elevation-unit",
+          "description": "The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display elevation values\nin the chart, results and legend.",
+          "values": [
+            {
+              "name": "centimeters"
+            },
+            {
+              "name": "decimeters"
+            },
+            {
+              "name": "feet"
+            },
+            {
+              "name": "imperial"
+            },
+            {
+              "name": "inches"
+            },
+            {
+              "name": "kilometers"
+            },
+            {
+              "name": "meters"
+            },
+            {
+              "name": "metric"
+            },
+            {
+              "name": "miles"
+            },
+            {
+              "name": "millimeters"
+            },
+            {
+              "name": "nautical-miles"
+            },
+            {
+              "name": "us-feet"
+            },
+            {
+              "name": "yards"
+            }
+          ]
+        },
         {
           "name": "hide-chart",
+          "description": "If true, the elevation profile chart will be hidden.",
           "values": []
         },
         {
           "name": "hide-clear-button",
+          "description": "If true, the clear button will be hidden.",
           "values": []
         },
         {
           "name": "hide-legend",
+          "description": "If true, the legend will be hidden.",
           "values": []
         },
         {
           "name": "hide-select-button",
+          "description": "If true, the button to select features in the view will be hidden.",
           "values": []
         },
         {
           "name": "hide-settings-button",
+          "description": "If true, the button which opens the settings popover will be hidden.",
           "values": []
         },
         {
           "name": "hide-sketch-button",
+          "description": "If true, the button to start sketching a new profile line will be hidden.",
           "values": []
         },
         {
           "name": "hide-uniform-chart-scaling-toggle",
+          "description": "If true, the uniform chart scaling toggle will be hidden in the settings popover.",
           "values": []
         },
         {
           "name": "hide-unit-selector",
+          "description": "If true, the unit selector will be hidden in the settings popover.",
           "values": []
         },
         {
-          "name": "highlight-enabled",
+          "name": "highlight-disabled",
+          "description": "If true, the component will not highlight features selected in the view.",
           "values": []
         },
         {
@@ -2634,96 +2733,6 @@
           "name": "uniform-chart-scaling",
           "description": "Whether the chart should use a uniform scale for the X and Y axes.",
           "values": []
-        },
-        {
-          "name": "unit-distance",
-          "description": "The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display distance values\nin the chart, results and legend.",
-          "values": [
-            {
-              "name": "centimeters"
-            },
-            {
-              "name": "decimeters"
-            },
-            {
-              "name": "feet"
-            },
-            {
-              "name": "imperial"
-            },
-            {
-              "name": "inches"
-            },
-            {
-              "name": "kilometers"
-            },
-            {
-              "name": "meters"
-            },
-            {
-              "name": "metric"
-            },
-            {
-              "name": "miles"
-            },
-            {
-              "name": "millimeters"
-            },
-            {
-              "name": "nautical-miles"
-            },
-            {
-              "name": "us-feet"
-            },
-            {
-              "name": "yards"
-            }
-          ]
-        },
-        {
-          "name": "unit-elevation",
-          "description": "The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display elevation values\nin the chart, results and legend.",
-          "values": [
-            {
-              "name": "centimeters"
-            },
-            {
-              "name": "decimeters"
-            },
-            {
-              "name": "feet"
-            },
-            {
-              "name": "imperial"
-            },
-            {
-              "name": "inches"
-            },
-            {
-              "name": "kilometers"
-            },
-            {
-              "name": "meters"
-            },
-            {
-              "name": "metric"
-            },
-            {
-              "name": "miles"
-            },
-            {
-              "name": "millimeters"
-            },
-            {
-              "name": "nautical-miles"
-            },
-            {
-              "name": "us-feet"
-            },
-            {
-              "name": "yards"
-            }
-          ]
         }
       ],
       "references": [