@arcgis/map-components 4.33.0-next.97 → 4.33.0-next.99

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

@@ -3602,12 +3602,8 @@
     },
     {
       "name": "arcgis-fullscreen",
-      "description": "Provides a simple component to present the View or a user-defined HTMLElement using the entire screen\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": "Provides a simple component to present the View or a user-defined HTMLElement using the entire screen\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.",
       "attributes": [
-        {
-          "name": "auto-destroy-disabled",
-          "values": []
-        },
         {
           "name": "label",
           "description": "The component's default label.",
@@ -5251,13 +5247,8 @@
     },
     {
       "name": "arcgis-navigation-toggle",
-      "description": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\nThe Navigation Toggle component is only supported in 3D.\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- `toggle(): Promise<void>`",
+      "description": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\nThe Navigation Toggle component is only supported in 3D.\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- `toggle(): Promise<void>`",
       "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": "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).",
@@ -5521,41 +5512,77 @@
     },
     {
       "name": "arcgis-print",
-      "description": "Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.\n--\n\n### Events\n- **arcgisComplete** - Emitted when the component is complete.\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- **arcgisSubmit** - Emitted when the component is submitted.\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 Print widget connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print widget works with the [module:esri/rest/print](module:esri/rest/print) which generates a printer-ready version of the map.\n\nThe Print widget has two required properties: [view](#view) (reference to the MapView)\nand [printServiceUrl](#printServiceUrl) (URL of the REST endpoint of the Export Web Map Task).\nThe widget can preserve map scale or map extent in the printout. By default, the map extent is\npreserved. Use [module:esri/widgets/Print/TemplateOptions#scaleEnabled](module:esri/widgets/Print/TemplateOptions#scaleEnabled) to preserve scale\ninstead.\n\nThe Print widget prints a localized date for all [layouts](module:esri/rest/support/PrintTemplate#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print widget under `Advanced options`. These values can\nbe overwritten in the Print widget UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](module:esri/rest/support/PrintTemplate#exportOptions).\n\n**Known Limitations**\n\nSee [print](module:esri/rest/print) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print position=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://zara.mapsdevext.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://zara.mapsdevext.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```\n--\n\n### Events\n- **arcgisComplete** - Emitted when the component is complete.\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- **arcgisSubmit** - Emitted when the component is submitted.\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": "allowed-formats",
-          "description": "Specify the print output file format(s) that the user can select based on the options available from the print service.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#allowedFormats)",
+          "description": "Specify the print output file format(s) that the user can select based on the options available from the print service.\nThis property can take a string value or an array of string values.\n\nWhen this value is \"all\" (default value), all the print service formats are available to be used.\nWhen an array of string values is used, only those values that match the options available from the print service will be used.\nIf none of the input string values match those available from the print service, `allowedFormats` will fallback to default behavior.",
           "values": []
         },
+        {
+          "name": "allowed-formats-for-saving",
+          "values": [
+            {
+              "name": "all"
+            }
+          ]
+        },
         {
           "name": "allowed-layouts",
-          "description": "Specify the print output layout(s) that the user can select based on the options available from the print service.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#allowedLayouts)",
+          "description": "Specify the print output layout(s) that the user can select based on the options available from the print service.\nThis property can take a string value or an array of string values.\n\nWhen this value is \"all\" (default value), all the print service layouts are available to be used.\nWhen an array of string values is used, only those values that match the options available from the print service will be used.\nIf none of the input string values match those available from the print service, `allowedLayouts` will fallback to default behavior.",
           "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.",
+          "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": "exclude-default-templates",
+          "description": "Indicates whether or not to include [defaultTemplates](module:esri/widgets/Print/PrintViewModel#defaultTemplates).",
+          "values": []
+        },
+        {
+          "name": "exclude-organization-templates",
+          "description": "Indicates whether or not to include templates from an organization's portal.",
           "values": []
         },
         {
           "name": "extra-parameters",
-          "description": "This option allows passing extra parameters (in addition to [templateOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions)) to the print (export webmap) requests.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#extraParameters)",
+          "description": "This option allows passing extra parameters (in addition to [templateOptions](#templateOptions)) to the print (export webmap) requests.",
           "values": []
         },
         {
           "name": "heading-level",
-          "description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#headingLevel)",
-          "values": []
+          "description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the widget's 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": "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.",
+          "name": "hide-header",
           "values": []
         },
         {
-          "name": "include-default-templates-disabled",
-          "description": "Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#defaultTemplates).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#includeDefaultTemplates)",
+          "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": []
         },
         {
@@ -5597,7 +5624,7 @@
         },
         {
           "name": "print-service-url",
-          "description": "The URL of the REST endpoint of the Export Web Map Task.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#printServiceUrl)",
+          "description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set, it is not necessary to set this property.",
           "values": []
         },
         {
@@ -5606,7 +5633,7 @@
         },
         {
           "name": "show-print-area-enabled",
-          "description": "The initial state of the print area toggle in the Print widget UI.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#showPrintAreaEnabled)",
+          "description": "The initial state of the print area toggle in the Print widget UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
           "values": []
         },
         {
@@ -7271,13 +7298,8 @@
     },
     {
       "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.",
+      "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.",
       "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.",
@@ -8139,7 +8161,7 @@
     },
     {
       "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- **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.",
+      "description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player 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\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\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 macOS and 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",