ImageHeightParameters

AMD: require(["esri/rest/support/ImageHeightParameters"], (ImageHeightParameters) => { /* code goes here */ });
ESM: import ImageHeightParameters from "@arcgis/core/rest/support/ImageHeightParameters.js";
Class: esri/rest/support/ImageHeightParameters
Inheritance: ImageHeightParametersAccessor
Since: ArcGIS Maps SDK for JavaScript 4.26

Input parameters used by the ImageryLayer.measureHeight() or imageService.measureHeight() methods to perform imagery height mensuration.

See also

Constructors

ImageHeightParameters

Constructor
new ImageHeightParameters(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

A point that defines the from location of the height measurement.

ImageHeightParameters

Linear unit used for height calculation.

ImageHeightParameters

Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed.

ImageHeightParameters

Determines how the height will be measured when the sensor info is available.

ImageHeightParameters

Specifies the pixel size.

ImageHeightParameters

A point that defines the to location of the height measurement.

ImageHeightParameters

The string value representing the type of imagery mensuration.

ImageHeightParameters

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

fromGeometry

Property
fromGeometry Point

A point that defines the from location of the height measurement.

linearUnit

Property
linearUnit LengthUnit

Linear unit used for height calculation.

Default Value:"meters"

mosaicRule

Property
mosaicRule MosaicRuleautocast
Since: ArcGIS Maps SDK for JavaScript 4.27 ImageHeightParameters 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

Property
operationType 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"

pixelSize

Property
pixelSize Pointautocast
Since: ArcGIS Maps SDK for JavaScript 4.27 ImageHeightParameters since 4.26, pixelSize added at 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

Property
toGeometry Point

A point that defines the to location of the height measurement.

type

Property
type Stringreadonly

The string value representing the type of imagery mensuration.

For ImageHeightParameters the type is always "height".

Method Overview

Show inherited methods Hide inherited methods
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

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

ImageHeightParameters

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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

Method
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.

Parameter
json Object

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
Type Description
* Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.