@arcgis/map-components 4.34.0-next.99 → 4.34.0

package/dist/components/arcgis-elevation-profile-legend/customElement.js

@@ -0,0 +1,33 @@
+import { c as l } from "../../chunks/runtime.js";
+import { css as o, html as r } from "lit";
+import { LitElement as d } from "@arcgis/lumina";
+/*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/4.34/esri/copyright.txt for details.
+v4.34.0 */
+const c = o`:host{display:flex;flex-direction:column;gap:var(--calcite-spacing-xxs)}`;
+class p extends d {
+  constructor() {
+    super(...arguments), this._expandedLine = void 0, this.featureSelected = !1;
+  }
+  static {
+    this.properties = { _expandedLine: 16, effectiveDisplayUnits: 0, featureSelected: 5, messages: 0, results: 0 };
+  }
+  static {
+    this.styles = c;
+  }
+  async destroy() {
+    await this.manager.destroy();
+  }
+  _onToggleExpand(t) {
+    const e = t.detail;
+    this._expandedLine = e === this._expandedLine ? void 0 : e;
+  }
+  render() {
+    const { messages: t, effectiveDisplayUnits: e, _expandedLine: n } = this, s = this.results ?? [], a = s.length <= 1;
+    return s.map((i) => r`<arcgis-elevation-profile-legend-item .effectiveDisplayUnits=${e} .expanded=${i.profile === n} .featureSelected=${this.featureSelected} .hideCheckbox=${a} .messages=${t} @arcgisExpandedToggle=${this._onToggleExpand} .result=${i}></arcgis-elevation-profile-legend-item>`);
+  }
+}
+l("arcgis-elevation-profile-legend", p);
+export {
+  p as ArcgisElevationProfileLegend
+};

package/dist/components/arcgis-elevation-profile-legend/index.d.ts

@@ -0,0 +1,2 @@
+import "../arcgis-elevation-profile-legend-item/index.js";
+export * from "./customElement.js";

package/dist/components/arcgis-elevation-profile-legend/index.js

@@ -0,0 +1,2 @@
+import "../arcgis-elevation-profile-legend-item/index.js";
+export * from "./customElement.js";

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

@@ -0,0 +1,24 @@
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+/// <reference path="../../index.d.ts" />
+import { default as ElevationProfileResult } from '@arcgis/core/views/analysis/ElevationProfile/ElevationProfileResult';
+import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { ElevationProfileEffectiveDisplayUnits, ElevationProfileMessages } from '../arcgis-elevation-profile-next/interfaces';
+
+/**
+ * Component which displays statistics for a profile line and a checkbox to toggle its visibility in the chart and view.
+ *
+ * @private
+ */
+export declare class ArcgisElevationProfileLegendItem extends LitElement {
+    effectiveDisplayUnits?: ElevationProfileEffectiveDisplayUnits;
+    /** @default false */
+    expanded: boolean;
+    /** @default false */
+    featureSelected: boolean;
+    /** @default false */
+    hideCheckbox: boolean;
+    messages: ElevationProfileMessages;
+    result: ElevationProfileResult;
+    destroy(): Promise<void>;
+    readonly arcgisExpandedToggle: TargetedEvent<this, __esri.ElevationProfileLineGround | __esri.ElevationProfileLineInput | __esri.ElevationProfileLineQuery | __esri.ElevationProfileLineScene>;
+}

package/dist/components/arcgis-elevation-profile-legend-item/customElement.js

