@arcgis/map-components 4.32.0-next.123 → 4.32.0-next.124

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

@@ -4450,6 +4450,93 @@
         }
       ]
     },
+    {
+      "name": "arcgis-link-chart-layout-switcher",
+      "description": "A widget for use in link charts that allows users to switch between different layouts.\nSee [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\n### Events\n- **arcgisPropertyChange**\n- **arcgisReady**\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": "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\\` method when you are done to prevent\nmemory leaks.",
+          "values": []
+        },
+        {
+          "name": "icon",
+          "description": "Icon displayed in the widget's button.",
+          "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": "prevent-extent-update",
+          "description": "Prevents extent from updating on changes to the layout.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#preventExtentUpdate)",
+          "values": []
+        },
+        {
+          "name": "reference-element",
+          "values": []
+        },
+        {
+          "name": "state",
+          "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#state)",
+          "values": [
+            {
+              "name": "disabled"
+            },
+            {
+              "name": "loading"
+            },
+            {
+              "name": "ready"
+            }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart-layout-switcher/"
+        },
+        {
+          "name": "Demo",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/?path=/story/arcgis-link-chart-layout-switcher--demo&singleStory=true"
+        }
+      ]
+    },
     {
       "name": "arcgis-locate",
       "description": "Locate component animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's current location.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange**\n- **arcgisReady**\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component\n- `locate(): Promise<GeolocationPosition | null>`",
@@ -6431,7 +6518,7 @@
     },
     {
       "name": "arcgis-swipe",
-      "description": "The Swipe component provides a tool to show a portion of a layer or layers on top of a map.\n--\n\n### Events\n- **arcgisPropertyChange**\n- **arcgisReady**\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 Swipe component provides a tool to show a portion of a layer or layers on top of a map. Layers can be swiped vertically or horizontally to easily compare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n__Note:__ This component is not currently supported within an `arcgis-scene` component.\n--\n\n### Events\n- **arcgisPropertyChange**\n- **arcgisReady**\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",