Layout

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

Объект Layout ссылается на одностраничную компоновку в проекте ArcGIS Pro (.aprx). Он предоставляет доступ к общим свойствам, таким как размер страницы и различные методы экспорта.

Обсуждение

Проект ArcGIS Pro может содержать несколько компоновок. Компоновки доступны с использованием функции listLayouts из объекта ArcGISProject и она возвращает список Python объектов Layout. Важно, чтобы у каждой компоновки было свое уникальное имя, благодаря чему на конкретную страницу компоновки было бы легко ссылаться с использованием свойства name.

Метод listElements обеспечивает доступ ко всем элементам страницы компоновки: GraphicElement, LegendElement, MapFrameElement, MapSurroundElement, PictureElement и TextElement.

В объекте Layout вы можете получить доступ к ряду методов exportTo. Используйте методы экспорта Layout, если вы хотите экспортировать всю страницу компоновки. Есть подобный набор методов экспорта, доступный для класса MapFrame если вы хотите экспортировать содержимое одного фрейма данных.

Компоновка может содержать один элемент MapSeries. Если свойство mapSeries возвращает None, серии карт в компоновке не создаются. Вы можете также проверить, являются ли серии карт enabled, перед тем, как изменять их свойства.

Свойства

Свойство	Описание	Тип данных
mapSeries (только чтение)	Возвращает объект MapSeries, если включена серия карт. Он возвращает NoneType, если серия карт не существует или это серия карт закладок.	MapSeries
metadata (чтение и запись)	Получите или настройте информацию о классе Metadata. Примечание: Установка метаданных зависит от значения свойства isReadOnly.	Metadata
name (чтение и запись)	Имя компоновки. Является важно, чтобы каждый фрейм данных имел уникальное имя, которое потом используется в ссылках на фрейм.	String
pageHeight (чтение и запись)	Высота компоновки страницы базируется на текущих pageUnits.	Double
pageUnits (чтение и запись)	Единицы страницы компоновки. Ниже приведен список допустимых строк при установке единиц страницы. CENTIMETER—Сантиметр INCH—Дюйм MILLIMETER—Миллиметр POINT—Точка	String
pageWidth (чтение и запись)	Ширина компоновки страницы базируется на текущих pageUnits.	Double
URI (только чтение)	Universal Resource Indicator для компоновки. Это уникальный идентификатор компоновки в проекте, который иногда требуется при использовании доступа Python CIM. После добавления компоновки и установления URI значение со временем не меняется. Например, если вы измените имя компоновки, URI не изменится.	String

Обзор метода

Метод	Описание
exportToAIX (out_aix, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {jpeg_compression_quality}, {embed_fonts}, {embed_color_profile}, {clip_to_elements}, {keep_layout_background})	Экспортирует компоновку страницы в формат Adobe Creative Cloud (AIX).
exportToBMP (out_bmp, {resolution}, {bmp_color_mode}, {bmp_image_compression}, {embed_color_profile}, {clip_to_elements})	Экспортирует компоновку страницы в файл формата Microsoft Windows Bitmap (BMP).
exportToEMF (out_emf, {resolution}, {image_quality}, {output_as_image}, {clip_to_elements})	Экспортирует компоновку страницы в файл формата Enhanced Metafile (EMF).
exportToEPS (out_eps, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image}, {clip_to_elements})	Экспортирует компоновку страницы в файл формата Encapsulated PostScript (EPS).
exportToGIF (out_gif, {resolution}, {gif_color_mode}, {clip_to_elements})	Экспортирует компоновку страницы в файл формата Graphic Interchange Format (GIF).
exportToJPEG (out_jpg, {resolution}, {jpeg_color_mode}, {jpeg_quality}, {embed_color_profile}, {clip_to_elements})	Экспортирует компоновку страницы в файл формата Joint Photographic Experts Group (JPEG).
exportToPAGX (out_pagx)	Экспортирует компоновку в файл страницы.
exportToPDF (out_pdf, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality}, {clip_to_elements}, {output_as_image}, {embed_color_profile}, {pdf_accessibility})	Экспортирует компоновку страницы в файл формата Portable Document Format (PDF).
exportToPNG (out_png, {resolution}, {color_mode}, {transparent_background}, {embed_color_profile}, {clip_to_elements})	Экспортирует компоновку страницы в файл формата Portable Network Graphics (PNG).
exportToSVG (out_svg, {resolution}, {compress_to_svgz}, {image_quality}, {embed_fonts}, {output_as_image}, {clip_to_elements})	Экспортирует компоновку страницы в файл формата Scalable Vector Graphics format (SVG).
exportToTGA (out_tga, {resolution}, {color_mode}, {transparent_background}, {clip_to_elements})	Экспортирует компоновку страницы в файл формата Truevision Graphics Adapter (TGA) .
exportToTIFF (out_tif, {resolution}, {color_mode}, {tiff_compression}, {jpeg_compression_quality}, {transparent_background}, {embed_color_profile}, {clip_to_elements}, {world_file}, {geoTIFF_tags}, {georef_mapframe})	Экспортирует компоновку страницы в Tagged Image File Format (TIFF).
getDefinition (cim_version)	Получает определение компоновки CIM.
listElements ({element_type}, {wildcard})	Возвращает список Python элементов компоновки страницы, который существует а объекте Layout.
setDefinition (definition_object)	Настраивает определение компоновки CIM.