@@ -0,0 +1,77 @@
+import { c as d } from "../../chunks/runtime.js";
+import { css as h, html as s } from "lit";
+import { substitute as p } from "@arcgis/core/intl.js";
+import { LitElement as g, createEvent as u, safeClassMap as b, safeStyleMap as f, nothing as n } from "@arcgis/lumina";
+/*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/4.34/esri/copyright.txt for details.
+v4.34.0 */
+const v = h`:host{--internal-block-spacing: var(--calcite-spacing-sm-plus);--internal-inline-spacing: var(--calcite-spacing-md);--internal-collapse-toggle-size: 32px;--internal-color-indicator-width: 3px;--internal-opacity-disabled: .4}.container{position:relative;background:var(--calcite-color-foreground-2)}.disabled{filter:grayscale(1);opacity:var(--internal-opacity-disabled)}.color-indicator{position:absolute;inset-inline-start:0;top:0;width:var(--internal-color-indicator-width);height:100%}.header{display:flex;flex-direction:row;align-items:center;justify-content:flex-start}.content{display:block;padding:var(--internal-block-spacing) var(--internal-inline-spacing);padding-top:0}.collapse-toggle{flex-shrink:0;width:var(--internal-collapse-toggle-size);height:var(--internal-collapse-toggle-size)}.label{--calcite-label-margin-bottom: 0;flex-grow:1;flex-shrink:1;padding-inline-start:var(--internal-inline-spacing);min-width:0}`;
+class m extends g {
+  constructor() {
+    super(...arguments), this.expanded = !1, this.featureSelected = !1, this.hideCheckbox = !1, this.arcgisExpandedToggle = u();
+  }
+  static {
+    this.properties = { effectiveDisplayUnits: 0, expanded: 5, featureSelected: 5, hideCheckbox: 5, messages: 0, result: 0 };
+  }
+  static {
+    this.styles = v;
+  }
+  async destroy() {
+    await this.manager.destroy();
+  }
+  render() {
+    return s`<div class=${b({
+      container: !0,
+      expanded: this.expanded,
+      disabled: this._disabled
+    })}>${this._renderColorIndicator()}<div class="header">${this._renderLabelWithCheckbox()}${this._renderCollapseToggleButton()}</div>${this.expanded ? this._renderStatistics() : void 0}</div>`;
+  }
+  _renderColorIndicator() {
+    return s`<div class="color-indicator" style=${f({ backgroundColor: this.result.profile.color.toCss() })}></div>`;
+  }
+  _renderCollapseToggleButton() {
+    const { expanded: e, messages: t } = this, i = t[e ? "hideDetails" : "showDetails"] ?? "";
+    return s`<calcite-action appearance=transparent class="collapse-toggle" data-testid=${`legend-toggle-${this.result.profile.id}`} .icon=${e ? "chevron-up" : "chevron-down"} @click=${() => this.arcgisExpandedToggle.emit(this.result.profile)} scale=s .text=${i} title=${i ?? n}></calcite-action>`;
+  }
+  _renderLabelWithCheckbox() {
+    const { result: e, hideCheckbox: t, messages: i } = this;
+    return s`<calcite-label class="label" layout=inline>${t ? void 0 : this._renderCheckbox()}${r(e, i)}</calcite-label>`;
+  }
+  _renderCheckbox() {
+    const { result: e, messages: t } = this, { profile: i } = e, l = i.enabled, c = t[l ? "hideProfile" : "showProfile"] ?? "", o = p(c, {
+      name: r(e, t)
+    });
+    return s`<calcite-checkbox .checked=${l} class="checkbox" title=${o ?? n} @calciteCheckboxChange=${() => {
+      i.enabled = !i.enabled;
+    }}></calcite-checkbox>`;
+  }
+  _renderStatistics() {
+    return s`<div class="content"><arcgis-elevation-profile-statistics .messages=${this.messages} .result=${this._disabled ? void 0 : this.result} .effectiveDisplayUnits=${this.effectiveDisplayUnits}></arcgis-elevation-profile-statistics></div>`;
+  }
+  get _disabled() {
+    return !this.featureSelected && this.result.profile.type === "input";
+  }
+}
+function r({ profile: a }, { profiles: e }) {
+  const t = a.title;
+  if (t != null)
+    return t;
+  if (!e)
+    return "";
+  switch (a.type) {
+    case "ground":
+      return e.ground;
+    case "input":
+      return e.input;
+    case "query":
+      return e.query;
+    case "scene":
+      return e.scene;
+    default:
+      return "";
+  }
+}
+d("arcgis-elevation-profile-legend-item", m);
+export {
+  m as ArcgisElevationProfileLegendItem
+};

package/dist/components/arcgis-elevation-profile-legend-item/index.d.ts

@@ -0,0 +1,5 @@
+import "@esri/calcite-components/components/calcite-action";
+import "@esri/calcite-components/components/calcite-label";
+import "@esri/calcite-components/components/calcite-checkbox";
+import "../arcgis-elevation-profile-statistics/index.js";
+export * from "./customElement.js";

package/dist/components/arcgis-elevation-profile-legend-item/index.js

