ImageSampleParameters

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

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 String

Defines how to interpolate pixel values.

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

Default Value:nearest

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 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 String[]

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

Default Value:null

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

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

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

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

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

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.