require(["esri/rest/support/ImageDistanceParameters"], (ImageDistanceParameters) => { /* code goes here */ });
import ImageDistanceParameters from "@arcgis/core/rest/support/ImageDistanceParameters.js";
esri/rest/support/ImageDistanceParameters
Input parameters used by the ImageryLayer.measureDistanceAndAngle() or imageService.measureDistanceAndAngle() methods to perform imagery distance and angle mensuration.
- See also
Constructors
-
new ImageDistanceParameters(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The angular unit used for angle calculation. more details | ImageDistanceParameters | |
String | The name of the class. more details | Accessor | |
Point | A point that defines the from location of the distance and angle measurement. more details | ImageDistanceParameters | |
Boolean | When | ImageDistanceParameters | |
String | The linear unit used for distance calculation. more details | ImageDistanceParameters | |
MosaicRule | Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed. more details | ImageDistanceParameters | |
PixelSize | Specifies the pixel size. more details | ImageDistanceParameters | |
Point | A point that defines the to location of the distance and angle measurement. more details | ImageDistanceParameters | |
String | The string value representing the type of imagery mensuration. more details | ImageDistanceParameters |
Property Details
-
angularUnit String
-
The angular unit used for angle calculation.
Possible Values:"degrees"|"radians"
- Default Value:"degrees"
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
fromGeometry Point
-
A point that defines the from location of the distance and angle measurement.
-
is3D 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 returnstrue
.- Default Value:false
-
linearUnit String
-
The linear unit used for distance calculation.
Possible Values:"millimeters"|"centimeters"|"decimeters"|"meters"|"kilometers"|"inches"|"feet"|"yards"|"miles"|"nautical-miles"|"us-feet"
- Default Value:"meters"
-
mosaicRule MosaicRuleautocastSince: 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 will be used.
-
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.
-
toGeometry Point
-
A point that defines the to location of the distance and angle measurement.
-
type Stringreadonly
-
The string value representing the type of imagery mensuration.
For ImageDistanceParameters the type is always "distance-angle".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | ImageDistanceParameters | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | ImageDistanceParameters |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
fromJSON(json){*}static
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inherited
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.