Методы

exportToAIX (out_aix, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {jpeg_compression_quality}, {embed_fonts}, {embed_color_profile}, {clip_to_elements}, {keep_layout_background})

Параметр	Описание	Тип данных
out_aix	Строка, представляющая путь и имя выходного файла для экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 300)	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 используется для всех других изображений. DEFLATE—Сжатие данных без потерь. JPEG—Сжатие данных с потерями. LZW—Lempel-Ziv-Welch, сжатие данных без потерь. NONE—Нет сжатия данных. RLE—Сжатие с кодированием по длинам серий. (Значение по умолчанию — ADAPTIVE)	String
jpeg_compression_quality	Число, управляющее значением качества сжатия, если image_compression задано как ADAPTIVE или JPEG. Допустимым является диапазон от 1 до 100. Значение jpeg_compression_quality, равное 100, обеспечивает высокое качество изображений, но создает большие файлы экспорта. Рекомендованный диапазон находится между 70 и 90. (Значение по умолчанию — 80)	Integer
embed_fonts	Логический параметр, управляющий внедрением шрифтов в файле для экспорта. Внедрение шрифтов позволяет правильно отображать текстовые и символьные маркеры при просмотре документа на компьютере без установленных шрифтов. (Значение по умолчанию — True)	Boolean
embed_color_profile	Если задан как True, то информация о цвете профиля будет встроена в метаданные изображения. (Значение по умолчанию — True)	Boolean
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean
keep_layout_background	Если установлено на True, белый фон компоновки сохраняется. (Значение по умолчанию — True)	Boolean

AIX - это файл Adobe Illustrator Exchange, экспортированный из ArcGIS, который будет использоваться с надстройкой ArcGIS Maps for Adobe Creative Cloud. При использовании с плагином содержимое векторной и растровой карты преобразуется в редактируемые многослойные графические объекты, которые удобно редактировать в Adobe Illustrator. После открытия в Illustrator их можно использовать для профессионального графического дизайна или завершающего этапа работ по подготовке карты, а также дальнейшей передачи этих данных в другие приложения Adobe Creative Cloud.

exportToBMP (out_bmp, {resolution}, {bmp_color_mode}, {bmp_image_compression}, {embed_color_profile}, {clip_to_elements})

Параметр	Описание	Тип данных
out_bmp	Строка, представляющая путь и имя выходного файла для экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
bmp_color_mode	Это значение определяет количество битов, используемых для описания цвета. 8-BIT_ADAPTIVE_PALETTE—8-разрядная адаптивная палитра 8-BIT_GRAYSCALE—8-разрядный режим, оттенки серого 24-BIT_TRUE_COLOR—24-разрядный режим, реальный цвет (Значение по умолчанию — 24-BIT_TRUE_COLOR)	String
bmp_image_compression	Строка, которая определяет схему сжатия, используемую для сжатия изображения или растровых данных в выходном файле. Данная опция применяется только к 8-разрядным опциям bmp_color_mode. NONE—Нет сжатия данных. RLE—Сжатие с кодированием по длинам серий. (Значение по умолчанию — NONE)	String
embed_color_profile	Если задан как True, то информация о цвете профиля будет встроена в метаданные изображения. (Значение по умолчанию — True)	Boolean
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean

