@arcgis/map-components 5.1.0-next.2 → 5.1.0-next.21

package/dist/components/arcgis-volume-measurement/customElement.d.ts

@@ -1,20 +1,23 @@
 /// <reference path="../../index.d.ts" />
+import type VolumeMeasurementAnalysis from "@arcgis/core/analysis/VolumeMeasurementAnalysis.js";
 import type SceneView from "@arcgis/core/views/SceneView.js";
-import type VolumeMeasurementAnalysis2 from "@arcgis/core/analysis/VolumeMeasurementAnalysis.js";
-import type { VolumeMeasureType } from "@arcgis/core/analysis/VolumeMeasurement/types";
+import type { VolumeMeasureType } from "@arcgis/core/analysis/VolumeMeasurement/types.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { HeadingLevel } from "../../support/heading.js";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
+import type { ArcgisReferenceElement, HeadingLevel } from "../types.js";
+import type { VolumeMeasurementState } from "./types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { Icon as Icon } from "@esri/calcite-components/components/calcite-icon";
 import type { SystemOrVolumeUnit, SystemOrLengthUnit, LengthUnit, SystemOrAreaUnit } from "@arcgis/core/core/units.js";
 
 /**
+ * > The Volume Measurement component is currently in _preview_.
+ * > To learn about features in preview, see the [Frequently Asked Questions](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-preview-tag-mean)
+ *
  * The Volume Measurement component can be added to a
- * [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) to
+ * [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) to
  * calculate and visualize the volume of ground surfaces within a defined polygonal area.
  *
- * ![measurement-volume](https://developers.arcgis.com/javascript/latest/assets/img/components/volume-measurement/volume_measurement_poster.png)
+ * ![measurement-volume](https://developers.arcgis.com/javascript/latest/assets/references/components/volume-measurement/volume_measurement_poster.png)
  *
  * The Volume Measurement component offers multiple volume measurement modes:
  *
@@ -37,15 +40,15 @@ import type { SystemOrVolumeUnit, SystemOrLengthUnit, LengthUnit, SystemOrAreaUn
  * **Known Limitations**
  *
  * -  The Volume Measurement component can only be added to a
- * [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ * [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.
  * - The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.
  * - If the view is too close or too far from the measurement polygon, the results will not be computed due to LOD-induced inaccuracies.
  * - The elevation of the target surface in the "Cut & Fill Volume" mode is restricted to the range of -11 km and +9 km.
- * - This tool operates only on the non-transparent [Map.ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground),
- * [IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html)
- * and an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html).
+ * - This tool operates only on the non-transparent [Map.ground](https://developers.arcgis.com/javascript/latest/references/core/Map/#ground),
+ * [IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMeshLayer/)
+ * and an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMesh3DTilesLayer/).
  * - This tool does not support WGS 1984 spatial reference in a local
- * [viewing mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode).
+ * [viewing mode](https://developers.arcgis.com/javascript/latest/references/core/webscene/InitialViewProperties/#viewingMode).
  *
  * **Things to consider**
  *
@@ -53,35 +56,35 @@ import type { SystemOrVolumeUnit, SystemOrLengthUnit, LengthUnit, SystemOrAreaUn
  * and enter the target surface elevation.
  * - Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.
  * - Layer types currently supported for snapping are:
- * [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),
- * [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),
- * [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),
- * [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),
- * [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),
- * [3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),
- * and [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).
+ * [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),
+ * [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) (except Mesh geometries),
+ * [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),
+ * [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/),
+ * [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),
+ * [3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),
+ * and [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).
  *
  * **See also**
  *
- * - [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html)
- * - [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurementAnalysisView3D.html)
- * - [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementResult.html)
- * - [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementDisplayUnits.html)
- * and [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementInputUnits.html)
- * - [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementError.html)
+ * - [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurementAnalysis/)
+ * - [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurementAnalysisView3D/)
+ * - [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurement/VolumeMeasurementResult/)
+ * - [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurement/VolumeMeasurementDisplayUnits/)
+ * and [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurement/VolumeMeasurementInputUnits/)
+ * - [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurement/VolumeMeasurementError/)
  * - [Sample - Volume measurement analysis object](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)
  *
  * @since 5.0
  */
 export abstract class ArcgisVolumeMeasurement extends LitElement {
   /**
-   * The [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html)
+   * The [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurementAnalysis/)
    * created or modified by the component.
    *
-   * When connecting the Volume Measurement component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)
+   * When connecting the Volume Measurement component to the [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)
    * component, it automatically creates an empty analysis and adds it to the Scene's
-   * [analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.
-   * You can then wait for the [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurementAnalysisView3D.html)
+   * [arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.
+   * You can then wait for the [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurementAnalysisView3D/)
    * to be created before accessing the analysis results.
    *
    * ```js
@@ -105,7 +108,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    * ```
    * Whenever the component is destroyed, the analysis is automatically removed from the collection.
    *
-   * Alternatively, a programmatically created [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html)
+   * Alternatively, a programmatically created [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurementAnalysis/)
    * can be provided to the component.
    * Then, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.
    *
@@ -140,10 +143,10 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    *
    * @since 5.0
    */
-  accessor analysis: VolumeMeasurementAnalysis2;
+  accessor analysis: VolumeMeasurementAnalysis;
   /**
    * Unit system (imperial, metric) or specific unit used for displaying the area. Possible values are listed in
-   * [areaDisplayUnitOptions](#areaDisplayUnitOptions).
+   * [areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions).
    *
    * @since 5.0
    */
@@ -151,7 +154,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
   /**
    * List of available units and unit systems (imperial, metric) that are shown in the component's area display unit dropdown.
    * By default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-yards`, `square-miles`, `square-nautical-miles`, `square-us-feet`, `square-millimeters`, `square-centimeters`, `square-decimeters`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.
-   * Possible [areaDisplayUnit](#areaDisplayUnit) values can only be a subset of this list.
+   * Possible [areaDisplayUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnit) values can only be a subset of this list.
    *
    * @since 5.0
    */
@@ -168,7 +171,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
   accessor autoDestroyDisabled: boolean;
   /**
    * Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in
-   * [elevationDisplayUnitOptions](#elevationDisplayUnitOptions).
+   * [elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions).
    *
    * @since 5.0
    */
@@ -176,14 +179,14 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
   /**
    * List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.
    * By default, the following units are included: `metric`, `imperial`, `meters`, `millimeters`, `centimeters`, `decimeters`, `kilometers`, `inches`, `feet`, `yards`, `miles`, `nautical-miles`, `us-feet`.
-   * Possible [elevationDisplayUnit](#elevationDisplayUnit) values can only be a subset of this list.
+   * Possible [elevationDisplayUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnit) values can only be a subset of this list.
    *
    * @since 5.0
    */
   accessor elevationDisplayUnitOptions: Array<SystemOrLengthUnit>;
   /**
    * Unit used for inputting the cut and fill target elevation.
-   * Possible values are listed in [elevationInputUnitOptions](#elevationInputUnitOptions).
+   * Possible values are listed in [elevationInputUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnitOptions).
    *
    * This controls which unit is used when entering an elevation value via the tool's UI (for example, using the
    * shift manipulator tooltip input in "Cut & Fill Volume" mode).
@@ -196,7 +199,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    *
    * By default, the following units are included: `inches`, `feet`, `yards`, `miles`, `nautical-miles`, `us-feet`,
    * `millimeters`, `centimeters`, `decimeters`, `meters`, `kilometers`.
-   * The current [elevationInputUnit](#elevationInputUnit) value can only be a subset of this list.
+   * The current [elevationInputUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnit) value can only be a subset of this list.
    *
    * @since 5.0
    */
@@ -267,6 +270,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    * Indicates whether the component's visualization is hidden in the view.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideVisualization: boolean;
   /**
@@ -356,7 +360,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
   accessor mode: VolumeMeasureType;
   /**
    * Unit system (imperial, metric) or specific unit used for displaying the perimeter values. Possible values are
-   * listed in [perimeterDisplayUnitOptions](#perimeterDisplayUnitOptions).
+   * listed in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions).
    *
    * @since 5.0
    */
@@ -364,7 +368,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
   /**
    * List of available units and unit systems (imperial, metric) that are shown in the component's perimeter display unit dropdown.
    * By default, the following units are included: `metric`, `imperial`, `meters`, `millimeters`, `centimeters`, `decimeters`, `kilometers`, `inches`, `feet`, `yards`, `miles`, `nautical-miles`, `us-feet`.
-   * Possible [perimeterDisplayUnit](#perimeterDisplayUnit) values can only be a subset of this list.
+   * Possible [perimeterDisplayUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnit) values can only be a subset of this list.
    *
    * @since 5.0
    */
@@ -385,7 +389,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    *
    * @since 5.0
    */
-  get state(): "disabled" | "ready" | "measured" | "measuring";
+  get state(): VolumeMeasurementState;
   /**
    * The view associated with the component. 
    *   > **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 arcgis-volume-measurement component will be associated with a map or scene component rather than using the `view` property.
@@ -393,7 +397,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
   accessor view: SceneView | undefined;
   /**
    * Unit system (imperial, metric) or specific unit used for displaying the volume values. Possible values are listed in
-   * [volumeDisplayUnitOptions](#volumeDisplayUnitOptions).
+   * [volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions).
    *
    * @since 5.0
    */
@@ -401,7 +405,7 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
   /**
    * List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.
    * By default, the following units are included: `imperial`, `metric`, `liters`, `megaliters`, `gigaliters`, `cubic-millimeters`, `cubic-centimeters`, `cubic-decimeters`, `cubic-meters`, `cubic-kilometers`, `cubic-inches`, `cubic-us-feet`, `cubic-feet`, `cubic-yards`, `cubic-miles`.
-   * Possible [volumeDisplayUnit](#volumeDisplayUnit) values can only be a subset of this list.
+   * Possible [volumeDisplayUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnit) values can only be a subset of this list.
    *
    * @since 5.0
    */