@arcgis/map-components 4.34.0-next.42 → 4.34.0-next.43

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-06-30T04:37:27",
+  "timestamp": "2025-07-01T04:43:43",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.42",
+    "version": "4.34.0-next.43",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -3627,8 +3627,16 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "The Bookmarks component allow end users to quickly navigate to a particular area of interest. It displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html), which are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks).",
+      "docs": "The Bookmarks component allows end users to quickly navigate to a particular area of interest.\nIt displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks).\n\nEach bookmark may contain the following properties: `name`, `thumbnail`, `viewpoint` (defines rotation, scale, and target geometry), and `timeExtent`.\nWhen a bookmark with a timeExtent is selected, the [arcgis-map.timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeExtent) of the Map will be set to the timeExtent of the selected bookmark.\nTo disable time capability in the Bookmarks component, set [timeDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#timeDisabled) to `true`.\n\nThe Bookmarks component can be used to create, edit, reorder, and delete bookmarks.\nTo enable these features, set the following properties to `true`:\n[showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) or are [provided manually](#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html).",
       "docsTags": [
+        {
+          "name": "since",
+          "text": "4.28"
+        },
+        {
+          "name": "see",
+          "text": "[Sample - Bookmarks component](https://developers.arcgis.com/javascript/latest/sample-code/bookmarks/)"
+        },
         {
           "name": "superclass",
           "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
@@ -3682,8 +3690,13 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#bookmarks)",
-          "docsTags": [],
+          "docs": "A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks), but can also be defined manually, as shown in the code snippet below.",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": "```js\nconst bookmarksElement = document.querySelector(\"arcgis-bookmarks\");\n// define bookmarks manually\nbookmarksElement.bookmarks = [\n  new Bookmark({\n    name: \"Angeles National Forest\",\n    viewpoint: {\n      targetGeometry: {\n        type: \"extent\",\n        spatialReference: {\n          wkid: 102100\n        },\n        xmin: -13139131.948889678,\n        ymin: 4047767.23531948,\n        xmax: -13092887.54677721,\n        ymax: 4090610.189673263\n      }\n    }\n  }),\n  new Bookmark({\n    name: \"Crystal Lake\",\n    viewpoint: {\n      targetGeometry: {\n        type: \"extent\",\n        spatialReference: {\n          wkid: 102100\n        },\n        xmin: -13125852.551697943,\n        ymin: 4066904.1101411926,\n        xmax: -13114291.451169826,\n        ymax: 4077614.8487296384\n      },\n      rotation: 90\n    }\n  })\n];"
+            }
+          ],
           "values": [],
           "optional": true,
           "required": false
@@ -3700,12 +3713,7 @@
           "attr": "closed",
           "reflectToAttr": false,
           "docs": "Indicates whether a component is closed. When `true`, the component will be hidden.",
-          "docsTags": [
-            {
-              "name": "since",
-              "text": "4.33"
-            }
-          ],
+          "docsTags": [],
           "default": "false",
           "values": [
             {
@@ -3731,8 +3739,13 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "Specifies how new bookmarks will be created if [visibleElements.addBookmarkButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#defaultCreateOptions)",
-          "docsTags": [],
+          "docs": "Specifies how new bookmarks will be created if [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is created. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel-BookmarkOptions.html)\nfor the full list of options.",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": "```js\nconst bookmarksElement = document.querySelector(\"arcgis-bookmarks\");\nbookmarksElement.showAddBookmarkButton = true;\nbookmarksElement.defaultCreateOptions = {\n  // whenever a new bookmark is created, a 100x100 px\n  // screenshot of the view will be taken and the rotation, scale, and extent\n  // of the view will not be set as the viewpoint of the new bookmark\n  takeScreenshot: true,\n  captureViewpoint: false,\n  captureTimeExtent: false, // the time extent will not be saved in the bookmark\n  screenshotSettings: {\n    width: 100,\n    height: 100\n  }\n};\n```"
+            }
+          ],
           "values": [],
           "optional": true,
           "required": false
@@ -3753,7 +3766,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "Specifies how bookmarks will be edited, if [visibleElements.editBookmarkButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#defaultEditOptions)",
+          "docs": "Specifies how bookmarks will be edited, if [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is edited. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel-BookmarkOptions.html)\nfor the full list of options.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -3769,8 +3782,8 @@
           },
           "mutable": true,
           "attr": "disabled",
