@arcgis/map-components 5.0.0-next.34 → 5.0.0-next.36

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

@@ -4,7 +4,7 @@
   "tags": [
     {
       "name": "arcgis-area-measurement-2d",
-      "description": "The Area Measurement 2D component calculates and displays the area and perimeter of a polygon only in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).\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 measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
+      "description": "The Area Measurement 2D component can be added to a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the area and perimeter of a polygon.\n\nHow areas and perimeters are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).\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>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -18,7 +18,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -61,7 +61,7 @@
         },
         {
           "name": "state",
-          "description": "The current state of the component.",
+          "description": "The component's state. The values mean the following:\n\n* `disabled` -  not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
           "values": [
             {
               "name": "disabled"
@@ -74,12 +74,15 @@
             },
             {
               "name": "ready"
+            },
+            {
+              "name": "unsupported"
             }
           ]
         },
         {
           "name": "unit",
-          "description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit)",
+          "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
           "values": [
             {
               "name": "acres"
@@ -2171,7 +2174,7 @@
     },
     {
       "name": "arcgis-distance-measurement-2d",
-      "description": "The Distance Measurement 2D component calculates and displays the distance between two or more points in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).\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 measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
+      "description": "The Distance Measurement 2D component can be added to a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the length of a polyline.\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, lengths are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, lengths are computed in a Euclidean manner (in their respective PCS).\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>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -2185,7 +2188,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -2228,7 +2231,7 @@
         },
         {
           "name": "state",
-          "description": "The current state of the component.",
+          "description": "The component's state. The values mean the following:\n\n* `disabled` -  not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
           "values": [
             {
               "name": "disabled"
@@ -2241,12 +2244,15 @@
             },
             {
               "name": "ready"
+            },
+            {
+              "name": "unsupported"
             }
           ]
         },
         {
           "name": "unit",
-          "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unit)",
+          "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
           "values": [
             {
               "name": "centimeters"
@@ -2476,196 +2482,11 @@
     },
     {
       "name": "arcgis-elevation-profile",
-      "description": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).\n\n**See also**\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- `start(): Promise<void>` - Switches to the \"creating\" state in which the user can draw a new line.\n- `stop(): Promise<void>` - Stops the creation operation.",
-      "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": "hide-chart",
-          "values": []
-        },
-        {
-          "name": "hide-clear-button",
-          "values": []
-        },
-        {
-          "name": "hide-legend",
-          "values": []
-        },
-        {
-          "name": "hide-select-button",
-          "values": []
-        },
-        {
-          "name": "hide-settings-button",
-          "values": []
-        },
-        {
-          "name": "hide-sketch-button",
-          "values": []
-        },
-        {
-          "name": "hide-uniform-chart-scaling-toggle",
-          "values": []
-        },
-        {
-          "name": "hide-unit-selector",
-          "values": []
-        },
-        {
-          "name": "highlight-enabled",
-          "description": "Whether the graphic used as [input](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)\nis highlighted.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled)",
-          "values": []
-        },
-        {
-          "name": "hovered-chart-position",
-          "description": "The position, in the range [0, 1], being hovered in the graph.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#hoveredChartPosition)",
-          "values": []
-        },
-        {
-          "name": "icon",
-          "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
-          "values": []
-        },
-        {
-          "name": "label",
-          "description": "The component's default label.",
-          "values": []
-        },
-        {
-          "name": "position",
-          "description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
-          "values": [
-            {
-              "name": "bottom-leading"
-            },
-            {
-              "name": "bottom-left"
-            },
-            {
-              "name": "bottom-right"
-            },
-            {
-              "name": "bottom-trailing"
-            },
-            {
-              "name": "manual"
-            },
-            {
-              "name": "top-leading"
-            },
-            {
-              "name": "top-left"
-            },
-            {
-              "name": "top-right"
-            },
-            {
-              "name": "top-trailing"
-            }
-          ]
-        },
-        {
-          "name": "reference-element",
-          "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
-          "values": []
-        },
-        {
-          "name": "state",
-          "description": "The component's state. The values mean the following:\n\n* `disabled` -  component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path",
-          "values": [
-            {
-              "name": "created"
-            },
-            {
-              "name": "creating"
-            },
-            {
-              "name": "disabled"
-            },
-            {
-              "name": "ready"
-            },
-            {
-              "name": "selected"
-            },
-            {
-              "name": "selecting"
-            }
-          ]
-        },
-        {
-          "name": "uniform-chart-scaling",
-          "description": "Whether the chart should use a uniform scale for the X and Y axes.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#uniformChartScaling)",
-          "values": []
-        },
-        {
-          "name": "unit",
-          "description": "Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unit)",
-          "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": [
-        {
-          "name": "Docs",
-          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/"
-        },
-        {
-          "name": "Elevation Profile",
-          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-elevation-profile--demo&singleStory=true"
-        }
-      ]
-    },
-    {
-      "name": "arcgis-elevation-profile-next",
       "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.",
       "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-next/#destroy) method when you are done to\nprevent memory leaks.",
+          "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": []
         },
         {
@@ -2880,11 +2701,11 @@
       "references": [
         {
           "name": "Docs",
-          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile-next/"
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/"
         },
         {
-          "name": "Elevation Profile (Next)",
-          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-elevation-profile-next--demo&singleStory=true"
+          "name": "Elevation Profile",
+          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-elevation-profile--demo&singleStory=true"
         }
       ]
     },