Skip To Content
ArcGIS Developer

Print widget

(Added at v1.0)

The Print widget connects the web app with a printing service to allow the current map to print.

Configure the Print widget

This widget can be set to open automatically when an app starts. Hover over the widget and click the Do not open this widget when the app starts button Do not open this widget when the app starts to change the setting to Open this widget automatically when the app starts. (For widgets that you need to add to the app first, you can turn on this option after configuring the widget.)

  1. Hover over the widget and click the Configure this widget button Configure this widget to open the configuration window.

    If you need to add the widget to the app first, click a widget placeholder on the Widget tab. In the Choose Widget window that opens, select the widget and click OK.

  2. Print configuration

    Service URL defaults to the ArcGIS Enterprise or ArcGIS Online print service, such as the following example:

    An alternate service can be used to provide custom layouts. See Share custom layouts for printing from ArcGIS Pro for instructions on publishing your own web printing service. For your print service to work with the Print widget, you must set its Execution Mode parameter to Synchronous.

    The Default title, Default author, and Default copyright properties are submitted directly to the print service for display in the printed layout. Uncheck the Editable check box if the copyright information is not allowed to be overridden.


    These properties are ignored if Default layout is set to MAP_ONLY.

    Default format controls the preselected format in the list of options on the Print widget. You have the following options:

    • PDF (georeferenced)
    • PNG32
    • PNG8
    • JPG
    • GIF
    • EPS
    • SVG
    • SVGZ

    Default layout controls the preselected layout in the list of options on the Print widget. Default options available on the ArcGIS Online service are as follows (your custom service may provide additional values):

    • A3 Landscape
    • A3 Portrait
    • A4 Landscape
    • A4 Portrait
    • Letter ANSI A Landscape
    • Letter ANSI A Portrait
    • Tabloid ANSI B Landscape
    • Tabloid ANSI B Portrait
    • MAP_ONLY

  3. Click OK to save the configuration and close the window.

Use the Print widget

  1. Click the Print button to open the Print widget.
    Print widget interface
  2. Type a title for the map in the Map title text box.
  3. Select the applicable Layout and Format for the exported map.


    The MAP_ONLY format prints only the map, omitting any marginal information from the output.


    The Print widget may not print the legend for the layers using some styles, such as Heat Map, from the February 2015 update of ArcGIS Online. This is a known issue.

  4. Click Advanced to open a menu with advanced print options.
    Advanced print options
    • Map scale/extent—Defines the method that the print service uses to calculate the printed extent of the map.

      Preserving map scale causes the printed map to maintain its scale while recalculating the extent around the existing center point. Preserving map extent causes the scale to adjust to fit the current map extent onto the printed map. You can also force a specific scale by clicking the Force scale option and providing a scale. Click current to populate the value with the present scale of the map.

    • Output spatial reference WKID—Defines the output spatial references of the print by specifying a valid well-known ID (WKID).
    • Layout metadata—Allows you to override the default values set in the configuration.

      Specify values for the Author and Copyright properties to provide current information to the print service. Check the Include legend check box to display the legend on the printed map.


      The Print widget supports custom text elements in the printing service published from ArcGIS Server 10.4. The layout options display based on the template's metadata.

    • MAP_ONLY size—If the Map_Only format is selected, you can provide dimensions for the Width and Height properties in pixels. Otherwise, these values are ignored.
    • Print quality—Allows you to update the resolution of the printed map.

      Provide an updated value for the DPI (dots per inch) in the text box.


      The widget supports custom text elements as layout metadata if the custom task is named Get Layout Templates Info.

    • Feature attributes—If Include attributes is checked, the feature's attributes are included in feature collection layers. This is only applicable to custom print services that use the feature attributes, for example, to display a table of features and their attributes.
  5. After all options have been set with the applicable values, click Print to submit all information to the print service.

    A progress bar displays next to the executing task.

    Print progress bar

    Upon completion of the print job, a link to the print output displays.

    Link to print output

  6. Click the task to open the file in a new window.
  7. Click Clear prints to clear the print history.

The date and time format of the printout is based on the location of the printer.