Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

modeStringreadonly

The mode for the print task execution.

Known Values: async | sync

Default Value:sync

requestOptionsObject inherited

The options to be used for data requests. These options can also be controlled through the requestOptions method parameter.

updateDelayNumber

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

Default Value:1000

urlString

The URL of the REST endpoint of the Export Web Map Task.

Example:

var printTask = new PrintTask({
   url: printUrl
});

Method Overview

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 PrintParameters Defines the printing options.

requestOptions Object optional Additional 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);