Формат BMP является "родным" форматом растровых изображений Windows. Файлы BMP могут хранить данных в пикселах в разной битовой глубине. Обычно файлы в формате BMP получаются гораздо больше, чем JPEG или PNG.

exportToEMF (out_emf, {resolution}, {image_quality}, {output_as_image}, {clip_to_elements})

Параметр	Описание	Тип данных
out_emf	Строка, представляющая системный путь и имя файла для выходного файла экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
image_quality	Строка, определяющая качество выходного изображения, разрешение вывода слоев карты в растровом формате. BEST—Качество выходного изображения с коэффициентом сжатия 1 BETTER—Качество выходного изображения с коэффициентом сжатия 2 NORMAL—Качество выходного изображения с коэффициентом сжатия 3 FASTER—Качество выходного изображения с коэффициентом сжатия 4 FASTEST—Качество выходного изображения с коэффициентом сжатия 5 (Значение по умолчанию — BEST)	String
output_as_image	Если установлено на True, векторные данные будут сохранены как изображение. Выбор этого параметра для карт или компоновок, содержащих векторные слои с высокой плотностью вершин, может значительно уменьшить размер выходного файла. Если выбран экспорт в PDF и опция установлена на True, вы не сможете просматривать слои PDF в выходных данных. (Значение по умолчанию — False)	Boolean
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean

EMF – собственные файлы Windows, которые могут хранит как векторные, так и растровые данные. Они удобны для включения в документы Windows, т.к. размер изображений, содержащихся в векторных частях EMF, изменяется без потери качества. Но так как EMF не поддерживает встроенные шрифты и является эксклюзивным форматом Windows, его редко используют в качестве обменного формата.

exportToEPS (out_eps, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image}, {clip_to_elements})

Параметр	Описание	Тип данных
out_eps	Строка, представляющая системный путь и имя файла для выходного файла экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
image_compression	Строка, которая определяет схему сжатия, используемую для сжатия изображения или растровых данных в выходном файле. DEFLATE—Сжатие данных без потерь. LZW—Lempel-Ziv-Welch, сжатие данных без потерь. NONE—Нет сжатия данных. RLE—Сжатие с кодированием по длинам серий. (Значение по умолчанию — DEFLATE)	String
image_quality	Строка, определяющая качество выходного изображения, разрешение вывода слоев карты в растровом формате. BEST—Качество выходного изображения с коэффициентом сжатия 1. BETTER—Качество выходного изображения с коэффициентом сжатия 2. NORMAL—Качество выходного изображения с коэффициентом сжатия 3. FASTER—Качество выходного изображения с коэффициентом сжатия 4. FASTEST—Качество выходного изображения с коэффициентом сжатия 5. (Значение по умолчанию — BEST)	String
embed_fonts	Логический параметр, управляющий внедрением шрифтов в файле для экспорта. Внедрение шрифтов позволяет правильно отображать текстовые и символьные маркеры при просмотре документа на компьютере без установленных шрифтов. (Значение по умолчанию — True)	Boolean
output_as_image	Если установлено на True, векторные данные будут сохранены как изображение. Выбор этого параметра для карт или компоновок, содержащих векторные слои с высокой плотностью вершин, может значительно уменьшить размер выходного файла. Если выбран экспорт в PDF и опция установлена на True, вы не сможете просматривать слои PDF в выходных данных. (Значение по умолчанию — False)	Boolean
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean

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

exportToGIF (out_gif, {resolution}, {gif_color_mode}, {clip_to_elements})

Параметр	Описание	Тип данных
out_gif	Строка, представляющая системный путь и имя файла для выходного файла экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
gif_color_mode	Это значение определяет количество битов, используемых для описания цвета. 8-BIT_PALETTE—8-разрядная адаптивная палитра 8-BIT_GRAYSCALE—8-разрядный режим, оттенки серого (Значение по умолчанию — 8-BIT_PALETTE)	String
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean

GIF – стандартный растровый формат, используемый в Интернете. Файлы GIF не могут содержать более 256 цветов (8 бит на пиксел), что вместе со сжатием без потерь делает их меньше, чем файлы других форматов.

exportToJPEG (out_jpg, {resolution}, {jpeg_color_mode}, {jpeg_quality}, {embed_color_profile}, {clip_to_elements})

