Report

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

Объект Report ссылается на отчет в файле проекта ArcGIS Pro (.aprx). Он обеспечивает доступ к общим свойствам и методам.

Обсуждение

Проект ArcGIS Pro может содержать несколько отчетов. Отчеты можно создавать с помощью метода createReport, а доступ к ним осуществляется с помощью метода listReports объекта ArcGISProject. Метод listReports возвращает список Python объектов Report. Важно, чтобы каждый отчет имел уникальное имя, благодаря этому на конкретный отчет можно будет ссылаться по его name. Каждый отчет имеет свойства metadata, которые можно просмотреть или изменить. С помощью свойства pageInfo можно получить доступ к информации о странице, включая единицы страницы, ширину, высоту и поля.

Объект Report, возвращаемый с помощью метода listReports, также представляет первый ReportSection. Свойство referenceDataSource можно изменить с помощью метода setReferenceDataSource. definitionQuery можно применить к первому разделу отчета для фильтрации строк, экспортируемых в PDF. Метод listSections дает доступ ко всем разделам отчета и объектам ReportLayoutSection в отчете.

Используйте метод exportToPDF для экспорта отчета в документ .pdf.

Свойства

Свойство	Описание	Тип данных
definitionQuery (чтение и запись)	Определяющий запрос первого ReportSection. Используйте его для применения фильтра к записям, экспортируемым в PDF.	String
metadata (чтение и запись)	Получите или задайте информацию класса Метаданные для отчета. Обратите внимание, что установка метаданных зависит от значения свойства isReadOnly.	Metadata
name (чтение и запись)	Имя отчета. Важно, чтобы у всех отчетов были уникальные имена, благодаря чему на них было бы легко ссылаться по имени.	String
pageInfo (только чтение)	Ширина, высота, единицы измерения и поля страницы отчета. Ключи словаря определяются следующим образом: height—Высота отчета в единицах страницы. width—Ширина отчета в единицах страницы. units—Ключевое слово единицы страницы отчета. Поддерживаемые значения inch, point, centimeter и millimeter. margins—Ключевое слово полей отчета. Поддерживаемые значения буферного расстояния NORMAL, MODERATE, WIDE и NARROW.	Dictionary
referenceDataSource (только чтение)	Информация о подключении к источнику базовых данных первого ReportSection. Ключи словаря определяются следующим образом: dataset—Имя набора данных. workspace_factory—Тип рабочей области. connection_info—Строка, представляющая путь к рабочей области	Dictionary

Обзор метода

Метод	Описание
exportToPDF (out_pdf, {page_range_type}, {page_range}, {starting_page_number}, {total_page_number}, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {jpeg_compression_quality})	Экспортирует отчета в файл формата Portable Document Format (PDF).
getDefinition (cim_version)	Получает определение CIM отчета.
listSections ({wildcard})	Возвращает список Python объектов ReportSection и ReportLayoutSection отчета.
openView ()	Открывает и активизирует новую панель вида отчета в приложении.
setDefinition (definition_object)	Задает определение CIM отчета.
setReferenceDataSource (data_source)	Задает источник данных отчета.
updatePageInfo (pageInfo)	Обновляет информацию о странице отчета.

Методы

exportToPDF (out_pdf, {page_range_type}, {page_range}, {starting_page_number}, {total_page_number}, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {jpeg_compression_quality})

Параметр	Описание	Тип данных
out_pdf	Строка, представляющая путь и имя выходного файла для экспорта.	String
page_range_type	Строка, определяющая тип диапазона страниц для экспорта. По умолчанию – ALL. ALL—Экспортируются все страницы отчета. LAST—Экспортирует последнюю страницу отчета. EVEN—Экспортирует четные страницы отчета. ODD—Экспортируются нечетные страницы отчета. RANGE—Экспортирует страницы, перечисленные в параметре page_range. (Значение по умолчанию — ALL)	String
page_range	Строка, определяющая экспортируемые страницы, если используется опция RANGE в параметре page_range_type (например, 1, 3, 5-12). Если используется любое другое значение page_range_type, параметр page_range будет игнорироваться.	String
starting_page_number	Задает сдвиг нумерации страниц, который позволит добавить дополнительные страницы в начало отчета. По умолчанию значение сдвига равно 1. (Значение по умолчанию — 1)	Integer
total_page_number	Общее число надписываемых страниц, например, когда ваш отчет отображает X из Y страниц. Это может быть полезным, если вы хотите объединить несколько отчетов в один. Значением по умолчанию является -1. Это значит, что замещение отсутствует. (Значение по умолчанию — None)	Integer
resolution	Целое число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
image_quality	Строка, определяющая качество выходного изображения. BEST—Качество выходного изображения с коэффициентом сжатия 1 BETTER—Качество выходного изображения с коэффициентом сжатия 2 NORMAL—Качество выходного изображения с коэффициентом сжатия 3 FASTER—Качество выходного изображения с коэффициентом сжатия 4 FASTEST—Качество выходного изображения с коэффициентом сжатия 5 (Значение по умолчанию — BEST)	String
compress_vector_graphics	Логический параметр, управляющий сжатием векторных и текстовых частей выходного файла. Сжатие изображения определяется отдельно. (Значение по умолчанию — True)	Boolean
image_compression	Строка, которая определяет схему сжатия, используемую для сжатия изображения или растровых данных в выходном файле. ADAPTIVE—Автоматически выбирает лучший тип сжатия для каждого изображения на странице. JPEG используется для крупных изображений со множеством уникальных цветов. DEFLATE используется для всех других изображений. JPEG—Сжатие данных с потерями. DEFLATE—Сжатие данных без потерь. LZW—Lempel-Ziv-Welch, сжатие данных без потерь NONE—Нет сжатия данных. RLE—Сжатие с кодированием по длинам серий (Значение по умолчанию — ADAPTIVE)	String
embed_fonts	Логический параметр, управляющий внедрением шрифтов в файле для экспорта. Внедрение шрифтов позволяет правильно отображать текстовые и символьные маркеры при просмотре документа на компьютере без установленных шрифтов. (Значение по умолчанию — True)	Boolean
jpeg_compression_quality	Число, управляющее качеством сжатия, если для параметра image_compression задано значение ADAPTIVE или JPEG. Допустимым является диапазон от 1 до 100. Если значение jpeg_compression_quality равно 100, это обеспечивает наилучшее качество изображений, но при экспорте создаются крупные файлы. Рекомендованный диапазон находится между 70 и 90. (Значение по умолчанию — 80)	Integer

