@arcgis/map-components 4.34.0-next.120 → 4.34.0-next.121

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

@@ -5030,7 +5030,7 @@
     },
     {
       "name": "arcgis-legend",
-      "description": "The Legend component describes the symbols used to represent layers in a map.\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 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.",
+      "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 or scene view 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.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -5039,33 +5039,78 @@
         },
         {
           "name": "basemap-legend-visible",
-          "description": "Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers in the Legend.",
+          "description": "Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers in the Legend. If you set this property to\n`true` and specify [layerInfos](#layerInfos), the basemap layers you want included in the legend must also be\nspecified in `layerInfos`.",
           "values": []
         },
+        {
+          "name": "card-style-layout",
+          "values": [
+            {
+              "name": "auto"
+            },
+            {
+              "name": "side-by-side"
+            },
+            {
+              "name": "stack"
+            }
+          ]
+        },
         {
           "name": "heading-level",
-          "description": "Indicates the heading level to use for the legend title.",
-          "values": []
+          "description": "Indicates the heading level to use for the legend title. By default, legend titles\nare rendered as level 3 headings (e.g. `<h3>Legend title</h3>`). Depending on the legend placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
+          "values": [
+            {
+              "name": "1"
+            },
+            {
+              "name": "2"
+            },
+            {
+              "name": "3"
+            },
+            {
+              "name": "4"
+            },
+            {
+              "name": "5"
+            },
+            {
+              "name": "6"
+            }
+          ]
         },
         {
           "name": "hide-layers-not-in-current-view",
-          "description": "When `true`, layers will only be shown in the legend if\nthey are visible in the view's extent.",
+          "description": "When `true`, layers will only be shown in the legend if\nthey are visible in the view's extent. When data from a layer\nis not visible in the view, the layer's legend information\nwill be hidden. Only layers that implement the `createQuery()`\nand `queryFeatureCount()` methods are supported by `hideLayersNotInCurrentView`.\n\nTo hide layers completely\nfrom the legend, you should set the `legendEnabled` property of\nthe layer to `false`.",
           "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": "ignore-layer-visibility",
+          "description": "Determines whether to respect the properties of the layers in the map that\ncontrol the legend's visibility (`minScale`, `maxScale`, `legendEnabled`).\nBy default, a layer's legend elements **will\nnot render** in the legend given the following conditions:\n\n- The layer's [legendEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#legendEnabled) property\nis set to `false`.\n- If the view's scale is outside the visibility range\ndefined by the layer's [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#minScale) and\n[maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#maxScale) properties.\n\nWhen the `respectLayerVisibility` property of the legend is set to `false`, the legend elements for each\nlayer in the map will always display, thus disregarding the `minScale`, `maxScale`,\nand `legendEnabled` properties for each layer in the map.",
           "values": []
         },
         {
           "name": "label",
-          "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#label)",
+          "description": "The component's default label.",
           "values": []
         },
         {
           "name": "legend-style",
-          "description": "Indicates the style of the legend.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style)",
-          "values": []
+          "description": "Indicates the style of the legend. The style determines the legend's layout and behavior.\nYou can either specify a string or an object to indicate the style. The known string values are the same values listed in\nthe table within the `type` property.",
+          "values": [
+            {
+              "name": "card"
+            },
+            {
+              "name": "classic"
+            }
+          ]
         },
         {
           "name": "position",
@@ -5107,12 +5152,7 @@
         },
         {
           "name": "respect-layer-definition-expression",
-          "description": "If a layer uses a unique value render, only features that satisfy the layer's\n[definition expression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#definitionExpression)\nwill be displayed in the legend when set to true.",
-          "values": []
-        },
-        {
-          "name": "respect-layer-visibility-disabled",
-          "description": "Determines whether to respect the properties of the layers in the map that\ncontrol the legend's visibility (`minScale`, `maxScale`, `legendEnabled`).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#respectLayerVisibility)",
+          "description": "If a layer uses a unique value render, only features that satisfy the layer's\n[definition](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#definitionExpression)\nwill be displayed in the legend when set to true.",
           "values": []
         },
         {
@@ -5139,6 +5179,328 @@
         }
       ]
     },
+    {
+      "name": "arcgis-legend-card-color-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "css-effect-filter",
+          "values": []
+        },
+        {
+          "name": "opacity",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-card-color-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-card-element",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "css-effect-filter",
+          "values": []
+        },
+        {
+          "name": "heading-level",
+          "values": [
+            {
+              "name": "1"
+            },
+            {
+              "name": "2"
+            },
+            {
+              "name": "3"
+            },
+            {
+              "name": "4"
+            },
+            {
+              "name": "5"
+            },
+            {
+              "name": "6"
+            }
+          ]
+        },
+        {
+          "name": "stacked",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-card-element/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-card-size-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "has-indicators",
+          "values": []
+        },
+        {
+          "name": "opacity",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-card-size-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-card-univariate-above-and-below-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "css-effect-filter",
+          "values": []
+        },
+        {
+          "name": "opacity",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-card-univariate-above-and-below-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-card-univariate-color-size-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "css-effect-filter",
+          "values": []
+        },
+        {
+          "name": "opacity",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-card-univariate-color-size-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-card-view",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "heading-level",
+          "values": [
+            {
+              "name": "1"
+            },
+            {
+              "name": "2"
+            },
+            {
+              "name": "3"
+            },
+            {
+              "name": "4"
+            },
+            {
+              "name": "5"
+            },
+            {
+              "name": "6"
+            }
+          ]
+        },
+        {
+          "name": "layout",
+          "description": "The rendering layout.",
+          "values": [
+            {
+              "name": "auto"
+            },
+            {
+              "name": "side-by-side"
+            },
+            {
+              "name": "stack"
+            }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-card-view/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-classic-color-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "opacity",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-classic-color-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-classic-element",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "css-effect-filter",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-classic-element/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-classic-size-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-classic-size-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-classic-univariate-above-and-below-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "css-effect-filter",
+          "values": []
+        },
+        {
+          "name": "opacity",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-classic-univariate-above-and-below-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-classic-univariate-color-size-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "css-effect-filter",
+          "values": []
+        },
+        {
+          "name": "opacity",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-classic-univariate-color-size-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-classic-view",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "heading-level",
+          "values": [
+            {
+              "name": "1"
+            },
+            {
+              "name": "2"
+            },
+            {
+              "name": "3"
+            },
+            {
+              "name": "4"
+            },
+            {
+              "name": "5"
+            },
+            {
+              "name": "6"
+            }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-classic-view/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-relationship-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [
+        {
+          "name": "css-effect-filter",
+          "values": []
+        },
+        {
+          "name": "opacity",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-relationship-ramp/"
+        }
+      ]
+    },
+    {
+      "name": "arcgis-legend-spike-ramp",
+      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "attributes": [],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend-spike-ramp/"
+        }
+      ]
+    },
     {
       "name": "arcgis-line-of-sight",
       "description": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including the ground, integrated meshes, and 3D objects such as buildings or trees.\n\n![line-of-sight](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/line-of-sight.png)\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\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 ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current analysis results. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](#stop) was called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stop the current placing of line of sight analysis. Any lines added this far are kept  in the view.\nUsers can still interact with existing targets and the observer, but they cannot place new target points.",