Параметр	Описание	Тип данных
out_jpg	Строка, представляющая путь и имя выходного файла для экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
jpeg_color_mode	Это значение определяет количество битов, используемых для описания цвета. 8-BIT_GRAYSCALE—8-разрядный режим, оттенки серого 24-BIT_TRUE_COLOR—24-разрядный режим, реальный цвет (Значение по умолчанию — 24-BIT_TRUE_COLOR)	String
jpeg_quality	Это значение (0-100) отвечает за степень сжатия, которому подвергается выходное изображение. Для изображений в формате JPEG степень сжатия отрицательно сказывается на качестве изображения. Если настроено высокое качество (максимально 100), изображение будет более четким, а размер файла увеличится. Настройка низкого качества дает более размытое изображение, но небольшой размер файлов. (Значение по умолчанию — 80)	Integer
embed_color_profile	Если задан как True, то информация о цвете профиля будет встроена в метаданные изображения. (Значение по умолчанию — True)	Boolean
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean

JPEG – это сжатые графические файлы. Они поддерживают 24-битовый цвет и их часто выбирают для использования в Интернет, так как размер JPEG-файла обычно меньше, чем у аналогичных файлов других форматов изображений. Но алгоритм сжатия JPEG выполняется с потерями и не рекомендуется для многих картографических изображений, так как линейные рисунки, текст и значки приобретают артефакты сжатия. Так что PNG для картографических изображений подходит лучше всего.

exportToPAGX (out_pagx)

Параметр	Описание	Тип данных
out_pagx	Строка, используемая для сохранения компоновки в файл страницы (.pagx).	String

Этот метод полезен, если вы хотите сохранить компоновку в файл страницы, который впоследствии можно будет импортировать в проект с помощью метода ArcGISProject importDocument.

exportToPDF (out_pdf, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality}, {clip_to_elements}, {output_as_image}, {embed_color_profile}, {pdf_accessibility})

Параметр	Описание	Тип данных
out_pdf	A string that represents the path and file name for the output export file.	String
resolution	A number that defines the resolution of the export file in dots per inch (dpi). (Значение по умолчанию — 300)	Integer
image_quality	A string that specifies output image quality, the draw resolution of map layers that draw as rasters. BEST—An output image quality resample ratio of 1 BETTER—An output image quality resample ratio of 2 NORMAL—An output image quality resample ratio of 3 FASTER—An output image quality resample ratio of 4 FASTEST—An output image quality resample ratio of 5 (Значение по умолчанию — BEST)	String
compress_vector_graphics	A Boolean that controls compression of vector and text portions of the output file. Image compression is defined separately. (Значение по умолчанию — True)	Boolean
image_compression	A string that specifies the compression scheme used to compress image or raster data in the output file. ADAPTIVE—Automatically selects the best compression type for each image on the page. JPEG will be used for large images with many unique colors. DEFLATE will be used for all other images. DEFLATE—A lossless data compression. JPEG—A lossy data compression. LZW—Lempel-Ziv-Welch, a lossless data compression. NONE—Compression is not applied. RLE—Run-length encoded compression. (Значение по умолчанию — ADAPTIVE)	String
embed_fonts	A Boolean that controls the embedding of fonts in the export file. Font embedding allows text and character markers to be displayed correctly when the document is viewed on a computer that does not have the necessary fonts installed. (Значение по умолчанию — True)	Boolean
layers_attributes	A string that specifies whether the PDF layer and PDF object data (attributes) will be included in the export file. LAYERS_ONLY—Export PDF layers only LAYERS_AND_ATTRIBUTES—Export PDF layers and feature attributes NONE—None (Значение по умолчанию — LAYERS_ONLY)	String
georef_info	A Boolean that enables the export of coordinate system information for each data frame into the output PDF file. (Значение по умолчанию — True)	Boolean
jpeg_compression_quality	A number that controls compression quality value when image_compression is set to ADAPTIVE or JPEG. The valid range is 1 through 100. A jpeg_compression_quality of 100 provides the best quality images but creates large export files. The recommended range is between 70 and 90. (Значение по умолчанию — 80)	Integer
clip_to_elements	If set to True, the layout is clipped to the smallest bounding box that includes all layout elements. (Значение по умолчанию — False)	Boolean
output_as_image	If set to True, vector content can be saved as an image. Selecting this option for maps or layouts that contain vector layers with a high density of vertices can reduce the output file size. When exporting to PDF and this option is set to True, you cannot view PDF layers in the output. (Значение по умолчанию — False)	Boolean
embed_color_profile	If set to True, color profile information is embedded in the image's metadata. (Значение по умолчанию — True)	Boolean
pdf_accessibility	Output a tagged PDF file where text can be read by screen readers or other assistive technology. A tagged PDF file can include alt text—a text description of a graphic element that a screen reader uses to describe the element—for map frames, pictures, and chart frames. Alt text is added in the Element Pane for each element. (Значение по умолчанию — False)	Boolean

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

