ImageSampleParametersProperties | @types/arcgis-js-api

Index

geometry: (PointProperties & { type: "point" }) | (MultipointProperties & { type: "multipoint" }) | (PolylineProperties & { type: "polyline" }) | (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" })

Input geometry that defines the the locations to be sampled.

interpolation: "nearest" | "bilinear" | "cubic" | "majority"

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.

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

outFields: string[]

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.

returnFirstValueOnly: boolean

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

sampleCount: number

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

sampleDistance: number

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

sliceId: number

Specifies the slice id of a multidimensional raster.

The time extent for which to perform sampling.