ImageSampleParameters

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

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.

Defines how to interpolate pixel values.

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.

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.

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

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.

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

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.

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.

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

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

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.

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