MapFrame

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

Объект MapFrame представляет собой элемент компоновки, который используется для отображения содержимого карты. Он также предоставляет доступ к размеру компоновки, положению в компоновке простым методам навигации и опциям экспорта.

Обсуждение

MapFrame является элементом компоновки Layout, который отображает географическую информацию добавленную на карту. Метод listElements для объекта Layout возвращает список Python элементов компоновки. Чтобы получить список, содержащий только фреймы карты, используйте константу MAPFRAME_ELEMENT для параметра element_type. wildcard также может быть использована для дальнейшей настройки поиска по name элемента.

Метод createMapFrame класса Layout также возвратит ссылку на фрейм карты.

После получения ссылки на MapFrame, свойства и методы позволяют выполнять различные операции. Во-первых, есть базовые свойства, позволяющие управлять размером, расположением и видимостью фрейма карты в компоновке. Во-вторых, существует несколько методов навигации, таких как panToExtent, zoomToAllLayers и zoomToBookmark, которые позволяют изменять область интереса, отображаемую во фрейме карты. В-третьих, свойство map позволяет вам изменить связанную карту или получить доступ к ней. Так вы можете напрямую управлять слоями, таблицами и базовыми картами на карте, а также получать доступ к информации о камере карты, что позволяет вам еще больше изменять область интереса. Можно переключать карты в одном или в разных измерениях. Наконец, есть ряд методов экспорта, которые позволяют экспортировать фрейм карты в различные форматы.

Подсказка:

Экспорт MapFrame компоновки работает стабильнее, чем попытки экспортировать MapView за пределы приложения. Ограничением экспорта MapView является то, что представления карты работают только со скриптами Python, выполняемыми внутри приложения. Это связано с тем, что размер окна и область интереса известны только тогда, когда приложение и его панели просмотра открыты. При экспорте MapFrame вся информация о размерах сохраняется в элементе, поэтому скрипты, запускаемые изнутри приложения, и автономные скрипты вне приложения, будут давать одинаковый результат экспорта.

Свойства

СвойствоОписаниеТип данных
anchor
(только чтение)

Возвращает одно из следующих строковых значений, которые описывают текущую позицию якоря. Чтобы изменить значение, используйте метод setAnchor.

  • BOTTOM_LEFT_CORNERВ левом нижнем углу
  • BOTTOM_MID_POINTСнизу по центру
  • BOTTOM_RIGHT_CORNERВ правом нижнем углу
  • CENTER_POINTВ центре
  • LEFT_MID_POINTСлева по центру
  • RIGHT_MID_POINTСправа по центру
  • TOP_LEFT_CORNERВ левом верхнем углу
  • TOP_MID_POINTСверху по центру
  • TOP_RIGHT_CORNERВ правом верхнем углу
String
camera
(чтение и запись)

Свойство Camera позиции расположения и наблюдателя данных, отображаемых в виде карты.

Camera
elementHeight
(чтение и запись)

Высота фрейма карты на компоновке страницы. Единицы измерения задаются или считываются в единицах страницы.

Double
elementPositionX
(чтение и запись)

Х-положение позиции точки якоря фрейма карты. Единицы измерения задаются или считываются в единицах страницы.

Double
elementPositionY
(чтение и запись)

Y-положение позиции точки якоря фрейма карты. Единицы измерения задаются или считываются в единицах страницы.

Double
elementRotation
(чтение и запись)

Угол поворота фрейма карты в градусах Положительные значения поворачивают по часовой стрелке, а отрицательные – против часовой стрелки. Это угол поворота фрейма карты на компоновке, а не угол поворота данных. Воспользуйтесь свойством heading camera для поворота данных.

Double
elementWidth
(чтение и запись)

Ширина фрейма карты на компоновке страницы. Единицы измерения задаются или считываются в единицах страницы.

Double
locked
(чтение и запись)

Если установлено значение True, элемент нельзя выбрать графически в виде компоновки.

Boolean
map
(чтение и запись)

Карта, отображенная во фрейме карты.

Map
name
(чтение и запись)

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

