将报表导出为 PDF (数据管理)

摘要

ArcGIS Pro 报表或报表文件 (.rptx) 导出至 .pdf 文件。

了解有关报表的详细信息

使用情况

  • 如果报表或报表文件定义中存在查询,则会在现有查询中追加其他表达式。

  • 除了整个报表之外,此工具还支持页面范围设置以导出某些页面。

  • 此工具支持自定义页面编号选项,以修改起始页码和总页数。

参数

标注说明数据类型
输入报表

输入报表或 .rptx 文件。

Report; File
PDF 文件

输出 .pdf 文件。

File
表达式
(可选)

用于选择记录子集的 SQL 表达式。 除了任何现有表达式之外,还应用此表达式。

SQL Expression
分辨率 (DPI)
(可选)

输出 .pdf 文件的分辨率,以每英寸点数 (dpi) 为单位。

Long
图像质量
(可选)

指定 PDF 的输出图像质量。 图像质量选项用于控制导出的栅格化数据的质量。

  • 最佳将使用可用的最高图像质量。 这是默认设置。
  • 更佳将使用高图像质量。
  • 正常将使用图像质量和速度之间的折衷。
  • 更快将使用较低的图像质量来更快地生成报表。
  • 最快将使用最低的图像质量来最快地创建报表。
String
嵌入字体
(可选)

指定是否将字体嵌入到输出 .pdf 文件中。 当在未安装所需字体的计算机上查看 .pdf 文件时,允许在字体嵌入中使用基于字体字形构建的文本和标记。

  • 选中 - 将在输出 .pdf 文件中嵌入字体。 这是默认设置。
  • 未选中 - 字体不会嵌入到输出 .pdf 文件中。
Boolean
压缩矢量图形
(可选)

指定是否压缩矢量图形。

  • 选中 - 将压缩矢量图形。 除非需要纯文本进行故障排除,否则请使用此选项。 这是默认设置。
  • 未选中 - 不会压缩矢量图形。

Boolean
图像压缩
(可选)

指定用于压缩输出 .pdf 文件中的图像或栅格数据的压缩方案。

  • 无图像压缩图像或栅格数据将不被压缩。
  • 游程编码 (RLE) 压缩图像或栅格数据将使用游程编码压缩进行压缩。
  • Deflate 压缩图像或栅格数据将使用 deflate(一种无损数据压缩)进行压缩。
  • Lempel-Ziv-Welch (LZW) 压缩图像或栅格数据将使用 Lempel-Ziv-Welch(一种无损数据压缩)进行压缩。
  • 联合图像专家组 (JPEG) 压缩图像或栅格数据将使用 JPEG(一种有损数据压缩)进行压缩。
  • Adaptive 压缩图像或栅格数据将使用自适应压缩进行压缩,该压缩将自动为页面上的每个图像选择最佳压缩类型。 JPEG 适用于包含许多唯一颜色的较大图像。 Deflate 适用于所有其他图像。 这是默认设置。
String
密码保护
(可选)

指定查看输出 .pdf 文件是否需要密码。

  • 选中 - 输出 .pdf 文件需要密码才能打开。
  • 未选中 - 输出 .pdf 文件无需提供密码即可打开。 这是默认设置。

Boolean
PDF 密码
(可选)

打开 .pdf 文件所需的密码。

Encrypted String
页面范围类型
(可选)

指定要导出的报表页面范围。

  • 所有页面将导出所有页面。 这是默认设置。
  • 最后一页仅导出最后一页。
  • 奇数页面仅导出奇数页。
  • 偶数页面仅导出偶数页。
  • 自定义页面范围将使用自定义页面范围参数值导出自定义页面范围。
String
自定义页面范围
(可选)

页面范围类型参数设置为自定义页面范围时要导出的页面。 可设置单独页面、范围或者以逗号分隔的两者组合,例如 1, 3-5, 10。

String
初始页码
(可选)

用于创建页面编号偏移量以向报表开头添加更多页面的初始页码。

Long
最终页码
(可选)

将显示在输出 .pdf 文件最后一页上的页码。

Long
显示选择符号系统
(可选)

指定在导出包含地图框和源地图中选定要素的报表时,是否包含选择符号系统。

  • 选中 - 选择符号系统将包含在输出 .pdf 文件中。 这是默认设置。
  • 未选中 - 选择符号系统将不包含在输出 .pdf 文件中。

Boolean

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})
名称说明数据类型
in_report

输入报表或 .rptx 文件。

