Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageSampleParameters

Hierarchy

Index

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

geometry

Input geometry that defines the the locations to be sampled.

Read more...

initialized

initialized: boolean

interpolation

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

Defines how to interpolate pixel values.

Read more...

locations

locations: Point[]

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

Read more...

mosaicRule

mosaicRule: MosaicRule

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

Read more...

outFields

outFields: string[]

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

Read more...

pixelSize

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

Read more...

returnFirstValueOnly

returnFirstValueOnly: boolean

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

Read more...

sampleCount

sampleCount: number

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

Read more...

sampleDistance

sampleDistance: number

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

Read more...

sliceId

sliceId: number

Specifies the slice id of a multidimensional raster.

Read more...

timeExtent

timeExtent: TimeExtent

The time extent for which to perform sampling.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ImageSampleParameters

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ImageSampleParameters

  • Parameters

    Returns ImageSampleParameters

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc