SpatialGetClosestPointOptionalParams interface

Optional Parameters.

Extends
RequestOptionsBase

Properties

abortSignal

The signal which can be used to abort requests.

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

numberOfClosestPoints

The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50

onDownloadProgress

Callback which fires upon download progress.

onUploadProgress

Callback which fires upon upload progress.

timeout

The number of milliseconds a request can take before automatically being terminated.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: [key: string]: string

Property Value

[key: string]: string

numberOfClosestPoints

The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50

numberOfClosestPoints?: number

Property Value

number

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number