require(["esri/rest/support/ImageHeightParameters"], (ImageHeightParameters) => { /* code goes here */ });
import ImageHeightParameters from "@arcgis/core/rest/support/ImageHeightParameters.js";
esri/rest/support/ImageHeightParameters
Input parameters used by the ImageryLayer.measureHeight() or imageService.measureHeight() methods to perform imagery height mensuration.
Constructors
-
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 name of the class. | Accessor | |
| Point | A point that defines the from location of the height measurement. | ImageHeightParameters | |
| String | Linear unit used for height calculation. | ImageHeightParameters | |
| MosaicRule | Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed. | ImageHeightParameters | |
| String | Determines how the height will be measured when the sensor info is available. | ImageHeightParameters | |
| PixelSize | Specifies the pixel size. | ImageHeightParameters | |
| Point | A point that defines the to location of the height measurement. | ImageHeightParameters | |
| String | The string value representing the type of imagery mensuration. | ImageHeightParameters |
Property Details
-
fromGeometry
PropertyfromGeometry Point -
A point that defines the from location of the height measurement.
-
linearUnit
PropertylinearUnit String -
Linear unit used for height calculation.
Possible Values:"millimeters"|"centimeters"|"decimeters"|"meters"|"kilometers"|"inches"|"feet"|"yards"|"miles"|"nautical-miles"|"us-feet"
- Default Value:"meters"
-
mosaicRule
PropertymosaicRule MosaicRuleautocastSince: ArcGIS Maps SDK for JavaScript 4.27ImageHeightParameters since 4.26, mosaicRule added at 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.
-
operationType
PropertyoperationType String -
Determines how the height will be measured when the sensor info is available.
Property Description base-and-top Calculates the height of a ground feature by measuring from the base of the object to the top of the object. Measurements are assumed to be perpendicular to the base; therefore, the line being measured along the building must have its endpoint directly above the start point. base-and-top-shadow Calculates the height of a feature by measuring from the base of the object to the top of the object's shadow on the ground. The point in the shadow must represent a point on the visible object that is perpendicular to the base. top-and-top-shadow Calculates the height of a feature by measuring from the top of the object to the top of the objects's shadow on the ground. The measurement points on the object and its shadow must represent the same point. Possible Values:"base-and-top"|"base-and-top-shadow"|"top-and-top-shadow"
- Default Value:"base-and-top"
-
Since: ArcGIS Maps SDK for JavaScript 4.27ImageHeightParameters since 4.26, pixelSize added at 4.27. -
Specifies the pixel size. If pixel size is not specified,
pixelSizewill 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
PropertytoGeometry Point -
A point that defines the to location of the height measurement.
-
type
Propertytype Stringreadonly -
The string value representing the type of imagery mensuration.
For ImageHeightParameters the type is always "height".
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | ImageHeightParameters | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | ImageHeightParameters |
Method Details
-
Inherited from Accessor
-
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.
-
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
jsonparameter 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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
-
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
MethodtoJSON(){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.