npm - @arcgis/map-components - Versions diffs - 4.34.0-next.12 → 4.34.0-next.13 - Mend

@arcgis/map-components 4.34.0-next.12 → 4.34.0-next.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (251) hide show

package/dist/docs/api.json CHANGED Viewed

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-06-02T04:37:55",
+  "timestamp": "2025-06-03T04:52:27",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.12",
+    "version": "4.34.0-next.13",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -675,6 +675,7 @@
             {
               "kind": "field",
               "name": "analysis",
+              "description": "Analysis data object.",
               "type": {
                 "text": "AreaMeasurementAnalysis",
                 "references": [
@@ -687,8 +688,7 @@
                     "end": 23
                   }
                 ]
-              },
-              "readonly": true
+              }
             },
             {
               "kind": "field",
@@ -10624,6 +10624,7 @@
             {
               "kind": "field",
               "name": "analysis",
+              "description": "Analysis data object.",
               "type": {
                 "text": "DirectLineMeasurementAnalysis",
                 "references": [
@@ -10636,8 +10637,7 @@
                     "end": 29
                   }
                 ]
-              },
-              "readonly": true
+              }
             },
             {
               "kind": "field",
@@ -11214,6 +11214,7 @@
             {
               "kind": "field",
               "name": "analysis",
+              "description": "Analysis data object.",
               "type": {
                 "text": "DirectLineMeasurementAnalysis",
                 "references": [
@@ -11227,7 +11228,6 @@
                   }
                 ]
               },
-              "readonly": true,
               "inheritedFrom": {
                 "name": "ArcgisDirectLineMeasurement3d",
                 "module": "components/arcgis-direct-line-measurement-3d"
@@ -28222,8 +28222,7 @@
                     "end": 19
                   }
                 ]