String
time
(только чтение)

Возвращает объект MapTime, если во фрейме карты есть слои со включенным временем. Значение None возвращается, если во фрейме карты нет слоев со включенным временем.

Подсказка:

Метод enableTime класса Layer позволяет включить время на слое, содержащем информацию о времени и делает возможным доступ к свойствам LayerTime и MapTime.

MapTime
type
(только чтение)

Возвращает значение MAPFRAME_ELEMENT.

String
visible
(чтение и запись)

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

Boolean

Обзор метода

МетодОписание
addGrid (style_item)

Метод addGrid добавляет сетку к MapFrame с помощью элемента стиля.

convertGridToFeatures (grid_name, output_geodatabase, {new_grid_name})

Преобразует сетки или градусные сетки MapFrame в пространственные объекты базы геоданных.

createBookmark ({name}, {description})

Метод createBookmark создает закладку для карты, связанную с фреймом карты и использующую текущие настройки камеры.

export (export_format)

Метод export экспортирует MapFrame, используя указанный формат экспорта.

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

Экспортирует MapFrame в формат Adobe Illustrator Exchange (AIX). Файлы AIX можно использовать с дополнительным модулем ArcGIS Maps for Adobe Creative Cloud или Adobe Illustrator.

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

Экспортирует MapFrame в файл формата Microsoft Windows Bitmap (BMP).

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

Экспортирует MapFrame в файл формата Enhanced Metafile (EMF).

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

Экспортирует MapFrame в файл формата Encapsulated PostScript (EPS).

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

Экспортирует MapFrame в файл формата Graphic Interchange Format (GIF).

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

Экспортирует MapFrame в формат Joint Photographic Experts Group (JPEG).

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

Экспортирует MapFrame в файл Portable Document Format (PDF).

exportToPNG (out_png, {resolution}, {world_file}, {color_mode}, {embed_color_profile})

Экспортирует MapFrame в формат Portable Network Graphics (PNG).

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

Экспортирует MapFrame в файл формата Scalable Vector Graphics (SVG).

exportToTGA (out_tga, {resolution}, {world_file}, {color_mode})

Экспортирует MapFrame в файл формата Truevision Graphics Adapter (TGA).

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

Экспортирует MapFrame в Tagged Image File Format (TIFF).

getDefinition (cim_version)

Возвращает определение CIM элемента фрейма карты.

getLayerExtent (layer, {selection_only}, {symbolized_extent})

Возвращает экстент слоя для всех объектов или только выбранных объектов слоя.

panToExtent (extent)

Перемещает и центрирует фрейм карты MapFrame с использованием объекта Extent без изменения масштаба фрейма карты.

removeGrids ({wildcard})

Метод removeGrids удаляет одну или несколько сеток из фрейма карты.

setAnchor (anchor)

Метод setAnchor управляет положением якоря для элемента MapFrame.

setDefinition (definition_object)

Задает определение CIM элемента фрейма карты.

zoomToAllLayers ({selection_only}, {symbolized_extent})

Изменяет вид MapFrame, чтобы он соответствовал экстенту всех слоев или выбранных слоев карты.

zoomToBookmark (bookmark)

Изменяет вид MapFrame, чтобы он соответствовал информации об элементе, хранящейся вместе с пространственной закладкой.

Методы

addGrid (style_item)
ПараметрОписаниеТип данных
style_item

The reference to a grid StyleItem object using the listStyleItems method on the ArcGISProject class.

StyleItem

Метод addGridдобавляет сетку на самый верх, если сетки уже присутствуют. Чтобы изменить порядок отображения сеток на панели Содержание, сначала удалите все сетки посредством метода removeGrids. Затем добавьте их обратно, начиная с самой нижней сетки, используя метод addGrid, и продвигайтесь до самой верхней позиции.

convertGridToFeatures (grid_name, output_geodatabase, {new_grid_name})
ПараметрОписаниеТип данных
grid_name

The name of the grid or graticule the way it appears in the Contents pane.

String
output_geodatabase

The full path to a file geodatabase (*.gdb) or an enterprise geodatabase (*.sde) including the geodatabase name and extension.

String
new_grid_name

The new name of the group layer added to the map frame's map that will contain all the resulting feature layers. This value will also be added to the GridName field in each feature class table.

String

С фреймом карты может быть связано несколько сеток и градусных сеток. Каждую из них можно преобразовать в объект, если использовать уникальное значение new_grid_name. Если использовать одинаковые значения, объекты будут перезаписываться.

createBookmark ({name}, {description})
ПараметрОписаниеТип данных
name

An string that represents the name of the new bookmark. If a name is not provided, the default name will follow the sequencing nomenclature, for example, Bookmark, Bookmark [1], Bookmark [2].

String
description

A string that represents the bookmark's description. If not specified, the value is an empty string.

String
Возвращаемое значение
Тип данныхОписание
Bookmark

Объект bookmark.

Этот метод возвращает ссылку на новый класс bookmark. См. пример кода в разделе справки, посвященном классу Bookmark.

export (export_format)
ПараметрОписаниеТип данных
export_format

The supported export format objects are: AIXFormat, BMPFormat, EMFFormat, EPSFormat, GIFFormat, JPEGFormat, PDFFormat, PNGFormat, SVGFormat, TGAFormat and TIFFFormat.

Object

Чтобы узнать больше и получить примеры кода, перейдите к описанию конкретного формата экспорта.

exportToAIX (out_aix, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {jpeg_compression_quality}, {embed_fonts}, {embed_color_profile}, {convert_markers})
ПараметрОписаниеТип данных
out_aix

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.

  • BESTAn output image quality resample ratio of 1
  • BETTERAn output image quality resample ratio of 2
  • NORMALAn output image quality resample ratio of 3
  • FASTERAn output image quality resample ratio of 4
  • FASTESTAn 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.

  • ADAPTIVEAutomatically 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.
  • DEFLATEA lossless data compression.
  • JPEGA lossy data compression.
  • JPEG2000Offers higher quality compression with smaller file size than JPEG. This compression is lossless if jpeg_compression_quality is set to 100.
  • LZWLempel-Ziv-Welch, a lossless data compression.
  • NONECompression is not applied.
  • RLERun-length encoded compression.

(Значение по умолчанию — ADAPTIVE)

String
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
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
embed_color_profile

If set to True, color profile information is embedded in the image's metadata.

(Значение по умолчанию — True)

Boolean
convert_markers

A Boolean that controls the conversion of character-based marker symbols to polygons. This allows the symbols to appear correctly if the symbol font is not available or cannot be embedded. However, setting this parameter to True disables font embedding for all character-based marker symbols, which can result in a change in their appearance.

(Значение по умолчанию — False)

Boolean

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

exportToBMP (out_bmp, {resolution}, {world_file}, {bmp_color_mode}, {bmp_image_compression}, {embed_color_profile})
ПараметрОписаниеТип данных
out_bmp

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
world_file

If set to True, a georeferenced world file is created. The file contains pixel scale information and real-world coordinate information.

(Значение по умолчанию — False)

Boolean
bmp_color_mode

This value specifies the number of bits used to describe color.

  • 8-BIT_ADAPTIVE_PALETTE8-bit adaptive palette
  • 8-BIT_GRAYSCALE8-bit grayscale
  • 24-BIT_TRUE_COLOR24-bit true color

(Значение по умолчанию — 24-BIT_TRUE_COLOR)

String
bmp_image_compression

A string that specifies the compression scheme used to compress image or raster data in the output file. This option only applies to 8-bit bmp_color_mode options.

  • NONECompression is not applied.
  • RLERun-length encoded compression.

(Значение по умолчанию — NONE)

String
embed_color_profile

If set to True, color profile information is embedded in the image's metadata.

(Значение по умолчанию — True)

Boolean

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

exportToEMF (out_emf, {resolution}, {image_quality}, {output_as_image}, {convert_markers})
ПараметрОписаниеТип данных
out_emf

A string that represents the system 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
image_quality

