Export Web Map

Title  Export Web Map

Summary

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


Usage

Syntax

Parameter Explanation
Web_Map_as_JSON

A JSON representation of the state of the map to be exported as it appears in the web app. See the ExportWebMap specification to understand how to format this text. ArcGIS API for JavaScript allows you to get this JSON string from the map.
Output_File

The output file name. The extension of the file depends on the Format parameter value.
Format (Optional)

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

  • 8-bit Portable Network Graphics (PNG8)—8-bit Portable Network Graphics (PNG8) will be used. This is the default.
  • Portable Document Format (PDF)—Portable Document Format (PDF) will be used.
  • 32-bit Portable Network Graphics (PNG32)—32-bit Portable Network Graphics (PNG32) will be used.
  • Joint Photographic Experts Group (JPG)— Joint Photographic Experts Group (JPG) will be used.
  • Graphics Interchange Format (GIF)— Graphics Interchange Format (GIF) will be used.
  • Encapsulated PostScript (EPS)— Encapsulated PostScript (EPS) will be used.
  • Scalable Vector Graphics (SVG)—Scalable Vector Graphics (SVG) will be used.
  • Compressed Scalable Vector Graphics (SVGZ)—Compressed Scalable Vector Graphics (SVGZ) will be used.
  • Adobe Illustrator Exchange (AIX)—Adobe Illustrator Exchange (AIX) will be used.
  • Tag Image File Format (TIFF)—Tag Image File Format (TIFF) will be used.

The background of the output file is always opaque.
Layout_Template (Optional)

The name of a template from the list or the keyword MAP_ONLY. When MAP_ONLY is used or an empty string is passed in, the output map will not contain any page layout elements such as title, legend, or scale bar.
Layout_Item_ID (Optional)

The portal ID (in JSON format) of the layout item that will be used for templates. Use the format: {"id": "<portal-id>"}. When a value is provided, this parameter takes precedence over the Layout Template parameter.
Report_Template (Optional)

The name of the report template.

When this parameter value is provided, the Format parameter must be set to Portable Document Format (PDF). When this parameter is unspecified, the output file will not contain any reports.
Report_Item_ID (Optional)

The portal ID (in JSON format) of the report item that will be used for templates. Use the format: {"id": "<portal-id>"}. When a value is provided, this parameter takes precedence over the Report Template parameter.

Code Samples

Tags

export web map, export webmap, map, print, print service, printing, printing service, server, web map, web print service, web printing, web printing service, webmap

Credits

Use limitations