@arcgis/map-components 4.32.0-next.60 → 4.32.0-next.62

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2024-12-25T12:56:47",
+  "timestamp": "2024-12-27T12:56:19",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.32.0-next.60",
+    "version": "4.32.0-next.62",
     "typescriptVersion": "5.6.3"
   },
   "schemaVersion": "1.0.0",
@@ -40073,7 +40073,7 @@
             {
               "kind": "field",
               "name": "autoDestroyDisabled",
-              "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 temporary hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.",
+              "description": "If true, the component will not be destroyed automatically when\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory leaks.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -40140,7 +40140,7 @@
             {
               "kind": "field",
               "name": "direction",
-              "description": "The direction the Swipe widget moves across the view.",
+              "description": "The direction the Swipe component moves across the view.\nIf `\"horizontal\"`, the component will move left and right and\nif `\"vertical\"`, the component will move up and down.",
               "type": {
                 "text": "\"horizontal\" | \"vertical\"",
                 "values": [
@@ -40155,12 +40155,61 @@
                 ]
               },
               "default": "\"horizontal\"",
-              "attribute": "direction"
+              "attribute": "direction",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "disabled",
+              "description": "When `true`, sets the component to a disabled state so the user cannot interact with it.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "disabled",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "hideDivider",
+              "description": "When `true`, the divider between the leading and trailing layers will be hidden.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "hide-divider",
+              "reflects": true
             },
             {
               "kind": "field",
-              "name": "dragLabel",
-              "description": "The text that shows in a tooltip when hovering over the handle of\nthe Swipe widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#dragLabel)",
+              "name": "hideHandle",
+              "description": "When `true`, the handle from which you drag the component will be hidden.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "hide-handle",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "icon",
+              "description": "Icon which represents the component. It is typically used when the component is controlled by another\none (e.g. in the Expand component).",
               "type": {
                 "text": "string",
                 "values": [
@@ -40169,12 +40218,20 @@
                   }
                 ]
               },
-              "attribute": "drag-label"
+              "default": "\"compare\"",
+              "attribute": "icon",
+              "reflects": true,
+              "docsTags": [
+                {
+                  "name": "see",
+                  "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
+                }
+              ]
             },
             {
               "kind": "field",
-              "name": "icon",
-              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.",
+              "name": "label",
+              "description": "The component's default label.",
               "type": {
                 "text": "string",
                 "values": [
@@ -40183,13 +40240,13 @@
                   }
                 ]
               },
-              "default": "null",
-              "attribute": "icon"
+              "default": "\"Swipe\"",
+              "attribute": "label"
             },
             {
               "kind": "field",
               "name": "leadingLayers",
-              "description": "A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the left or top side of the Swipe widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#leadingLayers)",
+              "description": "A collection of layers that will show on the left or top side of the Swipe component.",
               "type": {
                 "text": "Collection<Layer>",
                 "references": [
@@ -40211,6 +40268,95 @@
                 ]
               }
             },
+            {
+              "kind": "field",
+              "name": "messageOverrides",
+              "description": "Overwrite localized strings for this component",
+              "type": {
+                "text": "{\n    componentLabel?: string | undefined;\n    dragLabel?: string | undefined;\n}"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "position",
+              "type": {
+                "text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
+                "values": [
+                  {
+                    "value": "bottom-leading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-trailing",
+                    "type": "string"
+                  },
+                  {
+                    "value": "manual",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-leading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-trailing",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"manual\"",
+              "attribute": "position",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "referenceElement",
+              "type": {
+                "text": "ArcgisMap | ArcgisScene | string",
+                "references": [
+                  {
+                    "name": "ArcgisMap",
+                    "module": "dist/components/arcgis-map/customElement.d.ts",
+                    "start": 0,
+                    "end": 9
+                  },
+                  {
+                    "name": "ArcgisScene",
+                    "module": "dist/components/arcgis-scene/customElement.d.ts",
+                    "start": 12,
+                    "end": 23
+                  }
+                ],
+                "values": [
+                  {
+                    "type": "ArcgisMap"
+                  },
+                  {
+                    "type": "ArcgisScene"
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "attribute": "reference-element"
+            },
             {
               "kind": "field",
               "name": "state",
@@ -40237,7 +40383,7 @@
             {
               "kind": "field",
               "name": "swipePosition",
-              "description": "The position of the Swipe widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#position)",
+              "description": "The position of the Swipe component. This determines what percentage\nof the view will be taken up by the [leadingLayers](#leadingLayers).",
               "type": {
                 "text": "number",
                 "values": [
@@ -40252,7 +40398,7 @@
             {
               "kind": "field",
               "name": "trailingLayers",
-              "description": "A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that will show on the right or bottom side of the Swipe widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#trailingLayers)",
+              "description": "A collection of layers that will show on the right or bottom side of the Swipe component.",
               "type": {
                 "text": "Collection<Layer>",
                 "references": [
@@ -40278,7 +40424,7 @@
           "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 temporary hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.",
+              "description": "If true, the component will not be destroyed automatically when\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory leaks.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -40292,7 +40438,7 @@
             },
             {
               "name": "direction",
-              "description": "The direction the Swipe widget moves across the view.",
+              "description": "The direction the Swipe component moves across the view.\nIf `\"horizontal\"`, the component will move left and right and\nif `\"vertical\"`, the component will move up and down.",
               "type": {
                 "text": "\"horizontal\" | \"vertical\"",
                 "values": [
@@ -40310,21 +40456,50 @@
               "fieldName": "direction"
             },
             {
-              "name": "drag-label",
-              "description": "The text that shows in a tooltip when hovering over the handle of\nthe Swipe widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#dragLabel)",
+              "name": "disabled",
+              "description": "When `true`, sets the component to a disabled state so the user cannot interact with it.",
               "type": {
-                "text": "string",
+                "text": "boolean",
                 "values": [
                   {
-                    "type": "string"
+                    "type": "boolean"
                   }
                 ]
               },
-              "fieldName": "dragLabel"
+              "default": "false",
+              "fieldName": "disabled"
+            },
+            {
+              "name": "hide-divider",
+              "description": "When `true`, the divider between the leading and trailing layers will be hidden.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "hideDivider"
+            },
+            {
+              "name": "hide-handle",
+              "description": "When `true`, the handle from which you drag the component will be hidden.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "hideHandle"
             },
             {
               "name": "icon",
-              "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.",
+              "description": "Icon which represents the component. It is typically used when the component is controlled by another\none (e.g. in the Expand component).",
               "type": {
                 "text": "string",
                 "values": [
@@ -40333,9 +40508,81 @@
                   }
                 ]
               },
-              "default": "null",
+              "default": "\"compare\"",
               "fieldName": "icon"
             },
+            {
+              "name": "label",
+              "description": "The component's default label.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"Swipe\"",
+              "fieldName": "label"
+            },
+            {
+              "name": "position",
+              "type": {
+                "text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
+                "values": [
+                  {
+                    "value": "bottom-leading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "bottom-trailing",
+                    "type": "string"
+                  },
+                  {
+                    "value": "manual",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-leading",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top-trailing",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"manual\"",
+              "fieldName": "position"
+            },
+            {
+              "name": "reference-element",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "referenceElement"
+            },
             {
               "name": "state",
               "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe-SwipeViewModel.html#state)",
@@ -40357,7 +40604,7 @@
             },
             {
               "name": "swipe-position",
-              "description": "The position of the Swipe widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Swipe.html#position)",
+              "description": "The position of the Swipe component. This determines what percentage\nof the view will be taken up by the [leadingLayers](#leadingLayers).",
               "type": {
                 "text": "number",
                 "values": [