A string that specifies output image quality, the draw resolution of map layers that draw as rasters.

  • BESTAn output image quality resample ratio of 1
  • BETTERAn output image quality resample ratio of 2
  • NORMALAn output image quality resample ratio of 3
  • FASTERAn output image quality resample ratio of 4
  • FASTESTAn output image quality resample ratio of 5

(Значение по умолчанию — BEST)

String
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
convert_markers

A Boolean that controls the conversion of character-based marker symbols to polygons. This allows the symbols to appear correctly if the symbol font is not available or cannot be embedded. However, setting this parameter to True disables font embedding for all character-based marker symbols, which can result in a change in their appearance.

(Значение по умолчанию — False)

Boolean

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

exportToEPS (out_eps, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image}, {convert_markers})
ПараметрОписаниеТип данных
out_eps

A string that represents the system 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
image_compression

A string that specifies the compression scheme used to compress image or raster data in the output file.

  • DEFLATEA lossless data compression.
  • LZWLempel-Ziv-Welch, a lossless data compression.
  • NONECompression is not applied.
  • RLERun-length encoded compression.

(Значение по умолчанию — DEFLATE)

String
image_quality

A string that specifies output image quality, the draw resolution of map layers that draw as rasters.

  • BESTAn output image quality resample ratio of 1.
  • BETTERAn output image quality resample ratio of 2.
  • NORMALAn output image quality resample ratio of 3.
  • FASTERAn output image quality resample ratio of 4.
  • FASTESTAn output image quality resample ratio of 5.

(Значение по умолчанию — BEST)

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
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
convert_markers

A Boolean that controls the conversion of character-based marker symbols to polygons. This allows the symbols to appear correctly if the symbol font is not available or cannot be embedded. However, setting this parameter to True disables font embedding for all character-based marker symbols, which can result in a change in their appearance.

(Значение по умолчанию — False)

Boolean

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

exportToGIF (out_gif, {resolution}, {world_file}, {gif_color_mode})
ПараметрОписаниеТип данных
out_gif

A string that represents the system 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
world_file

If set to True, a georeferenced world file is created. The file contains pixel scale information and real-world coordinate information.

(Значение по умолчанию — False)

Boolean
gif_color_mode

This value specifies the number of bits used to describe color.

  • 8-BIT_ADAPTIVE_PALETTE8-bit adaptive palette
  • 8-BIT_GRAYSCALE8-bit grayscale

(Значение по умолчанию — 8-BIT_ADAPTIVE_PALETTE)

String

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

exportToJPEG (out_jpg, {resolution}, {world_file}, {jpeg_color_mode}, {jpeg_quality}, {embed_color_profile})
ПараметрОписаниеТип данных
out_jpg

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).

(Значение по умолчанию — 96)

Integer
world_file

If set to True, a georeferenced world file is created. The file contains pixel scale information and real-world coordinate information. If you export a 3D map frame, this parameter will be ignored regardless of the setting because world files are not applicable to 3D views.

(Значение по умолчанию — False)

Boolean
jpeg_color_mode

This value specifies the number of bits used to describe color.

  • 8-BIT_GRAYSCALE8-bit grayscale
  • 24-BIT_TRUE_COLOR24-bit true color

(Значение по умолчанию — 24-BIT_TRUE_COLOR)

String
jpeg_quality

This value (0–100) controls the amount of compression applied to the output image. For 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
embed_color_profile

If set to True, color profile information is embedded in the image's metadata.

(Значение по умолчанию — True)

Boolean

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

exportToPDF (out_pdf, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality}, {output_as_image}, {embed_color_profile}, {convert_markers}, {simulate_overprint})
ПараметрОписаниеТип данных
out_pdf

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).

(Значение по умолчанию — 300)

Integer
image_quality

A string that defines the output image quality and the draw resolution of map layers that draw as rasters.

  • BESTAn output image quality resample ratio of 1
  • BETTERAn output image quality resample ratio of 2
  • NORMALAn output image quality resample ratio of 3
  • FASTERAn output image quality resample ratio of 4
  • FASTESTAn output image quality resample ratio of 5