-          "reflectToAttr": true,
-          "docs": "When true, the widget is visually withdrawn and cannot be interacted with.",
+          "reflectToAttr": false,
+          "docs": "When true, the component is visually withdrawn and cannot be interacted with.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -3793,7 +3806,12 @@
           "attr": "drag-enabled",
           "reflectToAttr": false,
           "docs": "Indicates if a Bookmark is able to be dragged in order to update its position in the list.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.29"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -3814,8 +3832,14 @@
           "mutable": true,
           "attr": "filter-placeholder",
           "reflectToAttr": false,
-          "docs": "Defines the text used as a placeholder when visibleElements.filter is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterPlaceholder)",
-          "docsTags": [],
+          "docs": "Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.29"
+            }
+          ],
+          "default": "\"\"",
           "values": [
             {
               "type": "string"
@@ -3835,8 +3859,14 @@
           "mutable": true,
           "attr": "filter-text",
           "reflectToAttr": false,
-          "docs": "Defines the text used to filter the bookmarks when visibleElements.filter is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterText)",
-          "docsTags": [],
+          "docs": "Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.29"
+            }
+          ],
+          "default": "\"\"",
           "values": [
             {
               "type": "string"
@@ -3855,14 +3885,61 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "This function provides the ability to override either the\n[MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or\n[SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#goToOverride)",
+          "docs": "This function provides the ability to override either the\n[MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or\n[SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#goToOverride)",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "headingLevel",
+          "type": "1 | 2 | 3 | 4 | 5 | 6",
+          "complexType": {
+            "original": "1 | 2 | 3 | 4 | 5 | 6",
+            "resolved": "1 | 2 | 3 | 4 | 5 | 6",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "heading-level",
+          "reflectToAttr": false,
+          "docs": "Indicates the heading level to use for the message \"No bookmarks\" when no bookmarks\nare available. By default, this message is rendered\nas a level 2 heading (e.g. `<h2>No bookmarks</h2>`). 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.",
           "docsTags": [
             {
-              "name": "since",
-              "text": "4.33"
+              "name": "see",
+              "text": "[Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)"
+            },
+            {
+              "name": "example",
+              "text": "```js\n// \"No bookmarks\" will render as an <h3>\nbookmarksElement.headingLevel = 3;\n```"
+            }
+          ],
+          "default": "2",
+          "values": [
+            {
+              "value": "1",
+              "type": "number"
+            },
+            {
+              "value": "2",
+              "type": "number"
+            },
+            {
+              "value": "3",
+              "type": "number"
+            },
+            {
+              "value": "4",
+              "type": "number"
+            },
+            {
+              "value": "5",
+              "type": "number"
+            },
+            {
+              "value": "6",
+              "type": "number"
             }
           ],
-          "values": [],
           "optional": true,
           "required": false
         },
@@ -3877,8 +3954,13 @@
           "mutable": true,
           "attr": "hide-flow",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -3899,8 +3981,13 @@
           "mutable": true,
           "attr": "hide-thumbnail",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Indicates whether the thumbnail associated with the bookmark is hidden.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -3921,8 +4008,13 @@
           "mutable": true,
           "attr": "hide-time",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -3943,14 +4035,14 @@
           "mutable": true,
           "attr": "icon",
           "reflectToAttr": false,
-          "docs": "Icon which represents the widget.",
+          "docs": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
           "docsTags": [
             {
               "name": "see",
               "text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
             }
           ],
-          "default": "\"bookmark\"",
+          "default": "\"icon\"",
           "values": [
             {
               "type": "string"
@@ -3970,7 +4062,7 @@
           "mutable": true,
           "attr": "label",
           "reflectToAttr": false,
-          "docs": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#label)",
+          "docs": "The component's default label.",
           "docsTags": [],
           "values": [
             {
@@ -3980,6 +4072,22 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "messageOverrides",
+          "type": "Record<string, unknown>",
+          "complexType": {
+            "original": "Record<string, unknown>",
+            "resolved": "Record<string, unknown>",
+            "references": {}
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "position",
           "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
@@ -3990,10 +4098,10 @@
           },
           "mutable": true,
           "attr": "position",
-          "reflectToAttr": false,
+          "reflectToAttr": true,
           "docs": "",
           "docsTags": [],
-          "default": "\"bottom-left\"",
+          "default": "\"top-left\"",
           "values": [
             {
               "value": "bottom-leading",
@@ -4097,8 +4205,13 @@
           "mutable": true,
           "attr": "show-add-bookmark-button",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Indicates whether to display the button to add a new bookmark.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -4119,8 +4232,13 @@
           "mutable": true,
           "attr": "show-close-button",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Indicates whether to display the close button.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -4141,8 +4259,13 @@
           "mutable": true,
           "attr": "show-collapse-button",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Indicates whether to display the collapse button.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -4163,8 +4286,13 @@
           "mutable": true,
           "attr": "show-edit-bookmark-button",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Indicates whether to display the button to edit a bookmark.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -4185,8 +4313,13 @@
           "mutable": true,
           "attr": "show-filter",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Indicates whether to display the bookmark filter.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -4207,8 +4340,13 @@
           "mutable": true,
           "attr": "show-heading",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "Indicates whether to display the heading.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.30"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -4249,6 +4387,33 @@
           ],
           "optional": true,
           "required": false
+        },
+        {
+          "name": "timeDisabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "time-disabled",
+          "reflectToAttr": false,
+          "docs": "Indicates whether to disable the time capability of the Bookmarks component.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.34"
+            }
+          ],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
         }
       ],
       "methods": [
@@ -4306,37 +4471,83 @@
           "parameters": [],
           "docs": "Permanently destroy the component.",
           "docsTags": []
+        },
+        {
+          "name": "goTo",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(bookmark: __esri.Bookmark): Promise<void>",
+            "parameters": [
+              {
+                "name": "bookmark",
+                "type": "Bookmark",
+                "docs": ""
+              }
+            ],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              },
+              "Bookmark": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "goTo(bookmark: __esri.Bookmark): Promise<void>",
+          "parameters": [
+            {
+              "name": "bookmark",
+              "type": "Bookmark",
+              "docs": ""
+            }
+          ],
+          "docs": "Zoom to a specific bookmark.",
+          "docsTags": []
         }
       ],
       "events": [
         {
-          "event": "arcgisClose",
-          "detail": "void",
+          "event": "arcgisBookmarkEdit",
+          "detail": "BookmarksBookmarkEditEvent",
           "bubbles": true,
           "complexType": {
-            "original": "void",
-            "resolved": "void",
-            "references": {}
+            "original": "BookmarksBookmarkEditEvent",
+            "resolved": "BookmarksBookmarkEditEvent",
+            "references": {
+              "BookmarksBookmarkEditEvent": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
           },
           "cancelable": true,
           "composed": true,
-          "docs": "Emitted when the component's close button is clicked.",
+          "docs": "\nFires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.",
           "docsTags": [
             {
-              "name": "since",
-              "text": "4.33"
+              "name": "example",
+              "text": "```js\n// once an edit has been made, enable the \"Save Webmap\" button\n//    to allow the user to save their changes\nbookmarksElement.addEventListener(\"arcgisBookmarkEdit\", (event) => {\n   saveBtn.disabled = false;\n});\n```"
             }
           ]
         },
         {
-          "event": "arcgisEdit",
-          "detail": "BookmarksBookmarkEditEvent",
+          "event": "arcgisBookmarkSelect",
+          "detail": "BookmarksBookmarkSelectEvent",
           "bubbles": true,
           "complexType": {
-            "original": "BookmarksBookmarkEditEvent",
-            "resolved": "BookmarksBookmarkEditEvent",
+            "original": "BookmarksBookmarkSelectEvent",
+            "resolved": "BookmarksBookmarkSelectEvent",
             "references": {
-              "BookmarksBookmarkEditEvent": {
+              "BookmarksBookmarkSelectEvent": {
                 "location": "import",
                 "path": "@arcgis/core/interfaces.d.ts",
                 "id": "notImplemented"
@@ -4345,8 +4556,13 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "",
-          "docsTags": []
+          "docs": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected.",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": "```html\n<arcgis-expand expanded>\n <arcgis-bookmarks></arcgis-bookmarks>\n</arcgis-expand>\n```\n\n```js\nconst bookmarksElement = document.querySelector(\"arcgis-bookmarks\");\nconst expandElement = document.querySelector(\"arcgis-expand\");\n\n// collapses the associated Expand component\n// when a bookmark is selected\nbookmarksElement.addEventListener(\"arcgisBookmarkSelect\", (event) => {\n  expandElement.expanded = false;\n});\n```"
+            }
+          ]
         },
         {
           "event": "arcgisPropertyChange",
@@ -4375,26 +4591,6 @@
           "composed": true,
           "docs": "Emitted when the component associated with a map or scene view is is ready to be interacted with.",
           "docsTags": []
-        },
-        {
-          "event": "arcgisSelect",
-          "detail": "BookmarksBookmarkSelectEvent",
-          "bubbles": true,
-          "complexType": {
-            "original": "BookmarksBookmarkSelectEvent",
-            "resolved": "BookmarksBookmarkSelectEvent",
-            "references": {
-              "BookmarksBookmarkSelectEvent": {
-                "location": "import",
-                "path": "@arcgis/core/interfaces.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "cancelable": true,
-          "composed": true,
-          "docs": "",
-          "docsTags": []
         }
       ],
       "styles": [],