Summary
The JPEGFormat object represents a collection of Joint Photographic Experts Group (JPEG) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output JPG file.
Discussion
JPEG files are compressed image files. They support 24-bit color and have been a popular choice for use on the web because JPEG file size is often substantially smaller than many other image formats. However, the JPEG compression algorithm is lossy and is not recommended for many map images, as line drawings and text or iconic graphics become blurred by compression artifacts. Thus, PNG is usually a superior format for map images. JPEGs can be generated with an accompanying world file for use as georeferenced raster data.
The createExportFormat method can be used to create a JPEGFormat object if the format parameter is set to JPEG. The returned JPEGFormat object contains all the properties associated with a generating a JPEG 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 |
| colorMode (Read and Write) | A string constant that represents the number of bits to describe color in a pixel. The default value is 24-BIT_TRUE_COLOR.
| String |
| filePath (Read and Write) | A string that represents the system path and file name, including the extension, for the exported file. | String |
| geoReferenceMapFrame (Read and Write) | The MapFrame used to control the coordinate system when the worldFile property is set to True. The default value is None. | MapFrame |
| 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 |
| imageCompressionQuality (Read and Write) | The amount of image compression applied to the export. Low quality has a smaller file size but less clear data; max quality has a larger file size but crisper data. This only applies when certain compression types are used. The default value is 80. | Integer |
| 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 |
| worldFile (Read and Write) | If set to True and a valid georef_mapframe is set, a world file will be generated based on the map frame's coordinate system. The default value is False. | Boolean |
Method Overview
| Method | Explanation |
| setColorMode (color_mode) | A string constant that represents the number of bits to describe color in a pixel. |
Methods
setColorMode (color_mode)
| Parameter | Explanation | Data Type |
color_mode | Below is a list of valid strings.
| String |
Code sample
The following script exports a layout to JPEG format using default property values.
p = arcpy.mp.ArcGISProject('current')
lyt = p.listLayouts()[0]
jpg = arcpy.mp.CreateExportFormat('JPEG', r'C:\Temp\Output.jpg')
lyt.export(jpg)