@arcgis/core
Version:
ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API
32 lines (30 loc) • 2.4 kB
TypeScript
import type Polygon from "../../geometry/Polygon.js";
import type Polyline from "../../geometry/Polyline.js";
import type { JSONSupport } from "../../core/JSONSupport.js";
import type { PolygonProperties } from "../../geometry/Polygon.js";
import type { PolylineProperties } from "../../geometry/Polyline.js";
export interface MeasureFromImageParametersProperties extends Partial<Pick<MeasureFromImageParameters, "rasterId">> {
/** The polyline or polygon geometry used to perform length or area measurements in an image space. */
geometry?: (PolylineProperties & { type: "polyline" }) | (PolygonProperties & { type: "polygon" });
}
/**
* Input parameters used by the [ImageryLayer.measureLengthFromImage()](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/#measureLengthFromImage),
* [ImageryLayer.measureAreaFromImage()](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/#measureAreaFromImage),
* [measureLengthFromImage()](https://developers.arcgis.com/javascript/latest/references/core/rest/imageService/#measureLengthFromImage)
* and [measureAreaFromImage()](https://developers.arcgis.com/javascript/latest/references/core/rest/imageService/#measureAreaFromImage) methods to perform imagery
* area, perimeter and length mensuration.
*
* @since 4.29
* @see [ImageryLayer.measureLengthFromImage()](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/#measureLengthFromImage)
* @see [ImageryLayer.measureAreaFromImage()](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/#measureAreaFromImage)
* @see [measureLengthFromImage()](https://developers.arcgis.com/javascript/latest/references/core/rest/imageService/#measureLengthFromImage)
* @see [measureAreaFromImage()](https://developers.arcgis.com/javascript/latest/references/core/rest/imageService/#measureAreaFromImage)
*/
export default class MeasureFromImageParameters extends JSONSupport {
constructor(properties?: MeasureFromImageParametersProperties);
/** The polyline or polygon geometry used to perform length or area measurements in an image space. */
get geometry(): Polyline | Polygon;
set geometry(value: (PolylineProperties & { type: "polyline" }) | (PolygonProperties & { type: "polygon" }));
/** The id of the raster to be measured. */
accessor rasterId: number;
}