@arcgis/map-components 4.32.0-next.82 → 4.32.0-next.83

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

@@ -4335,6 +4335,110 @@
         }
       ]
     },
+    {
+      "name": "arcgis-link-chart",
+      "description": "### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - Adds a layer to the layers collection.\n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - Adds a layer or array of layers to the layers collection.\n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
+      "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": "basemap",
+          "description": "Specifies a basemap for the link chart. The basemap is only visible when the link\nchart is set to a geographic layout. See\n[documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm)\nfor more detail. The basemap is a set of layers that give\ngeographic context to the LinkChartView and the other operational layers\nin the link chart.",
+          "values": []
+        },
+        {
+          "name": "center",
+          "description": "Represents the view's center point; when setting the center, you may pass a\nesri/geometry/Point instance or a string representing\na longitude/latitude pair (`\"-100.4593, 36.9014\"`).\nSetting the center immediately changes the current view.\nFor animating the view, see this component's goTo() method.",
+          "values": []
+        },
+        {
+          "name": "item-id",
+          "description": "The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) before the `arcgis-linkchart` component loads.",
+          "values": []
+        },
+        {
+          "name": "popup-disabled",
+          "description": "Controls whether the popup opens when users click on the view.",
+          "values": []
+        },
+        {
+          "name": "resize-align",
+          "description": "Defines which anchor stays still while resizing the browser window. The default, `center`,\nensures the view's center point remains constantly visible as the window size changes. The other\noptions allow  the respective portion of the view to remain visible when the window's size is changed.",
+          "values": [
+            {
+              "name": "bottom"
+            },
+            {
+              "name": "bottom-left"
+            },
+            {
+              "name": "bottom-right"
+            },
+            {
+              "name": "center"
+            },
+            {
+              "name": "left"
+            },
+            {
+              "name": "right"
+            },
+            {
+              "name": "top"
+            },
+            {
+              "name": "top-left"
+            },
+            {
+              "name": "top-right"
+            }
+          ]
+        },
+        {
+          "name": "rotation",
+          "description": "The clockwise rotation of due north in relation to the top of the view in degrees.\nThe view may be rotated by directly setting\nthe rotation or by using the following mouse event: `Right-click + Drag`.\nWebLinkChart rotation may be disabled by setting the `rotationEnabled` property\nin [constraints](#constraints) to `false`.",
+          "values": []
+        },
+        {
+          "name": "scale",
+          "description": "Represents the link chart scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's goTo() method.",
+          "values": []
+        },
+        {
+          "name": "suspended",
+          "description": "Indicates if the view is visible on the page.",
+          "values": []
+        },
+        {
+          "name": "time-zone",
+          "description": "Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.",
+          "values": []
+        },
+        {
+          "name": "updating",
+          "description": "Indicates whether the view is being updated by additional data requests to the network,\nor by processing received data.",
+          "values": []
+        },
+        {
+          "name": "zoom",
+          "description": "Represents the level of detail (LOD) at the center of the view.\nA zoom level (or scale) is a number that defines how large or small the contents of a link chart appear in a link chart view.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the view has no LODs.\nWhen setting the zoom value, the LinkChartView converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\nLinkChartView can display link charts with different projections at a full range of scales, and so use the scale property on this component rather than zoom level.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's goTo() method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/components/storybook/?path=/docs/map-components_component-arcgis-link-chart--docs"
+        },
+        {
+          "name": "Demo",
+          "url": "https://developers.arcgis.com/javascript/latest/components/storybook/?path=/story/map-components_component-reference-arcgis-link-chart--arcgis-link-chart"
+        }
+      ]
+    },
     {
       "name": "arcgis-locate",
       "description": "[Locate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html) 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>`",
@@ -6446,6 +6550,14 @@
           "description": "The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.",
           "values": []
         },
+        {
+          "name": "hide-flow",
+          "values": []
+        },
+        {
+          "name": "hide-status-indicators",
+          "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.",
@@ -6521,51 +6633,43 @@
           ]
         },
         {
-          "name": "state",
-          "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#state)",
-          "values": [
-            {
-              "name": "disabled"
-            },
-            {
-              "name": "loading"
-            },
-            {
-              "name": "ready"
-            }
-          ]
-        },
-        {
-          "name": "visible-elements-close-button",
-          "values": []
-        },
-        {
-          "name": "visible-elements-collapse-button",
+          "name": "show-close-button",
           "values": []
         },
         {
-          "name": "visible-elements-errors",
+          "name": "show-collapse-button",
           "values": []
         },
         {
-          "name": "visible-elements-filter",
+          "name": "show-errors",
           "values": []
         },
         {
-          "name": "visible-elements-flow",
+          "name": "show-filter",
           "values": []
         },
         {
-          "name": "visible-elements-heading",
+          "name": "show-heading",
           "values": []
         },
         {
-          "name": "visible-elements-status-indicators",
+          "name": "show-temporary-table-indicators",
           "values": []
         },
         {
-          "name": "visible-elements-temporary-table-indicators",
-          "values": []
+          "name": "state",
+          "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#state)",
+          "values": [
+            {
+              "name": "disabled"
+            },
+            {
+              "name": "loading"
+            },
+            {
+              "name": "ready"
+            }
+          ]
         }
       ],
       "references": [