setExportFileOptions

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

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

Обсуждение

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

Функцию CreateExportOptions можно использовать для создания объекта MapSeriesExportOptions, если параметру class_type присвоено значение MAPSERIES. Возвращаемый объект содержит все свойства, необходимые для настройки способа экспорта серий карт.

Примечание:

В настоящее время объекты серии карт можно экспортировать только в JPEGFormat, PNGFormat, PDFFormat и TIFFFormat.

Синтаксис

setExportFileOptions()

Свойства

Имя	Объяснение	Тип данных
customPages (Чтение / Запись)	Строка, идентифицирующая страницы серии карт, которые необходимо экспортировать, если свойство `exportPages` имеет значение `CUSTOM`. Например, следующая строка экспортирует 5 страниц: 1, 3, 5-7. Значение по умолчанию - пустая строка.	String
exportFileOptions (Только для чтения)	Строковая константа, представляющая способ экспорта страниц. Чтобы изменить это значение, используйте метод `setFileExportOptions`. Значение по умолчанию равно `PDF_SINGLE_FILE`. PDF_MULTIPLE_FILES_PAGE_NAME—Выполните экспорт каждой страницы серии карт в отдельный файл и прибавьте к имени файла название страницы. Например, Output.PDF станет Output_LakeErie.PDF. PDF_MULTIPLE_FILES_PAGE_NUMBER—Выполните экспорт каждой страницы серии карт в отдельный файл и прибавьте к имени файла номер страницы. Например, Output.PDF станет Output_1.PDF. PDF_SINGLE_FILE—Выполните экспорт всех страниц в один многостраничный файловый документ.	String
exportPages (Только для чтения)	Строковая константа, представляющая коллекцию страниц серии карт, которые необходимо экспортировать. Чтобы изменить это значение, используйте метод `setExportPages`. Значение по умолчанию равно `ALL`. ALL—Экспортировать все страницы в серии карт. CURRENT—Экспорт только активной страницы. Эта опция применяется только при запуске скрипта внутри приложения. CUSTOM—Экспортируйте пользовательский набор страниц, заданный в свойстве `customPages`. SELECTED_INDEX_FEATURES—Экспортируйте только те страницы серии карт, которые соответствуют выбранным индексным объектам, связанным с серией карт.	String
showExportCount (Чтение / Запись)	Если установлено значение True, вы увидите статус каждой экспортируемой страницы, отображаемый в Python shell. Значение по умолчанию равно `False`.	Boolean

Методы

`setExportFileOptions(export_file_options)`

Строковая константа, представляющая способ экспорта страниц.

Имя	Объяснение	Тип данных
export_file_options	MULTIPLE_FILES_PAGE_NAME—Export each map series page to an individual file and append the page name to the file name. For example, Output.PDF will become Output_LakeErie.PDF. MULTIPLE_FILES_PAGE_NUMBER—Export each map series page to an individual file and append the page number to the file name. For example, Output.PDF will become Output_1.PDF. PDF_SINGLE_FILE—Export all pages into a multipage, single file document. (Значение по умолчанию — PDF_SINGLE_FILE)	String

Имя

Объяснение

Тип данных

export_file_options

MULTIPLE_FILES_PAGE_NAME—Export each map series page to an individual file and append the page name to the file name. For example, Output.PDF will become Output_LakeErie.PDF.
MULTIPLE_FILES_PAGE_NUMBER—Export each map series page to an individual file and append the page number to the file name. For example, Output.PDF will become Output_1.PDF.
PDF_SINGLE_FILE—Export all pages into a multipage, single file document.

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

String

`setExportPages(export_pages)`

Строковая константа, представляющая коллекцию страниц серии карт, которые необходимо экспортировать.

Имя	Объяснение	Тип данных
export_pages	ALL— Export all pages in the map series. CURRENT— Export the currently active page. This option only applies when running a script inside the application. CUSTOM—Export a custom set of pages that is defined using the `customPages` property. SELECTED_INDEX_FEATURES—Only export map series pages that correspond to the selected index features associated with the map series.	String

Пример кода

Пример MapSeriesExportOptions

Следующий скрипт экспортирует объект MapSeries, используя свойства PDFFormat по умолчанию, но настраивает MapSeriesExportOptions для экспорта пользовательского набора страниц серии карт.

p = arcpy.mp.ArcGISProject('current')
l = p.listLayouts('Layout_MS')[0]
ms = l.mapSeries

pdf = arcpy.mp.CreateExportFormat('PDF', r'c:\temp\MS_PDF.pdf')

msExOpt = arcpy.mp.CreateExportOptions('MAPSERIES')
msExOpt.setExportPages('CUSTOM')
msExOpt.customPages = '1-3'

ms.export(pdf, msExOpt)