@arcgis/map-components 5.0.0-next.4 → 5.0.0-next.42

package/dist/components/arcgis-elevation-profile/customElement.d.ts

@@ -1,48 +1,64 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
+import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { Use } from '@arcgis/lumina/controllers';
-import { default as ElevationProfile } from '@arcgis/core/widgets/ElevationProfile.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { default as ElevationProfileViewModel } from './ElevationProfileViewModel';
 
-declare const useElevationProfileWidget: (component: LitElement & Pick<ElevationProfile, "icon" | "label" | "input" | "viewModel" | "unit" | "profiles" | "unitOptions"> & {
-    state?: unknown;
-    viewModel?: __esri.ElevationProfileViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/toolkit/type').nil | string;
-    label: import('@arcgis/toolkit/type').nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    position?: __esri.UIPosition;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | nullish;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => ElevationProfile;
+declare const useElevationProfileViewModel: (component: LitElement & Pick<ElevationProfileViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<ElevationProfileViewModel>) => ElevationProfileViewModel;
 /**
- * The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).
+ * The Elevation Profile component is used to generate and display an elevation profile from an
+ * [input line](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#input).
  *
  * **See also**
  *
+ * - [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)
+ * -
  * - [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/)
  *
- * @since 4.28
+ * @internal
  */
 export declare class ArcgisElevationProfile extends LitElement {
+    /**
+     * The [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)
+     * created or modified by the component.
+     *
+     * When connecting the Elevation Profile component to the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)
+     * or [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)
+     * components, it automatically creates an empty analysis and adds it to the
+     * [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 analyses collection.
+     *
+     * ```js
+     * // Create the analysis.
+     * const analysis = new ElevationProfileAnalysis({
+     *   profiles: [{ type: "ground" }, { type: "scene" }]
+     * });
+     *
+     * // Get the view element and the component and wait until they are ready.
+     * const viewElement = document.querySelector("arcgis-map");
+     * await viewElement.viewOnReady();
+     * const elevationProfileElement = document.querySelector("arcgis-elevation-profile");
+     * await elevationProfileElement.componentOnReady();
+     *
+     * // Add the analysis to the analyses collection.
+     * viewElement.analyses.add(analysis);
+     *
+     * // Connect the analysis to the elevation profile component.
+     * elevationProfileElement.analysis = sliceAnalysis;
+     * ```
+     */
+    analysis: __esri.ElevationProfileAnalysis;
     /**
      * 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 ArcgisElevationProfile component will be associated with a map or scene component rather than using the `view` property.
+     *   > **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 Elevation Profile component will be associated with a map or scene component rather than using the `view` property.
      */
-    view?: __esri.MapView | __esri.SceneView | nullish;
+    view: __esri.MapView | __esri.SceneView | undefined;
     /**
      * 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
@@ -53,8 +69,11 @@ export declare class ArcgisElevationProfile extends LitElement {
      * @default false
      */
     autoDestroyDisabled: boolean;
-    /** Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the component, according to the selected unit or unit system. */
-    readonly effectiveUnits: __esri.EffectiveUnits;
+    /**
+     * Units which have been selected according to the magnitude of the elevations and distances that are to be displayed
+     * in the component, according to the selected elevation and distance units or unit systems.
+     */
+    readonly effectiveDisplayUnits: __esri.ElevationProfileEffectiveDisplayUnits | undefined;
     /** @default false */
     hideChart: boolean;
     /** @default false */
@@ -71,21 +90,14 @@ export declare class ArcgisElevationProfile extends LitElement {
     hideUniformChartScalingToggle: boolean;
     /** @default false */
     hideUnitSelector: boolean;
-    /**
-     * Whether the graphic used as [input](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)
-     * is highlighted.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled)
-     *
-     * @default true
-     */
+    /** @default true */
     highlightEnabled: boolean;
     /**
-     * The position, in the range [0, 1], being hovered in the graph.
+     * The position, in [0, 1], being hovered in the elevation profile chart.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#hoveredChartPosition)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ElevationProfileAnalysisView3D.html#hoveredPosition)
      */
-    hoveredChartPosition: number | nullish;
+    hoveredPosition: number | undefined;
     /**
      * Icon which represents the component.
      * Typically used when the component is controlled by another component (e.g. by the Expand component).
@@ -93,37 +105,46 @@ export declare class ArcgisElevationProfile extends LitElement {
      * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      * @default "altitude"
      */
-    icon: string;
+    icon?: HTMLCalciteIconElement["icon"];
     /**
-     * The input path along which elevation will be queried in order to generate an elevation profile.
-     *
-     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)
-     *
-     * @default null
+     * Path along which elevation will be queried in order to generate an elevation profile. It should be a
+     * Polyline geometry.
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#geometry)
      */
-    input: nullish | __esri.Graphic;
-    /** The component's default label. */
-    label: string;
-    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead. */
-    position?: __esri.UIPosition;
+    geometry: __esri.Polyline | nullish;
     /**
-     * Collection of elevation profile lines which are to be generated and displayed in the component's chart.
+     * Specifies how the geometry Z values are interpreted, for example to compute elevations for an
+     * [input](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileLineInput.html)
+     * profile line. This property can only be used in a
+     * [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
      *
-     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#profiles)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#elevationInfo)
      */
-    profiles: __esri.Collection<__esri.ElevationProfileElevationProfileLineGround | __esri.ElevationProfileElevationProfileLineInput | __esri.ElevationProfileElevationProfileLineQuery | __esri.ElevationProfileLineView>;
+    elevationInfo: nullish | __esri.ElevationInfo;
+    /** The component's default label. */
+    label?: string;
     /**
-     * The progress, between 0 and 1 of generating all the configured elevation profiles.
+     * Replace localized message strings with your own strings.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#progress)
+     * _**Note**: Individual message keys may change between releases._
      */
-    readonly progress: number;
+    messageOverrides?: typeof this._messages._overrides;
+    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
+    position?: __esri.UIPosition;
     /**
      * 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;
+    /**
+     * Collection of elevation profile lines which are to be generated and displayed in the component's chart.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#profiles)
+     */
+    profiles: __esri.Collection<__esri.ElevationProfileLineGround | __esri.ElevationProfileLineInput | __esri.ElevationProfileLineQuery | __esri.ElevationProfileLineScene>;
+    /** The progress, between 0 and 1 of generating all the configured elevation profiles. */
+    readonly progress: number;
     /**
      * The component's state. The values mean the following:
      *
@@ -133,41 +154,55 @@ export declare class ArcgisElevationProfile extends LitElement {
      * * `created` - input path is configured but no interactive operation is ongoing
      * * `selecting` - user is selecting an existing input path
      * * `selected` - user selected an existing input path
-     *
-     * @default "disabled"
      */
-    readonly state: "ready" | "selected" | "disabled" | "created" | "creating" | "selecting";
+    state: "ready" | "disabled" | "selected" | "created" | "creating" | "selecting";
     /**
      * Whether the chart should use a uniform scale for the X and Y axes.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#uniformChartScaling)
-     *
      * @default false
      */
     uniformChartScaling: boolean;
     /**
-     * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unit)
+     * The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display distance values
+     * in the chart, results and legend.
      */
-    unit: __esri.SystemOrLengthUnit;
+    unitDistance: __esri.SystemOrLengthUnit | undefined;
     /**
-     * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unitOptions)
+     * The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display elevation values
+     * in the chart, results and legend.
+     */
+    unitElevation: __esri.SystemOrLengthUnit | undefined;
+    /**
+     * List of available units and unit systems (imperial, metric) for displaying the distance values. These are the
+     * options displayed in the distance unit selector in the settings popover.
+     */
+    unitOptionsDistance: __esri.SystemOrLengthUnit[];
+    /**
+     * List of available units and unit systems (imperial, metric) for displaying the elevation values. These are the
+     * options displayed in the elevation unit selector in the settings popover.
      */
-    unitOptions: __esri.SystemOrLengthUnit[];
+    unitOptionsElevation: __esri.SystemOrLengthUnit[];
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
-    /** Switches to the "creating" state in which the user can draw a new line. */
+    /**
+     * Starts an interactive operation to pick a polyline feature in the view to use as the input for the elevation
+     * profile analysis. The operation will finish when the user presses the escape key.
+     * To cancel the operation, call the `stop()` method.
+     */
+    select(): Promise<void>;
+    /**
+     * Starts an interactive operation which allows the user to sketch a new path in the view.
+     * To cancel the operation, call the `stop()` method.
+     */
     start(): Promise<void>;
-    /** Stops the creation operation. */
+    /** Stops any ongoing interactive operation. */
     stop(): Promise<void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "state" | "input" | "progress" | "effectiveUnits";
+        name: "geometry" | "progress" | "state" | "effectiveDisplayUnits";
     }>;
     /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
+    private _messages;
 }
 export {};