Display Name: Export Web Map

Description: 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).

Category:

Help URL: https://egisp.dfo-mpo.gc.ca/arcgis/rest/directories/arcgisoutput/CustomPrinter/DataViewer_Print_GPServer/CustomPrinter_DataViewer_Print/ExportWebMap.htm

Execution Type: esriExecutionTypeAsynchronous

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 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: #
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: Output_File

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


Parameter: Format

Data Type: GPString
Display Name Format
Description: 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: PDF
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Portable Document Format (PDF), 32-bit Portable Network Graphics (PNG32), 8-bit Portable Network Graphics (PNG8), Joint Photographic Experts Group (JPG), Graphics Interchange Format (GIF), Encapsulated PostScript (EPS), Scalable Vector Graphics (SVG), Compressed Scalable Vector Graphics (SVGZ), Adobe Illustrator Exchange (AIX), Tag Image File Format (TIFF) ]


Parameter: Layout_Template

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


Parameter: Layout_Item_ID

Data Type: GPString
Display Name Layout Item ID
Description: The portal ID (in JSON format) of the layout item that will be used for templates. Use the format: {"id": ""}. When a value is provided, this parameter takes precedence over the Layout Template parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: Report_Template

Data Type: GPString
Display Name Report Template
Description: 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: Report_Item_ID

Data Type: GPString
Display Name Report Item ID
Description: The portal ID (in JSON format) of the report item that will be used for templates. Use the format: {"id": ""}. When a value is provided, this parameter takes precedence over the Report Template parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:

Supported Operations:   Submit Job

Child Resources:   Metadata