Export Web Map (Server)

License Level:BasicStandardAdvanced

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

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
NoteNote:

The background of the output file is always opaque.

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

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Yes
ArcGIS for Desktop Standard: Yes
ArcGIS for Desktop Advanced: Yes
1/21/2015