Summary
The GIFFormat object represents a collection of Graphic Interchange Format (GIF) file properties that can be configured and used with the export method on the Layout, MapFrame, and MapView objects to create an output GIF file.
Discussion
GIF files are a legacy raster format for use on the web. GIFs cannot contain more than 256 colors (8 bits per pixel), which, along with optional lossless RLE or LZW compression, makes them smaller than other file formats. GIF files can also define a transparent color. GIFs can be generated with an accompanying world file for use as georeferenced raster data.
The createExportFormat method can be used to create a GIFFormat object if the format parameter is set to GIF. The returned GIFFormat object contains all the properties associated with a generating a GIF 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 8-BIT_ADAPTIVE_PALETTE.
| 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.
| String |
Code sample
The following script exports a layout to GIF format using default property values.
p = arcpy.mp.ArcGISProject('current')
lyt = p.listLayouts()[0]
gif = arcpy.mp.CreateExportFormat('GIF', r'C:\Temp\Output.gif')
lyt.export(gif)