(Значение по умолчанию — BEST)

String
compress_vector_graphics

A Boolean that controls the compression of vector and text portions of the output file. Image compression is defined separately.

(Значение по умолчанию — True)

Boolean
image_compression

A string that defines the compression scheme used to compress image or raster data in the output file.

  • ADAPTIVEAutomatically 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.
  • DEFLATEA lossless data compression.
  • JPEGA lossy data compression.
  • JPEG2000Offers higher quality compression with smaller file size than JPEG. This compression is lossless if jpeg_compression_quality is set to 100.
  • LZWLempel-Ziv-Welch, a lossless data compression.
  • NONECompression is not applied.
  • RLERun-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 controls the inclusion of PDF layers and PDF object data (attributes) in the export file.

  • LAYERS_ONLYExport PDF layers only.
  • LAYERS_AND_ATTRIBUTESExport PDF layers and feature attributes.
  • NONENo setting is applied.

(Значение по умолчанию — 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 the 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 70 through 90.

(Значение по умолчанию — 80)

Integer
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
convert_markers

A Boolean that controls the conversion of character-based marker symbols to polygons. This allows the symbols to appear correctly if the symbol font is not available or cannot be embedded. However, setting this parameter to True disables font embedding for all character-based marker symbols, which can result in a change in their appearance.

(Значение по умолчанию — False)

Boolean
simulate_overprint

Sometimes called soft proofing, simulating overprinting shows a representation of how overlapping areas of ink will appear when printed on a page. You set up overprinting on symbol layers.

(Значение по умолчанию — False)

Boolean

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

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

exportToPNG (out_png, {resolution}, {world_file}, {color_mode}, {embed_color_profile})
ПараметрОписаниеТип данных
out_png

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).

(Значение по умолчанию — 96)

Integer
world_file

If set to True, a georeferenced world file is created. The file contains pixel scale information and real-world coordinate information. If you export a 3D map frame, this parameter will be ignored regardless of the setting because world files are not applicable to 3D views.

(Значение по умолчанию — False)

Boolean
color_mode

This value specifies the number of bits used to describe color.

  • 8-BIT_ADAPTIVE_PALETTE8-bit adaptive palette
  • 8-BIT_GRAYSCALE8-bit grayscale
  • 24-BIT_TRUE_COLOR24-bit true color
  • 32-BIT_WITH_ALPHA32-bit with alpha

(Значение по умолчанию — 32-BIT_WITH_ALPHA)

String
embed_color_profile

If set to True, color profile information is embedded in the image's metadata.

(Значение по умолчанию — True)

Boolean

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

exportToSVG (out_svg, {resolution}, {compress_to_svgz}, {image_quality}, {embed_fonts}, {output_as_image}, {convert_markers})
ПараметрОписаниеТип данных
out_svg

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
compress_to_svgz

If set to True, the output is compressed.

(Значение по умолчанию — False)

Boolean
image_quality

A string that specifies output image quality, the draw resolution of map layers that draw as rasters.

  • BESTAn output image quality resample ratio of 1.
  • BETTERAn output image quality resample ratio of 2.
  • NORMALAn output image quality resample ratio of 3.
  • FASTERAn output image quality resample ratio of 4.
  • FASTESTAn output image quality resample ratio of 5.

(Значение по умолчанию — BEST)

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
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
convert_markers

A Boolean that controls the conversion of character-based marker symbols to polygons. This allows the symbols to appear correctly if the symbol font is not available or cannot be embedded. However, setting this parameter to True disables font embedding for all character-based marker symbols, which can result in a change in their appearance.

(Значение по умолчанию — False)

Boolean

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

exportToTGA (out_tga, {resolution}, {world_file}, {color_mode})
ПараметрОписаниеТип данных
out_tga

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
world_file

If set to True, a georeferenced world file is created. The file contains pixel scale information and real-world coordinate information.

(Значение по умолчанию — False)

Boolean
color_mode

