Geoprocessor | @types/arcgis-js-api

Hierarchy

Task
- Geoprocessor

Index

Properties

Methods

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

initialized

initialized: boolean

outSpatialReference

outSpatialReference: SpatialReference

The spatial reference of the output geometries.

processExtent

processExtent: Extent

ProcessExtent, if specified, will only process features that overlap this extent.

processSpatialReference

processSpatialReference: SpatialReference

The spatial reference that the model will use to perform geometry operations.

requestOptions

requestOptions: any

The options to be used for data requests.

returnM

returnM: boolean

If true, m-values will be included in the results if the features have m-values.

returnZ

returnZ: boolean

If true, z-values will be included in the results if the features have z-values.

url

url: string

The ArcGIS Server REST service URL (usually of a Feature Service Layer or Map Service Layer) for use in a task.

Methods

Protected _get

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

Inherited from Task._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Task._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): Geoprocessor

Inherited from Task._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Geoprocessor

cancelJob

cancelJob(jobId: string, requestOptions?: any): Promise<JobInfo>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54115
Cancels an asynchronous geoprocessing job.

Read more...

Parameters
- jobId: string
- Optional requestOptions: any
Returns Promise<JobInfo>

checkJobStatus

checkJobStatus(jobId: string, requestOptions?: any): Promise<JobInfo>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54121
Sends a request to the GP Task for the current state of the job identified by jobId.

Read more...

Parameters
- jobId: string
- Optional requestOptions: any
Returns Promise<JobInfo>

destroy

destroy(): void

Inherited from Task.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:26
Returns void

execute

execute(params: any, requestOptions?: any): Promise<any>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54127
Sends a request to the server to execute a synchronous GP task.

Read more...

Parameters
- params: any
- Optional requestOptions: any
Returns Promise<any>

get

get<T>(propertyName: string): T
get(propertyName: string): any

Inherited from Task.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Task.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

getResultData

getResultData(jobId: string, resultName: string, requestOptions?: any): Promise<ParameterValue>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54133
Sends a request to the GP Task to get the task result identified by jobId and resultName.

Read more...

Parameters
- jobId: string
- resultName: string
- Optional requestOptions: any
Returns Promise<ParameterValue>

getResultImage

getResultImage(jobId: string, resultName: string, imageParams: ImageParameters, requestOptions?: any): Promise<ParameterValue>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54139
Sends a request to the GP Task to get the task result identified by jobId and resultName as an image.

Read more...

Parameters
- jobId: string
- resultName: string
- imageParams: ImageParameters
- Optional requestOptions: any
Returns Promise<ParameterValue>

getResultMapImageLayer

getResultMapImageLayer(jobId: string): Promise<MapImageLayer>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54150
Get the task result identified by jobId as an MapImageLayer.

Read more...

Parameters
- jobId: string
Returns Promise<MapImageLayer>

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Task.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

set

set<T>(propertyName: string, value: T): Geoprocessor
set(props: HashMap<any>): Geoprocessor

Inherited from Task.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Geoprocessor
Inherited from Task.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns Geoprocessor

submitJob

submitJob(params: any, requestOptions?: any): Promise<JobInfo>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54156
Submits a job to the server for asynchronous processing by the GP task.

Read more...

Parameters
- params: any
- Optional requestOptions: any
Returns Promise<JobInfo>

waitForJobCompletion

waitForJobCompletion(jobId: string, options?: GeoprocessorWaitForJobCompletionOptions): Promise<JobInfo>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54162
Resolves when an asynchronous job has completed.

Read more...

Parameters
- jobId: string
- Optional options: GeoprocessorWaitForJobCompletionOptions
Returns Promise<JobInfo>

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Task.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Hierarchy

Index

Properties

Methods

Properties

declaredClass

destroyed

initialized

outSpatialReference

processExtent

processSpatialReference

requestOptions

returnM

returnZ

url

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type parameters

T

Parameters

propertyName: string

value: T

Returns Geoprocessor

cancelJob

Parameters

jobId: string

Optional requestOptions: any

Returns Promise<JobInfo>

checkJobStatus

Parameters

jobId: string

Optional requestOptions: any

Returns Promise<JobInfo>

destroy

Returns void

execute

Parameters

params: any

Optional requestOptions: any

Returns Promise<any>

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

getResultData

Parameters

jobId: string

resultName: string

Optional requestOptions: any

Returns Promise<ParameterValue>

getResultImage

Parameters

jobId: string

resultName: string

imageParams: ImageParameters

Optional requestOptions: any

Returns Promise<ParameterValue>

getResultMapImageLayer

Parameters

jobId: string

Returns Promise<MapImageLayer>

Protected notifyChange

Parameters

propertyName: string

Returns void

set