Посмотрите класс PDFDocument, чтобы узнать более подробно о том, как работать в файлами PDF, в том числе, выполнять операции присоединения, вставки и настройки свойств.

exportToPNG (out_png, {resolution}, {color_mode}, {transparent_background}, {embed_color_profile}, {clip_to_elements})

Параметр	Описание	Тип данных
out_png	Строка, представляющая путь и имя выходного файла для экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
color_mode	Это значение определяет количество битов, используемых для описания цвета. 8-BIT_ADAPTIVE_PALETTE—8-разрядная адаптивная палитра 8-BIT_GRAYSCALE—8-разрядный режим, оттенки серого 24-BIT_TRUE_COLOR—24-разрядный режим, реальный цвет 32-BIT_WITH_ALPHA—32-разрядная с альфа (Значение по умолчанию — 32-BIT_WITH_ALPHA)	String
transparent_background	Если задано как True, то белый цвет фона будет настроен как прозрачный. (Значение по умолчанию — False)	Boolean
embed_color_profile	Если задан как True, то информация о цвете профиля будет встроена в метаданные изображения. (Значение по умолчанию — True)	Boolean
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean

Файл PNG – это универсальный растровый формат, который может отображаться в веб-браузерах и поддерживает вставку в другие документы. Он поддерживает большую битовую глубину цвета и использует сжатие без потерь. Для карт часто лучше всего подходит формат PNG, так как сжатие без потерь обеспечивает читаемость текста и линий, препятствуя возникновению артефактов сжатия, которые могут возникать в формате JPEG. В файлах PNG можно задавать цвет прозрачности.

exportToSVG (out_svg, {resolution}, {compress_to_svgz}, {image_quality}, {embed_fonts}, {output_as_image}, {clip_to_elements})

Параметр	Описание	Тип данных
out_svg	Строка, представляющая путь и имя выходного файла для экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
compress_to_svgz	Если установлено значение True, выходные данные сжимаются. (Значение по умолчанию — False)	Boolean
image_quality	Строка, определяющая качество выходного изображения, разрешение вывода слоев карты в растровом формате. BEST—Качество выходного изображения с коэффициентом сжатия 1. BETTER—Качество выходного изображения с коэффициентом сжатия 2. NORMAL—Качество выходного изображения с коэффициентом сжатия 3. FASTER—Качество выходного изображения с коэффициентом сжатия 4. FASTEST—Качество выходного изображения с коэффициентом сжатия 5. (Значение по умолчанию — BEST)	String
embed_fonts	Логический параметр, управляющий внедрением шрифтов в файле для экспорта. Внедрение шрифтов позволяет правильно отображать текстовые и символьные маркеры при просмотре документа на компьютере без установленных шрифтов. (Значение по умолчанию — True)	Boolean
output_as_image	Если установлено на True, векторные данные будут сохранены как изображение. Выбор этого параметра для карт или компоновок, содержащих векторные слои с высокой плотностью вершин, может значительно уменьшить размер выходного файла. Если выбран экспорт в PDF и опция установлена на True, вы не сможете просматривать слои PDF в выходных данных. (Значение по умолчанию — False)	Boolean
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean

SVG – это формат файлов на базе XML, специально разработанный для просмотра веб-страниц. SVG могут содержать как векторную, так и растровую графику. Для некоторых веб-браузеров может потребоваться плагин для просмотра файлов SVG. Другие веб-браузеры могут не иметь возможности для просмотра файлов SVG. Формат SVG поддерживает встроенные шрифты, поэтому даже если у пользователей не установлены шрифты Esri, символы все равно будут отображаться корректно. Вы также можете выбрать создавать сжатые файлы SVG. При включении этой опции расширение файла изменяется на .svgz.

