Export Web Map Task

Title  Export Web Map Task


Takes the state of a web application (for example, included services, layer visibility settings, and client-side graphics) and returns a printable page layout or basic map of the specified area of interest.


The input for this tool is a piece of text in JavaScript object notation (JSON) format describing the layers, graphics, and other settings in the web map. The JSON must be structured according to the ExportWebMap specification.This tool is shipped with ArcGIS Server to support web services for printing, including the preconfigured service named PrintingTools. The ArcGIS web APIs for JavaScript, Flex, and Silverlight use the PrintingTools service to generate images for effortless map printing. For advanced printing scenarios, for example, swapping out service layers with local vector data, creating map books, use the ConvertWebMapToArcGISProject() function in the Python arcpy.mp module instead of this tool. To make your Python script available to a web application, you can expose the script through an ArcGIS Server geoprocessing service. For more information, see Printing in web applications in the ArcGIS Server help.


Parameter Explanation

A JSON representation of the state of the map to be exported as it appears in the web application. See the ExportWebMap specification to understand how this text should be formatted. The ArcGIS web APIs (for JavaScript, Flex, Silverlight, and so on) allow developers to easily get this JSON string from the map.

Format (Optional)

The format in which the map image for printing will be delivered.

  • PDF — Portable Document Format. This is the default.

  • PNG8 — 8-bit Portable Network Graphics

  • PNG32 —32-bit Portable Network Graphics

  • JPG — Joint Photographic Experts Group

  • GIF — Graphics Interchange Format

  • EPS — Encapsulated PostScript

  • SVG — Encapsulated PostScript

  • SVGZ — Compressed Scalable Vector Graphics

Layout_Template (Optional)

Either a name of a template from the list or the keyword MAP_ONLY. When MAP_ONLY is chosen or an empty string is passed in, the output map does not contain any page layout elements like titles, legends, or scale bars, for example.


The output file name. The extension of the file depends on the Format parameter.

Code Samples


Printing Service, Print, Service, Layout, Template


Use limitations