Сводка
Объект 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 (чтение и запись) | Единицы страницы компоновки. Ниже приведен список допустимых строк при установке единиц страницы.
| String |
| pageWidth (чтение и запись) | Ширина компоновки страницы базируется на текущих pageUnits. | Double |
Обзор метода
| Метод | Объяснение |
| 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}) | Экспортирует компоновку страницы в файл формата 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})| Parameter | Объяснение | Тип данных |
out_aix | Строка, представляющая путь и имя выходного файла для экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 300) | Integer |
image_quality | Строка, определяющая качество выходного изображения, разрешение вывода слоев карты в растровом формате.
(Значение по умолчанию — BEST) | String |
compress_vector_graphics | Логический параметр, управляющий сжатием векторных и текстовых частей выходного файла. Сжатие изображения определяется отдельно. (Значение по умолчанию — True) | Boolean |
image_compression | Строка, которая определяет схему сжатия, используемую для сжатия изображения или растровых данных в выходном файле.
(Значение по умолчанию — 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})| Parameter | Объяснение | Тип данных |
out_bmp | Строка, представляющая путь и имя выходного файла для экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
bmp_color_mode | Это значение определяет количество битов, используемых для описания цвета.
(Значение по умолчанию — 24-BIT_TRUE_COLOR) | String |
bmp_image_compression | Строка, которая определяет схему сжатия, используемую для сжатия изображения или растровых данных в выходном файле. Данная опция применяется только к 8-разрядным опциям bmp_color_mode.
(Значение по умолчанию — 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})| Parameter | Объяснение | Тип данных |
out_emf | Строка, представляющая системный путь и имя файла для выходного файла экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
image_quality | Строка, определяющая качество выходного изображения, разрешение вывода слоев карты в растровом формате.
(Значение по умолчанию — 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})| Parameter | Объяснение | Тип данных |
out_eps | Строка, представляющая системный путь и имя файла для выходного файла экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
image_compression | Строка, которая определяет схему сжатия, используемую для сжатия изображения или растровых данных в выходном файле.
(Значение по умолчанию — DEFLATE) | String |
image_quality | Строка, определяющая качество выходного изображения, разрешение вывода слоев карты в растровом формате.
(Значение по умолчанию — 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})| Parameter | Объяснение | Тип данных |
out_gif | Строка, представляющая системный путь и имя файла для выходного файла экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
gif_color_mode | Это значение определяет количество битов, используемых для описания цвета.
(Значение по умолчанию — 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})| Parameter | Объяснение | Тип данных |
out_jpg | Строка, представляющая путь и имя выходного файла для экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
jpeg_color_mode | Это значение определяет количество битов, используемых для описания цвета.
(Значение по умолчанию — 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)
| Parameter | Объяснение | Тип данных |
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})| Parameter | Объяснение | Тип данных |
out_pdf | Строка, представляющая путь и имя выходного файла для экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 300) | Integer |
image_quality | Строка, определяющая качество выходного изображения, разрешение вывода слоев карты в растровом формате.
(Значение по умолчанию — BEST) | String |
compress_vector_graphics | Логический параметр, управляющий сжатием векторных и текстовых частей выходного файла. Сжатие изображения определяется отдельно. (Значение по умолчанию — True) | Boolean |
image_compression | Строка, которая определяет схему сжатия, используемую для сжатия изображения или растровых данных в выходном файле.
(Значение по умолчанию — ADAPTIVE) | String |
embed_fonts | Логический параметр, управляющий внедрением шрифтов в файле для экспорта. Внедрение шрифтов позволяет правильно отображать текстовые и символьные маркеры при просмотре документа на компьютере без установленных шрифтов. (Значение по умолчанию — True) | Boolean |
layers_attributes | Строка, управляющая включением слоя PDF и данных объектов PDF (атрибутов) в файл для экспорта.
(Значение по умолчанию — LAYERS_ONLY) | String |
georef_info | Логический параметр, позволяющий экспортировать информацию о системе координат каждого фрейма данных в выходной файл PDF. (Значение по умолчанию — True) | Boolean |
jpeg_compression_quality | Число, управляющее значением качества сжатия, если image_compression задано как ADAPTIVE или JPEG. Допустимым является диапазон от 1 до 100. Если значение jpeg_compression_quality равно 100, это обеспечивает наилучшее качество изображений, но при экспорте создаются крупные файлы. Рекомендованный диапазон находится между 70 и 90. (Значение по умолчанию — 80) | Integer |
clip_to_elements | Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False) | Boolean |
output_as_image | Если установлено на True, векторные данные будут сохранены как изображение. Выбор этого параметра для карт или компоновок, содержащих векторные слои с высокой плотностью вершин, может значительно уменьшить размер выходного файла. Если выбран экспорт в PDF и опция установлена на True, вы не сможете просматривать слои PDF в выходных данных. (Значение по умолчанию — False) | Boolean |
embed_color_profile | Если задан как True, то информация о цвете профиля будет встроена в метаданные изображения. (Значение по умолчанию — True) | Boolean |
PDF формат создан с учетом возможности работы на разных платформах. Эти файлы часто используются для распространения документов через Интернет. Теперь этот формат стал официальным стандартом ISO для обмена документацией. Файлы PDF можно редактировать во многих графических приложениях, с сохранением геопространственной информации, аннотаций, надписей и атрибутов пространственных объектов. Экспорт PDF поддерживает встроенные шрифты, поэтому, даже если у пользователей не установлены шрифты Esri, символы все равно будут отображаться корректно.
Посмотрите класс PDFDocument, чтобы узнать более подробно о том, как работать в файлами PDF, в том числе, выполнять операции присоединения, вставки и настройки свойств.
exportToPNG (out_png, {resolution}, {color_mode}, {transparent_background}, {embed_color_profile}, {clip_to_elements})| Parameter | Объяснение | Тип данных |
out_png | Строка, представляющая путь и имя выходного файла для экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
color_mode | Это значение определяет количество битов, используемых для описания цвета.
(Значение по умолчанию — 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})| Parameter | Объяснение | Тип данных |
out_svg | Строка, представляющая путь и имя выходного файла для экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
compress_to_svgz | Если установлено значение True, выходные данные сжимаются. (Значение по умолчанию — False) | Boolean |
image_quality | Строка, определяющая качество выходного изображения, разрешение вывода слоев карты в растровом формате.
(Значение по умолчанию — 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})| Parameter | Объяснение | Тип данных |
out_tga | Строка, представляющая путь и имя выходного файла для экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
color_mode | Это значение определяет количество битов, используемых для описания цвета.
(Значение по умолчанию — 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})| Parameter | Объяснение | Тип данных |
out_tif | Строка, представляющая путь и имя выходного файла для экспорта. | String |
resolution | Число, определяющее разрешение файла для экспорта в точках на дюйм (dpi). (Значение по умолчанию — 96) | Integer |
color_mode | Это значение определяет количество битов, используемых для описания цвета.
(Значение по умолчанию — 24-BIT_TRUE_COLOR) | String |
tiff_compression | Это значение отображает схему сжатия.
(Значение по умолчанию — LZW) | String |
jpeg_compression_quality | Это значение (0-100) отвечает за степень сжатия, которому подвергается выходное изображение. Для изображений в формате JPEG степень сжатия отрицательно сказывается на качестве изображения. Если настроено высокое качество (максимально 100), изображение будет более четким, а размер файла увеличится. Настройка низкого качества дает более размытое изображение, но небольшой размер файлов. (Значение по умолчанию — 80) | Integer |
transparent_background | Если задано как True, то белый цвет фона будет настроен как прозрачный. (Значение по умолчанию — False) | Boolean |
embed_color_profile | Если задан как True, то информация о цвете профиля будет встроена в метаданные изображения. (Значение по умолчанию — True) | Boolean |
clip_to_elements | Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — False) | Boolean |
world_file | Если установлен на True и задан корректный georef_mapframe, создается мировой файл на основании системы координат фрейма данных. (Значение по умолчанию — False) | Boolean |
geoTIFF_tags | Если установлен на True и задан корректный georef_mapframe, теги geoTIFF встраиваются в результирующее изображение на основании системы коордиинат фрейма данных. (Значение по умолчанию — False) | Boolean |
georef_mapframe | Если задано значение True, то компоновка вырезается по наименьшей ограничивающей рамке, включающей все элементы компоновки. (Значение по умолчанию — None) | MapFrame |
Файлы TIFF наилучшим образом подходят для импорта в приложения для редактирования изображений и тоже считаются распространенным в ГИС растровым форматом. Но их невозможно просматривать в веб-браузерах.
getDefinition (cim_version)
| Parameter | Объяснение | Тип данных |
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})| Parameter | Объяснение | Тип данных |
element_type | Строка, представляющая тип элемента, который будет использоваться для фильтрации полученного списка элементов.
(Значение по умолчанию — 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)
| Parameter | Объяснение | Тип данных |
definition_object | Объект измененного определения CIM, изначально полученный с помощью getDefinition. | Object |
Более подробно о работе с CIM и примеры см. Доступ к CIM в Python.
Пример кода
Следующий скрипт использует ключевое слово 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})")Следующий скрипт будет обновлять область интереса фрейма карты путем масштабирования для каждой закладки, которая принадлежит карте с именем 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Следующий скрипт проверяет наличие серий карт, а затем экспортирует две страницы серий в 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")