@arcgis/map-components 5.0.0-next.11 → 5.0.0-next.13

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-10-05T04:45:55",
+  "timestamp": "2025-10-07T04:45:40",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "5.0.0-next.11",
+    "version": "5.0.0-next.13",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -10462,590 +10462,6 @@
       "parts": [],
       "listeners": []
     },
-    {
-      "filePath": "src/components/directline-measurement-3d/directline-measurement-3d.tsx",
-      "tag": "arcgis-directline-measurement-3d",
-      "overview": "",
-      "readme": "",
-      "usage": {},
-      "docs": "The Directline Measurement 3D component calculates and displays the 3D distance between two points. It can be used in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component to measure the vertical, horizontal, and direct distance between two points.",
-      "docsTags": [
-        {
-          "name": "internal"
-        },
-        {
-          "name": "superclass",
-          "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-        }
-      ],
-      "encapsulation": "shadow",
-      "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {},
-      "deprecation": "",
-      "props": [
-        {
-          "name": "analysis",
-          "type": "DirectLineMeasurementAnalysis",
-          "complexType": {
-            "original": "DirectLineMeasurementAnalysis",
-            "resolved": "DirectLineMeasurementAnalysis",
-            "references": {
-              "DirectLineMeasurementAnalysis": {
-                "location": "import",
-                "path": "@arcgis/core/interfaces.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n   startPoint: new Point({\n     spatialReference: { latestWkid: 3857, wkid: 102100 },\n     x: -13624995.61798748,\n     y: 4550334.030096778,\n     z: 63.378210234455764\n   }),\n   endPoint: new Point({\n     spatialReference: { latestWkid: 3857, wkid: 102100 },\n     x: -13624921.53589075,\n     y: 4550407.42357004,\n     z: 63.3783810287714\n   }),\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "values": [],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "autoDestroyDisabled",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "auto-destroy-disabled",
-          "reflectToAttr": false,
-          "docs": "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](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "icon",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "icon",
-          "reflectToAttr": true,
-          "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/)"
-            },
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "default": "\"measure-line\"",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "label",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "label",
-          "reflectToAttr": false,
-          "docs": "The component's default label.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "position",
-          "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
-          "complexType": {
-            "original": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
-            "resolved": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "position",
-          "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "deprecation": "since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead.",
-          "values": [
-            {
-              "value": "bottom-leading",
-              "type": "string"
-            },
-            {
-              "value": "bottom-left",
-              "type": "string"
-            },
-            {
-              "value": "bottom-right",
-              "type": "string"
-            },
-            {
-              "value": "bottom-trailing",
-              "type": "string"
-            },
-            {
-              "value": "manual",
-              "type": "string"
-            },
-            {
-              "value": "top-leading",
-              "type": "string"
-            },
-            {
-              "value": "top-left",
-              "type": "string"
-            },
-            {
-              "value": "top-right",
-              "type": "string"
-            },
-            {
-              "value": "top-trailing",
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "referenceElement",
-          "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string",
-          "complexType": {
-            "original": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string",
-            "resolved": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string",
-            "references": {
-              "HTMLArcgisLinkChartElement": {
-                "location": "local",
-                "path": "index.js",
-                "id": "notImplemented"
-              },
-              "HTMLArcgisMapElement": {
-                "location": "local",
-                "path": "index.js",
-                "id": "notImplemented"
-              },
-              "HTMLArcgisSceneElement": {
-                "location": "local",
-                "path": "index.js",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "mutable": true,
-          "attr": "reference-element",
-          "reflectToAttr": false,
-          "docs": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
-          "docsTags": [
-            {
-              "name": "see",
-              "text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
-            },
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "values": [
-            {
-              "type": "HTMLArcgisLinkChartElement"
-            },
-            {
-              "type": "HTMLArcgisMapElement"
-            },
-            {
-              "type": "HTMLArcgisSceneElement"
-            },
-            {
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "state",
-          "type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"",
-          "complexType": {
-            "original": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"",
-            "resolved": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "state",
-          "reflectToAttr": true,
-          "docs": "The component's state. The values mean the following:\n\n* `disabled` -  not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
-          "docsTags": [
-            {
-              "name": "readonly",
-              "text": ""
-            },
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "values": [
-            {
-              "value": "disabled",
-              "type": "string"
-            },
-            {
-              "value": "measured",
-              "type": "string"
-            },
-            {
-              "value": "measuring",
-              "type": "string"
-            },
-            {
-              "value": "ready",
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "unit",
-          "type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"",
-          "complexType": {
-            "original": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"",
-            "resolved": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "unit",
-          "reflectToAttr": false,
-          "docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "values": [
-            {
-              "value": "centimeters",
-              "type": "string"
-            },
-            {
-              "value": "decimeters",
-              "type": "string"
-            },
-            {
-              "value": "feet",
-              "type": "string"
-            },
-            {
-              "value": "imperial",
-              "type": "string"
-            },
-            {
-              "value": "inches",
-              "type": "string"
-            },
-            {
-              "value": "kilometers",
-              "type": "string"
-            },
-            {
-              "value": "meters",
-              "type": "string"
-            },
-            {
-              "value": "metric",
-              "type": "string"
-            },
-            {
-              "value": "miles",
-              "type": "string"
-            },
-            {
-              "value": "millimeters",
-              "type": "string"
-            },
-            {
-              "value": "nautical-miles",
-              "type": "string"
-            },
-            {
-              "value": "us-feet",
-              "type": "string"
-            },
-            {
-              "value": "yards",
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "unitOptions",
-          "type": "Array<\"imperial\" | \"metric\" | \"meters\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\">",
-          "complexType": {
-            "original": "Array<\"imperial\" | \"metric\" | \"meters\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\">",
-            "resolved": "Array<\"imperial\" | \"metric\" | \"meters\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\">",
-            "references": {
-              "Array": {
-                "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](#unit) values can only be a subset of this list.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "values": [],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "view",
-          "type": "SceneView",
-          "complexType": {
-            "original": "SceneView",
-            "resolved": "SceneView",
-            "references": {
-              "SceneView": {
-                "location": "import",
-                "path": "@arcgis/core/interfaces.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "The view associated with the component. \n  > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the ArcgisDirectLineMeasurement3d component will be associated with a map or scene component rather than using the `view` property.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ],
-          "values": [],
-          "optional": true,
-          "required": false
-        }
-      ],
-      "methods": [
-        {
-          "name": "clear",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "(): Promise<void>",
-            "parameters": [],
-            "return": "Promise<void>",
-            "references": {
-              "Promise": {
-                "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "signature": "clear(): Promise<void>",
-          "parameters": [],
-          "docs": "Clears the current measurement.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ]
-        },
-        {
-          "name": "componentOnReady",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "(): Promise<void>",
-            "parameters": [],
-            "return": "Promise<void>",
-            "references": {
-              "Promise": {
-                "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "signature": "componentOnReady(): Promise<void>",
-          "parameters": [],
-          "docs": "Create a promise that resolves once component is fully loaded.",
-          "docsTags": [
-            {
-              "name": "example",
-              "text": "```js\nconst deprecatedArcgisDirectLineMeasurement3d = document.querySelector(\"arcgis-directline-measurement-3d\");\ndocument.body.append(deprecatedArcgisDirectLineMeasurement3d);\nawait deprecatedArcgisDirectLineMeasurement3d.componentOnReady();\nconsole.log(\"arcgis-directline-measurement-3d is ready to go!\");\n```"
-            },
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
-            }
-          ]
-        },
-        {
-          "name": "destroy",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "(): Promise<void>",
-            "parameters": [],
-            "return": "Promise<void>",
-            "references": {
-              "Promise": {
-                "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "signature": "destroy(): Promise<void>",
-          "parameters": [],
-          "docs": "Permanently destroy the component.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ]
-        },
-        {
-          "name": "start",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "(): Promise<void>",
-            "parameters": [],
-            "return": "Promise<void>",
-            "references": {
-              "Promise": {
-                "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "signature": "start(): Promise<void>",
-          "parameters": [],
-          "docs": "Starts a new measurement.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ]
-        }
-      ],
-      "events": [
-        {
-          "event": "arcgisPropertyChange",
-          "detail": "{ name: \"state\" | \"analysis\"; }",
-          "bubbles": true,
-          "complexType": {
-            "original": "{ name: \"state\" | \"analysis\"; }",
-            "resolved": "{ name: \"state\" | \"analysis\"; }",
-            "references": {}
-          },
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ]
-        },
-        {
-          "event": "arcgisReady",
-          "detail": "void",
-          "bubbles": true,
-          "complexType": {
-            "original": "void",
-            "resolved": "void",
-            "references": {}
-          },
-          "cancelable": true,
-          "composed": true,
-          "docs": "Emitted when the component associated with a map or scene view is ready to be interacted with.",
-          "docsTags": [
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
-            }
-          ]
-        }
-      ],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "listeners": []
-    },
     {
       "filePath": "src/components/distance-measurement-2d/distance-measurement-2d.tsx",
       "tag": "arcgis-distance-measurement-2d",
@@ -14902,7 +14318,7 @@
           "mutable": true,
           "attr": "mode",
           "reflectToAttr": false,
-          "docs": "The mode in which the component displays. These modes are listed below.\n\n| mode         | description |\n|--------------|-------------|\n| auto         | This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application. |\n| floating     | Use this mode if you wish to always display the component as floating regardless of browser size. |\n| drawer       | Use this mode if you wish to always display the component in a panel regardless of browser size. |",
+          "docs": "The mode in which the component displays. These modes are listed below:\n\n- `auto`: This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application.\n- `floating`: Use this mode if you wish to always display the component as floating in a [Calcite Popover component](https://developers.arcgis.com/calcite-design-system/components/popover/) regardless of browser size.\n- `drawer`: Use this mode if you wish to always display the component in a [Calcite Sheet component](https://developers.arcgis.com/calcite-design-system/components/sheet/) regardless of browser size.",
           "docsTags": [],
           "default": "\"auto\"",
           "values": [
@@ -14933,7 +14349,7 @@
           "mutable": true,
           "attr": "placement",
           "reflectToAttr": false,
-          "docs": "The placement used by the [calcite popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
+          "docs": "The placement used by the [Calcite Popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
           "docsTags": [],
           "values": [
             {