Label | Explanation | Data Type |
Input Report
| The input report or .rptx file. | Report; File |
PDF File
| The output .pdf file. | File |
Expression (Optional) | A SQL expression that will be used to select a subset of records. This expression is applied in addition to any existing expressions. | SQL Expression |
Resolution (DPI)
(Optional) | The resolution of the output .pdf file in dots per inch (dpi). | Long |
Image Quality
(Optional) | Specifies the output image quality of the PDF. The image quality option controls the quality of exported rasterized data.
| String |
Embed Fonts
(Optional) | Specifies whether fonts will be embedded in the output .pdf file. Font embedding allows text and markers built from font glyphs to be displayed correctly when the .pdf file is viewed on a computer that does not have the necessary fonts installed.
| Boolean |
Compress Vector Graphics
(Optional) | Specifies whether vector graphics will be compressed.
| Boolean |
Image Compression
(Optional) | Specifies the compression scheme that will be used to compress image or raster data in the output .pdf file.
| String |
Password Protect
(Optional) | Specifies whether a password will be needed to view the output .pdf file.
| Boolean |
PDF Password
(Optional) | The password that will be required to open the .pdf file. | Encrypted String |
Page Range Type
(Optional) | Specifies the page range of the report that will exported.
| String |
Custom Page Range
(Optional) | The pages that will be exported when the Page Range Type parameter is set to Custom page range. You can set individual pages, ranges, or a combination of both separated by commas, such as 1, 3-5, 10. | String |
Initial Page Number
(Optional) | The initial page number that will be used to create a page numbering offset to add more pages to the beginning of the report. | Long |
Final Page Number
(Optional) | The page number that will be displayed on the last page of the output .pdf file. | Long |
Show Selection Symbology
(Optional) | Specifies whether selection symbology will be included when exporting a report with a map frame and selected features in the source map.
| Boolean |
Summary
Exports an ArcGIS Pro report or a report file (.rptx) to a .pdf file.
Usage
If a query exists in the report or report file definition, additional expressions are appended to the existing query.
This tool supports page range settings to export certain pages in addition to the entire report.
This tool supports custom page numbering options to modify start and total page numbers.
Parameters
arcpy.management.ExportReportToPDF(in_report, out_pdf_file, {expression}, {resolution}, {image_quality}, {embed_font}, {compress_vector_graphics}, {image_compression}, {password_protect}, {pdf_password}, {page_range_type}, {custom_page_range}, {initial_page_number}, {final_page_number}, {selection_symbology})
Name | Explanation | Data Type |
in_report | The input report or .rptx file. | Report; File |
out_pdf_file | The output .pdf file. | File |
expression (Optional) | A SQL expression that will be used to select a subset of records. This expression is applied in addition to any existing expressions. | SQL Expression |
resolution (Optional) | The resolution of the output .pdf file in dots per inch (dpi). | Long |
image_quality (Optional) | Specifies the output image quality of the PDF. The image quality option controls the quality of exported rasterized data.
| String |
embed_font (Optional) | Specifies whether fonts will be embedded in the output .pdf file. Font embedding allows text and markers built from font glyphs to be displayed correctly when the .pdf file is viewed on a computer that does not have the necessary fonts installed.
| Boolean |
compress_vector_graphics (Optional) | Specifies whether vector graphics will be compressed.
| Boolean |
image_compression (Optional) | Specifies the compression scheme that will be used to compress image or raster data in the output .pdf file.
| String |
password_protect (Optional) | Specifies whether a password will be needed to view the output .pdf file.
| Boolean |
pdf_password (Optional) | The password that will be required to open the .pdf file. | Encrypted String |
page_range_type (Optional) | Specifies the page range of the report that will exported.
| String |
custom_page_range (Optional) | The pages that will be exported when the page_range_type parameter is set to CUSTOM. You can set individual pages, ranges, or a combination of both separated by commas, such as 1, 3-5, 10. | String |
initial_page_number (Optional) | The initial page number that will be used to create a page numbering offset to add more pages to the beginning of the report. | Long |
final_page_number (Optional) | The page number that will be displayed on the last page of the output .pdf file. | Long |
selection_symbology (Optional) | Specifies whether selection symbology will be included when exporting a report with a map frame and selected features in the source map.
| Boolean |
Code sample
The following Python window script demonstrates how to use the ExportReportToPDF function.
import arcpy
arcpy.management.ExportReportToPDF('C:/data/sample.rptx', 'C:/data/samplePDF.pdf',
'STATEFIPS = 42', 96, 'BETTER', 'EMBED_FONTS',
'COMPRESS_GRAPHICS', 'ADAPTIVE',
'PASSWORD_PROTECT', 'password', 'CUSTOM',
'1-10')
Use the ExportReportToPDF function to export a report after performing a selection on the data source.
# Import system variables
import arcpy
# Set the workspace
arcpy.env.workspace = 'C:/data/cities.gdb'
# Set local variables
in_layer = 'cities'
in_report = 'US Cities Report'
out_PDF = 'C/data/cities.pdf'
# Modify the report data source by selecting only the records where
# POP1990 < 50000
arcpy.management.SelectLayerByAttribute(in_layer, 'NEW_SELECTION',
'POP1990 < 50000')
# Export the report with the layer selection set
arcpy.management.ExportReportToPDF(in_report, out_PDF)
Use the arcpy.mp module in addition to the ExportReportToPDF function.
# Import system variables
import arcpy
# Identify all parcel reports in a project
aprx = arcpy.mp.ArcGISProject('C:/data/parcels/Parcels.aprx')
report = aprx.listReports('Parcels Report')[0]
# Export the report with a definition query
arcpy.management.ExportReportToPDF(report.name, 'C:/data/parcels/ParcelsPDF.pdf',
' "LotSize" > 325 ')
Environments
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes