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

package/dist/support/AnalysisViewModel.d.ts

@@ -1,53 +1,100 @@
+import { AnalysisUnion, AnalysisType } from '@arcgis/core/analysis/types';
 import { default as Accessor } from '@arcgis/core/core/Accessor.js';
-import { AnalysisUnion, AnalysisViewUnion } from '@arcgis/core/unionTypes.js';
+import { AnalysisViewUnion } from '@arcgis/core/views/analysis/types';
 import { default as MapView } from '@arcgis/core/views/MapView.js';
-import { default as SceneView } from '@arcgis/core/views/SceneView';
-export type AnalysisMap = {
-    [Key in AnalysisUnion["type"]]: Extract<AnalysisUnion, {
+import { default as SceneView } from '@arcgis/core/views/SceneView.js';
+type AnalysisMap = {
+    [Key in AnalysisType]: Extract<AnalysisUnion, {
         type: Key;
     }>;
 };
-export type AnalysisViewMap = {
+type AnalysisViewMap = {
     [Key in keyof AnalysisMap]: Extract<AnalysisViewUnion, {
         analysis: {
             type: Key;
         };
     }>;
 };
-export type AnalysisViewFor<Analysis extends AnalysisUnion> = AnalysisViewMap[Analysis["type"]];
+type AnalysisViewFor<T extends AnalysisUnion> = AnalysisViewMap[T["type"]];
 type OperationState = "active" | "inactive";
+/**
+ * A small lifecycle manager for ArcGIS analysis objects that need to be
+ * attached to a `MapView`/`SceneView`, expose an `analysisView`, and support
+ * an interactive user operation (e.g., placing inputs). This base class:
+ *
+ * - Tracks analysis ownership: created internally vs. provided externally.
+ * - Connects/disconnects the analysis to/from `view.analyses` when the view
+ *   becomes ready/unready, or when inputs change.
+ * - Exposes a consistent `start()`/`stop()` user-operation contract with
+ *   abort semantics and a lightweight active/inactive state.
+ * - Mirrors `visible` onto the underlying `analysisView` and optionally forces
+ *   interactive mode.
+ */
 export declare abstract class AnalysisViewModel<IViewType extends MapView | SceneView, AnalysisType extends AnalysisUnion> extends Accessor {
     constructor();
     protected initialize(): void;
     destroy(): void;
-    get supported(): boolean;
-    view?: IViewType;
-    set visible(v: boolean);
+    /**
+     * Whether there is an active user operation in progress.
+     */
     get active(): boolean;
-    get disabled(): boolean;
     /**
-     * Analysis data object.
+     * The analysis backing this view model.
+     *
+     * Assigning an external analysis transfers ownership away from the view model. The reconnect cycle will attach/detach
+     * it as the view becomes ready/unready, mirroring visibility and interactive behavior.
      */
     set analysis(v: AnalysisType);
-    protected _analysisView?: AnalysisViewFor<AnalysisType>;
-    protected shouldForceInteractive: boolean;
-    get analysisView(): AnalysisViewFor<AnalysisType> | undefined;
-    get ready(): boolean;
+    /**
+     * Whether the view model is in the process of connecting to the view.
+     */
     get connectingToView(): boolean;
     /**
-     * Whether the viewmodel owns the analysis. In that case, it will remove and destroy the analysis when it is is
-     * destroyed. An analysis is initially created by the view model if none is provided and the view model owns it until
-     * it is moved to a layer or removed from the view.
+     * Whether the analysis view model is disabled (view not ready or unsupported).
+     */
+    get disabled(): boolean;
+    /**
+     * If true, the analysis visualization will be hidden in the view.
+     */
+    set hideVisualization(value: boolean);
+    /**
+     * The current state of the user operation - active or inactive.
+     */
+    operationState: OperationState;
+    /**
+     * Whether the view model is ready for user interaction.
+     */
+    get ready(): boolean;
+    /**
+     * Whether the analysis is supported in the current view.
+     */
+    get supported(): boolean;
+    /**
+     * The view to which the analysis is connected.
+     */
+    view?: IViewType;
+    /**
+     * Ownership flag: when true, this view model created the analysis and will remove and destroy it during teardown.
+     * Ownership is release when the analysis leaves `view.analyses` by external action.
      */
     private _ownsAnalysis;
     private get _viewHasAnalysis();
     private _reconnectViewTask?;
-    private _forceInteractiveHandle?;
-    private _operationState;
-    get operationState(): OperationState;
+    /**
+     * The analysis view associated with the analysis and view, if connected.
+     */
+    analysisView?: AnalysisViewFor<AnalysisType>;
+    /**
+     * Whether to force interactive mode on the analysis view when connected.
+     */
+    protected shouldForceInteractive: boolean;
     protected abstract readonly supportedViewType: "2d" | "3d" | "both";
     protected abstract readonly unsupportedErrorMessage: string;
-    private _loggedUnsupportedErrorMessage;
+    /**
+     * Override to construct the analysis managed by this view model. When no external analysis is provided, this is
+     * called during initialization to create the owned analysis.
+     */
+    protected abstract constructAnalysis(): AnalysisType;
     /**
      * Breaks the loop of:
      *   Analysis move event
@@ -56,17 +103,17 @@ export declare abstract class AnalysisViewModel<IViewType extends MapView | Scen
      *   -> Analysis move event
      */
     private _changeFromReconnect;
-    private _startUserOperation;
-    protected abstract constructAnalysis(): AnalysisType;
+    private _userOperationInfo;
+    private _loggedUnsupportedErrorMessage;
     /**
-     * Removes the tool and clears the analysis by resetting its inputs.
+     * Reset analysis inputs and cancel any active user operation.
      */
     clear(): void;
-    protected abstract place(options?: {
-        signal?: AbortSignal;
-    }): Promise<void>;
     /**
-     * If analysis has unset inputs, start() will kick off the user operation to specify those inputs.
+     * Start the user operation.
+     *
+     * If the required analysis inputs are missing, this calls `place()` once the view is ready. You can provide a custom
+     * `operation` to override the default behavior. Set `clear: false` to retain existing analysis inputs.
      */
     start(options?: {
         operation?: (options?: {
@@ -74,25 +121,44 @@ export declare abstract class AnalysisViewModel<IViewType extends MapView | Scen
         }) => Promise<void>;
         clear?: boolean;
     }): Promise<void>;
+    /**
+     * Stop the active user operation, if any.
+     */
     stop(): void;
-    protected abstract clearAnalysis(): void;
     /**
-     * A callback used by view models that manage an analysis belonging to an Layer.
-     *
-     * The function will be called each time the view becomes ready, the internal Layer of
-     * the view model has been added to the map and the analysis view of the analysis has been created.
+     * Define the interactive placement workflow for the analysis.
+     * Implement in subclasses to collect required inputs. Honor `AbortSignal`.
+     */
+    protected place(_options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Hook for subclasses to clear analysis inputs when `clear()` is called.
+     */
+    protected clearAnalysis(): void;
+    /**
+     * Hook for subclasses managing an analysis that belongs to a layer.
+     * Called when the view is ready and the `analysisView` is created.
      */
     protected onConnectToAnalysisView(_analysisView: AnalysisViewFor<AnalysisType>): void;
     /**
-     * A callback used by view models that manage an analysis.
-     *
-     * The function will be called each time the view becomes unready and the internal analysis
-     * has been removed the map or analyses.
+     * Hook for subclasses to react when the view becomes unready and the
+     * internal analysis is removed from the map/analyses.
      */
     protected onDisconnectFromAnalysisView(): void;
     private _scheduleViewReconnect;
+    /**
+     * Reconnect the analysis to the current view, obtaining an `analysisView` when supported and ready.
+     * Aborts active operations that are past the "waiting for view" phase.
+     */
     private _reconnectView;
+    /**
+     * Disconnect the analysis from the given view.
+     */
     private _disconnectFromView;
+    /**
+     * Set an externally owned analysis.
+     */
     private _setExternalAnalysis;
 }
 export {};

package/dist/support/measurementUtils.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 import { default as QuantityFormatter } from '@arcgis/core/applications/Components/QuantityFormatter.js';
+import { Unit } from '@arcgis/core/core/units';
 export type MeasurementSystem = __esri.MeasurementSystem;
 export type Length = __esri.Length;
 export type LengthUnit = __esri.LengthUnit;
@@ -7,8 +8,10 @@ export type SystemOrLengthUnit = __esri.SystemOrLengthUnit;
 export type Area = __esri.Area;
 export type AreaUnit = __esri.AreaUnit;
 export type SystemOrAreaUnit = __esri.SystemOrAreaUnit;
-export type MeasurementModeString = "euclidean" | "geodesic";
-export type Quantity = Area | Length;
+export type Volume = __esri.Volume;
+export type VolumeUnit = __esri.VolumeUnit;
+export type SystemOrVolumeUnit = __esri.SystemOrVolumeUnit;
+export type Quantity = Area | Length | Volume;
 export type MeasurementState = "disabled" | "measured" | "measuring" | "ready" | "unsupported";
 export type MeasurementValue<T extends Quantity = Quantity> = {
     state: "available";
@@ -20,8 +23,18 @@ export type MeasurementValue<T extends Quantity = Quantity> = {
     state: "unavailable";
     value?: never;
 };
-export declare const measurementAreaUnits: ("imperial" | "metric" | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-nautical-miles" | "square-us-feet" | "acres" | "ares" | "hectares")[];
-export declare const measurementLengthUnits: ("imperial" | "metric" | "meters" | "centimeters" | "decimeters" | "feet" | "inches" | "kilometers" | "millimeters" | "nautical-miles" | "us-feet" | "yards" | "miles")[];
+export declare const measurementSystems: ["metric", "imperial"];
+export declare const lengthUnits: ["inches", "feet", "yards", "miles", "nautical-miles", "us-feet", "millimeters", "centimeters", "decimeters", "meters", "kilometers"];
+export declare const areaUnits: ["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"];
+export declare const volumeUnits: ["liters", "cubic-millimeters", "cubic-centimeters", "cubic-decimeters", "cubic-meters", "cubic-kilometers", "cubic-inches", "cubic-us-feet", "cubic-feet", "cubic-yards", "cubic-miles"];
+export declare const measurementLengthUnits: ("imperial" | "metric" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers")[];
+export declare const measurementAreaUnits: ("imperial" | "metric" | "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")[];
+export declare const measurementVolumeUnits: ("imperial" | "metric" | "cubic-inches" | "cubic-feet" | "cubic-yards" | "cubic-miles" | "cubic-us-feet" | "liters" | "cubic-millimeters" | "cubic-centimeters" | "cubic-decimeters" | "cubic-meters" | "cubic-kilometers")[];
 export declare function getMeasurementValue<T extends Quantity>(value: nullish | T, valid?: boolean): MeasurementValue<T>;
 export declare function formatQuantity(formatter: QuantityFormatter, quantity: Quantity): string;
 export declare function isMeasurementSystem(value: string): value is MeasurementSystem;
+export declare function isLengthUnit(value: string): value is LengthUnit;
+export declare function isAreaUnit(value: string): value is AreaUnit;
+export declare function isVolumeUnit(value: string): value is VolumeUnit;
+export declare function resolveUnitOptions<T extends MeasurementSystem | Unit>(userOptions: readonly T[] | undefined, allowed: readonly T[], fallback: readonly T[]): T[];
+export declare function resolveUnit<T extends MeasurementSystem | Unit>(userUnit: T | undefined, analysisUnit: T | undefined, options: readonly T[], defaultUnit: T | undefined): T;

package/dist/support/time-utils.d.ts

@@ -1,3 +1,6 @@
+import { default as SunLighting } from '@arcgis/core/views/3d/environment/SunLighting';
+import { default as VirtualLighting } from '@arcgis/core/views/3d/environment/VirtualLighting';
+import { default as SceneView } from '@arcgis/core/views/SceneView';
 export type TimeUnit = "centuries" | "days" | "decades" | "hours" | "milliseconds" | "minutes" | "months" | "seconds" | "weeks" | "years";
 export type IANATimeZone = NonNullable<Intl.DateTimeFormatOptions["timeZone"]>;
 type SystemTimeZone = "system";
@@ -34,4 +37,7 @@ export declare function utcToLocalParts(utcDate: Date, offsetHours: number): {
     localDate: string;
     minutesSinceMidnight: number;
 };
+export declare function getLocalDate(view: nullish | SceneView): string | undefined;
+export type LightingUnion = SunLighting | VirtualLighting;
+export declare function isSunlighting(lighting: LightingUnion | nullish): lighting is SunLighting;
 export {};

package/dist/types/components.d.ts

@@ -1 +1,2 @@
-export * from "./stencil";
+/** @deprecated import from stencil.d.ts instead */
+export * from "./stencil.js";