Report; File
out_pdf_file

输出 .pdf 文件。

File
expression
(可选)

用于选择记录子集的 SQL 表达式。 除了任何现有表达式之外,还应用此表达式。

SQL Expression
resolution
(可选)

输出 .pdf 文件的分辨率,以每英寸点数 (dpi) 为单位。

Long
image_quality
(可选)

指定 PDF 的输出图像质量。 图像质量选项用于控制导出的栅格化数据的质量。

  • BEST将使用可用的最高图像质量。 这是默认设置。
  • BETTER将使用高图像质量。
  • NORMAL将使用图像质量和速度之间的折衷。
  • FASTER将使用较低的图像质量来更快地生成报表。
  • FASTEST将使用最低的图像质量来最快地创建报表。
String
embed_font
(可选)

指定是否将字体嵌入到输出 .pdf 文件中。 当在未安装所需字体的计算机上查看 .pdf 文件时,允许在字体嵌入中使用基于字体字形构建的文本和标记。

  • EMBED_FONTS将在输出 .pdf 文件中嵌入字体。 这是默认设置。
  • NO_EMBED_FONTS字体不会嵌入到输出 .pdf 文件中。
Boolean
compress_vector_graphics
(可选)

指定是否压缩矢量图形。

  • COMPRESS_GRAPHICS将压缩矢量图形。 除非需要纯文本进行故障排除,否则请使用此选项。 这是默认设置。
  • NO_COMPRESS_GRAPHICS不会压缩矢量图形。
Boolean
image_compression
(可选)

指定用于压缩输出 .pdf 文件中的图像或栅格数据的压缩方案。

  • NONE图像或栅格数据将不被压缩。
  • RLE图像或栅格数据将使用游程编码压缩进行压缩。
  • DEFLATE图像或栅格数据将使用 deflate(一种无损数据压缩)进行压缩。
  • LZW图像或栅格数据将使用 Lempel-Ziv-Welch(一种无损数据压缩)进行压缩。
  • JPEG图像或栅格数据将使用 JPEG(一种有损数据压缩)进行压缩。
  • ADAPTIVE图像或栅格数据将使用自适应压缩进行压缩,该压缩将自动为页面上的每个图像选择最佳压缩类型。 JPEG 适用于包含许多唯一颜色的较大图像。 Deflate 适用于所有其他图像。 这是默认设置。
String
password_protect
(可选)

指定查看输出 .pdf 文件是否需要密码。

  • PASSWORD_PROTECT输出 .pdf 文件需要密码才能打开。
  • NO_PASSWORD_PROTECT输出 .pdf 文件无需提供密码即可打开。 这是默认设置。
Boolean
pdf_password
(可选)

打开 .pdf 文件所需的密码。

Encrypted String
page_range_type
(可选)

指定要导出的报表页面范围。

  • ALL将导出所有页面。 这是默认设置。
  • LAST仅导出最后一页。
  • ODD仅导出奇数页。
  • EVEN仅导出偶数页。
  • CUSTOM将使用 custom_page_range 参数值导出自定义页面范围。
String
custom_page_range
(可选)

page_range_type 参数设置为 CUSTOM 时要导出的页面。 可设置单独页面、范围或者以逗号分隔的两者组合,例如 1, 3-5, 10。

String
initial_page_number
(可选)

用于创建页面编号偏移量以向报表开头添加更多页面的初始页码。

Long
final_page_number
(可选)

将显示在输出 .pdf 文件最后一页上的页码。

Long
selection_symbology
(可选)

指定在导出包含地图框和源地图中选定要素的报表时,是否包含选择符号系统。

  • SELECTION_SYMBOLOGY选择符号系统将包含在输出 .pdf 文件中。 这是默认设置。
  • NO_SELECTION_SYMBOLOGY选择符号系统将不包含在输出 .pdf 文件中。
Boolean

代码示例

ExportReportToPDF 示例 1(Python 窗口)

以下 Python 窗口脚本演示了如何使用 ExportReportToPDF 函数。

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')
ExportReportToPDF 示例 2(独立脚本)

使用 ExportReportToPDF 函数在对数据源执行选择后导出报表。

# 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)
ExportReportToPDF 示例 3(独立脚本)

除了 ExportReportToPDF 函数之外,还使用 arcpy.mp 模块。

# 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 ')

环境

此工具不使用任何地理处理环境。

许可信息

  • Basic: 是
  • Standard: 是
  • Advanced: 是

相关主题