Help

Export Web Map

Summary

This tool 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 Export Web Map 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 the ExportWebMap specification topic found in the ArcGIS Help.

  • 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 Printing Tools 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, and so on, you do not use Export Web Map at all; rather, you can use the ConvertWebMapToMapDocument() function in the Python arcpy.mapping module included with ArcGIS. 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

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. The following strings are accepted.

For example:

  • PNG8 (default if the parameter is left blank)
  • PDF
  • PNG32
  • JPG
  • GIF
  • EPS
  • SVG
  • SVGZ

String
Layout_Templates_Folder
(Optional)

Full path to the folder where map documents (.mxd's) to be used as Layout Templates are located. The default location is <install_directory>\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 surroundings (for example, title, legends, scale bar, and so forth).

String

Environments

This tool does not use any geoprocessing environments

Licensing Information

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

Related Topics

Feedback on this topic?