@arcgis/core/analysis/ElevationProfile/ElevationProfileDisplayUnits.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

import type { Clonable } from "../../core/Clonable.js";
import type { SystemOrLengthUnit } from "../../core/units.js";

export interface ElevationProfileDisplayUnitsProperties extends Partial<Pick<ElevationProfileDisplayUnits, "distance" | "elevation">> {}

/**
 * Unit systems (imperial, metric) or specific units used for computing and displaying elevation profile results.
 *
 * If not specified, units are chosen automatically based on the magnitude of the results. The effective units can be accessed
 * through the [ElevationProfileAnalysisView2D.results](https://developers.arcgis.com/javascript/latest/references/core/views/2d/analysis/ElevationProfileAnalysisView2D/#results)
 * or [ElevationProfileAnalysisView3D.results](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ElevationProfileAnalysisView3D/#results) properties.
 *
 * @since 4.34
 * @see [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)
 */
export default class ElevationProfileDisplayUnits extends Clonable {
  constructor(properties?: ElevationProfileDisplayUnitsProperties);
  /** Unit system (imperial, metric) or specific unit used for computing and displaying distances along the profile line. */
  accessor distance: SystemOrLengthUnit | null | undefined;
  /** Unit system (imperial, metric) or specific unit used for computing and displaying elevation values. */
  accessor elevation: SystemOrLengthUnit | null | undefined;
}