Print

The Print widget connects your application with a printing service to allow the map to be printed. It takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS, which can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc. The Print widget works with the PrintTask which generates a printer-ready version of the map.

The Print widget has two required properties: view (reference to the MapView) and printServiceUrl (URL of the REST endpoint of the Export Web Map Task).

By default, the Print widget prints a localized date for all layouts except map-only. This can be customized using the customTextElements property of PrintTemplate.layoutOptions.

For more information about printing with the MAP_ONLY layout, please see exportOptions.

Known Limitations

No support

There is no current support for printing SceneViews. Instead, see SceneView.takeScreenshot().
There is no current support for printing layer blending. Instead, see MapView.takeScreenshot().
There is no current support for printing highlighted features. Instead, see MapView.takeScreenshot().
There is no current support for printing ImageryLayers when a pixelFilter is defined.
There is no current support for printing renderers generated from univariateColorSize.createContinuousRenderer() with an above-and-below theme.
There is no current support for printing legend items for layers that are sent as a client-side image in the printout.

Versioned support

CIMSymbol cannot be printed with any Printing Service published with ArcMap.
Labels currently cannot be printed as part of a FeatureLayer with ArcGIS Server 10.5.1 or any Printing Service published with ArcMap.
ImageryLayer cannot be printed with ArcGIS Server 10.5.1 or earlier, or any Printing Service published with ArcMap.
VectorTileLayer printing requires ArcGIS Server 10.5.1 or later.
Printing layers rendered with the DotDensityRenderer will create a client-side image of the layer in the printout with ArcGIS Server 10.8.0 or earlier.
For printing secure VectorTileLayers with ArcGIS Server 10.5.1 or 10.6.0, or for printing VectorTileLayers with ArcGIS Server 10.5.1 or any Printing Service published with ArcMap, the PrintTask will create a client-side image for the VectorTileLayer to use in the printout. This has some limitations related to large size printing quality and a dependency on browser window height/width ratio.

Behavior notes

Printing layers using clustering will create a client-side image of the layer in the printout.
The print server does not directly print SVG symbols. Rather, they are converted to PictureMarkerSymbols for display.
If the application and the print service are on the same origin, the name of the downloadable file can be customized with the fileName or title properties. If not, the name of the downloadable file will be generated by the ArcGIS Enterprise that hosts the print service.
Make certain that any resources to be printed are accessible by the print server. For example, if printing a map containing PictureMarkerSymbols, the URL to these symbols must be accessible to the print server for it to work properly.

For information about gaining full control of widget styles, see the Styling topic.

See also:

Example:

const print = new Print({
  view: view,
  // specify your own print service
  printServiceUrl:
     "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
});

// Adds widget below other elements in the top left corner of the view
view.ui.add(print, {
  position: "top-left"
});

Constructors

new Print(properties)

Parameter:

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:

