The PrintTask generates a printer-ready version of the map using an Export Web Map Task available with ArGIS Server 10.1 and later. This class is used when you want to have more granular control over the user interface, for example, if you want to provide users the ability to define what appears on the printed page.
Use PrintParameters to set the printing options of the task.
Known Limitations
- PrintTask is not supported in SceneView.
- VectorTileLayer printing requires ArcGIS Server 10.5.1 or later. When printing the VectorTileLayer, print task will use a client-side image for the VectorTileLayer in the printout. This has some limitations related to large size printing quality and a dependency on browser window height/width ratio.
Constructors
new PrintTask(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
| Name | Type | Summary | |
|---|---|---|---|
| String | The name of the class. more details | more details | |
| String | The mode for the print task execution. more details | more details | |
| Object | The options to be used for data requests. more details | more details | |
| Number | The time interval in milliseconds between each job status request sent to an asynchronous GP task. more details | more details | |
| String | The URL of the REST endpoint of the Export Web Map Task. more details | more details | |
Property Details
declaredClassStringreadonly
The name of the class. The declared class name is formatted as
esri.folder.className.modeString
The mode for the print task execution.
Known Values: async | sync
Default Value: syncrequestOptionsObject
The options to be used for data requests. These options can also be controlled through the
requestOptionsmethod parameter.updateDelayNumber
The time interval in milliseconds between each job status request sent to an asynchronous GP task.
Default Value: 1000urlString
The URL of the REST endpoint of the Export Web Map Task.
Example:var printTask = new PrintTask({ url: printUrl });
Method Overview
| Name | Return Type | Summary | |
|---|---|---|---|
| Promise | Sends a request to the print service to create a print page using the options specified in the PrintParameters. more details | more details | |
Method Details
execute(params, requestOptions){Promise}
Sends a request to the print service to create a print page using the options specified in the PrintParameters.
Parameters:params PrintParametersDefines the printing options.
optionalrequestOptions ObjectAdditional options to be used for the data request (will override requestOptions defined during construction).
Returns:Type Description Promise When resolved, prints a layout of the map. Example:var printTask = new PrintTask({ url: printUrl }); var template = new PrintTemplate({ format: "pdf", exportOptions: { dpi: 300 }, layout: "a4-portrait", layoutOptions: { titleText: "Warren Wilson College Trees", authorText: "Sam" } }); var params = new PrintParameters({ view: view, template: template }); printTask.execute(params).then(printResult, printError);