PDF формат создан с учетом возможности просмотра и печати файлов на разных платформах. Эти файлы часто используются для распространения документов через Интернет и становятся стандартным форматом для обмена документацией. Файлы PDF можно редактировать во многих графических приложениях, здесь сохраняются аннотации, надписи и атрибутивные данные для слоев карты. Экспорт PDF поддерживает встроенные шрифты, поэтому, даже если у пользователей не установлены шрифты Esri, символы все равно будут отображаться корректно.

getDefinition (cim_version)

Параметр	Описание	Тип данных
cim_version	A string that represents the major version of the CIM.	String

Уровень доступа CIM для дополнительных свойств объекта был введен в версии ArcGIS Pro 2.4. Уровень доступа CIM для отчетов был введен в ArcGIS Pro 3.1. Если вы хотите вернуть определение CIM объекта, необходимо указать cim_version. Esri использует спецификацию семантического версионирования. Это означает, что критические изменения API разрешены в основных версиях — например, 3.0 Это даст авторам скриптов Python возможность управления версией CIM, которая будет использоваться во время запуска скрипта, если существует вероятность внесения критических изменений в новой версии. Если вы создаете скрипты для ArcGIS Pro 2.x, укажите значение cim_version как 'V2'. Если вы создаете скрипты для ArcGIS Pro 3.x, укажите значение cim_version как 'V3'. Скрипты, созданные с использованием cim_version 'V2', будут продолжать работать в ArcGIS Pro 3.x.

Более подробно о работе с CIM и примеры см. Доступ к CIM в Python.

listSections ({wildcard})

Параметр	Описание	Тип данных
wildcard	A wildcard is based on the section name and is not case sensitive. A combination of asterisks (*) and characters can be used to help limit the resulting list. (Значение по умолчанию — None)	String

Возвращаемое значение

Тип данных	Описание
List	Список Python объектов ReportSection и ReportLayoutSection отчета.

Возвращает список Python объектов ReportSection и ReportLayoutSection отчета.

openView ()

Это полезно, если вид отчета еще не открыт или в приложении активен другой вид. Этот метод создает вид отчета, увеличенный до полного размера, и активирует его. Чтобы закрыть другие существующие виды перед открытием нового вида, используйте метод ArcGISProject closeViews.

Примечание:

Этот метод предназначен для запуска в приложении с помощью инструмента-скрипта, блокнота или окна Python. Это не будет иметь никакого эффекта, если запустить его вне приложения.

setDefinition (definition_object)

Параметр	Описание	Тип данных
definition_object	A modified CIM definition object originally retrieved using getDefinition.	Object

Более подробно о работе с CIM и примеры использования см. в разделе Доступ к Python CIM.

setReferenceDataSource (data_source)

Параметр	Описание	Тип данных
data_source	Источник данных, входящий в отчет. Этот параметр может быть объектом Layer, объектом Table или строкой, задающей путь к внешнему источнику данных. (Значение по умолчанию — None)	Object

Метод setReferenceDataSource задает источник данных, на который ссылается отчет, с использованием объекта Layer, объекта Table или строки, задающей путь к внешнему источнику данных

updatePageInfo (pageInfo)

Параметр	Описание	Тип данных
pageInfo	The keys for the dictionary are defined as follows: height—The report's height in page units. width—The report's width in page units. units—The report's page unit keyword. The supported values are inch, point, centimeter, and millimeter. margins—The report's margins keyword. The supported margin values are NORMAL, MODERATE, WIDE, and NARROW.	Dictionary

