ImageSample

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

The getSamples method on ImageryLayer returns ImageSampleResult containing array of this class.

See also

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
Object

Name-value pairs of fields and field values associated with the sample location.

more details
ImageSample
String

The name of the class.

more details
Accessor
Point

The sample location.

more details
ImageSample
Number

The location id.

more details
ImageSample
Number[]

The pixel value associated with the sampled location.

more details
ImageSample
Number

The raster id.

more details
ImageSample
Number

The resolution representing the average of source raster's resolutions in x and y axes.

more details
ImageSample

Property Details

attributes Object

Name-value pairs of fields and field values associated with the sample location. The returned name-value pairs will correspond to fields specified in outFields parameter.

declaredClass Stringreadonly inherited

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

location Point

The sample location.

locationId Number

The location id.

pixelValue Number[]

The pixel value associated with the sampled location.

rasterId Number

The raster id.

resolution Number

The resolution representing the average of source raster's resolutions in x and y axes.

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

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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
Since: ArcGIS Maps SDK for JavaScript 4.25

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
Since: ArcGIS Maps SDK for JavaScript 4.25

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.