@arcgis/map-components 4.34.0-next.14 → 4.34.0-next.15

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-06-04T04:37:39",
+  "timestamp": "2025-06-05T04:42:36",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.14",
+    "version": "4.34.0-next.15",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -2207,7 +2207,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -4012,7 +4012,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -7040,7 +7040,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -9214,7 +9214,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -23422,7 +23422,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -24106,7 +24106,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -25969,7 +25969,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -28372,7 +28372,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -30743,7 +30743,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -31405,7 +31405,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -34950,7 +34950,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -36247,7 +36247,7 @@
           "customElement": true,
           "name": "ArcgisPrint",
           "tagName": "arcgis-print",
-          "description": "The 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.\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 component works with the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) which generates a printer-ready version of the map.\n\nThe Print component 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 component can preserve map scale or map extent in the printout. By default, the map extent is\npreserved. Use [TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale\ninstead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#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 component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known Limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) 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://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```",
+          "description": "The 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.\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 component works with the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#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 component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known Limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) 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://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```",
           "demos": [
             {
               "description": "Docs",
@@ -36296,6 +36296,7 @@
             {
               "kind": "field",
               "name": "allowedFormatsForSaving",
+              "description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
               "type": {
                 "text": "\"all\" | Array<string>",
                 "references": [
@@ -36366,7 +36367,12 @@
               "name": "browseTemplateButtonOnClick",
               "type": {
                 "text": "((() => void))"
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "internal"
+                }
+              ]
             },
             {
               "kind": "method",
@@ -36578,7 +36584,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -36670,7 +36676,7 @@
             {
               "kind": "field",
               "name": "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.",
+              "description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
               "type": {
                 "text": "string",
                 "values": [
@@ -36756,7 +36762,12 @@
                     "end": 48
                   }
                 ]
-              }
+              },
+              "docsTags": [
+                {
+                  "name": "internal"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -36776,7 +36787,7 @@
             {
               "kind": "field",
               "name": "state",
-              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#state)",
+              "description": "The state of the Print component.",
               "type": {
                 "text": "\"disabled\" | \"error\" | \"initializing\" | \"ready\"",
                 "values": [
@@ -36824,7 +36835,7 @@
             {
               "kind": "field",
               "name": "templateOptions",
-              "description": "Defines the layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) component to generate the print page.",
+              "description": "Defines the layout template options used by the Print component to generate the print page.",
               "type": {
                 "text": "TemplateOptions",
                 "references": [
@@ -36857,6 +36868,7 @@
             },
             {
               "name": "allowed-formats-for-saving",
+              "description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
               "type": {
                 "text": "\"all\"",
                 "values": [
@@ -37060,7 +37072,7 @@
             },
             {
               "name": "print-service-url",
-              "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.",
+              "description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
               "type": {
                 "text": "string",
                 "values": [
@@ -37099,7 +37111,7 @@
             },
             {
               "name": "state",
-              "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#state)",
+              "description": "The state of the Print component.",
               "type": {
                 "text": "\"disabled\" | \"error\" | \"initializing\" | \"ready\"",
                 "values": [
@@ -37128,6 +37140,7 @@
           "events": [
             {
               "name": "arcgisComplete",
+              "description": "Emitted when the component is complete.",
               "type": {
                 "text": "{ link: FileLink; }"
               }
@@ -37148,6 +37161,7 @@
             },
             {
               "name": "arcgisSubmit",
+              "description": "Emitted when the component is submitted.",
               "type": {
                 "text": "{ link: FileLink; }"
               }
@@ -37319,7 +37333,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -41321,7 +41335,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -45757,7 +45771,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -47665,7 +47679,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -50140,7 +50154,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               },
@@ -50636,7 +50650,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -54796,7 +54810,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -55222,6 +55236,12 @@
               "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/"
             }
           ],
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.33"
+            }
+          ],
           "superclass": {
             "name": "LitElement",
             "package": "@arcgis/lumina"
@@ -55402,6 +55422,12 @@
               "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/"
             }
           ],
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.33"
+            }
+          ],
           "superclass": {
             "name": "LitElement",
             "package": "@arcgis/lumina"
@@ -55600,7 +55626,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -56162,7 +56188,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }
@@ -56640,7 +56666,7 @@
             {
               "kind": "field",
               "name": "messageOverrides",
-              "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
+              "description": "Replace localized message strings with your own strings. <br>_**Note**: Individual message keys may change between releases._",
               "type": {
                 "text": "Record<string, unknown>"
               }