npm - @arcgis/map-components - Versions diffs - 5.1.0-next.2 → 5.1.0-next.21 - Mend

@arcgis/map-components 5.1.0-next.2 → 5.1.0-next.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (490) hide show

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

@@ -1,5 +1,5 @@
 /// <reference path="../../index.d.ts" />
-import type Graphic from "@arcgis/core/Graphic";
+import type Graphic from "@arcgis/core/Graphic.js";
 import type ElevationProfileAnalysis from "@arcgis/core/analysis/ElevationProfileAnalysis.js";
 import type MapView from "@arcgis/core/views/MapView.js";
 import type SceneView from "@arcgis/core/views/SceneView.js";
@@ -7,7 +7,7 @@ import type Polyline from "@arcgis/core/geometry/Polyline.js";
 import type ElevationInfo from "@arcgis/core/symbols/support/ElevationInfo.js";
 import type Collection from "@arcgis/core/core/Collection.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
+import type { ArcgisReferenceElement } from "../types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { ElevationProfileEffectiveDisplayUnits } from "@arcgis/core/views/analysis/ElevationProfile/types.js";
 import type { Icon as Icon } from "@esri/calcite-components/components/calcite-icon";
@@ -16,22 +16,22 @@ import type { ElevationProfileLineUnion } from "@arcgis/core/analysis/ElevationP
 import type { SystemOrLengthUnit } from "@arcgis/core/core/units.js";
 /**
- * The Elevation Profile component manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html) and displays its elevation profiles.
+ * The Elevation Profile component manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/) 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/)
+ * [![elevation profile poster](https://developers.arcgis.com/javascript/latest/assets/references/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:
+ * The component can visualize multiple profile lines, depending on whether it is used in an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) component or an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/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 an 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).
+ * * [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineGround/): represents a profile line that uses elevation from [arcgis-map.ground](https://developers.arcgis.com/javascript/latest/references/map-components/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/references/core/analysis/ElevationProfile/ElevationProfileLineInput/): 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/references/core/analysis/ElevationProfile/ElevationProfileLineQuery/): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineQuery/#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/) or an object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/#queryElevation).
+ * * [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineScene/): 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.
+ * You can choose to display one or several profile lines in the chart, by setting them in the [profiles](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#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/)
+ * [![elevation profile chart gif](https://developers.arcgis.com/javascript/latest/assets/references/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.
  *
@@ -44,12 +44,12 @@ import type { SystemOrLengthUnit } from "@arcgis/core/core/units.js";
  *
  * **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.
+ * - [ElevationProfileLineInput](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#elevationInfo) is set.
+ * - [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineScene/) is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.
  *
  * **See also**
  *
- * - [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)
+ * - [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)
  * - [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/)
  *
@@ -157,16 +157,16 @@ export abstract class ArcgisElevationProfile extends LitElement {
       zoomOut: string;
   }>;
   /**
-   * The [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)
+   * The [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)
    * 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-map/)
-   * or [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)
+   * When connecting the Elevation Profile component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)
+   * or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)
    * components, it automatically creates an empty analysis and adds it to the Map's
-   * [analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#analyses) collection or the Scene's
-   * [analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.
-   * You can then wait for the [ElevationProfileAnalysisView2D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-2d-analysis-ElevationProfileAnalysisView2D.html)
-   * or [ElevationProfileAnalysisView3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ElevationProfileAnalysisView3D.html)
+   * [arcgis-map.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#analyses) collection or the Scene's
+   * [arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.
+   * You can then wait for the [ElevationProfileAnalysisView2D](https://developers.arcgis.com/javascript/latest/references/core/views/2d/analysis/ElevationProfileAnalysisView2D/)
+   * or [ElevationProfileAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ElevationProfileAnalysisView3D/)
    * to be created (depending on whether you are using a Map or Scene component) before accessing the analysis results.
    *
    * ```js
@@ -190,7 +190,7 @@ export abstract class ArcgisElevationProfile extends LitElement {
    * ```
    * Whenever the component is destroyed, the analysis is automatically removed from the collection.
    *
-   * Alternatively, a programmatically created [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)
+   * Alternatively, a programmatically created [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)
    * can be provided to the component.
    * Then, the application itself needs to add it to and later remove it from the analyses collection of the Map or Scene component.
    *
@@ -249,11 +249,11 @@ export abstract class ArcgisElevationProfile extends LitElement {
   get effectiveDisplayUnits(): ElevationProfileEffectiveDisplayUnits | undefined;
   /**
    * 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)
+   * [input](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/)
    * profile line. This property can only be used in a
-   * [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   * [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
    *
-   * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#elevationInfo)
+   * [Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#elevationInfo)
    *
    * @since 5.0
    */
@@ -283,7 +283,7 @@ export abstract class ArcgisElevationProfile extends LitElement {
   /**
    * 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)
+   * [Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#geometry)
    *
    * @since 5.0
    */
@@ -336,6 +336,7 @@ export abstract class ArcgisElevationProfile extends LitElement {
    * If true, the button to start sketching a new profile line will be hidden.
    *
    * @default false
+   * @since 5.0
    */
   accessor hideStartButton: boolean;
   /**
@@ -370,7 +371,7 @@ export abstract class ArcgisElevationProfile extends LitElement {
    * Relative position along the current elevation profile line, in the range [0, 1].
    * The component updates this value as the user hovers the chart.
    *
-   * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ElevationProfileAnalysisView3D.html#indicatorRelativePosition)
+   * [Read more](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ElevationProfileAnalysisView3D/#indicatorRelativePosition)
    *
    * @since 5.0
    */
@@ -439,13 +440,13 @@ export abstract class ArcgisElevationProfile extends LitElement {
    * 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)
+   * [Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#profiles)
    */
   accessor profiles: Collection<ElevationProfileLineUnion>;
   /**
    * 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)
+   * [Read more](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ElevationProfileAnalysisView3D/#progress)
    */
   get progress(): number;
   /**