@arcgis/map-components 4.33.0-next.87 → 4.33.0-next.88

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

@@ -3685,6 +3685,242 @@
         }
       ]
     },
+    {
+      "name": "arcgis-grid-controls",
+      "description": "`GridControls` provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- GridControls is only supported in 2D/arcgis-map.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\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 view is 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- `trySetDisplayEnabled(enabled: boolean): void` - Call this to turn the grid on/off.",
+      "attributes": [
+        {
+          "name": "auto-destroy-disabled",
+          "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": "custom-color",
+          "description": "The custom color used for drawing the grid, if any.",
+          "values": []
+        },
+        {
+          "name": "dynamic-scaling",
+          "description": "Returns `true` if the grid is set to scale dynamically. When dynamic scaling is enabled,\ngrid cells are added or removed to ensure that grid cells are a reasonable size on screen as the user zooms.\nThe way additional grid lines are shown is controlled by the [majorLineInterval](#majorLineInterval) property.",
+          "values": []
+        },
+        {
+          "name": "effective-spacing-after-dynamic-scaling",
+          "description": "Returns the actual spacing of grid lines after dynamic scaling has been applied at the current scale.",
+          "values": []
+        },
+        {
+          "name": "grid-color",
+          "description": "Controls the color of the major grid lines. Minor grid lines are a slightly transparent version of this color.",
+          "values": []
+        },
+        {
+          "name": "grid-out-of-scale",
+          "description": "True if the grid is currently not displayed (and therefore also not a valid snap target),\nbecause [dynamicScaling](#dynamicScaling) is off and the grid cells are too small\nto render at the current scale.",
+          "values": []
+        },
+        {
+          "name": "hide-color-selection",
+          "description": "Controls display of the color and theme selection options.",
+          "values": []
+        },
+        {
+          "name": "hide-dynamic-scale-toggle",
+          "description": "Controls display of the dynamic scaling toggle. Dynamic scaling adjusts the size of the grid to work\nwell regardless of view scale.",
+          "values": []
+        },
+        {
+          "name": "hide-grid-enabled-toggle",
+          "description": "Controls display of the grid enabled toggle. This toggle controls whether the grid is displayed.",
+          "values": []
+        },
+        {
+          "name": "hide-grid-snap-enabled-toggle",
+          "description": "Controls display of the grid snapping enabled toggle. This toggle controls whether snapping is enabled.",
+          "values": []
+        },
+        {
+          "name": "hide-line-interval-input",
+          "description": "Controls display of the line interval input field for setting the interval between major grid lines.",
+          "values": []
+        },
+        {
+          "name": "hide-numeric-inputs",
+          "description": "Controls display of the numeric input fields for setting grid spacing and rotation.",
+          "values": []
+        },
+        {
+          "name": "hide-out-of-scale-warning",
+          "description": "Controls display of the out of scale warning. This warning is displayed when the grid is not shown\nbecause it would be too small at the current scale and dynamic scaling is disabled.",
+          "values": []
+        },
+        {
+          "name": "hide-placement-buttons",
+          "description": "Controls display of the grid placement buttons. These buttons allow the user to start interactive\nconfiguration of the grid.",
+          "values": []
+        },
+        {
+          "name": "hide-rotate-with-map-toggle",
+          "description": "Controls display of the rotate with map toggle. This toggle controls whether the grid rotates with the map.",
+          "values": []
+        },
+        {
+          "name": "icon",
+          "description": "Icon which represents the component. It is typically used when the component is controlled by another\none (e.g. in <arcgis-expand>).",
+          "values": []
+        },
+        {
+          "name": "interactive-placement-state",
+          "description": "Sets the interactive placement state, either starting or ending a draw operation that implicitly adjusts the grid.\nInteractive placement allows the user to define the center of the grid, then the scale and rotation of the grid by\ndrawing a second point. Setting this to \"place\" allows the user to move the grid center only. Setting this to \"rotate\"\nkeeps the scale and center of the grid constant while rotating the grid by defining a second point.",
+          "values": [
+            {
+              "name": "interactive"
+            },
+            {
+              "name": "place"
+            },
+            {
+              "name": "rotate"
+            }
+          ]
+        },
+        {
+          "name": "label",
+          "description": "The component's default label.",
+          "values": []
+        },
+        {
+          "name": "major-line-interval",
+          "description": "Controls the number of grid cells shown between major grid lines. Can be anything between 1 and 15.\nNo minor grid lines are shown when this is set to 1.",
+          "values": []
+        },
+        {
+          "name": "placement-disabled",
+          "description": "Use this property to disable the interactive grid placement buttons as needed.\nAn example use case might be to block interaction while another interactive operation\n(e.g. sketching) is in progress.",
+          "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": "rotate-with-map",
+          "description": "Controls whether the grid rotates with the map, or stays fixed to the screen.",
+          "values": []
+        },
+        {
+          "name": "rotation",
+          "description": "Rotation of the grid in radians. NOTE: UI controls convert to and from degrees automatically.",
+          "values": []
+        },
+        {
+          "name": "snapping-enabled",
+          "description": "Controls snapping behavior if [snappingOptions](#snappingOptions) has been defined.\nIf [snappingOptions](#snappingOptions) have been defined, disabling or enabling grid snapping will\nalso disable or enable grid display.",
+          "values": []
+        },
+        {
+          "name": "spacing",
+          "description": "Length of a grid cell. Grid cells are always square. Defined in [unit](#unit).",
+          "values": []
+        },
+        {
+          "name": "theme",
+          "description": "The color scheme used to display the grid. This will be light, dark, or custom. When theme is set to custom,\nthe [customColor](#customColor) is shown, otherwise a default light or dark theme color is used.",
+          "values": [
+            {
+              "name": "custom"
+            },
+            {
+              "name": "dark"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        },
+        {
+          "name": "unit",
+          "description": "Unit of measure (foot, meter, etc) used when defining the [spacing](#spacing) grid cell.\nNote that units are defined relatively to the map's spatial reference length unit,\nwhich will not correspond to geographic distance unless using a special-purpose basemap\nwithin a supported target area.\n\nWhen using Web Mercator, the projection defines the length of a meter in projection system units;\nthis length is equal to a geographic meter only at the equator. On screen, the size of the grid cells is constant\nfrom the equator to the poles, but the real-world size of the grid cell is much larger further from the equator.\n\nThe length of the grid cells can usefully correspond to a geographic length when the Grid is used with an\nappropriate spatial reference (for example a local system or a State Plane system) within the reference's area of interest.",
+          "values": [
+            {
+              "name": "centimeters"
+            },
+            {
+              "name": "decimeters"
+            },
+            {
+              "name": "feet"
+            },
+            {
+              "name": "inches"
+            },
+            {
+              "name": "kilometers"
+            },
+            {
+              "name": "meters"
+            },
+            {
+              "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-grid-controls/"
+        },
+        {
+          "name": "Demo",
+          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-grid-controls--demo&singleStory=true"
+        }
+      ]
+    },
     {
       "name": "arcgis-histogram",
       "description": "### 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 view is 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.",
@@ -5917,7 +6153,7 @@
         },
         {
           "name": "include-default-sources-disabled",
-          "description": "Indicates whether or not to include defaultSources in the Search UI.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#includeDefaultSources)",
+          "description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#includeDefaultSources)",
           "values": []
         },
         {