ImagePointParameters

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

Input parameters used by the ImageryLayer.measurePointOrCentroid() or imageService.measurePointOrCentroid() methods to perform imagery point or centroid mensuration. The point mensuration determines the location of point-based geographic coordinates while the centroid mensuration determines the centroid of the area of interest for given geometry.

See also

Constructors

new ImagePointParameters(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
String

The name of the class.

more details
Accessor
Point|Extent|Polygon

Input geometry to determine a a point location or a centroid of a given area.

more details
ImagePointParameters
Boolean

When true, this method calculates the z-value for the returned point geometry.

more details
ImagePointParameters
MosaicRule

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

more details
ImagePointParameters
PixelSize

Specifies the pixel size.

more details
ImagePointParameters
String

The string value representing the type of imagery mensuration.

more details
ImagePointParameters

Property Details

declaredClass Stringreadonly inherited

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

geometry Point|Extent|Polygon

Input geometry to determine a a point location or a centroid of a given area.

is3D Boolean

When true, this method calculates the z-value for the returned point geometry. 3D calculation can only be done when the layer's capabilities.mensuration.supports3D returns true.

Default Value:false
mosaicRule MosaicRuleautocast
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 will be used.

pixelSize PixelSizeautocast
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.

type Stringreadonly

The string value representing the type of imagery mensuration.

For ImagePointParameters the type is always "point".

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.

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
ImagePointParameters
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
ImagePointParameters

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();
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(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(groupKey){Boolean}inherited

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(groupKey)inherited

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(){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.