ImageSample

Class: esri/rest/support/ImageSample
Inheritance: ImageSample Accessor
Since: ArcGIS API 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
Objectmore details

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

more detailsImageSample
Stringmore details

The name of the class.

more detailsAccessor
Pointmore details

The sample location.

more detailsImageSample
Numbermore details

The location id.

more detailsImageSample
Number[]more details

The pixel value associated with the sampled location.

more detailsImageSample
Numbermore details

The raster id.

more detailsImageSample
Numbermore details

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

more detailsImageSample

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

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsImageSample
Objectmore details

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

more detailsImageSample

Method Details

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