@arcgis/map-components 4.33.0-next.136 → 4.33.0-next.138

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

@@ -143,7 +143,7 @@
     },
     {
       "name": "arcgis-area-measurement-3d",
-      "description": "The Area Measurement 3D component calculates and displays the area and perimeter of a polygon. This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the area and perimeter of a polygon.\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 is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\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>`",
+      "description": "The Area Measurement 3D component calculates and displays the area and perimeter of a polygon.\nThis component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nto measure the area and perimeter of a polygon.\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 is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\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>`",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -152,12 +152,12 @@
         },
         {
           "name": "icon",
-          "description": "Icon which represents the widget.",
+          "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 widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -198,7 +198,7 @@
         },
         {
           "name": "state",
-          "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#state)",
+          "description": "The current state of the component.",
           "values": [
             {
               "name": "disabled"
@@ -216,7 +216,7 @@
         },
         {
           "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-AreaMeasurement3D.html#unit)",
+          "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
           "values": [
             {
               "name": "acres"
@@ -1910,22 +1910,22 @@
       ]
     },
     {
-      "name": "arcgis-directline-measurement-3d",
-      "description": "The Direct Line Measurement 3D component calculates and displays the 3D distance between two points. This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the vertical, horizontal, and direct distance between two points.\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 is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\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>`",
+      "name": "arcgis-direct-line-measurement-3d",
+      "description": "The Direct Line Measurement 3D component calculates and displays the 3D distance between two points. This component\ncan be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nto measure the vertical, horizontal, and direct distance between two points.\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 is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\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>`",
       "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-directline-measurement-3d/#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-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.",
           "values": []
         },
         {
           "name": "icon",
-          "description": "Icon which represents the widget.",
+          "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 widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1966,7 +1966,6 @@
         },
         {
           "name": "state",
-          "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#state)",
           "values": [
             {
               "name": "disabled"
@@ -1984,7 +1983,7 @@
         },
         {
           "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-DirectLineMeasurement3D.html#unit)",
+          "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
           "values": [
             {
               "name": "centimeters"
@@ -2031,11 +2030,136 @@
       "references": [
         {
           "name": "Docs",
-          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directline-measurement-3d/"
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/"
         },
         {
           "name": "Direct Line Measurement 3D",
-          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-directline-measurement-3d--demo&singleStory=true"
+          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-direct-line-measurement-3d--demo&singleStory=true"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-directline-measurement-3d",
+      "description": "**Deprecated**. The Direct Line Measurement 3D component calculates and displays the 3D distance between two points. This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the vertical, horizontal, and direct distance between two points.\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 is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\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>`",
+      "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-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.",
+          "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",
+          "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",
+          "values": []
+        },
+        {
+          "name": "state",
+          "values": [
+            {
+              "name": "disabled"
+            },
+            {
+              "name": "measured"
+            },
+            {
+              "name": "measuring"
+            },
+            {
+              "name": "ready"
+            }
+          ]
+        },
+        {
+          "name": "unit",
+          "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
+          "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-directline-measurement-3d/"
         }
       ]
     },
@@ -2316,6 +2440,9 @@
             },
             {
               "name": "ready"
+            },
+            {
+              "name": "viewing-selection-list"
             }
           ]
         }
@@ -4696,14 +4823,31 @@
       "name": "arcgis-link-chart-layout-switcher",
       "description": "A component for use in link charts that allows users to switch between different layouts. See [documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm) for more details.\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\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 is ready to be interacted with.\n- **arcgisSwitchLayout** - Fires when component has completed the layout switch\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- `switchLayout(newLayout: \"basic-grid\" | \"chronological-mono-timeline\" | \"chronological-multi-timeline\" | \"geographic-organic-standard\" | \"hierarchical-bottom-to-top\" | \"organic-community\" | \"organic-standard\" | \"radial-root-centric\" | \"tree-left-to-right\"): Promise<void>` - Switches the layout of the link chart to the value provided.",
       "attributes": [
+        {
+          "name": "appearance",
+          "description": "The appearance of the layout switcher. `dropdown` displays a button that is clicked to reveal a dropdown menu, while `menu-bar` displays a menu bar.",
+          "values": [
+            {
+              "name": "dropdown"
+            },
+            {
+              "name": "menu-bar"
+            }
+          ]
+        },
         {
           "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-link-chart-layout-switcher/#destroy) method when you are done to\nprevent memory leaks.",
           "values": []
         },
+        {
+          "name": "close-on-select-disabled",
+          "description": "When `true`, the layout menu will not close when a layout is selected. Only applicable when `appearance` is `dropdown`.",
+          "values": []
+        },
         {
           "name": "icon",
-          "description": "Icon displayed in the widget's button.",
+          "description": "Icon displayed in the component's button, when `appearance` is `dropdown`.",
           "values": []
         },
         {