Skip To Content

Export Web Map

Summary

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.

Usage

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

Syntax

ExportWebMap_server (Web_Map_as_JSON, Output_File, {Format}, {Layout_Templates_Folder}, {Layout_Template})
ParameterExplanationData Type
Web_Map_as_JSON

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.

String
Output_File

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

File
Format
(Optional)

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

  • PNG88-bit Portable Network Graphics (PNG8). This is the default.
  • PDFPortable Document Format (PDF)
  • PNG3232-bit Portable Network Graphics (PNG32)
  • JPG Joint Photographic Experts Group (JPG)
  • GIF Graphics Interchange Format (GIF)
  • EPS Encapsulated PostScript (EPS)
  • SVGScalable Vector Graphics (SVG)
  • SVGZCompressed Scalable Vector Graphics (SVGZ)
Note:

The background of the output file is always opaque.

String
Layout_Templates_Folder
(Optional)

Full path to the folder containing layout pages (.pagx files ) to be used as layout templates are located. The default location is <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.

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

String

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • ArcGIS Desktop Basic: Yes
  • ArcGIS Desktop Standard: Yes
  • ArcGIS Desktop Advanced: Yes

Related topics