This value specifies the number of bits used to describe color.

  • 8-BIT_ADAPTIVE_PALETTE8-bit adaptive palette
  • 8-BIT_GRAYSCALE8-bit grayscale
  • 24-BIT_TRUE_COLOR24-bit true color
  • 32-BIT_WITH_ALPHA32-bit with alpha

(Значение по умолчанию — 32-BIT_WITH_ALPHA)

String

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

exportToTIFF (out_tif, {resolution}, {world_file}, {color_mode}, {tiff_compression}, {geoTIFF_tags}, {jpeg_compression_quality}, {embed_color_profile})
ПараметрОписаниеТип данных
out_tif

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).

(Значение по умолчанию — 96)

Integer
world_file

If set to True, a georeferenced world file is created. The file contains pixel scale information and real-world coordinate information. If you export a 3D map frame, this parameter will be ignored regardless of the setting because world files are not applicable to 3D views.

(Значение по умолчанию — False)

Boolean
color_mode

This value specifies the number of bits used to describe color. The available options are dependent on the specified Color Model set in the layout's Color Management properties.

  • 8-BIT_ADAPTIVE_PALETTE8-bit adaptive palette. Available to RGB and CMYK.
  • 8-BIT_GRAYSCALE8-bit grayscale. Available to RGB and CMYK.
  • 24-BIT_TRUE_COLOR24-bit true color. Available only to RGB.
  • 32-BIT_WITH_ALPHA32-bit with alpha. Available only to RGB.
  • 32-BIT_CMYK_TRUE_COLOR32-bit CMYK true color. Available only to CMYK.
  • 40-BIT_CMYK_WITH_ALPHA40-bit CMYK with alpha. Available only to CMYK.

(Значение по умолчанию — 24-BIT_TRUE_COLOR)

String
tiff_compression

This value represents a compression scheme.

  • DEFLATEA lossless data compression.
  • JPEGJPEG compression.
  • LZWLempel-Ziv-Welch, a lossless data compression.
  • NONECompression is not applied.
  • PACK_BITSPack bits compression.

(Значение по умолчанию — LZW)

String
geoTIFF_tags

If set to True, georeferencing tags are included in the structure of the TIFF export file. The tags contain pixel scale information and real-world coordinate information. These tags can be read by applications that support GeoTIFF format.

(Значение по умолчанию — False)

Boolean
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
embed_color_profile

If set to True, color profile information is embedded in the image's metadata.

(Значение по умолчанию — True)

Boolean

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

getDefinition (cim_version)
ПараметрОписаниеТип данных
cim_version

A string that represents the major version of the CIM that will be used.

  • V2The 2.x version of the CIM will be used.
  • V3The 3.x version of the CIM will be used.
String
Возвращаемое значение
Тип данныхОписание
Object

Возвращает определение CIM для значения MapFrame.

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

getLayerExtent (layer, {selection_only}, {symbolized_extent})
ПараметрОписаниеТип данных
layer

Ссылка на объект Layer.

Layer
selection_only

Если имеет значение True, то возвращает экстент для выбранных объектов; в случае значения False возвращает экстент для всех объектов.

(Значение по умолчанию — True)

Boolean
symbolized_extent

При настройке Истина (True) возвращается символьный экстент; в противном случае возвращается геометрический экстент. Символьный экстент охватывает ту область, которую покрывают символы, так что он не выходит за границы фрейма данных.

(Значение по умолчанию — True)

Boolean
Возвращаемое значение
Тип данныхОписание
Extent

Объект геообработки Extent.

Метод getLayerExtent отдает предпочтение определяющему запросу слоя, так что, если запрашивается поднабор объектов, то метод вернет экстент только для этих объектов. Если выбранных объектов нет, будет возвращен экстент самого слоя.

panToExtent (extent)
ПараметрОписаниеТип данных
extent

Объект геообработки Extent.

Extent

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

removeGrids ({wildcard})
ПараметрОписаниеТип данных
wildcard

A wildcard is based on the grid or graticule name in the Contents pane and is not case sensitive. A combination of asterisks (*) and characters can be used to limit the resulting list.

