ReportExportOptions

摘要

ReportExportOptions 对象表示可选属性的集合,这些属性可与 Report 对象的 export 方法配合使用来配置报表的导出方式。

说明

仅当您要使用不同于默认值的属性导出 Report 时,才需要此对象。

如果 class_type 参数设置为 REPORT,则可以使用 CreateExportOptions 函数创建 ReportExportOptions 对象。 返回的对象包含配置如何导出报表所需的所有属性。 当前 Report 对象仅可以导出为 PDF。

属性

属性说明数据类型
customPages
(可读写)

一个字符串,用于在 exportPages 属性设置为 CUSTOM 时标识要导出的报表页面。 例如,以下字符串可导出 5 个页面:'1, 3, 5-7'。 默认值是空字符串。

String
exportPages
(只读)

一个字符串常量,用于表示要导出的报表页面集合。 要更改此值,请使用 setExportPages 方法。 默认值为 ALL

  • ALL导出报表中的所有页面。
  • CUSTOM导出使用 customPages 属性定义的一组自定义页面。
  • EVEN导出报表的偶数页面。
  • LAST导出报表的最后一页。
  • ODD导出报表的奇数页面。
String
startingPageNumberLabelOffset
(可读写)

将偏移应用于页面编号以在报表开始处添加附加页面。 默认偏移为 1

Integer
totalPageNumberOverride
(可读写)

要标注的总页面数,例如,如果报表显示第 X 页,共 Y 页。 这在将多个报表合并为一个报表时将非常有用。 默认值为 -1,表示没有覆盖。

Integer

方法概述

方法说明
setExportPages (export_pages)

一个字符串常量,用于表示要导出的 Report 页面集合。

方法

setExportPages (export_pages)
参数说明数据类型
export_pages
  • ALL Export all pages in the report.
  • CUSTOMExport a custom set of pages that is defined using the customPages property.
  • EVENExport the even numbered pages of the report.
  • LASTExport the last page of the report.
  • ODDExport the odd numbered pages of the report.
String

代码示例

ReportExportOptions 示例

以下脚本使用默认 PDFFormat 属性导出 Report 对象,但会将 ReportExportOptions 配置为导出一组自定义报表页面。

p = arcpy.mp.ArcGISProject('current')
rp = p.listReports('Report')[0]

pdf = arcpy.mp.CreateExportFormat('PDF', r'c:\temp\MS_PDF.pdf')

rpExOpt = arcpy.mp.CreateExportOptions('REPORT')
rpExOpt.setExportPages('CUSTOM')
rpExOpt.customPages = '1-3'

rp.export(pdf, msExOpt)