Skip to content
import ImageSample from "@arcgis/core/rest/support/ImageSample.js";
Inheritance:
ImageSampleAccessor
Since
ArcGIS Maps SDK for JavaScript 4.20

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

See also

Constructors

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

attributes

Property
Type
Record<string, any> | null | undefined

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

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

location

autocast Property
Type
Point

The sample location.

locationId

Property
Type
number

The location id.

pixelValue

Property
Type
number[] | null | undefined

The pixel value associated with the sampled location.

rasterId

Property
Type
number | null | undefined

The raster id. Available when the layer's data source is a mosaic dataset.

resolution

Property
Type
number

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

Methods

MethodSignatureClass
fromJSON
inherited static
fromJSON(json: any): any
toJSON
inherited
toJSON(): any

fromJSON

inheritedstatic Method
Signature
fromJSON (json: any): any
Inherited from: JSONSupportMixin

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.

Parameters
ParameterTypeDescriptionRequired
json
any

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
any

Returns a new instance of this class.

toJSON

inherited Method
Signature
toJSON (): any
Inherited from: JSONSupportMixin

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

Returns
any

The ArcGIS portal JSON representation of an instance of this class.