ReportExportOptions

Краткая информация

Объект ReportExportOptions представляет собой набор необязательных свойств, которые можно использовать с методом export объекта Report для настройки способа экспорта отчета.

Обсуждение

Этот объект необходим только в том случае, если вы хотите экспортировать Report со свойствами, отличными от их значений по умолчанию.

Функцию CreateExportOptions можно использовать для создания объекта ReportExportOptions, если параметру class_type присвоено значение REPORT. Возвращаемый объект содержит все свойства, необходимые для настройки способа экспорта отчета. В настоящее время объект 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. CUSTOM—Export a custom set of pages that is defined using the customPages property. EVEN—Export the even numbered pages of the report. LAST—Export the last page of the report. ODD—Export the odd numbered pages of the report.	String

Пример кода

Пример ReportExportOptions

Следующий скрипт экспортирует объект Report, используя свойства PDFFormat по умолчанию, но настраивает 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)