@arcgis/map-components 5.0.0-next.6 → 5.0.0-next.60

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

@@ -1,48 +1,93 @@
 /// <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';
+import { default as Graphic } from '@arcgis/core/Graphic';
 
-declare const useElevationProfileWidget: (component: LitElement & Pick<ElevationProfile, "input" | "label" | "viewModel" | "icon" | "unit" | "unitOptions" | "profiles"> & {
-    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 manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html) and displays its elevation profiles.
+ *
+ * [![elevation profile poster](https://developers.arcgis.com/javascript/latest/assets/img/components/elevation-profile/elevation_profile_poster.png)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)
+ *
+ * The component can visualize multiple profile lines, depending on whether it is used in a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) component or a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component and on the available elevation source data:
+ *
+ * * [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineGround.html): represents a profile line that uses elevation from [Map.ground](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#ground) of the connected Map or Scene component. The profile recomputes automatically when ground layers are added, removed, or their visibility changes.
+ * * [**ElevationProfileLineInput**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html): represents a profile line that reads elevation from the analysis geometry itself; typically used for polylines with z values. If the line lacks z values but is displayed with a non-draped elevation mode, a profile is still computed. If `elevationInfo` is set to `on-the-ground`, elevation comes from the Ground (when ground layers are present). An elevation offset can be applied. In a Map this requires client-side graphics that already contain z values.
+ * * [**ElevationProfileLineQuery**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) or ant object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation).
+ * * [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html): represents a profile line that derives elevation from the `Scene` and all its volumetric objects (e.g. SceneLayer, IntegratedMeshLayer).
+ *
+ * You can choose to display one or several profile lines in the chart, by setting them in the [profiles](#profiles) property.
+ *
+ * Hovering over the chart shows an overlaid tooltip with elevation values of all profiles, and displays colored dot markers at the matching positions.
+ *
+ * [![elevation profile chart gif](https://developers.arcgis.com/javascript/latest/assets/img/components/elevation-profile/elevation_profile_chart_gif.gif)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)
+ *
+ * Checkboxes in the legend allow hiding individual profiles. Chart units can be set via the settings menu to metric, imperial or a specific unit.
+ *
+ * Scrolling the chart zooms in to a specific part of the profile chart. When zoomed in, click the minus button to reset the zoom. On touch devices, pinch to zoom in and out.
+ *
+ * How distance values are computed depends on the map's spatial reference:
+ *
+ * * In geographic coordinate systems (GCS) and in Web Mercator, distances are computed geodetically.
+ * * In projected coordinate systems (PCS), apart from Web Mercator, distances are computed in a Euclidean manner (in their respective PCS).
+ *
+ * **Known limitations**
+ *
+ * - [ElevationProfileLineInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#elevationInfo) is set.
+ * - [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html) is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
  *
  * **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/)
+ * - [Sample - Elevation Profile analysis](https://developers.arcgis.com/javascript/latest/sample-code/analysis-elevation-profile/)
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/)
  *
- * @since 4.28
+ * @since 5.0
  */
 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,77 +98,130 @@ 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;
-    /** @default false */
+    /**
+     * 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;
+    /**
+     * The feature which is currently selected for display in the elevation profile. The feature is highlighted in the
+     * view and its geometry is used as the profile line. When the user starts drawing a new profile line, this feature
+     * is cleared.
+     */
+    feature?: Graphic;
+    /**
+     * If true, the elevation profile chart will be hidden.
+     *
+     * @default false
+     */
     hideChart: boolean;
-    /** @default false */
+    /**
+     * If true, the clear button will be hidden.
+     *
+     * @default false
+     */
     hideClearButton: boolean;
-    /** @default false */
+    /**
+     * If true, the legend will be hidden.
+     *
+     * @default false
+     */
     hideLegend: boolean;
-    /** @default false */
+    /**
+     * If true, the button to select features in the view will be hidden.
+     *
+     * @default false
+     */
     hideSelectButton: boolean;
-    /** @default false */
+    /**
+     * If true, the button which opens the settings popover will be hidden.
+     *
+     * @default false
+     */
     hideSettingsButton: boolean;
-    /** @default false */
+    /**
+     * If true, the button to start sketching a new profile line will be hidden.
+     *
+     * @default false
+     */
     hideSketchButton: boolean;
-    /** @default false */
+    /**
+     * If true, the uniform chart scaling toggle will be hidden in the settings popover.
+     *
+     * @default false
+     */
     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.
+     * If true, the unit selector will be hidden in the settings popover.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled)
+     * @default false
+     */
+    hideUnitSelector: boolean;
+    /**
+     * If true, the component will not highlight features selected in the view.
      *
-     * @default true
+     * @default false
      */
-    highlightEnabled: boolean;
+    highlightDisabled: 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).
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      * @default "altitude"
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    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: __esri.Graphic | nullish;
-    /** 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-analysis-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;
+    /**
+     * The collection of profile lines to compute and display. Each profile line defines a different source for sampling
+     * elevation along the input geometry (such as ground, input geometry itself, custom elevation sources, or scene
+     * content), and includes settings for how the resulting line will appear in the component chart and in the view.
+     *
+     * [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.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ElevationProfileAnalysisView3D.html#progress)
+     */
+    readonly progress: number;
     /**
      * The component's state. The values mean the following:
      *
@@ -133,41 +231,63 @@ 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" | "creating" | "created" | "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;
+    distanceUnit: __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)
+     * List of available units unit systems (imperial, metric) and specific units (e.g. feet, kilometers) for displaying
+     * the distance values. These are the options displayed in the distance unit selector in the settings popover.
+     */
+    distanceUnitOptions: __esri.SystemOrLengthUnit[];
+    /**
+     * The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display elevation values
+     * in the chart, results and legend.
      */
-    unitOptions: __esri.SystemOrLengthUnit[];
+    elevationUnit: __esri.SystemOrLengthUnit | undefined;
+    /**
+     * List of available units unit systems (imperial, metric) and specific units (e.g. feet, kilometers) for displaying
+     * the elevation values. These are the options displayed in the elevation unit selector in the settings popover.
+     */
+    elevationUnitOptions: __esri.SystemOrLengthUnit[];
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
-    /** Switches to the "creating" state in which the user can draw a new line. */
+    /**
+     * Start an interactive operation to pick an existing polyline feature in the view to use as the input for the
+     * elevation profile. The operation ends when the user presses the <kbd>Escape</kbd> key.
+     * To programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#stop) method.
+     */
+    select(): Promise<void>;
+    /**
+     * Start an interactive operation that lets the user sketch a new path in the view along which the elevation profile
+     * will be generated. The operation completes when the user double-clicks, presses the <kbd>Escape</kbd> key or clicks
+     * the Done button in the UI.
+     * To programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#stop) method.
+     */
     start(): Promise<void>;
-    /** Stops the creation operation. */
+    /**
+     * Stop any ongoing interactive operation (for example, selecting or sketching a profile line). This can be used to
+     * programmatically cancel operations started by [start()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#start) or
+     * [select()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#select).
+     */
     stop(): Promise<void>;
+    /** Clear the current elevation profile. If an interactive operation is in progress, it will also be stopped. */
+    clear(): Promise<void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "input" | "progress" | "state" | "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 {};