import ImageDistanceParameters from "@arcgis/core/rest/support/ImageDistanceParameters.js";const ImageDistanceParameters = await $arcgis.import("@arcgis/core/rest/support/ImageDistanceParameters.js");- Inheritance:
- ImageDistanceParameters→
BaseImageMeasureParameters→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.26
Input parameters used by the ImageryLayer.measureDistanceAndAngle() or measureDistanceAndAngle() methods to perform imagery distance and angle mensuration.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
mosaicRule inherited | MosaicRule | null | undefined | |
pixelSize inherited | ||
| | ||
type readonly | "distance-angle" | |
angularUnit
- Type
- AngleUnit
The angular unit used for angle calculation.
- Default value
- "degrees"
is3D
- Type
- boolean
When true, this method calculates the 3D measurements for the distance and angle between two points on an image service.
The elevation surface will be incorporated when performing the calculations.
3D calculation can only be done when the layer's capabilities.mensuration.supports3D returns true.
- Default value
- false
linearUnit
- Type
- LengthUnit
The linear unit used for distance calculation.
- Default value
- "meters"
mosaicRule
- Type
- MosaicRule | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.27
Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed. When a mosaic rule is not specified, the current settings on the ImageryLayer.mosaicRule will be used.
pixelSize
- Type
- Point
- Since
- ArcGIS Maps SDK for JavaScript 4.27
Specifies the pixel size. If pixel size is not specified, pixelSize will default to the base resolution of the image service.
The raster at the specified pixel size in the mosaic dataset will be used for the Measure calculation.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
Creates a new instance of this class and initializes it with values from a JSON object
generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a
toJSON()
method from another ArcGIS product. See the Using fromJSON()
topic in the Guide for details and examples of when and how to use this function.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects. | |
- Returns
- any
Returns a new instance of this class.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.