Display Name: Export Web Map

Description: 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., 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 ExportWebMap specification 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 PrintingTools service to generate images for simple map printing.

Category:

Help URL: https://w12-agis105.compass.ie/arcgis2/rest/directories/arcgisoutput/TeagascNMP/NMPPrintingTools_GPServer/TeagascNMP_NMPPrintingTools/ExportWebMap.htm

Execution Type: esriExecutionTypeSynchronous

Parameters:

Parameter: Web_Map_as_JSON

Data Type: GPString
Display Name Web Map as JSON
Description: A JSON representation of the state of the map to be exported as it appears in the web application. See the ExportWebMap specification in the ArcGIS Help to understand how this text should be formatted. The ArcGIS web APIs (for JavaScript, Flex, Silverlight, etc.) allow developers to easily get this JSON string from the map.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: Output_File

Data Type: GPDataFile
Display Name Output File
Description: Output file name. The extension of the file depends on the output file format.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: Format

Data Type: GPString
Display Name Format
Description: 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 EPSSVGSVGZ
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: PDF
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ PDF, PNG32, PNG8, JPG, GIF, EPS, SVG, SVGZ ]

Parameter: Layout_Template

Data Type: GPString
Display Name Layout Template
Description: 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)
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ A3 Landscape, A3 Portrait, A4 Landscape, A4 Portrait, MAP_ONLY ]

Supported Operations:   Execute Task

Child Resources:   Metadata