BMPFormat

Summary

The BMPFormat object represents a collection of Microsoft Windows bitmap (BMP) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output BMP file.

Discussion

BMP files are native Windows raster images. BMP files can store pixel data at several bit depths and can be compressed using the lossless RLE method. BMP images are typically much larger than formats such as JPEG or PNG.

The createExportFormat method can be used to create a BMPFormat object if the format parameter is set to BMP. The returned BMPFormat object contains all the properties associated with a generating a BMP 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. 1-BIT_MONOCHROME_THRESHOLD— 2 possible colors, black and white. The areas which are white and black are determined by the threshold value. 8-BIT_ADAPTIVE_PALETTE—Uses 256 of the most commonly-used pixel colors in the image’s palette, thereby minimizing the number of pixels whose color may change during output. 8-BIT_GRAYSCALE— 256 shades of gray. All colors are converted to grayscale. 24-BIT_TRUE_COLOR— 16,777,216 possible colors. This option is good for maximum color fidelity.	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
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
threshold (Read and Write)	Image intensities set above this value will appear white in the output file and all other values will appear black. This property is applied only when the colorMode property is set to 1-BIT_MONOCHROME_THRESHOLD. The default value is 128.	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. 1-BIT_MONOCHROME_THRESHOLD— 2 possible colors, black and white. The areas which are white and black are determined by the threshold value. 8-BIT_ADAPTIVE_PALETTE—Uses 256 of the most commonly-used pixel colors in the image’s palette, thereby minimizing the number of pixels whose color may change during output. 8-BIT_GRAYSCALE— 256 shades of gray. All colors are converted to grayscale. 24-BIT_TRUE_COLOR— 16,777,216 possible colors. This option is good for maximum color fidelity.	String

Code sample

BMPFormat example

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

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

bmp = arcpy.mp.CreateExportFormat('BMP', r'C:\Temp\output.bmp')

lyt.export(bmp)