@arcgis/core
Version:
ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API
33 lines (31 loc) • 1.82 kB
TypeScript
import type { JSONSupport } from "../../core/JSONSupport.js";
export interface ImageVolumeProperties extends Partial<Pick<ImageVolume, "area" | "cut" | "cutCellCount" | "fill" | "fillCellCount" | "maxZ" | "meanZ" | "minZ">> {}
/**
* The [ImageryLayer.calculateVolume()](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/#calculateVolume)
* method on [ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/) returns
* [ImageVolumeResult](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ImageVolumeResult/) containing array of this class.
*
* @since 4.32
* @see [ImageVolumeResult](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ImageVolumeResult/)
* @see [ImageVolumeParameters](https://developers.arcgis.com/javascript/latest/references/core/rest/support/ImageVolumeParameters/)
* @see [ImageryLayer.calculateVolume()](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/#calculateVolume)
*/
export default class ImageVolume extends JSONSupport {
constructor(properties?: ImageVolumeProperties);
/** Area of the surface. Unit is square meters. */
accessor area: number;
/** The cut volume. Unit is cubic meters. */
accessor cut: number;
/** Cut cell count. */
accessor cutCellCount: number | null | undefined;
/** The fill volume (negative). Unit is cubic meters. */
accessor fill: number;
/** Fill cell count. */
accessor fillCellCount: number | null | undefined;
/** Maximum z of the surface perimeter. Unit is meter. */
accessor maxZ: number;
/** Average z of the surface perimeter. Unit is meter. */
accessor meanZ: number;
/** Minimum z of the surface perimeter. Unit is meter. */
accessor minZ: number;
}