@arcgis/map-components 4.33.0-next.64 → 4.33.0-next.66

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

@@ -413,6 +413,11 @@
       "name": "arcgis-basemap-gallery",
       "description": "BasemapGallery component displays a collection images representing basemaps from [ArcGIS.com](https://www.arcgis.com/index.html) or a user-defined set of map or image services. When a new basemap is selected from the BasemapGallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.\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.",
       "attributes": [
+        {
+          "name": "active-basemap",
+          "description": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).",
+          "values": []
+        },
         {
           "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.",
@@ -743,6 +748,11 @@
           "description": "The component's default label.",
           "values": []
         },
+        {
+          "name": "next-basemap",
+          "description": "The next basemap for toggling.",
+          "values": []
+        },
         {
           "name": "position",
           "values": [
@@ -2673,7 +2683,7 @@
     },
     {
       "name": "arcgis-feature",
-      "description": "Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This component is useful in instances where you want to display information about a feature but without the use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\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- `nextMedia(contentElementIndex: number): Promise<void>`\n- `previousMedia(contentElementIndex: number): Promise<void>`\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>`",
+      "description": "Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This component is useful in instances where you want to display information about a feature but without the use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\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- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos).\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos).\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media info](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos) object.\nFor example, you may have [media content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html#mediaInfos) which contains multiple mediaInfos.\nThis method allows you to specify the index of the mediaInfos you wish to display.",
       "attributes": [
         {
           "name": "auto-destroy-disabled",
@@ -2692,35 +2702,42 @@
         },
         {
           "name": "hide-content-attachments",
+          "description": "Indicates whether to hide all [AttachmentsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html).",
           "values": []
         },
         {
           "name": "hide-content-expression",
+          "description": "Indicates whether to hide all [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html).",
           "values": []
         },
         {
           "name": "hide-content-fields",
+          "description": "Indicates whether to hide all [FieldsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html).",
           "values": []
         },
         {
           "name": "hide-content-media",
+          "description": "Indicates whether to hide all [MediaContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html).",
           "values": []
         },
         {
           "name": "hide-content-text",
+          "description": "Indicates whether to hide all [TextContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html).",
           "values": []
         },
         {
           "name": "hide-last-edit-info",
-          "description": "**Deprecated**: since version 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead.. ",
+          "description": "**Deprecated**: Deprecated since version 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead.. ",
           "values": []
         },
         {
           "name": "hide-last-edited-info",
+          "description": "Indicates whether to hide the [lastEditInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#lastEditInfo).",
           "values": []
         },
         {
           "name": "hide-title",
+          "description": "Indicates whether to hide the title associated with the feature.",
           "values": []
         },
         {
@@ -3313,7 +3330,7 @@
     },
     {
       "name": "arcgis-features",
-      "description": "Features component allows users to view a feature's popupTemplate content such as attributes, actions, related records, etc., without having to be tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).\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- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `clear(): Promise<void>` - Clears the component.\n- `close(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.FeaturesFetchFeaturesScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>`\n- `next(): Promise<__esri.FeaturesViewModel>` - Moves to the next item.\n- `open(options?: __esri.FeaturesOpenOptions): Promise<void>`\n- `previous(): Promise<__esri.FeaturesViewModel>` - Moves to the previous item.\n- `triggerAction(actionIndex: number): Promise<void>` - Triggers an action on the component.",
+      "description": "Features component allows users to view a feature's popupTemplate content such as attributes, actions, related records, etc., without having to be tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).\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- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `clear(): Promise<void>` - Clears the component.\n- `close(): Promise<void>` - Closes the component.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.FeaturesFetchFeaturesScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [layer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html).\nIn order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis method allows a developer to control how the input location is handled.\n- `next(): Promise<__esri.FeaturesViewModel>` - Moves to the next item.\n- `open(options?: __esri.FeaturesOpenOptions): Promise<void>` - Opens Features with content defined either explicitly or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features.\n- `previous(): Promise<__esri.FeaturesViewModel>` - Moves to the previous item.\n- `triggerAction(actionIndex: number): Promise<void>` - Triggers an action on the component.",
       "attributes": [
         {
           "name": "active",
@@ -3357,30 +3374,37 @@
         },
         {
           "name": "hide-action-bar",
+          "description": "Indicates whether to hide the action bar that holds the feature's [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions).",
           "values": []
         },
         {
           "name": "hide-close-button",
+          "description": "Indicates whether to hide the close button.",
           "values": []
         },
         {
           "name": "hide-feature-menu-heading",
+          "description": "Indicates whether to hide a heading and description on the widget feature menu list.",
           "values": []
         },
         {
           "name": "hide-feature-navigation",
+          "description": "Indicates whether to hide pagination for feature navigation.\nThis allows the user to scroll through various selected features using pagination arrows.",
           "values": []
         },
         {
           "name": "hide-flow",
+          "description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if `false`.\nThe flow component will be omitted if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
           "values": []
         },
         {
           "name": "hide-heading",
+          "description": "Indicates whether is hide the heading.",
           "values": []
         },
         {
           "name": "hide-spinner",
+          "description": "Indicates whether to hide the loading spinner.",
           "values": []
         },
         {
@@ -3781,11 +3805,21 @@
           "description": "The statistical average of the data in the histogram.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#average)",
           "values": []
         },
+        {
+          "name": "excluded-bar-color",
+          "description": "Sets the color of the histogram bars that are excluded based on the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor)",
+          "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.",
           "values": []
         },
+        {
+          "name": "included-bar-color",
+          "description": "Sets the color of the histogram bars that are included in the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor)",
+          "values": []
+        },
         {
           "name": "label",
           "description": "The component's default label.",
@@ -6983,6 +7017,107 @@
         }
       ]
     },
+    {
+      "name": "arcgis-time-zone-label",
+      "description": "TimeZoneLabel is component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) of a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\nThe component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone.\nUsers can toggle between these states by clicking the component's expand/collapse button.\nBy default the component is collapsed.\n\nWhen expanding, the component will lengthen inwards when [positioned](#position) within a Map.\nThis behavior can be overridden by setting the [expandDirection](#expandDirection) property to either `\"start\"` or `\"end\"`.\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.",
+      "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": "disabled",
+          "description": "When `true`, sets the component to a disabled state so the user cannot interact with it.",
+          "values": []
+        },
+        {
+          "name": "expand-direction",
+          "description": "The direction the component will expand.\n\nBy default, the component will expand inward if assigned to a View UI corner. If the component is positioned manually,\nthe component will expand towards the \"end\" which is equivalent to right in a LTR application.",
+          "values": [
+            {
+              "name": "end"
+            },
+            {
+              "name": "start"
+            }
+          ]
+        },
+        {
+          "name": "expanded",
+          "description": "The expanded state of the component.",
+          "values": []
+        },
+        {
+          "name": "icon",
+          "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 component's default label.",
+          "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": "state",
+          "description": "The state of the component.",
+          "values": [
+            {
+              "name": "disabled"
+            },
+            {
+              "name": "ready"
+            }
+          ]
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-time-zone-label/"
+        },
+        {
+          "name": "Demo",
+          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-time-zone-label--demo&singleStory=true"
+        }
+      ]
+    },
     {
       "name": "arcgis-track",
       "description": "Track component is a button that animates the map or scene to the user's location when clicked.\nThe view rotates based on device heading.\nThe default heading symbol will display when speed is greater than zero and the browser provides heading information.\n\n**Known Limitations**\n\n- The heading symbol is not currently supported within an `arcgis-scene` component.\n--\n\n### Events\n- **arcgisComplete** - Emitted when the component is complete.\n- **arcgisError** - Emitted when an error occurs.\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- `start(): Promise<void>`\n- `stop(): Promise<void>` - Stops the component.",
@@ -7726,9 +7861,33 @@
         }
       ]
     },
+    {
+      "name": "arcgis-video",
+      "description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid url or layer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\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",
+          "values": []
+        },
+        {
+          "name": "layer-url",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Docs",
+          "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/"
+        },
+        {
+          "name": "Demo",
+          "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-video--demo&singleStory=true"
+        }
+      ]
+    },
     {
       "name": "arcgis-video-player",
-      "description": "The VideoPlayer component provides a user interface for interacting with a VideoLayer.\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe VideoPlayer component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\n**Known Limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on the Safari browser or on iOS devices.\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.",
+      "description": "The VideoPlayer component provides a user interface for interacting with a VideoLayer.\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe VideoPlayer component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\n**Known Limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on the Safari browser or on iOS devices.\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- **arcgisVideoReady**\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",