(Значение по умолчанию — None)

String

Если значение wildcard не задано, из фрейма карты будут удалены все сетки. Если задано значение wildcard, все сетки, соответствующие его условию, будут удалены.

setAnchor (anchor)
ПараметрОписаниеТип данных
anchor

A string that specifies the location of the anchor position.

  • BOTTOM_LEFT_CORNERThe anchor will be set at the bottom left corner position.
  • BOTTOM_MID_POINTThe anchor will be set at the bottom center position.
  • BOTTOM_RIGHT_CORNERThe anchor will be set at the bottom right corner position.
  • CENTER_POINTThe anchor will be set at the center position.
  • LEFT_MID_POINTThe anchor will be set at the left center position.
  • RIGHT_MID_POINTThe anchor will be set at the right center position.
  • TOP_LEFT_CORNERThe anchor will be set at the top left corner position.
  • TOP_MID_POINTThe anchor will be set at the top center position.
  • TOP_RIGHT_CORNERThe anchor will be set at the top right corner position.
String

Задание положения якоря привязки полезно, поскольку с его помощью вы можете контролировать, как элемент будет расширяться при изменении размера. Например, положение якоря по умолчанию для элемента фрейма карты - BOTTOM_LEFT_CORNER. Если вы измените положение якоря на TOP_RIGHT_CORNER, изменение значения elementHeight приведет к расширению элемента вниз вместо расширения вверх (по умолчанию), а изменение значения elementWidth - к расширению элемента влево.

setDefinition (definition_object)
ПараметрОписаниеТип данных
definition_object

A modified CIM definition object originally retrieved using getDefinition.

Object

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

zoomToAllLayers ({selection_only}, {symbolized_extent})
ПараметрОписаниеТип данных
selection_only

Если имеет значение True, то устанавливает экстент на основе выбранных объектов; в случае значения False, устанавливает экстент для отображения всех объектов карты.

(Значение по умолчанию — True)

Boolean
symbolized_extent

При настройке Истина (True) возвращается символьный экстент; в противном случае возвращается геометрический экстент. Символьный экстент охватывает ту область, которую покрывают символы, так что он не выходит за границы фрейма данных карты.

(Значение по умолчанию — True)

Boolean

Если используется значение zoomToAllLayers для параметра MapFrame с глобальной или локальной сценой, то результатом будет планиметрический вид.

zoomToBookmark (bookmark)
ПараметрОписаниеТип данных
bookmark

Ссылка на объект Bookmark.

Bookmark

Если 3D-закладка используется для вида MapFrame, ссылающегося на 2D-вид Map, или наоборот, то результатом будет планиметрический вид.

Пример кода

MapFrame, пример 1

Следующий скрипт задает экстент фрейма карты различными способами и экспортирует каждый результат в PDF. Сначала задается экстент с помощью выборки объектов. Затем он приближается к экстенту одного слоя и применяется небольшой буфер. Наконец, он делает то же самое, но приближается экстент каждого объекта.

import arcpy, os
aprx = arcpy.mp.ArcGISProject(r'C:\Projects\GreatLakes\GreatLakes.aprx')

m = aprx.listMaps('Map')[0]
lyr = m.listLayers('GreatLakes')[0]
lyt = aprx.listLayouts('Layout')[0]
mf = lyt.listElements('mapframe_element', 'Map Frame')[0]

#Zoom to ALL selected features and export to PDF
arcpy.SelectLayerByAttribute_management(lyr, 'NEW_SELECTION', "NAME = 'Lake Superior'")
mf.zoomToAllLayers(True)
mf.exportToPDF(r'C:\Projects\GreatLakes\Selection.pdf')
arcpy.SelectLayerByAttribute_management(lyr, 'CLEAR_SELECTION')

#Set the map frame extent to the extent of a layer and export to PDF
mf.camera.setExtent(mf.getLayerExtent(lyr, False, True))
mf.camera.scale = mf.camera.scale * 1.1 #add a slight buffer
mf.exportToPDF(r'C:\Projects\GreatLakes\GreatLakesExtent.pdf')

