npm - @arcgis/map-components - Versions diffs - 4.32.0-next.77 → 4.32.0-next.78 - Mend

@arcgis/map-components 4.32.0-next.77 → 4.32.0-next.78

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (319) hide show

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

@@ -18,7 +18,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -154,7 +154,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -337,7 +337,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -448,7 +448,7 @@
         },
         {
           "name": "label",
-          "description": "The components default label.",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -588,7 +588,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -734,7 +734,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's default label.",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -856,7 +856,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -976,7 +976,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1089,7 +1089,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1229,6 +1229,7 @@
         },
         {
           "name": "label",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1331,7 +1332,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1526,7 +1527,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1594,26 +1595,31 @@
     },
     {
       "name": "arcgis-directional-pad",
-      "description": "The [DirectionalPad](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad.html) component can be used to control the position and rotation of the map. The D-Pad provides 8 directions of movement, a small compass which indicates the current orientation of the map and a slider for rotating the 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": "A directional pad (D-Pad) component can be used to control the position and\nrotation of the map. The D-Pad provides eight directions of movement, a small\ncompass which indicates the current orientation of the map and a slider for\nrotating the map.\n\nIt is also possible to disable the map's rotation controls or change the size\nof the component.\n\nThe DirectionalPad component is not supported in 3d.\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",
-          "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.",
           "values": []
         },
         {
           "name": "disabled",
-          "description": "Indicates whether interaction is allowed on the widget.",
+          "description": "Indicates whether interaction is allowed on the component. When `true`,\nthis property sets the component to a disabled state to disable any user\ninteraction.",
+          "values": []
+        },
+        {
+          "name": "hide-directional-buttons",
+          "description": "Whether to hide directional pad buttons.",
           "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).\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\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).",
           "values": []
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1652,6 +1658,16 @@
           "name": "reference-element",
           "values": []
         },
+        {
+          "name": "show-rotation-reset-button",
+          "description": "Whether to display the button to reset the rotation angle. This only takes\neffect if showRotationSlider is true.",
+          "values": []
+        },
+        {
+          "name": "show-rotation-slider",
+          "description": "Whether to display the map rotation slider.",
+          "values": []
+        },
         {
           "name": "state",
           "description": "The state of the view model.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectionalPad-DirectionalPadViewModel.html#state)",
@@ -1669,7 +1685,7 @@
         },
         {
           "name": "visual-scale",
-          "description": "Determines the size of directional pad buttons and the slider.",
+          "description": "Determines the size of directional pad buttons and the slider.\n\nIn addition to this parameter, you can set the width on the component\ncontainer to dictate directional pad size.",
           "values": [
             {
               "name": "l"
@@ -1732,7 +1748,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1857,7 +1873,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -1987,7 +2003,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -2154,7 +2170,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -2309,7 +2325,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -2478,6 +2494,11 @@
           "description": "Indicates whether the widget is currently expanded or not.",
           "values": []
         },
+        {
+          "name": "focus-trap-enabled",
+          "description": "Disables focus trapping within the expand widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)",
+          "values": []
+        },
         {
           "name": "group",
           "description": "This value associates two or more Expand widget instances with each other, allowing one\ninstance to auto collapse when another instance in the same group is expanded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#group)",
@@ -2495,7 +2516,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -2684,7 +2705,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -2786,7 +2807,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -3182,7 +3203,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -3340,7 +3361,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -3443,7 +3464,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -3520,12 +3541,12 @@
         },
         {
           "name": "icon",
-          "description": "Icon displayed in the widget's button.",
+          "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.",
           "values": []
         },
         {
           "name": "label",
-          "description": "The widget's default label.",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -3615,7 +3636,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -3721,7 +3742,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -3855,7 +3876,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's default label.",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -3974,7 +3995,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -4135,7 +4156,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -4229,7 +4250,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -4323,6 +4344,7 @@
         },
         {
           "name": "label",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -4595,7 +4617,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -4725,7 +4747,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -4846,7 +4868,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -5004,7 +5026,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -5111,7 +5133,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's default label.",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -5210,7 +5232,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -5480,7 +5502,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -5644,7 +5666,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -5881,7 +5903,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -6016,7 +6038,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -6121,7 +6143,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -6405,7 +6427,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -6552,7 +6574,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -6701,6 +6723,7 @@
         },
         {
           "name": "label",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -7079,7 +7102,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -7283,7 +7306,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
@@ -7365,7 +7388,7 @@
         },
         {
           "name": "label",
-          "description": "The widget's default label.",
+          "description": "The component's default label.",
           "values": []
         },
         {