@arcgis/map-components 5.0.0-next.120 → 5.0.0-next.122

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

@@ -5,7 +5,6 @@ import { ArcgisReferenceElement } from '../../utils/component-utils';
 import { default as VolumeMeasurementViewModel } from './VolumeMeasurementViewModel';
 import { default as VolumeMeasurementAnalysis } from '@arcgis/core/analysis/VolumeMeasurementAnalysis';
 import { HeadingLevel } from '../../support/heading';
-import { LengthUnit, SystemOrLengthUnit, SystemOrVolumeUnit } from '@arcgis/core/core/units';
 import { VolumeMeasureType } from '@arcgis/core/analysis/VolumeMeasurement/types';
 
 declare const useViewModel: (component: LitElement & Pick<VolumeMeasurementViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<VolumeMeasurementViewModel>) => VolumeMeasurementViewModel;
@@ -120,6 +119,8 @@ export declare class ArcgisVolumeMeasurement extends LitElement {
      * // Connect the analysis to the measurement component:
      * volumeMeasurementElement.analysis = volumeMeasurementAnalysis;
      * ```
+     *
+     * @since 5.0
      */
     analysis: VolumeMeasurementAnalysis;
     /**
@@ -148,6 +149,11 @@ export declare class ArcgisVolumeMeasurement extends LitElement {
      * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
      */
     referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * Specifies the analysis' desired measurement type.
+     *
+     * @since 5.0
+     */
     get mode(): VolumeMeasureType;
     set mode(value: VolumeMeasureType);
     /**
@@ -157,58 +163,112 @@ export declare class ArcgisVolumeMeasurement extends LitElement {
      * * `ready` - ready for measuring
      * * `measuring` - currently measuring
      * * `measured` - measuring has finished
+     *
+     * @since 5.0
      */
     readonly state: "disabled" | "ready" | "measured" | "measuring";
     /**
      * Unit system (imperial, metric) or specific unit used for displaying the volume values. Possible values are listed in
-     * [volumeUnitOptions](#volumeUnitOptions).
+     * [volumeDisplayUnitOptions](#volumeDisplayUnitOptions).
+     *
+     * @since 5.0
      */
-    volumeUnit: SystemOrVolumeUnit;
+    volumeDisplayUnit: import('@arcgis/core/core/units').SystemOrVolumeUnit;
     /**
      * 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`, `cubic-millimeters`, `cubic-centimeters`, `cubic-decimeters`, `cubic-meters`, `cubic-kilometers`, `cubic-inches`, `cubic-feet`, `cubic-yards`, `cubic-miles`.
-     * Possible [volumeUnit](#volumeUnit) values can only be a subset of this list.
+     * Possible [volumeDisplayUnit](#volumeDisplayUnit) values can only be a subset of this list.
+     *
+     * @since 5.0
      */
-    volumeUnitOptions: SystemOrVolumeUnit[];
+    volumeDisplayUnitOptions: import('@arcgis/core/core/units').SystemOrVolumeUnit[];
     /**
      * Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in
-     * [elevationUnitOptions](#elevationUnitOptions).
+     * [elevationDisplayUnitOptions](#elevationDisplayUnitOptions).
+     *
+     * @since 5.0
      */
-    elevationUnit: SystemOrLengthUnit;
+    elevationDisplayUnit: import('@arcgis/core/core/units').SystemOrLengthUnit;
     /**
      * 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 [elevationUnit](#elevationUnit) values can only be a subset of this list.
+     * Possible [elevationDisplayUnit](#elevationDisplayUnit) values can only be a subset of this list.
+     *
+     * @since 5.0
+     */
+    elevationDisplayUnitOptions: import('@arcgis/core/core/units').SystemOrLengthUnit[];
+    elevationInputUnit: import('@arcgis/core/core/units').LengthUnit;
+    elevationInputUnitOptions: import('@arcgis/core/core/units').LengthUnit[];
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the area. Possible values are listed in
+     * [areaDisplayUnitOptions](#areaDisplayUnitOptions).
+     *
+     * @since 5.0
+     */
+    areaDisplayUnit: import('@arcgis/core/core/units').SystemOrAreaUnit;
+    /**
+     * 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.
+     *
+     * @since 5.0
+     */
+    areaDisplayUnitOptions: import('@arcgis/core/core/units').SystemOrAreaUnit[];
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the area. Possible values are listed in
+     * [areaDisplayUnitOptions](#areaDisplayUnitOptions).
+     *
+     * @since 5.0
+     */
+    perimeterDisplayUnit: import('@arcgis/core/core/units').SystemOrLengthUnit;
+    /**
+     * 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`, `meters`, `millimeters`, `centimeters`, `decimeters`, `kilometers`, `inches`, `feet`, `yards`, `miles`, `nautical-miles`, `us-feet`.
+     * Possible [areaDisplayUnit](#areaDisplayUnit) values can only be a subset of this list.
+     *
+     * @since 5.0
      */
-    elevationUnitOptions: SystemOrLengthUnit[];
-    elevationInputUnit: LengthUnit;
-    elevationInputUnitOptions: LengthUnit[];
+    perimeterDisplayUnitOptions: import('@arcgis/core/core/units').SystemOrLengthUnit[];
     /**
      * Hides the header.
      *
      * @default false
+     * @since 5.0
      */
     hideHeader: boolean;
     /**
      * Hides the unit settings button.
      *
      * @default false
+     * @since 5.0
      */
     hideUnitSettings: boolean;
-    /** @default false */
-    hideInputUnitSettings: boolean;
-    /** @default false */
-    hideDisplayUnitSettings: boolean;
-    /** @default false */
+    /**
+     * Hides the elevation display unit dropdown.
+     *
+     * @default false
+     * @since 5.0
+     */
     hideElevationDisplayUnitSelect: boolean;
-    /** @default false */
+    /**
+     * Hides the elevation input unit dropdown.
+     *
+     * @default false
+     * @since 5.0
+     */
     hideElevationInputUnitSelect: boolean;
-    /** @default false */
+    /**
+     * Hides the volume display unit dropdown.
+     *
+     * @default false
+     * @since 5.0
+     */
     hideVolumeDisplayUnitSelect: boolean;
     /**
      * Hides the mode selection dropdown.
      *
      * @default false
+     * @since 5.0
      */
     hideModeSelect: boolean;
     /**
@@ -223,11 +283,33 @@ export declare class ArcgisVolumeMeasurement extends LitElement {
      * @default 2
      */
     headingLevel: HeadingLevel;
-    /** Clears the current measurement. */
+    /**
+     * Hides the area display unit dropdown.
+     *
+     * @default false
+     * @since 5.0
+     */
+    hideAreaDisplayUnitSelect: boolean;
+    /**
+     * Hides the perimeter display unit dropdown.
+     *
+     * @default false
+     * @since 5.0
+     */
+    hidePerimeterDisplayUnitSelect: boolean;
+    /**
+     * Clears the current measurement.
+     *
+     * @since 5.0
+     */
     clear(): Promise<void>;
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
-    /** Starts a new measurement. */
+    /**
+     * Starts a new measurement.
+     *
+     * @since 5.0
+     */
     start(): Promise<void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {