PrintTask | @types/arcgis-js-api

Hierarchy

Task
- PrintTask

Index

Properties

Methods

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

initialized

initialized: boolean

Readonly mode

mode: "async" | "sync"

The mode for the print task execution.

requestOptions

requestOptions: any

The options to be used for data requests.

updateDelay

updateDelay: number

The time interval in milliseconds between each job status request sent to an asynchronous GP task.

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): PrintTask

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 PrintTask

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: PrintParameters, requestOptions?: any): Promise<PrintResponse>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:54533
Sends a request to the print service to create a printable static image of the map using the options specified in the PrintParameters.

Read more...

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

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

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): PrintTask
set(props: HashMap<any>): PrintTask

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 PrintTask
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 PrintTask

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

Readonly mode

requestOptions

updateDelay

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 PrintTask

destroy

Returns void

execute

Parameters

params: PrintParameters

Optional requestOptions: any

Returns Promise<PrintResponse>

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

Protected notifyChange

Parameters

propertyName: string

Returns void

set

Type parameters

T

Parameters

propertyName: string

value: T

Returns PrintTask

Parameters

props: HashMap<any>

Returns PrintTask

watch

Parameters

path: string | string[]

callback: WatchCallback

Optional sync: boolean

Returns WatchHandle