EPSFormat

Summary

The EPSFormat object represents a collection of Encapsulated PostScript (EPS) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output EPS file.

Discussion

EPS format files use the PostScript page description language to describe vector and raster objects. PostScript is the publishing industry standard for high-end graphics files, cartography, and printing. EPS files can be edited in many drawing applications or placed as a graphic in most page layout applications. EPS format supports font embedding and can define colors in CMYK or RGB values.

The createExportFormat method can be used to create a EPSFormat object if the format parameter is set to EPS. The returned EMFFormat object contains all the properties associated with a generating a EPS file. These properties can be modified accordingly to produce different output results.

Properties

Property	Explanation	Data Type
clipToElements (Read and Write)	If set to True, include the areas of the page that have map or layout element content only, rather than exporting the entire page. This property only applies when exporting a Layout object. The default value is False.	Boolean
convertMarkers (Read and Write)	Controls whether marker symbols based on font characters are exported as font characters or as polygons. Set this option to True to view the output on a machine that does not have the appropriate fonts installed when you cannot embed the fonts due to licensing or file format restrictions. This does not apply to text, only marker symbols based on fonts. The default value is False.	Boolean
embedFonts (Read and Write)	Include embeddable fonts in the exported file to maintain font consistency across different platforms. Fonts that do not support embedding are not included, regardless of this setting. The default value is True. Note: To correctly edit text as graphics, Illustrator requires fonts to be installed and accessible. Check the sharing permissions before embedding and sharing fonts.	Boolean
filePath (Read and Write)	A string that represents the system path and file name, including the extension, for the exported file.	String
height (Read and Write)	The height, in pixels, of the map area to be exported. This property only applies when exporting a MapView object. The default value is 960.	Double
imageCompression (Read and Write)	The compression scheme used to compress image or raster data in the output file. The default value is DEFLATE. DEFLATE— Lossless compression method that works well for most cases. LZW— Lossless compression method using a code table. NONE—Compression is not applied. RLE— Run-length encoded compression, a lossless compression method that works well if there are large areas of the same color.	String
imageQuality (Read and Write)	The amount of image resampling. The property determines the effective resolution of raster content on output. For instance, if imageQuality is set to BETTER, a resample ratio of 1:2, and the output resolution is set to 300 dpi, the raster content is output at approximately 150 dpi. In many cases, the raster data can be included at a lower dpi than the vector data without visibly affecting quality, reducing the output file size. The default value is BEST. BEST—An output image quality resample ratio of 1 BETTER—An output image quality resample ratio of 2 NORMAL—An output image quality resample ratio of 3 FASTER—An output image quality resample ratio of 4 FASTEST—An output image quality resample ratio of 5	String
outputAsImage (Read and Write)	Export vector content as an image. For maps or layouts containing vector layers with a high density of vertices, this can drastically reduce the output file size. The default value is False. Note: Options specific to vector data, such as embedFonts are unavailable when outputAsImage is set to True.	Boolean
resolution (Read and Write)	The effective dpi of the output vector data. The default value is 96. Note: When exporting a MapView, the dpi is calculated automatically using system dpi scaling and therefore this value will be ignored.	Integer
showSelectionSymbology (Read and Write)	Show selected features in the map or map frame as selected in the output file. Setting this value to False does not affect selection within the view, only in the output file. The default value is False.	Boolean
width (Read and Write)	The width, in pixels, of the map area to be exported. This property only applies when exporting a MapView object. The default value is 960.	Double

Method Overview

Method	Explanation
setImageCompression (image_compression)	A string constant that represents the compression scheme used to compress image or raster data in the output file.
setImageQuality (image_quality)	A string constant that sets the amount of image resampling.

Methods

setImageCompression (image_compression)

Parameter	Explanation	Data Type
image_compression	Below is a list of valid strings. DEFLATE— Lossless compression method that works well for most cases. LZW— Lossless compression method using a code table. NONE—Compression is not applied. RLE— Run-length encoded compression, a lossless compression method that works well if there are large areas of the same color.	String

setImageQuality (image_quality)

Parameter	Explanation	Data Type
image_quality	Below is a list of valid strings. BEST—An output image quality resample ratio of 1 BETTER—An output image quality resample ratio of 2 NORMAL—An output image quality resample ratio of 3 FASTER—An output image quality resample ratio of 4 FASTEST—An output image quality resample ratio of 5	String

The value determines the effective resolution of raster content on output. For instance, if the output image quality ratio is set to 1:2, an image_quality value of BETTER, and the output resolution is set to 300 dpi, the raster content is output at approximately 150 dpi. In many cases, the raster data can be included at a lower dpi than the vector data without visibly affecting quality, reducing the output file size.

Code sample

EPSFormat example

The following script exports a layout to EPS format using default property values.

p = arcpy.mp.ArcGISProject('current')
lyt = p.listLayouts()[0]

eps = arcpy.mp.CreateExportFormat('EPS', r'C:\Temp\output.eps')

lyt.export(eps)