PubPy User Guide

PubPy has a number of methods for creating GeoPDFs, plus a few supporting objects. Here we will explain each, describe their many options, and provide samples of their usage. The section includes a summary of the available methods and objects and provides details about additional PubPy resources.

In this section:

Available Methods and Objects

• geopdf_export 
  • api 
    • DDP(mxd_path) 
      • exportToGeoPDF(geopdf_path, page_range_type, page_range_string, multiple_files, show_selection_symbology, export_config)
      • getPageIDFromName()
      • refresh()
      • setCurrentPageID()
    • ExportGeoPDFConfig() 
      • archive()
      • dearchive()
    • ExportMXDToGeoPDF(mxd_path, geopdf_path)
    • ExportToGeoPDF(map_document, out_geopdf, {data_frame}, {df_export_width}, {df_export_height}, {resolution}, {image_quality}, {colorspace}, {compress_vectors}, {image_compression}, {picture_symbol}, {convert_markers}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality})
    • ExportToGeoPDFWithConfig(map_document, geopdf_path, config)
    • GeoPDFLayerSchemeHelper() 
      • attach(mxd_path, {source_scheme})
      • save()
      • saveAs(mxd_path, {version})

Export GeoPDF Methods 

ExportMXDToGeoPDF

Export a pre-configured MXD to GeoPDF file format. The export configuration is stored in the MXD.

Usage:

ExportMXDToGeoPDF(mxd_path, geopdf_path)

Parameters:

ExportToGeoPDF

Exports the page layout or data frame of a map document ( .mxd ) to the Portable Document Format (PDF). This function is, so far as possible, a substitute for arcpy.mapping.ExportToPDF(). Not all ExportToPDF() options are supported.

Usage:

ExportToGeoPDF(map_document, out_geopdf, {data_frame}, {df_export_width}, {df_export_height}, {resolution}, {image_quality}, {colorspace}, {compress_vectors}, {image_compression}, {picture_symbol}, {convert_markers}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality})

Parameters:

ExportToGeoPDFWithConfig

Exports a MapDocument to GeoPDF, reading export configuration from an ExportGeoPDFConfig object.

Usage:

ExportToGeoPDFWithConfig(map_document, geopdf_path, config)

Parameters:

Data Driven Pages

Class DDP

DDP is a class to configure and generate data driven pages. You can use it just like the ArcPy class arcpy.mapping.MapDocument.dataDrivenPages. To create an instance of DDP you must pass a path to valid map document (.mxd).

Usage:

class DDP(mxd_path)

Instance variables:

DDP.exportToGeoPDF

Exports a specified set of pages to a multipage GeoPDF document for a map document (.mxd) that has Data Driven Pages enabled.

Usage:

DDP.exportToGeoPDF(geopdf_path, page_range_type, page_range_string, multiple_files,show_selection_symbology, export_config)

Parameters:

DDP.getPageIDFromName

A passthrough method to arcpy.mapping.MapDocument.dataDrivenPages.getPageIDFromName()

Usage:

DDP.getPageIDFromName(page_name)

Parameters:

DDP.refresh

A passthrough method to arcpy.mapping.MapDocument.dataDrivenPages.getPageIDFromName()

Usage:

DDP.refresh()

DDP.setCurrentPageID

Sets the current page from its ID.

Usage:

DDP.setCurrentPageID(page_id)

Parameters:

Advanced Export Configuration

class ExportGeoPDFConfig()

Stores export configuration information for GeoPDF export as instance variables. Instance variables listed below. Many correspond to ExportToPDF() and ExportToGeoPDF() options. These override any options persisted to the document. If an option is set to None here, the option will be read from the document if present. If not persisted in the document, then the preferences file will be read. If there is no preference, the exporter default will be used.

Usage:

class ExportGeoPDFConfig()

Instance variables:

GeoPDFLayerSchemeHelper 

class GeoPDFLayerSchemeHelper()

Supports editing a MapDocument's custom GeoPDF layer scheme. GeoPDF layer schemes are a representation of a PDF's Layers pane, which is a tree structure composed of menu, group and layer nodes. Menu nodes are items that can be expanded and collapsed but do not control the visibility of their contents. Group nodes are similar but control the visibility of their contents. Layer nodes only control visibility. Menu nodes can contain menu, group and layer child nodes. Group nodes can contain group and layer child nodes. All node types have names. Only layer nodes contain references to MapDocument content.  

Returns the MapDocument's custom layer scheme as a list of dicts. Each dict is a node at the root of the custom layer scheme. Each dict minimally contains the keys 'type' and 'name'. The 'type' value is one of 'MENU', 'GROUP or 'LAYER'. The remaining keys of the dict differ by type. Menu and group nodes have a 'children' key. The value of this key is a list of dicts in the same format as the root of the custom layer scheme. Group and layer nodes have a 'visible' key. The value of this key is a boolean. Layer nodes have a 'content' key. The value is a list of dicts, each dict describing a content item. Content item dicts have 'type' and 'tag' keys. The type value is either 'SIMPLE' or 'ANNOGROUP'. The tag value is a delimited text string that is unique to each component of the MapDocument. 

The MapDocument's PageLayout represent the document page. The PageLayout's content is a tree structure composed of elements. Most elements are simple, but one type is complex the MapFrame element. One of the subelements of a MapFrame element is a Map. The Map contains layers, which themselves form a tree. Tags represent paths in the PageLayout element tree. The paths are constructed of labels delimited by ':' characters. Because many elements in this tree are often unnamed and duplicate names are possible, labels are generated based component type and position. The elements at the root level are labeled 'elem_0', 'elem_1', and so on. If an element is a group element, its children are labeled 'elem_0', 'elem_1', and so on. Layers in a map follow a similar pattern, 'layer_n'. A full specification is not presented. Dumping the default layer scheme is a viable way of learning the system.

GeoPDFLayerSchemeHelper.attach()

Attach this class instance to a MapDocument and optionally load its custom or default layer scheme into the instance layer scheme.

Usage:

GeoPDFLayerSchemeHelper.attach(mxd_path, {source_scheme})

Parameters:

GeoPDFLayerSchemeHelper.save()

Save the layer scheme to the MXD. This action replaces the document's custom layer scheme with the current layer scheme.

GeoPDFLayerSchemeHelper.saveAs()

Save the layer scheme to a different MXD, optionally specifying the ArcGIS version. The saved document's custom layer scheme will be the current layer scheme.

Usage:

GeoPDFLayerSchemeHelper.saveAs(mxd_path, {version})

Parameters:

More Resources

There are currently two sample scripts/tools on our GitHub site:

1. A command-line utility that creates a GeoPDF given a path to an MXD and an output file name: https://github.com/GeoPDF/pub4server_samples/blob/master/MXD2GeoPDF.py
2. A geoprocessing service that will take the current state of a web map and generate a GeoPDF: https://github.com/GeoPDF/pub4server_samples/tree/master/WebMap2GeoPDF