@arcgis/map-components 5.0.0-next.46 → 5.0.0-next.47

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-11-06T04:39:41",
+  "timestamp": "2025-11-07T04:36:36",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "5.0.0-next.46",
+    "version": "5.0.0-next.47",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -56071,6 +56071,715 @@
       "parts": [],
       "listeners": []
     },
+    {
+      "filePath": "src/components/volume-measurement/volume-measurement.tsx",
+      "tag": "arcgis-volume-measurement",
+      "overview": "",
+      "readme": "",
+      "usage": {},
+      "docs": "The Volume Measurement component can be used to measure the volume of content in the scene.",
+      "docsTags": [
+        {
+          "name": "since",
+          "text": "5.0"
+        },
+        {
+          "name": "superclass",
+          "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+        }
+      ],
+      "encapsulation": "shadow",
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {},
+      "props": [
+        {
+          "name": "analysis",
+          "type": "VolumeMeasurementAnalysis",
+          "complexType": {
+            "original": "VolumeMeasurementAnalysis",
+            "resolved": "VolumeMeasurementAnalysis",
+            "references": {
+              "VolumeMeasurementAnalysis": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "Analysis data object.",
+          "docsTags": [],
+          "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-volume-measurement/#destroy) method when you are done to\nprevent memory leaks.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "elevationUnit",
+          "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": "elevation-unit",
+          "reflectToAttr": false,
+          "docs": "Unit system (imperial, metric) or specific unit used for displaying the elevation values. Possible values are listed in\n[elevationUnitOptions](#elevationUnitOptions).",
+          "docsTags": [],
+          "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": "elevationUnitOptions",
+          "type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">",
+          "complexType": {
+            "original": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">",
+            "resolved": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">",
+            "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: `meters`, `imperial`, `metric`, `millimeters`, `centimeters`, `decimeters`, `kilometers`, `inches`, `feet`, `yards`, `miles`, `nautical-miles`, `us-feet`.\nPossible [elevationUnit](#elevationUnit) values can only be a subset of this list.",
+          "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": "",
+          "docsTags": [],
+          "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"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "hideHeader",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "hide-header",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "hideModeSelect",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "hide-mode-select",
+          "reflectToAttr": false,
+          "docs": "Hides the mode selection dropdown.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "hideUnits",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "hide-units",
+          "reflectToAttr": false,
+          "docs": "Hides the units dropdown selectors.",
+          "docsTags": [],
+          "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/)"
+            }
+          ],
+          "default": "\"measure-area\"",
+          "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": [],
+          "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": [],
+          "deprecation": "since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) 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)"
+            }
+          ],
+          "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": ""
+            }
+          ],
+          "values": [
+            {
+              "value": "disabled",
+              "type": "string"
+            },
+            {
+              "value": "measured",
+              "type": "string"
+            },
+            {
+              "value": "measuring",
+              "type": "string"
+            },
+            {
+              "value": "ready",
+              "type": "string"
+            }
+          ],
+          "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 Volume Measurement component will be associated with a map or scene component rather than using the `view` property.",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "volumeUnit",
+          "type": "\"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-feet\" | \"cubic-inches\" | \"cubic-kilometers\" | \"cubic-meters\" | \"cubic-miles\" | \"cubic-millimeters\" | \"cubic-yards\" | \"imperial\" | \"liters\" | \"metric\"",
+          "complexType": {
+            "original": "\"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-feet\" | \"cubic-inches\" | \"cubic-kilometers\" | \"cubic-meters\" | \"cubic-miles\" | \"cubic-millimeters\" | \"cubic-yards\" | \"imperial\" | \"liters\" | \"metric\"",
+            "resolved": "\"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-feet\" | \"cubic-inches\" | \"cubic-kilometers\" | \"cubic-meters\" | \"cubic-miles\" | \"cubic-millimeters\" | \"cubic-yards\" | \"imperial\" | \"liters\" | \"metric\"",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "volume-unit",
+          "reflectToAttr": false,
+          "docs": "Unit system (imperial, metric) or specific unit used for displaying the volume values. Possible values are listed in\n[volumeUnitOptions](#volumeUnitOptions).",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "cubic-centimeters",
+              "type": "string"
+            },
+            {
+              "value": "cubic-decimeters",
+              "type": "string"
+            },
+            {
+              "value": "cubic-feet",
+              "type": "string"
+            },
+            {
+              "value": "cubic-inches",
+              "type": "string"
+            },
+            {
+              "value": "cubic-kilometers",
+              "type": "string"
+            },
+            {
+              "value": "cubic-meters",
+              "type": "string"
+            },
+            {
+              "value": "cubic-miles",
+              "type": "string"
+            },
+            {
+              "value": "cubic-millimeters",
+              "type": "string"
+            },
+            {
+              "value": "cubic-yards",
+              "type": "string"
+            },
+            {
+              "value": "imperial",
+              "type": "string"
+            },
+            {
+              "value": "liters",
+              "type": "string"
+            },
+            {
+              "value": "metric",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "volumeUnitOptions",
+          "type": "Array<\"imperial\" | \"metric\" | \"liters\" | \"cubic-millimeters\" | \"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-meters\" | \"cubic-kilometers\" | \"cubic-inches\" | \"cubic-feet\" | \"cubic-yards\" | \"cubic-miles\">",
+          "complexType": {
+            "original": "Array<\"imperial\" | \"metric\" | \"liters\" | \"cubic-millimeters\" | \"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-meters\" | \"cubic-kilometers\" | \"cubic-inches\" | \"cubic-feet\" | \"cubic-yards\" | \"cubic-miles\">",
+            "resolved": "Array<\"imperial\" | \"metric\" | \"liters\" | \"cubic-millimeters\" | \"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-meters\" | \"cubic-kilometers\" | \"cubic-inches\" | \"cubic-feet\" | \"cubic-yards\" | \"cubic-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: `imperial`, `metric`, `liters`, `cubic-millimeters`, `cubic-centimeters`, `cubic-decimeters`, `cubic-meters`, `cubic-kilometers`, `cubic-inches`, `cubic-feet`, `cubic-yards`, `cubic-miles`.\nPossible [volumeUnit](#volumeUnit) values can only be a subset of this list.",
+          "docsTags": [],
+          "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": "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 arcgisVolumeMeasurement = document.querySelector(\"arcgis-volume-measurement\");\ndocument.body.append(arcgisVolumeMeasurement);\nawait arcgisVolumeMeasurement.componentOnReady();\nconsole.log(\"arcgis-volume-measurement 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": "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": []
+        }
+      ],
+      "events": [
+        {
+          "event": "arcgisPropertyChange",
+          "detail": "{ name: \"analysis\" | \"state\"; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{ name: \"analysis\" | \"state\"; }",
+            "resolved": "{ name: \"analysis\" | \"state\"; }",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
+          "docsTags": []
+        },
+        {
+          "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": []
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "listeners": []
+    },
     {
       "filePath": "src/components/weather/weather.tsx",
       "tag": "arcgis-weather",