@arcgis/map-components 5.2.0-next.143 → 5.2.0-next.145

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

@@ -48,6 +48,9 @@ import type { SystemOrVolumeUnit, SystemOrLengthUnit, LengthUnit, SystemOrAreaUn
  * 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/references/core/webscene/InitialViewProperties/#viewingMode).
+ * - The cut-fill elevation tooltip remains enabled independently of
+ * [ViewOptions.tooltips](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#tooltips).
+ * Its display and input units can still inherit options on the view.
  *
  * **Things to consider**
  *
@@ -149,7 +152,10 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    *
    * When no area unit is explicitly set on the component or its analysis, this property uses the area unit configured in the view through
    * [view.options.displayUnits.area](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).
+   * If that option is unset or unavailable in [areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions),
+   * the component uses its default unit if available, or the first available unit.
    * This property overrides the area unit on this component's analysis without changing the units configured in the view.
+   * The reset button clears both overrides and resumes this inheritance and fallback behavior.
    *
    * @since 5.0
    */
@@ -157,9 +163,9 @@ 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`.
-   * If the unit inherited from the view through
+   * When neither the component nor its analysis has an explicit area unit, the unit inherited from
    * [view.options.displayUnits.area](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits)
-   * is not listed in [areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions), the component checks whether its default unit is listed there.
+   * is used if listed in [areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions). Otherwise, the component checks whether its default unit is listed there.
    * If it is, the component uses that default. If neither unit is listed, it uses the first entry in
    * [areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions).
    *
@@ -191,7 +197,10 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    *
    * When no elevation unit is explicitly set on the component or its analysis, this property uses the vertical length unit configured in the view through
    * [view.options.displayUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).
+   * If that option is unset or unavailable in [elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions),
+   * the component uses its default unit if available, or the first available unit.
    * This property overrides the elevation unit on this component's analysis without changing the units configured in the view.
+   * The reset button clears both overrides and resumes this inheritance and fallback behavior.
    *
    * @since 5.0
    */
@@ -199,9 +208,9 @@ 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`.
-   * If the unit inherited from the view through
+   * When neither the component nor its analysis has an explicit elevation display unit, the unit inherited from
    * [view.options.displayUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits)
-   * is not listed in [elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions), the component checks whether its default unit is listed there.
+   * is used if listed in [elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions). Otherwise, the component checks whether its default unit is listed there.
    * If it is, the component uses that default. If neither unit is listed, it uses the first entry in
    * [elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions).
    *
@@ -218,8 +227,11 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    * When no elevation input unit is explicitly set on the component or its analysis, this property uses the vertical length input unit configured in the view through
    * [view.options.inputUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits).
    * The `metric` and `imperial` measurement systems resolve to `meters` and `feet`, respectively.
+   * If that option is unset or its resolved unit is unavailable in [elevationInputUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnitOptions),
+   * the component uses its default unit if available, or the first available unit.
    * This property overrides the elevation input unit on this component's analysis without changing the units configured in the view.
    * Changing this property preserves the target surface elevation.
+   * The reset button clears both overrides and resumes this inheritance and fallback behavior while preserving the target surface elevation.
    *
    * @since 5.0
    */
@@ -229,7 +241,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 unit inherited from the view through
+   * When neither the component nor its analysis has an explicit elevation input unit, the unit inherited from
    * [view.options.inputUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits)
    * resolves to `meters` for `metric` and `feet` for `imperial`.
    * If the inherited unit is not listed in [elevationInputUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnitOptions), the component checks whether its default unit is listed there.
@@ -298,7 +310,9 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    */
   accessor hidePerimeterDisplayUnitSelect: boolean;
   /**
-   * If true, all unit-reset buttons will be hidden. Unit selection dropdowns remain available, but users cannot reset units to their defaults using the UI.
+   * If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.
+   *
+   * Resetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.
    *
    * @default false
    * @since 5.2
@@ -466,7 +480,10 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    *
    * When no perimeter unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through
    * [view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).
+   * If that option is unset or unavailable in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions),
+   * the component uses its default unit if available, or the first available unit.
    * This property overrides the perimeter unit on this component's analysis without changing the units configured in the view.
+   * The reset button clears both overrides and resumes this inheritance and fallback behavior.
    *
    * @since 5.0
    */
@@ -474,9 +491,9 @@ 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`.
-   * If the unit inherited from the view through
+   * When neither the component nor its analysis has an explicit perimeter unit, the unit inherited from
    * [view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits)
-   * is not listed in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions), the component checks whether its default unit is listed there.
+   * is used if listed in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions). Otherwise, the component checks whether its default unit is listed there.
    * If it is, the component uses that default. If neither unit is listed, it uses the first entry in
    * [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions).
    *
@@ -511,7 +528,10 @@ export abstract class ArcgisVolumeMeasurement extends LitElement {
    *
    * When no volume unit is explicitly set on the component or its analysis, this property uses the volume unit configured in the view through
    * [view.options.displayUnits.volume](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).
+   * If that option is unset or unavailable in [volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions),
+   * the component uses its default unit if available, or the first available unit.
    * This property overrides the volume unit on this component's analysis without changing the units configured in the view.
+   * The reset button clears both overrides and resumes this inheritance and fallback behavior.
    *
    * @since 5.0
    */
@@ -519,9 +539,9 @@ 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`.
-   * If the unit inherited from the view through
+   * When neither the component nor its analysis has an explicit volume unit, the unit inherited from
    * [view.options.displayUnits.volume](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits)
-   * is not listed in [volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions), the component checks whether its default unit is listed there.
+   * is used if listed in [volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions). Otherwise, the component checks whether its default unit is listed there.
    * If it is, the component uses that default. If neither unit is listed, it uses the first entry in
    * [volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions).
    *