ImageSampleParameters

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

Input parameters for the getSamples() method on ImageryLayer.

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
String

The name of the class.

Accessor
Point|Multipoint|Polyline|Extent|Polygon

Input geometry that defines the locations to be sampled.

ImageSampleParameters
String

Defines how to interpolate pixel values.

ImageSampleParameters
Point[]

When sampling multiple locations, you can use an array of points instead of providing a multipoint for the geometry property.

ImageSampleParameters
MosaicRule

Specifies the mosaic rule defining the image sort order and selection.

ImageSampleParameters
String[]

The list of fields associated with the rasters to be included in the response.

ImageSampleParameters
PixelSize

Specifies the pixel size (or the resolution) that will be used for the sampling.

ImageSampleParameters
Boolean

When true, returns the first valid pixel value that meets specified conditions at each sampling point location.

ImageSampleParameters
Number

Specifies the approximate number of locations to sample from the provided geometry when the input geometry is polyline, polygon or extent.

ImageSampleParameters
Number

Specifies the distance interval to sample points from the provided geometry when input geometry is polyline.

ImageSampleParameters
Number

Specifies the slice id of a multidimensional raster.

ImageSampleParameters
TimeExtent

The time extent for which to perform sampling.

ImageSampleParameters

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.

geometry

Property
geometry Point|Multipoint|Polyline|Extent|Polygonautocast
Autocasts from Object

Input geometry that defines the locations to be sampled. The geometry can be a point, multipoint, polyline, extent or a polygon.

The locations property can be used to set an array of points for convenience if the geometry is a multipoint. If you set the locations property, the array of points will be converted to a multipoint geometry at runtime.

interpolation

Property
interpolation String

Defines how to interpolate pixel values.

Possible Values:"nearest"|"bilinear"|"cubic"|"majority"

Default Value:nearest

locations

Property
locations Point[]

When sampling multiple locations, you can use an array of points instead of providing a multipoint for the geometry property. The array of points will be converted to a multipoint and used as the geometry at runtime. The first point's spatial reference is used in getSamples operation.

mosaicRule

Property
mosaicRule MosaicRuleautocast
Autocasts from Object

Specifies the mosaic rule defining the image sort order and selection. When a mosaic rule is not specified, the current settings on the ImageryLayer will be used.

outFields

Property
outFields String[]

The list of fields associated with the rasters to be included in the response.

Default Value:null

pixelSize

Property
pixelSize PixelSizeautocast
Autocasts from Object

Specifies the pixel size (or the resolution) that will be used for the sampling. 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 this operation.

returnFirstValueOnly

Property
returnFirstValueOnly Boolean

When true, returns the first valid pixel value that meets specified conditions at each sampling point location. When false, all pixel values are returned.

Default Value:true

sampleCount

Property
sampleCount Number

Specifies the approximate number of locations to sample from the provided geometry when the input geometry is polyline, polygon or extent. Either sampleDistance or sampleCount is needed to perform densification on the input polyline to sample points. The unit of the geometry's spatial reference will be used for the densification.

sampleDistance

Property
sampleDistance Number

Specifies the distance interval to sample points from the provided geometry when input geometry is polyline. Either sampleDistance or sampleCount is needed to perform densification on the input polyline to sample points. The unit of the geometry's spatial reference will be used for the densification.

sliceId

Property
sliceId Number

Specifies the slice id of a multidimensional raster. This parameter is supported at ArcGIS Server 10.9 and later.

timeExtent

Property
timeExtent TimeExtentautocast
Autocasts from Object

The time extent for which to perform sampling. This parameter is supported at ArcGIS Server 10.9 and later.

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.

ImageSampleParameters
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Object

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

ImageSampleParameters

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

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
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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

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.