// typical usage
var print = new Print({
  view: view,
  printServiceUrl: "https://www.example.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String\|String []	Specify the print output file format(s) that the user can select based on the options available from the print service. more details	more details	Print
String\|String []	Specify the print output layout(s) that the user can select based on the options available from the print service. more details	more details	Print
String\|HTMLElement	The ID or node representing the DOM element containing the widget. more details	more details	Widget
String	The name of the class. more details	more details	Accessor
Collection<FileLink>	The collection of links exported from the Print widget. more details	more details	Print
String	The widget's default CSS icon class. more details	more details	Print
String	The unique ID assigned to the widget when the widget is created. more details	more details	Widget
Boolean	Indicates whether or not to include defaultTemplates. more details	more details	Print
String	The widget's default label. more details	more details	Print
Portal	It is possible to search a specified portal instance's locator services. more details	more details	Print
String	The URL of the REST endpoint of the Export Web Map Task. more details	more details	Print
TemplateOptions	Defines the layout template options used by the Print widget to generate the print page. more details	more details	Print
MapView	A reference to the MapView. more details	more details	Print
PrintViewModel	The view model for this widget. more details	more details	Print

Property Details

allowedFormats String|String [] Since: ArcGIS API for JavaScript 4.15

Specify the print output file format(s) that the user can select based on the options available from the print service. This property can take a string value or an array of string values.

When this value is "all" (default value), all the print service formats are available to be used. When an array of string values is used, only those values that match the options available from the print service will be used. If none of the input string values match those available from the print service, allowedFormats will fallback to default behavior.

Default Value:"all"

See also:

TemplateOptions.format

Example:

const print = new Print({
  view: view,
  printServiceUrl:
         "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task",
  allowedFormats: ["jpg", "png8", "png32"]
});

allowedLayouts String|String [] Since: ArcGIS API for JavaScript 4.15

Specify the print output layout(s) that the user can select based on the options available from the print service. This property can take a string value or an array of string values.

When this value is "all" (default value), all the print service layouts are available to be used. When an array of string values is used, only those values that match the options available from the print service will be used. If none of the input string values match those available from the print service, allowedLayouts will fallback to default behavior.

Default Value:"all"

See also:

TemplateOptions.layout

Example:

const print = new Print({
  view: view,
  printServiceUrl:
         "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task",
  allowedLayouts: ["a3-landscape", "a3-portrait"]
});

container String|HTMLElement inherited

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Stringreadonly inherited Since: ArcGIS API for JavaScript 4.7

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

exportedLinks Collection<FileLink>readonly Since: ArcGIS API for JavaScript 4.17

The collection of links exported from the Print widget.

Example:

require([
  "esri/widgets/Print",
  "esri/config"
], function(Print, esriConfig) {

  // ...

  view.when(function () {
    print = new Print({
      view: view,
      // specify your own print service
      printServiceUrl:
        "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
    });

    // Add widget to the top right corner of the view
    view.ui.add(print, "top-right");

    // use a requestInterceptor to monitor the print widget
    // for print completion
    esriConfig.request.interceptors.push({
      // set the `urls` property to the URL of the print service so that this
      // interceptor only applies to requests made to the print service URL
      urls: print.printServiceUrl,
      // use the AfterInterceptorCallback to interogate the exportedLinks property
      after: function(response) {
        console.log("exportedLinks: ", print.exportedLinks.items[0]);
      }
    });
  });

iconClass String Since: ArcGIS API for JavaScript 4.7

The widget's default CSS icon class.

id String inherited

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

includeDefaultTemplates Boolean Since: ArcGIS API for JavaScript 4.18

Indicates whether or not to include defaultTemplates.

Default Value:true

Example:

const printWidget = new Print({
   view: view,
   includeDefaultTemplates: false,
   portal: {url: "https://.example.arcgis.com/sharing/"},
   container: "printDiv"
});

label String Since: ArcGIS API for JavaScript 4.7

The widget's default label.

portal Portal Since: ArcGIS API for JavaScript 4.18

It is possible to search a specified portal instance's locator services. Use this property to set this ArcGIS Portal instance to search. This is especially helpful when working with a custom print template.

If this property is set, it is not necessary to set the printServiceUrl property.

See also:

CustomTemplate

Example:

const printWidget = new Print({
   view: view,
   portal: {url: "https://example.arcgis.com/sharing/"},
   container: "printDiv"
});

printServiceUrl String

The URL of the REST endpoint of the Export Web Map Task. If the portal property is set, it is not necessary to set this property.

templateOptions TemplateOptionsautocast Since: ArcGIS API for JavaScript 4.6

Defines the layout template options used by the Print widget to generate the print page.

Example:

templateOptions: {
  title: "My Print",
  author: "Sam",
  copyright: "My Company",
  legendEnabled: false
}

view MapView

A reference to the MapView. Set this to link the widget to a specific view.

viewModel PrintViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the PrintViewModel class to access all properties and methods on the widget.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
String	A utility method used for building the value for a widget's `class` property. more details	more details	Widget
	Destroys the widget instance. more details	more details	Widget
Boolean	Emits an event on the instance. more details	more details	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name. more details	more details	Widget
Object	Registers an event handler on the instance. more details	more details	Widget
	Widget teardown helper. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
Object	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
	Renders widget to the DOM immediately. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget

Method Details

classes(classNames){String}inherited Since: ArcGIS API for JavaScript 4.7

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:

classNames String|String []|Object

repeatable

The class names.

Returns:

Type	Description
String	The computed class name.

See also:

Guide - Widget development (rendering)

Example:

// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:

type String

The name of the event.

event Object

optional

The event payload.

Returns:

Type	Description
Boolean	`true` if a listener was notified

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String

The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

type String|String []

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:

Type Description

Object

Returns an event handler with a remove() method that can be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

handles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

Type Definitions

FileLink

Represents an exported map request from the result of the Print widget. Successful exports will have a URL that links to the printout. Failed ones will have information on what went wrong.

Properties:

count Number

The location of the FileLink element in the array.

error String

The error from the Print widget, if any.

extension String

The file type of the print-out.

name String

The fileName or title of the print-out.

state String

The state of the print-out. Either "ready" or "pending" or "error".

url String

The printServiceUrl of the print-out.

Example:

require([
  "esri/widgets/Print",
  "esri/config"
], function(Print, esriConfig) {

  // ...

  view.when(function () {
    print = new Print({
      view: view,
      // specify your own print service
      printServiceUrl:
        "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
    });

    // Add widget to the top right corner of the view
    view.ui.add(print, "top-right");

    // use a requestInterceptor to monitor the print widget
    // for print completion
    esriConfig.request.interceptors.push({
      // set the `urls` property to the URL of the print service so that this
      // interceptor only applies to requests made to the print service URL
      urls: print.printServiceUrl,
      // use the AfterInterceptorCallback to interogate the exportedLinks property
      after: function(response) {
        console.log("exportedLinks: ", print.exportedLinks.items[0]);
      }
    });
  });

Event Overview

Name	Type	Summary	Class
	{results: Object,}	Fires when a print request has been completed and returns its results. more details	more details	Print
	{results: Object,}	Fires when an export request begins, and returns a reference to the exported link. more details	more details	Print

Event Details

complete Since: ArcGIS API for JavaScript 4.17

Fires when a print request has been completed and returns its results. This event will fire whether an export succeeds or fails.

Properties:

results Object

An object representing the results of the print.

Specification:

link Collection<FileLink>

Represents an exported map request from the result of the Print widget.

Example:

const printWidget = new Print();

printWidget.on("complete", function(results){
  // The results are stored in the results object
  console.log("Results of the print: ", results.link);
});

submit Since: ArcGIS API for JavaScript 4.17

Fires when an export request begins, and returns a reference to the exported link.

Properties:

results Object

An object representing the results of submitting the print.

Specification:

link Collection<FileLink>

Represents an exported map request from the result of the Print widget.

Example:

const printWidget = new Print();

printWidget.on("submit", function(results){
  // The results are stored in the event object
  console.log("Results of submitting the print: ", results.link);
});

ArcGIS API for JavaScript

Was this page helpful?

Was this page helpful?

Was this page helpful?