Display Name: PrintMap

Description: Takes the state of a web app (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.

Category:

Help URL: https://gis.blm.gov/nlsdb/rest/directories/arcgisoutput/CustomUtils/PrintMap_GPServer/CustomUtils_PrintMap/PrintMap.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 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: #
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: Format

Data Type: GPString
Display Name Format
Description: The format in which the map image for printing will be delivered. PDF — Portable Document Format. This is the default. PNG32 —32-bit Portable Network Graphics JPG — Joint Photographic Experts
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: PDF
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ PDF, PNG32, JPG ]

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 elements like titles, legends, or scale bars, for example.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Letter ANSI A Landscape, Letter ANSI A Portrait, Tabloid ANSI B Landscape, Tabloid ANSI B Portrait ]

Parameter: Legend_Options_JSON

Data Type: GPString
Display Name Legend_Options_JSON
Description: Optional options for the legend
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: Legend_Layer_List

Data Type: GPString
Display Name Legend_Layer_List
Description: List of layers to add to the legend
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: Legend_URL

Data Type: GPString
Display Name Legend_URL
Description: Dynamic URL provided to the service from EGMS
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: Print_Config

Data Type: GPString
Display Name Print_Config
Description: Network path and name of the print service configuration file
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: \\blm.doi.net\dfs\loc\EGIS\AppsNational\NLSDB\env\Prod\PrintService.config
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: Output_File

Data Type: GPDataFile
Display Name Output_File
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:

Supported Operations:   Execute Task

Child Resources:   Metadata