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

package/dist/components/arcgis-video-player-slider/customElement.js

@@ -1,33 +1,33 @@
 import { c as a } from "../../chunks/runtime.js";
-import { css as c, html as l } from "lit";
-import { LitElement as t, safeClassMap as s } from "@arcgis/lumina";
+import { css as t, html as l } from "lit";
+import { LitElement as c, safeClassMap as s } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.12 */
-const d = c`.arcgis-video-player__slider-progress-container{position:relative;z-index:1;width:100%}.arcgis-video-player__progress{--arcgis-video-player-progress-width: 2px;appearance:none;display:block;position:absolute;top:calc(50% - var(--arcgis-video-player-progress-width) / 2);left:var(--arcgis-video-player-controls-spacing);border:none;background:var(--calcite-color-border-1);cursor:pointer;width:calc(100% - var(--arcgis-video-player-controls-spacing) * 2);height:var(--arcgis-video-player-progress-width)}.arcgis-video-player__progress::-webkit-progress-bar{background-color:var(--calcite-color-border-3)}.arcgis-video-player__progress::-webkit-progress-value{background-color:var(--calcite-color-border-input)}.arcgis-video-player__progress::-moz-progress-bar{background-color:var(--calcite-color-border-3)}.arcgis-video-player__slider{--calcite-slider-track-color: transparent;background-color:var(--calcite-color-foreground-1);padding:calc(var(--arcgis-video-player-controls-spacing) / 4) calc(var(--arcgis-video-player-controls-spacing) / 2)}`, o = "arcgis-video-player", i = {
-  progress: `${o}__progress`,
-  slider: `${o}__slider`,
-  sliderProgressContainer: `${o}__slider-progress-container`
+v5.0.0-next.120 */
+const d = t`:host{min-width:100px;flex:1 1 auto;display:flex;align-items:center;justify-content:center}.arcgis-video-player__slider-progress-container{position:relative;z-index:1;flex:1 1 auto;display:flex;flex-direction:column;align-items:center;justify-content:center}.arcgis-video-player__progress{--arcgis-video-player-progress-width: 2px;appearance:none;position:absolute;top:calc(50% - var(--arcgis-video-player-progress-width) / 2);left:var(--calcite-spacing-xs);border:none;background:var(--calcite-color-border-1);cursor:pointer;width:calc(100% - var(--calcite-spacing-xs) * 2);height:var(--arcgis-video-player-progress-width)}.arcgis-video-player__progress::-webkit-progress-bar{background-color:var(--calcite-color-border-3)}.arcgis-video-player__progress::-webkit-progress-value{background-color:var(--calcite-color-border-input)}.arcgis-video-player__progress::-moz-progress-bar{background-color:var(--calcite-color-border-3)}.arcgis-video-player__slider{--calcite-slider-track-color: transparent;width:100%}`, i = "arcgis-video-player", o = {
+  progress: `${i}__progress`,
+  slider: `${i}__slider`,
+  sliderProgressContainer: `${i}__slider-progress-container`
 };
-class p extends t {
+class n extends c {
   static {
     this.properties = { viewModel: 0, buffered: 9, value: 9 };
   }
   static {
     this.styles = d;
   }
-  _onSliderInput({ currentTarget: r }) {
-    if (typeof r.value == "number") {
-      const e = r.value * this.viewModel.duration / 100;
-      this.viewModel.seekTo(e);
+  _onSliderInput({ currentTarget: e }) {
+    if (typeof e.value == "number") {
+      const r = e.value * this.viewModel.duration / 100;
+      this.viewModel.seekTo(r);
     }
   }
   render() {
-    const { value: r, buffered: e } = this;
-    return l`<div class=${s(i.sliderProgressContainer)}><progress class=${s(i.progress)} max=1 .value=${`${e}`}></progress><div class=${s(i.slider)}><calcite-slider max=100 min=0 .value=${r} @calciteSliderInput=${this._onSliderInput}></calcite-slider></div></div>`;
+    const { value: e, buffered: r } = this;
+    return l`<div class=${s(o.sliderProgressContainer)} dir=ltr><progress class=${s(o.progress)} max=1 .value=${`${r}`}></progress><div class=${s(o.slider)}><calcite-slider max=100 min=0 .value=${e} @calciteSliderInput=${this._onSliderInput}></calcite-slider></div></div>`;
   }
 }
-a("arcgis-video-player-slider", p);
+a("arcgis-video-player-slider", n);
 export {
-  p as VideoPlayerSlider
+  n as VideoPlayerSlider
 };

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

@@ -0,0 +1,68 @@
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+import { default as SceneView } from '@arcgis/core/views/SceneView';
+import { AnalysisViewModel } from '../../support/AnalysisViewModel';
+import { default as VolumeMeasurementAnalysis } from '@arcgis/core/analysis/VolumeMeasurementAnalysis.js';
+import { MeasurementState, MeasurementValue } from '../../support/measurementUtils';
+import { MeasurementMode } from '@arcgis/core/views/analysis/types';
+import { LengthUnit } from '@arcgis/core/core/units';
+export interface Measurement {
+    readonly mode: MeasurementMode;
+    readonly totalVolume: MeasurementValue<__esri.Volume>;
+    readonly cutVolume: MeasurementValue<__esri.Volume>;
+    readonly fillVolume: MeasurementValue<__esri.Volume>;
+    readonly netVolume: MeasurementValue<__esri.Volume>;
+}
+export default class VolumeMeasurementViewModel extends AnalysisViewModel<SceneView, VolumeMeasurementAnalysis> {
+    initialize(): void;
+    protected readonly supportedViewType = "3d";
+    protected readonly unsupportedErrorMessage = "The Volume Measurement component is only supported in 3D views.";
+    get state(): Exclude<MeasurementState, "unsupported">;
+    get displayState(): MeasurementState;
+    /**
+     * The current measurement calculated based on the provided polygon.
+     */
+    get measurement(): Measurement;
+    protected constructAnalysis(): VolumeMeasurementAnalysis;
+    protected place(options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    protected clearAnalysis(): void;
+    /**
+     * List of unit systems (imperial, metric) and specific units for displaying the v values.
+     */
+    get volumeUnitOptions(): __esri.SystemOrVolumeUnit[];
+    set volumeUnitOptions(units: __esri.SystemOrVolumeUnit[] | undefined);
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the volume values.
+     */
+    get volumeUnit(): __esri.SystemOrVolumeUnit;
+    set volumeUnit(unit: __esri.SystemOrVolumeUnit | undefined);
+    get defaultVolumeUnit(): __esri.MeasurementSystem | undefined;
+    private _userVolumeUnit?;
+    private _userVolumeUnitOptions?;
+    /**
+     * List of unit systems (imperial, metric) and specific units for displaying the elevation values.
+     */
+    get elevationUnitOptions(): __esri.SystemOrLengthUnit[];
+    set elevationUnitOptions(units: __esri.SystemOrLengthUnit[] | undefined);
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the elevation values.
+     */
+    get elevationUnit(): __esri.SystemOrLengthUnit;
+    set elevationUnit(unit: __esri.SystemOrLengthUnit | undefined);
+    get defaultElevationUnit(): __esri.MeasurementSystem | undefined;
+    private _userElevationUnit?;
+    private _userElevationUnitOptions?;
+    /**
+     * List of units for inputting the elevation values.
+     */
+    get elevationInputUnitOptions(): LengthUnit[];
+    set elevationInputUnitOptions(units: LengthUnit[] | undefined);
+    /**
+     * Unit used for inputting the elevation values.
+     */
+    get elevationInputUnit(): LengthUnit;
+    set elevationInputUnit(unit: LengthUnit | undefined);
+    private _userElevationInputUnit?;
+    private _userElevationInputUnitOptions?;
+}

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

@@ -0,0 +1,243 @@
+/// <reference path="../../index.d.ts" />
+import { PublicLitElement as LitElement, TargetedEvent, JsxNode } from '@arcgis/lumina';
+import { Use } from '@arcgis/lumina/controllers';
+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;
+/**
+ * The Volume Measurement component can be added to a
+ * [Scene](https://developers.arcgis.com/javascript/latest/references/map-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)](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)*
+ *
+ * Volume Measurement component offers multiple volume measurement modes:
+ *
+ * - **Cut & Fill Volume**: Computes cut and fill volumes relative to a flat, horizontal surface defined by the input
+ * polygon. Ideal for estimating the amount of material to remove or add to level terrain for construction.
+ *
+ * - **Stockpile Volume**: Calculates cut and fill volumes against a surface approximated from the polygon's coordinates.
+ * Useful for estimating the volume of temporary ground features such as piles of material, mounds or depressions.
+ *
+ * The analysis depends on the scene's spatial reference, and the length of the measured perimeter:
+ *
+ * - In **Projected Coordinate Systems (PCS)**, apart from Web Mercator used in **local** viewing mode, there is no limit
+ * to the measurement's perimeter, making it the recommended setup for analysis as accuracy is not compromised.
+ *
+ * - In **Web Mercator PCS** used in **local** viewing mode, if the measurement's perimeter exceeds 10 km, the analysis is considered invalid due to potential accuracy issues.
+ *
+ * - In **Geographic Coordinate Systems (GCS)** and **Web Mercator** in **global** viewing mode, if the measurement's perimeter exceeds 50 km, the analysis is considered invalid due to potential accuracy issues.
+ *
+ *
+ * **Known Limitations**
+ *
+ * -  Volume Measurement component can only be added to a
+ * [Scene](https://developers.arcgis.com/javascript/latest/references/map-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 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).
+ *
+ * **Things to consider**
+ *
+ * - In "Cut & Fill Volume" mode, you can hover over the shift manipulator, press `Tab` to enable tooltip input,
+ * 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).
+ *
+ * **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)
+ * - [VolumeMeasurementCutFillOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementCutFillOptions.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)
+ * - [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)
+ * - [Sample - Volume measurement analysis object](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-volume-measurement/)
+ *
+ * @since 5.0
+ */
+export declare class ArcgisVolumeMeasurement extends LitElement {
+    /**
+     * 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 Volume Measurement component will be associated with a map or scene component rather than using the `view` property.
+     */
+    view?: import('@arcgis/core/views/SceneView').default | undefined;
+    /**
+     * The [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html)
+     * 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/)
+     * 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.
+     * Whenever the component is destroyed, the analysis is automatically removed from the collection.
+     *
+     * Alternatively, a programmatically created analysis can be provided to the component.
+     * Then, the application itself needs to add it to and later remove it from the Scene's analyses collection.
+     *
+     * ```js
+     * // Create the analysis.
+     * const volumeMeasurementAnalysis = new VolumeMeasurementAnalysis({
+     *    geometry: new Polygon({
+     *      spatialReference: { latestWkid: 3857, wkid: 102100 },
+     *      rings: [
+     *        [
+     *          [-13624861.22274897, 4550346.5519295, 63.378210234455764],
+     *          [-13624935.305160372, 4550273.144585712, 63.37829629518092],
+     *          [-13624995.61798748, 4550334.030096778, 63.37819860037416],
+     *          [-13624921.53589075, 4550407.42357004, 63.3783810287714],
+     *          [-13624861.22274897, 4550346.5519295, 63.378210234455764]
+     *        ]
+     *      ]
+     *    })
+     * });
+     * // Get the Scene and measurement component and wait until they are ready.
+     * const viewElement = document.querySelector("arcgis-scene");
+     * await viewElement.viewOnReady();
+     * const volumeMeasurementElement = document.querySelector("arcgis-volume-measurement");
+     * await volumeMeasurementElement.componentOnReady();
+     * // Add the analysis to the Scene component.
+     * viewElement.analyses.add(volumeMeasurementAnalysis);
+     * // Connect the analysis to the measurement component:
+     * volumeMeasurementElement.analysis = volumeMeasurementAnalysis;
+     * ```
+     */
+    analysis: VolumeMeasurementAnalysis;
+    /**
+     * If true, the component will not be destroyed automatically when it is
+     * disconnected from the document. This is useful when you want to move the
+     * component to a different place on the page, or temporarily hide it. If this
+     * is 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
+     * prevent memory leaks.
+     *
+     * @default false
+     */
+    autoDestroyDisabled: boolean;
+    /**
+     * Icon which represents the component.
+     * Typically used when the component is controlled by another component (e.g. by the Expand component).
+     *
+     * @default "measure-area"
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     */
+    icon?: HTMLCalciteIconElement["icon"];
+    /** The component's default label. */
+    label?: string;
+    /**
+     * 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.
+     *
+     * @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;
+    get mode(): VolumeMeasureType;
+    set mode(value: VolumeMeasureType);
+    /**
+     * The component's state. The values mean the following:
+     *
+     * * `disabled` -  not ready yet
+     * * `ready` - ready for measuring
+     * * `measuring` - currently measuring
+     * * `measured` - measuring has finished
+     */
+    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).
+     */
+    volumeUnit: 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.
+     */
+    volumeUnitOptions: SystemOrVolumeUnit[];
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in
+     * [elevationUnitOptions](#elevationUnitOptions).
+     */
+    elevationUnit: 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.
+     */
+    elevationUnitOptions: SystemOrLengthUnit[];
+    elevationInputUnit: LengthUnit;
+    elevationInputUnitOptions: LengthUnit[];
+    /**
+     * Hides the header.
+     *
+     * @default false
+     */
+    hideHeader: boolean;
+    /**
+     * Hides the unit settings button.
+     *
+     * @default false
+     */
+    hideUnitSettings: boolean;
+    /** @default false */
+    hideInputUnitSettings: boolean;
+    /** @default false */
+    hideDisplayUnitSettings: boolean;
+    /** @default false */
+    hideElevationDisplayUnitSelect: boolean;
+    /** @default false */
+    hideElevationInputUnitSelect: boolean;
+    /** @default false */
+    hideVolumeDisplayUnitSelect: boolean;
+    /**
+     * Hides the mode selection dropdown.
+     *
+     * @default false
+     */
+    hideModeSelect: boolean;
+    /**
+     * Indicates whether the component's visualization is hidden in the view.
+     *
+     * @default false
+     */
+    hideVisualization: boolean;
+    /**
+     * Indicates the heading level to use for the headings in the component.
+     *
+     * @default 2
+     */
+    headingLevel: HeadingLevel;
+    /** Clears the current measurement. */
+    clear(): Promise<void>;
+    /** Permanently destroy the component. */
+    destroy(): Promise<void>;
+    /** Starts a new measurement. */
+    start(): Promise<void>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
+    readonly arcgisPropertyChange: TargetedEvent<this, {
+        name: "analysis" | "state";
+    }>;
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    "@eventTypes": {
+        "arcgisPropertyChange": ArcgisVolumeMeasurement["arcgisPropertyChange"]["detail"];
+        "arcgisReady": ArcgisVolumeMeasurement["arcgisReady"]["detail"];
+    };
+}
+export {};