Get Layout Templates Info

Titleā€ƒ Get Layout Templates Info

Summary

Geoprocessing tool that returns layout contents for the associated printing service.


Usage

This tool is intended to be published as a geoprocessing task within a printing service. It is also used by the preconfigured PrintingTools service.

The output of this tool is a string formatted as JSON. The string is a list of available map documents (used as layout templates) and the following information:

The size of the page layout The size of the active data frameAvailability of following layout elements:Legend elementTitle text elementCopyright text elementAuthor text elementCustom text elements and their names and existing values

The sizes are returned in the unit that is saved with the map document.

A sample output JSON

The tool should use the same folder location that is used by the associated Export Web Map tool.

For more information, see Printing in web applications in the ArcGIS Enterprise help.


Syntax

Code Samples

GetLayoutTemplatesInfo example (Python window)

The following script returns a list of metadata for each layout.


import arcpy
arcpy.GetLayoutTemplatesInfo_server(r'C:\Data\MyLayouts')

                    

Tags

Credits

Use limitations