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 print 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). The widget can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use TemplateOptions to preserve scale instead.

The Print widget prints a localized date for all layouts except map-only. If using a custom print service, then customTextElements are supported for each print template. Values found there will be populated in the Print widget under Advanced options. These values can be overwritten in the Print widget UI, or programmatically using the templateCustomTextElements property.

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

Known Limitations

See print for a detailed list of known limitations.

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
let 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	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	Print
String\|HTMLElement	The ID or node representing the DOM element containing the widget. more details	Widget
String	The name of the class. more details	Accessor
Collection<FileLink>	The collection of links exported from the Print widget. more details	Print
Object	This option allows passing extra parameters (in addition to templateOptions) to the print (export webmap) requests. more details	extraParameters
Number	Indicates the heading level to use for the "Exported files" text where users can access the exported map printout. more details	Print
String	The widget's default CSS icon class. more details	Print
String	The unique ID assigned to the widget when the widget is created. more details	Widget
Boolean	Indicates whether or not to include defaultTemplates. more details	Print
String	The widget's default label. more details	Print
Portal	It is possible to search a specified portal instance's locator services. more details	Print
String	The URL of the REST endpoint of the Export Web Map Task. more details	Print
Object []	An object containing an array of `customTextElements` name-value pair objects for each print template in a custom print service. more details	Print
TemplateOptions	Defines the layout template options used by the Print widget to generate the print page. more details	Print
MapView	A reference to the MapView. more details	Print
PrintViewModel	The view model for this widget. more details	Print
Boolean	Indicates whether the widget is visible. more details	Widget

Property Details

allowedFormats String|String [] Since: ArcGIS Maps SDK 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 Maps SDK 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 Maps SDK 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 Maps SDK 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]);
      }
    });
  });

extraParameters Objectinner Since: ArcGIS Maps SDK for JavaScript 4.20

This option allows passing extra parameters (in addition to templateOptions) to the print (export webmap) requests.

headingLevel Number Since: ArcGIS Maps SDK for JavaScript 4.20

Indicates the heading level to use for the "Exported files" text where users can access the exported map printout. By default, this text is rendered as a level 3 heading (e.g. <h3>Exported files</h3>). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.

Default Value:3

See also

Heading Elements

Example

// "Exported files" will render as an <h4>
print.headingLevel = 4;

iconClass String Since: ArcGIS Maps SDK 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 Maps SDK 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 Maps SDK for JavaScript 4.7

The widget's default label.

portal Portal Since: ArcGIS Maps SDK 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.

templateCustomTextElements Object [] Since: ArcGIS Maps SDK for JavaScript 4.22

An object containing an array of customTextElements name-value pair objects for each print template in a custom print service. Use this property to update the text for custom text elements on the page layout.

The Print widget calls the Get Layout Templates Info task on the GPServer to discover possible customTextElements values for each template. The name of the task must match Get Layout Templates Info, templates must be published with customTextElements, and values must be strings. Values found there will be populated in the Print widget under Advanced options. These values can be overwritten in the Print widget UI, or programmatically using this property. To list all print templates available on the print service to see see which templates were published with customTextElements, use the effectiveTemplateCustomTextElements property.

Example

const printWidget = new Print({
   view: view,
   // specify your custom print service
   printServiceUrl: "",
   // `customTextElements` are defined per print template
   // this example has one template with `customTextElements`
   templateCustomTextElements: {
      // if there were more applicable templates, then we would
      // create another object with the template name containing
      // an array of more name-value pairs
      "Landscape_TextElements": [
         // the possible values are defined in the print service
         { "headquarters": "Foxborough, Massachusetts" },
         { "division": "AFC East" },
         { "founded": "1959" }
      ]
   }
});

templateOptions TemplateOptionsautocast Since: ArcGIS Maps SDK 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.

visible Boolean inherited

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of "none".

Default Value:true

Example

// Hides the widget in the view
widget.visible = false;

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object. more details	Accessor
String	A utility method used for building the value for a widget's `class` property. more details	Widget
	Destroys the widget instance. more details	Widget
Boolean	Emits an event on the instance. more details	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name. more details	Widget
Boolean	Returns true if a named group of handles exist. more details	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). more details	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected. more details	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved. more details	Widget
Object	Registers an event handler on the instance. more details	Widget
	Adds one or more handles which are to be tied to the lifecycle of the widget. more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	Widget
	Removes a group of handles owned by the object. more details	Accessor
Object	This method is primarily used by developers when implementing custom widgets. more details	Widget
	Renders widget to the DOM immediately. more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	Widget
Promise	`when()` may be leveraged once an instance of the class is created. more details	Widget

Method Details

addHandles(handleOrHandles, groupKey)inherited Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

classes(classNames){String}inherited Since: ArcGIS Maps SDK 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 Maps SDK 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.

hasHandles(groupKey){Boolean}inherited Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled(){Boolean}inherited Since: ArcGIS Maps SDK for JavaScript 4.19

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited Since: ArcGIS Maps SDK for JavaScript 4.19

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}inherited Since: ArcGIS Maps SDK for JavaScript 4.19

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

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 []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type Description

Object

Returns an event handler with a remove() method that should 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(handleOrHandles)inherited Since: ArcGIS Maps SDK for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.

Parameter

handleOrHandles 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.

removeHandles(groupKey)inherited Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

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.

when(callback, errback){Promise}inherited Since: ArcGIS Maps SDK for JavaScript 4.19

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	Description
Promise	Returns a new promise for the result of `callback`.

Example

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

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,results.link: Collection<FileLink>}	Fires when a print request has been completed and returns its results. more details	Print
	{results: Object,results.link: Collection<FileLink>}	Fires when an export request begins, and returns a reference to the exported link. more details	Print

Event Details

complete Since: ArcGIS Maps SDK 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 Maps SDK 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 Maps SDK for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?