#Set the map frame extent based on eash feature in a layer and export to PDF
for row in arcpy.da.SearchCursor(lyr, ['SHAPE@', 'NAME']):
    mf.camera.setExtent(row[0].extent)
    mf.camera.scale = mf.camera.scale * 1.1 #add a slight buffer
    mf.exportToPDF(os.path.join(r'C:\Projects\GreatLakes', f'{row[1]}.pdf'))
MapFrame, пример 2

В следующем скрипте импортируется MXD и 3DD документ в пустой проект. После ссылки на соответствующие элементы он заменяет каждую из 2D карт-врезок на 3D-сцены и применяет подходящую закладку к каждому фрейму карты. Наконец, вся компоновка экспортируется в PDF.

import arcpy
p = arcpy.mp.ArcGISProject(r'C:\Projects\Blank.aprx')

#Import documents into project
p.importDocument(r'C:\Projects\YosemiteNP\Documents\Yosemite.mxd')
p.importDocument(r'C:\Projects\YosemiteNP\Documents\Yosemite_3DViews.3dd')

#Reference maps
scene = p.listMaps('Globe layers')[0]

#Reference Layout and map frames
lyt = p.listLayouts()[0]
mainMF = lyt.listElements('MapFrame_Element', 'Yosemite National Park*')[0]
inset1MF = lyt.listElements('MapFrame_Element', 'Inset1*')[0]
inset2MF = lyt.listElements('MapFrame_Element', 'Inset2*')[0]

#Convert imported 2D insets into 3D views and zoom to bookmarks
mainMF.zoomToBookmark(mainMF.map.listBookmarks('Yosemite Valley')[0])

inset1MF.map = scene
inset1MF.zoomToBookmark(inset1MF.map.listBookmarks('Yosemite Yalley (looking East)')[0])

inset2MF.map = scene
inset2MF.zoomToBookmark(inset2MF.map.listBookmarks('Yosemite Valley (looking West)')[0])

#Export the resulting imported layout and changes to PDF
lyt.exportToPDF(r'C:\Projects\YosemiteNP\Example2_Export.pdf')
MapFrame, пример 3

В следующем скрипте демонстрируется, как можно создать фрейм карты, используя геометрию Polygon и геометрию Point.

p = arcpy.mp.ArcGISProject("CURRENT")

#Create a new map, layout
m = p.createMap('New Map', 'MAP')
lyt = p.createLayout(8.5, 11, 'INCH', 'New Layout')
lyt.openView()

#Create a new map frame using a polygon geometry
envCoordList = [[0.5, 5.75], [0.5, 10.5], [8, 10.5], [8, 5.75], [0.5, 5.75]]
envArray = arcpy.Array([arcpy.Point(*coords) for coords in envCoordList])
mf1 = lyt.createMapFrame(arcpy.Polygon(envArray), m, 'New MF - Poly')

#Create a new bookmark set to the map frame's default extent
bkmk = mf1.createBookmark('Default Extent', "The map's default extent")
bkmk.updateThumbnail()

#Create a new map frame using a point geometry
mf2 = lyt.createMapFrame(arcpy.Point(0.5,0.5), m, 'New MF - Point')
mf2.elementWidth = 7.5
mf2.elementHeight = 4.75
MapFrame, пример 4

В следующем скрипте показано, как можно использовать Python CIM Access для изменения символов границ каждого фрейма карты компоновки.

p = arcpy.mp.ArcGISProject('CURRENT')
lyt = p.listLayouts('Layout')[0]
lyt_cim = lyt.getDefinition('V3')
for elm in lyt_cim.elements:
    if type(elm).__name__ == 'CIMMapFrame':
        if elm.graphicFrame.borderSymbol.symbol.symbolLayers:
            sym = elm.graphicFrame.borderSymbol.symbol.symbolLayers[0]
            sym.width = 5
            sym.color.values = [255, 0, 0, 100]
        else:
            print(elm.name + ' has NO symbol layers')            
lyt.setDefinition(lyt_cim)