@@ -0,0 +1,5 @@
+import "@esri/calcite-components/components/calcite-action";
+import "@esri/calcite-components/components/calcite-label";
+import "@esri/calcite-components/components/calcite-checkbox";
+import "../arcgis-elevation-profile-statistics/index.js";
+export * from "./customElement.js";

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

@@ -0,0 +1,78 @@
+import { default as ElevationProfileAnalysis } from '@arcgis/core/analysis/ElevationProfileAnalysis.js';
+import { default as MapView } from '@arcgis/core/views/MapView.js';
+import { default as SceneView } from '@arcgis/core/views/SceneView';
+import { default as ElevationProfileResult } from '@arcgis/core/views/analysis/ElevationProfile/ElevationProfileResult';
+import { AnalysisViewModel } from '../../support/AnalysisViewModel';
+import { SystemOrLengthUnit } from '../../support/measurementUtils';
+import { ElevationProfileEffectiveDisplayUnits, ElevationProfileErrorState } from './interfaces';
+export default class ElevationProfileViewModel extends AnalysisViewModel<MapView | SceneView, ElevationProfileAnalysis> {
+    private _userUnitOptionsDistance?;
+    private _userUnitOptionsElevation?;
+    private _userUnitDistance?;
+    private _userUnitElevation?;
+    private get _measurementSystem();
+    private _selectingPromise?;
+    private _selectedFeature?;
+    private _selectionHighlightTask?;
+    private get _hasSamples();
+    /**
+     * Whether the current geometry is valid and the "Done" button should be enabled to finish the sketch operation.
+     */
+    get doneButtonAvailable(): boolean;
+    get effectiveDisplayUnits(): ElevationProfileEffectiveDisplayUnits | undefined;
+    get errorState(): ElevationProfileErrorState;
+    /**
+     * Whether a feature is currently being used as input for the analysis.
+     */
+    get featureSelected(): boolean;
+    get hasVertices(): boolean;
+    highlightEnabled: boolean;
+    get hoveredPosition(): number | undefined;
+    get geometry(): ElevationProfileAnalysis["geometry"];
+    set geometry(value: ElevationProfileAnalysis["geometry"]);
+    get elevationInfo(): ElevationProfileAnalysis["elevationInfo"];
+    set elevationInfo(value: ElevationProfileAnalysis["elevationInfo"]);
+    get profiles(): ElevationProfileAnalysis["profiles"];
+    set profiles(value: ElevationProfileAnalysis["profiles"]);
+    get progress(): number;
+    get results(): ElevationProfileResult[];
+    /**
+     * Whether there are layers in the map or graphics in the view that can be selected. In that case, the select button
+     * can be enabled.
+     */
+    get selectButtonAvailable(): boolean;
+    /**
+     * The current state of the component
+     *
+     * - `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
+     */
+    get state(): "created" | "creating" | "disabled" | "ready" | "selected" | "selecting";
+    uniformChartScaling: boolean;
+    get unitDistance(): SystemOrLengthUnit | undefined;
+    set unitDistance(unit: SystemOrLengthUnit | undefined);
+    get unitElevation(): SystemOrLengthUnit | undefined;
+    set unitElevation(unit: SystemOrLengthUnit | undefined);
+    get unitOptionsDistance(): SystemOrLengthUnit[];
+    set unitOptionsDistance(units: SystemOrLengthUnit[] | undefined);
+    get unitOptionsElevation(): SystemOrLengthUnit[];
+    set unitOptionsElevation(units: SystemOrLengthUnit[] | undefined);
+    initialize(): void;
+    destroy(): void;
+    select(): Promise<void>;
+    protected place(options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    protected shouldForceInteractive: boolean;
+    protected clearAnalysis(): void;
+    protected readonly supportedViewType = "both";
+    protected readonly unsupportedErrorMessage = "";
+    protected constructAnalysis(): ElevationProfileAnalysis;
+    private _highlightSelectedFeature;
+    private _removeSelectionHighlight;
+    private _excludeSelectedFeatureFromProfile;
+}

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

@@ -0,0 +1,208 @@
+/// <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: nullish | __esri.Polyline;
+    /**
+     * 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" | "selected" | "disabled" | "created" | "creating" | "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: "state" | "progress" | "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 {};