exportToTGA (out_tga, {resolution}, {color_mode}, {transparent_background}, {clip_to_elements})

Параметр	Описание	Тип данных
out_tga	Строка, представляющая путь и имя выходного файла для экспорта.	String
resolution	Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96)	Integer
color_mode	Это значение определяет количество битов, используемых для описания цвета. 8-BIT_ADAPTIVE_PALETTE—8-разрядная адаптивная палитра 8-BIT_GRAYSCALE—8-разрядный режим, оттенки серого 24-BIT_TRUE_COLOR—24-разрядный режим, реальный цвет 32-BIT_WITH_ALPHA—32-разрядная с альфа (Значение по умолчанию — 32-BIT_WITH_ALPHA)	String
transparent_background	Если задано как True, то белый цвет фона будет настроен как прозрачный. (Значение по умолчанию — False)	Boolean
clip_to_elements	Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False)	Boolean

Файлы TGA исторически применялись для ресурсов, которые должны использоваться в других приложениях (например, скрываемое изображение для анимированных игр), и читаются и записываются множеством популярных приложений по работе с графикой. Формат TGA поддерживант многобитную глубину, включая 32-битную с alpha-поддержкой (прозрачность).

exportToTIFF (out_tif, {resolution}, {color_mode}, {tiff_compression}, {jpeg_compression_quality}, {transparent_background}, {embed_color_profile}, {clip_to_elements}, {world_file}, {geoTIFF_tags}, {georef_mapframe})

Параметр	Описание	Тип данных
out_tif	A string that represents the path and file name of the output export file.	String
resolution	A number that defines the resolution of the export file in dots per inch (dpi). (Значение по умолчанию — 96)	Integer
color_mode	This value specifies the number of bits used to describe color. 8-BIT_ADAPTIVE_PALETTE—8-bit adaptive palette 8-BIT_GRAYSCALE—8-bit grayscale 24-BIT_TRUE_COLOR—24-bit true color 32-BIT_WITH_ALPHA—32-bit with alpha (Значение по умолчанию — 24-BIT_TRUE_COLOR)	String
tiff_compression	This value represents a compression scheme. DEFLATE—A lossless data compression. JPEG—JPEG compression. LZW—Lempel-Ziv-Welch, a lossless data compression. NONE—Compression is not applied. PACK_BITS—Pack bits compression. (Значение по умолчанию — LZW)	String
jpeg_compression_quality	This value (0–100) controls the amount of compression applied to the output image. With a JPEG image, quality is adversely affected the more compression is applied. A higher quality (highest = 100) setting will produce sharper images and larger file sizes. A lower quality setting will produce more image artifacts and smaller files. (Значение по умолчанию — 80)	Integer
transparent_background	If set to True, the white page background is set to transparent. (Значение по умолчанию — False)	Boolean
embed_color_profile	If set to True, color profile information is embedded in the image's metadata. (Значение по умолчанию — True)	Boolean
clip_to_elements	If set to True, the layout is clipped to the smallest bounding box that includes all layout elements. (Значение по умолчанию — False)	Boolean
world_file	If set to True and a valid georef_mapframe is set, a world file will be generated based on the map frame's coordinate system. (Значение по умолчанию — False)	Boolean
geoTIFF_tags	If set to True and a valid georef_mapframe is set, geoTIFF tags will be embedded in the resulting image based on the map frame's coordinate system. (Значение по умолчанию — False)	Boolean
georef_mapframe	The MapFrame used to control the coordinate system when geoTIFF_tags are set to True. (Значение по умолчанию — None)	MapFrame

Файлы TIFF наилучшим образом подходят для импортирования в приложения для редактирования изображений и тоже считаются распространенным в ГИС растровым форматом. Но их невозможно просматривать в веб-браузерах.

getDefinition (cim_version)

Параметр	Описание	Тип данных
cim_version	Строка, представляющая основную версию CIM.	String

Доступ уровня CIM к дополнительным свойствам объектов, которые появились в версии 2.4. Esri соблюдает спецификацию семантики версий. Это означает, что до следующего выпуска основной версии, например, версии 3.0, при появлении существенных изменений в API, для cim_version будет использовано значение V2. После выпуска версии 3.0 станет доступной новая опция V3. Это дает авторам скриптов Python контроль над версией CIM, которая будет использоваться во время выполнения, если есть вероятность, что будут внесены существенные изменения в новую версию.

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

