@arcgis/map-components 5.0.0-next.35 → 5.0.0-next.36

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

@@ -1,208 +0,0 @@
-/// <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 { ArcgisReferenceElement } from '../../utils/component-utils';
-import { default as ElevationProfileViewModel } from './ElevationProfileViewModel';
-
-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](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-next/)
- *
- * @internal
- */
-export declare class ArcgisElevationProfileNext 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 Elevation Profile Next component will be associated with a map or scene component rather than using the `view` property.
-     */
-    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
-     * 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-elevation-profile-next/#destroy) method when you are done to
-     * prevent memory leaks.
-     *
-     * @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 elevation and distance units or unit systems.
-     */
-    readonly effectiveDisplayUnits: __esri.ElevationProfileEffectiveDisplayUnits | undefined;
-    /** @default false */
-    hideChart: boolean;
-    /** @default false */
-    hideClearButton: boolean;
-    /** @default false */
-    hideLegend: boolean;
-    /** @default false */
-    hideSelectButton: boolean;
-    /** @default false */
-    hideSettingsButton: boolean;
-    /** @default false */
-    hideSketchButton: boolean;
-    /** @default false */
-    hideUniformChartScalingToggle: boolean;
-    /** @default false */
-    hideUnitSelector: boolean;
-    /** @default true */
-    highlightEnabled: boolean;
-    /**
-     * The position, in [0, 1], being hovered in the elevation profile chart.
-     *
-     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ElevationProfileAnalysisView3D.html#hoveredPosition)
-     */
-    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"
-     */
-    icon?: HTMLCalciteIconElement["icon"];
-    /**
-     * 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)
-     */
-    geometry: __esri.Polyline | nullish;
-    /**
-     * 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-analysis-ElevationProfileAnalysis.html#elevationInfo)
-     */
-    elevationInfo: nullish | __esri.ElevationInfo;
-    /** The component's default label. */
-    label?: string;
-    /**
-     * Replace localized message strings with your own strings.
-     *
-     * _**Note**: Individual message keys may change between releases._
-     */
-    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:
-     *
-     * * `disabled` -  component is being created
-     * * `ready` - component is ready; no path configured and no interactive operation ongoing
-     * * `creating` - user is creating a new input path
-     * * `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
-     */
-    state: "ready" | "disabled" | "selected" | "creating" | "created" | "selecting";
-    /**
-     * Whether the chart should use a uniform scale for the X and Y axes.
-     *
-     * @default false
-     */
-    uniformChartScaling: boolean;
-    /**
-     * The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display distance values
-     * in the chart, results and legend.
-     */
-    unitDistance: __esri.SystemOrLengthUnit | undefined;
-    /**
-     * 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.
-     */
-    unitOptionsElevation: __esri.SystemOrLengthUnit[];
-    /** Permanently destroy the component. */
-    destroy(): Promise<void>;
-    /**
-     * 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 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: "progress" | "state" | "geometry" | "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 {};