Значения height и units этой страницы определяются width, указанным в словаре. Если вы измените эти единицы, вам также может понадобиться изменить значения width и height.

Пример кода

Отчет, пример 1

Следующий скрипт экспортирует отчет в PDF, используя диапазон страниц:

aprx = arcpy.mp.ArcGISProject(r"C:\DemoData\USA_States.aprx")
report = aprx.listReports("Cities Report")[0] # Find report by name
report.exportToPDF(r"C:\DemoData\CitiesReport.pdf", page_range="2-10")

Отчет, пример 2

Следующий скрипт изменяет метаданные для отчета:

aprx = arcpy.mp.ArcGISProject(r"C:\DemoData\USA_States.aprx")
report = aprx.listReports("States Report")[1] # Find second report by name
md = report.metadata # Get report metadata
md.title = "Modified States Report"
md.save()

Отчет, пример 3

Следующий скрипт задает источник базовых данных для первого раздела отчета в отчете:

aprx = arcpy.mp.ArcGISProject(r"C:\DemoData\USA_States.aprx")
report = aprx.listReports("Counties Report")[0] # Find report by name, this also returns the first report section
report.setReferenceDataSource(r"C:\DemoData\USA_States.gdb\Counties")
print(report.referenceDataSource)
#{'dataset':'counties', 'workspace_factory':'File Geodatabase',
# 'connection_info':{'database':'C:\\DemoData\\USA_States.gdb'}}

Отчет, пример 4

Следующий скрипт изменяет определяющий запрос для первого раздела отчета в отчете:

aprx = arcpy.mp.ArcGISProject(r"C:\DemoData\USA_States.aprx")
report = aprx.listReports()[2] # Find the third report in the project
print(report.name)
# State Population Report
report.definitionQuery = "STATE_NAME = 'California'"
print(report.definitionQuery)
# STATE_NAME = 'California'

Отчет, пример 5

Следующий скрипт получает все объекты раздела отчета и компоновки отчета, используя listSections:

aprx = arcpy.mp.ArcGISProject('current') # Run this from the Python window in Pro
report = aprx.listReports("Complete Report")[0] # Find report by name
sections = report.listSections() # Get all report and report layout sections in a report
for s in sections:
	print(f"Section Name: {s.name} Section Type: {s.type}")
# Section Name: Cover Page Section Type: REPORT_LAYOUT_SECTION
# Section Name: Cities Section Type: REPORT_SECTION
# Section Name: States Section Type: REPORT_SECTION

Отчет, пример 6

Следующий скрипт изменяет определение отчета для текстового элемента:

aprx = arcpy.mp.ArcGISProject(r'C:\projects\WaterSupply.aprx')
report = aprx.listReports('Suppliers')[0] # Find the report by name
df = report.getDefinition('V3') # Get the current CIM definition of the report

report_section = df.elements[0] # Find the first report section in the CIM
report_header = report_section.elements[4] # Find the report header subsection
title_text = report_header.elements[3] # Find the title text element

symbol = title_text.graphic.symbol.symbol # Get the text symbol
symbol.fontFamilyName = "Arial" # Change the font 

report.setDefinition(df) # Set the new CIM definition

Отчет, пример 7

Следующий скрипт создает отчет и открывает новый вид:

aprx = arcpy.mp.ArcGISProject('current') # This must be run in the application
map = aprx.listMaps('TaxLots')[0] # Find the map by name

# Define report properties
ds = map.listTables('Owners')[0] # Find the data source table by name
pi = {'width': 297, 'height': 420, 'units': 'MILLIMETER', 'margins': 'WIDE'} # Define page info
f = [{'fieldName': 'Name', 'sortInfo': 'DESC', 'groupField': False},
        {'fieldName': 'Address', 'sortInfo': 'ASC', 'groupField': False},
        {'fieldName': 'Status', 'sortInfo': 'None', 'groupField': False}] # Define fields
s = [] # Pass no statistics

report = aprx.createReport(
            page_info = pi,
            data_source = ds,
            fields = f,
            statistics = s,
            name = 'Owners') # Create the report

report_view = report.openView() # Open a new report view

Отчет, пример 8

Следующий скрипт получает информацию о странице отчета:

aprx = arcpy.mp.ArcGISProject('current') # This must be run in the application
map = aprx.listMaps('TaxLots')[0] # Find the map by name

# Define report properties
ds = map.listTables('Owners')[0] # Find the data source table by name
pi = {'width': 297, 'height': 420, 'units': 'MILLIMETER', 'margins': 'WIDE'} # Define page info
f = [{'fieldName': 'Name', 'sortInfo': 'DESC', 'groupField': False},
        {'fieldName': 'Address', 'sortInfo': 'ASC', 'groupField': False},
        {'fieldName': 'Status', 'sortInfo': 'None', 'groupField': False}] # Define fields
s = [] # Pass no statistics

report = aprx.createReport(
            page_info = pi,
            data_source = ds,
            fields = f,
            statistics = s,
            name = 'Owners') # Create the report

report_view = report.openView() # Open a new report view