listElements ({element_type}, {wildcard})

Параметр	Описание	Тип данных
element_type	Строка, представляющая тип элемента, который будет использоваться для фильтрации полученного списка элементов. GRAPHIC_ELEMENT—Фильтр для объектов GraphicElement. LEGEND_ELEMENT—Фильтр для объектов LegendElement. MAPFRAME_ELEMENT— Фильтр для объектов MapFrame. MAPSURROUND_ELEMENT—Фильтр для объектов MapsurroundElement. PICTURE_ELEMENT—Фильтр для объектов PictureElement. TEXT_ELEMENT—Фильтр для объектов TextElement. (Значение по умолчанию — None)	String
wildcard	Групповой символ базируется на имени элемента и не является чувствительным к регистру. Для наложения ограничения на результаты можно использовать сочетание звездочек (*) и символов. (Значение по умолчанию — None)	String

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

Тип данных	Описание
List	Список Python объектов компоновки страницы. Могут быть получены следующие типы элементов: GraphicElement, LegendElement, MapFrame, MapsurroundElement, PictureElement и TextElement.

Каждый элемент страницы имеет свойство name, которое может быть установлено в диалоговом окне свойств элемента. Автор компоновки должен убедиться, что каждому элементу страницы присвоено уникальное имя, чтобы эти элементы можно было однозначно идентифицировать. Если два элемента имеют одинаковое имя, то нет никакого способа убедиться в том, что вы выбрали для ссылки требуемый элемент.

Метод listElements возвращает элементы внутри составного элемента в упрощенном списке. Это делает возможным легко искать и заменять, например, текстовые строки, без необходимости переходить по элементам внутри структуры составного элемента.

Параметр element_type может быть пропущен посредством передачи пустой строки или посредством включения имени параметра для всех параметров, которые следуют за пропущенным параметром. Например:

elm = lyt.listElements("", "Title")[0]

#or

elm = lyt.listElements(wildcard="Title")[0]

setDefinition (definition_object)

Параметр	Описание	Тип данных
definition_object	Объект измененного определения CIM, изначально полученный с помощью getDefinition.	Object

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

Пример кода

Layout, пример 1

Следующий скрипт использует ключевое слово current, поэтому он должен быть запущен из окна Python. Скрипт печатает имя каждой карты в проекте и ее слоев, а также имя каждой компоновки и размер ее страницы.

aprx = arcpy.mp.ArcGISProject("CURRENT")
for m in aprx.listMaps():
    print("Map: " + m.name)
    for lyr in m.listLayers():
        print("  " + lyr.name)
print("Layouts:")
for lyt in aprx.listLayouts():
    print(f"  {lyt.name} ({lyt.pageHeight} x {lyt.pageWidth} {lyt.pageUnits})")

Layout, пример 2

Следующий скрипт будет обновлять область интереса фрейма карты путем масштабирования для каждой закладки, которая принадлежит карте с именем Yosemite National Park и экспортирует результат в отдельный документ PDF.

import arcpy, os
aprx = arcpy.mp.ArcGISProject(r"C:\Projects\YosemiteNP\Yosemite.aprx")

lyt = aprx.listLayouts("Main Attractions*")[0]
mf = lyt.listElements("MAPFRAME_ELEMENT", "Yosemite National Park*")[0]

bkmks = mf.map.listBookmarks()
for bkmk in bkmks:
  mf.zoomToBookmark(bkmk)
  lyt.exportToPDF(os.path.join(r"C:\Projects\YosemiteNP", f"{bkmk.name}.pdf"))
del aprx

Layout, пример 3

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

import arcpy
import os
import sys
relpath = os.path.dirname(sys.argv[0])

p = arcpy.mp.ArcGISProject(relpath + "\\MapSeries\\US_States.aprx")
l = p.listLayouts()[0]
if not l.mapSeries is None:
    ms = l.mapSeries
    if ms.enabled:
        ms.currentPageNumber = ms.getPageNumberFromName("Rhode Island") 
        ms.exportToPDF(relpath + "\\Output\\Ex1_RI.pdf", "CURRENT", resolution=300)
        ms.currentPageNumber = ms.getPageNumberFromName("Washington") 
        ms.exportToPDF(relpath + "\\Output\\Ex1_WA.pdf", "CURRENT")