-              },
-              "readonly": true
+              }
             },
             {
               "kind": "field",
@@ -36228,7 +36227,7 @@
           "customElement": true,
           "name": "ArcgisPrint",
           "tagName": "arcgis-print",
-          "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 [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 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 [TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale\ninstead.\n\nThe Print widget 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 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](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://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```",
+          "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```",
           "demos": [
             {
               "description": "Docs",
@@ -36434,7 +36433,7 @@
             {
               "kind": "field",
               "name": "exportedLinks",
-              "description": "The collection of links exported from the Print widget.",
+              "description": "The collection of links exported from the Print component.",
               "type": {
                 "text": "Collection<FileLink>",
                 "references": [
@@ -36474,7 +36473,7 @@
             {
               "kind": "field",
               "name": "headingLevel",
-              "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.",
+              "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 component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
               "type": {
                 "text": "1 | 2 | 3 | 4 | 5 | 6",
                 "values": [
@@ -36742,7 +36741,7 @@
             {
               "kind": "field",
               "name": "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.",
+              "description": "The initial state of the print area toggle in the Print component 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.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -36788,7 +36787,7 @@
             {
               "kind": "field",
               "name": "templateCustomTextElements",
-              "description": "An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print widget calls the `Get Layout Templates Info` task on the GPServer\nto discover possible `customTextElements` values for each template. The name of\nthe task must match `Get Layout Templates Info`, templates must be published\nwith `customTextElements`, and values must be strings. Values found there will be\npopulated in the Print widget under `Advanced options`. These values can be\noverwritten in the Print widget UI, or programmatically using this property.\nTo list all print templates available on the print service to see\nsee which templates were published with `customTextElements`, use the\n[effectiveTemplateCustomTextElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#effectiveTemplateCustomTextElements)\nproperty.",
+              "description": "An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print component calls the `Get Layout Templates Info` task on the GPServer\nto discover possible `customTextElements` values for each template. The name of\nthe task must match `Get Layout Templates Info`, templates must be published\nwith `customTextElements`, and values must be strings. Values found there will be\npopulated in the Print component under `Advanced options`. These values can be\noverwritten in the Print component UI, or programmatically using this property.\nTo list all print templates available on the print service to see\nsee which templates were published with `customTextElements`, use the\n[effectiveTemplateCustomTextElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#effectiveTemplateCustomTextElements)\nproperty.",
               "type": {
                 "text": "{\n    [x: string]: Array<HashMap<string>> | undefined;\n}",
                 "references": [
@@ -36805,7 +36804,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) widget to generate the print page.",
+              "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.",
               "type": {
                 "text": "TemplateOptions",
                 "references": [
@@ -36920,7 +36919,7 @@
             },
             {
               "name": "heading-level",
-              "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.",
+              "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 component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
               "type": {
                 "text": "1 | 2 | 3 | 4 | 5 | 6",
                 "values": [
@@ -37066,7 +37065,7 @@
             },
             {
               "name": "show-print-area-enabled",
-              "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.",
+              "description": "The initial state of the print area toggle in the Print component 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.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -41045,7 +41044,7 @@
             },
             {
               "kind": "field",
-              "name": "autoSelect",
+              "name": "autoSelectDisabled",
               "description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
               "type": {
                 "text": "boolean",
@@ -41055,8 +41054,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "attribute": "auto-select"
+              "default": "false",
+              "attribute": "auto-select-disabled"
             },
             {
               "kind": "method",
@@ -41209,7 +41208,7 @@
             },
             {
               "kind": "field",
-              "name": "includeDefaultSources",
+              "name": "includeDefaultSourcesDisabled",
               "description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
               "type": {
                 "text": "Function | boolean",
@@ -41231,8 +41230,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "attribute": "include-default-sources"
+              "default": "false",
+              "attribute": "include-default-sources-disabled"
             },
             {
               "kind": "field",
@@ -41250,7 +41249,7 @@
             },
             {
               "kind": "field",
-              "name": "locationEnabled",
+              "name": "locationDisabled",
               "description": "Enables location services within the component.\n\n![locationEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-locationEnabled.png)\n\n::: esri-md class=\"warning\"\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).\n:::",
               "type": {
                 "text": "boolean",
@@ -41260,8 +41259,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "attribute": "location-enabled"
+              "default": "false",
+              "attribute": "location-disabled"
             },
             {
               "kind": "field",
@@ -41318,7 +41317,7 @@
             },
             {
               "kind": "field",
-              "name": "popupEnabled",
+              "name": "popupDisabled",
               "description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
               "type": {
                 "text": "boolean",
@@ -41328,8 +41327,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "attribute": "popup-enabled"
+              "default": "false",
+              "attribute": "popup-disabled"
             },
             {
               "kind": "field",
@@ -41489,7 +41488,7 @@
             },
             {
               "kind": "field",
-              "name": "resultGraphicEnabled",
+              "name": "resultGraphicDisabled",
               "description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
               "type": {
                 "text": "boolean",
@@ -41499,8 +41498,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "attribute": "result-graphic-enabled"
+              "default": "false",
+              "attribute": "result-graphic-disabled"
             },
             {
               "kind": "field",
@@ -41626,7 +41625,7 @@
             },
             {
               "kind": "field",
-              "name": "searchAllEnabled",
+              "name": "searchAllDisabled",
               "description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-true.png)\n\nWhen `false`, no option to search all sources at once is available:\n\n![search-searchAllEnabled-false](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-false.png)",
               "type": {
                 "text": "boolean",
@@ -41636,8 +41635,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "attribute": "search-all-enabled"
+              "default": "false",
+              "attribute": "search-all-disabled"
             },
             {
               "kind": "field",
@@ -41852,7 +41851,7 @@
             },
             {
               "kind": "field",
-              "name": "suggestionsEnabled",
+              "name": "suggestionsDisabled",
               "description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
               "type": {
                 "text": "boolean",
@@ -41862,8 +41861,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "attribute": "suggestions-enabled"
+              "default": "false",
+              "attribute": "suggestions-disabled"
             }
           ],
           "attributes": [
@@ -41933,7 +41932,7 @@
               "fieldName": "autoDestroyDisabled"
             },
             {
-              "name": "auto-select",
+              "name": "auto-select-disabled",
               "description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
               "type": {
                 "text": "boolean",
@@ -41943,8 +41942,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "fieldName": "autoSelect"
+              "default": "false",
+              "fieldName": "autoSelectDisabled"
             },
             {
               "name": "disabled",
@@ -41975,7 +41974,7 @@
               "fieldName": "icon"
             },
             {
-              "name": "include-default-sources",
+              "name": "include-default-sources-disabled",
               "description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
               "type": {
                 "text": "boolean",
@@ -41985,8 +41984,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "fieldName": "includeDefaultSources"
+              "default": "false",
+              "fieldName": "includeDefaultSourcesDisabled"
             },
             {
               "name": "label",
@@ -42002,7 +42001,7 @@
               "fieldName": "label"
             },
             {
-              "name": "location-enabled",
+              "name": "location-disabled",
               "description": "Enables location services within the component.\n\n![locationEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-locationEnabled.png)\n\n::: esri-md class=\"warning\"\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).\n:::",
               "type": {
                 "text": "boolean",
@@ -42012,8 +42011,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "fieldName": "locationEnabled"
+              "default": "false",
+              "fieldName": "locationDisabled"
             },
             {
               "name": "max-results",
@@ -42058,7 +42057,7 @@
               "fieldName": "minSuggestCharacters"
             },
             {
-              "name": "popup-enabled",
+              "name": "popup-disabled",
               "description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
               "type": {
                 "text": "boolean",
@@ -42068,8 +42067,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "fieldName": "popupEnabled"
+              "default": "false",
+              "fieldName": "popupDisabled"
             },
             {
               "name": "position",
@@ -42130,7 +42129,7 @@
               "fieldName": "referenceElement"
             },
             {
-              "name": "result-graphic-enabled",
+              "name": "result-graphic-disabled",
               "description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
               "type": {
                 "text": "boolean",
@@ -42140,11 +42139,11 @@
                   }
                 ]
               },
-              "default": "true",
-              "fieldName": "resultGraphicEnabled"
+              "default": "false",
+              "fieldName": "resultGraphicDisabled"
             },
             {
-              "name": "search-all-enabled",
+              "name": "search-all-disabled",
               "description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-true.png)\n\nWhen `false`, no option to search all sources at once is available:\n\n![search-searchAllEnabled-false](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-false.png)",
               "type": {
                 "text": "boolean",
@@ -42154,8 +42153,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "fieldName": "searchAllEnabled"
+              "default": "false",
+              "fieldName": "searchAllDisabled"
             },
             {
               "name": "search-term",
@@ -42198,7 +42197,7 @@
               "fieldName": "state"
             },
             {
-              "name": "suggestions-enabled",
+              "name": "suggestions-disabled",
               "description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
               "type": {
                 "text": "boolean",
@@ -42208,8 +42207,8 @@
                   }
                 ]
               },
-              "default": "true",
-              "fieldName": "suggestionsEnabled"
+              "default": "false",
+              "fieldName": "suggestionsDisabled"
             }
           ],
           "events": [