Skip To Content

Alphabetical list of arcpy.mp classes

The arcpy.mp classes provide access to various methods and properties for the different object types found within an ArcGIS Pro project or layer file. This document is intended to serve as a quick reference. For more specific information, use the links to jump to the individual help pages.

arcpy.mp classes

ArcGISProject

  • Methods
    • importDocument(document_path, {include_layout})
    • listBrokenDataSources()
    • listColorRamps({wildcard})
    • listLayouts({wildcard})
    • listMaps({wildcard})
    • save()
    • saveACopy(file_name)
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate})
  • Properties
    • activeMap—Read-only; Map object
    • dateSaved—Read-only; Python datetime object
    • defaultGeodatabase—Read/Write; String
    • defaultToolbox—Read/Write; String
    • documentVersion—Read-only; String
    • filePath—Read-only; String
    • homeFolder—Read/Write; String

Bookmark

  • Methods
    • updateThumbnail()
  • Properties
    • hasThumbnail—Read-only; Boolean
    • map—Read-only; Map object
    • name—Read/Write; String

Camera

  • Methods
    • getExtent()
    • setExtent(extent)
  • Properties
    • heading—Read/Write; Double
    • mode—Read/Write; String
    • pitch—Read/Write; Double
    • roll—Read/Write; Double
    • scale—Read/Write; Double
    • X—Read/Write; Double
    • Y—Read/Write; Double
    • Z—Read/Write; Double

ClassBreak

  • Properties
    • description—Read/Write; String
    • label—Read/Write; String
    • symbol—Read/Write; Symbol
    • upperBound—Read/Write; Double

ColorRamp

  • Properties
    • name—Read-only; String

GraduatedColorsRenderer

  • Properties
    • breakCount—Read/Write; Integer
    • classBreaks—Read/Write; List of ClassBreak objects
    • classificationField—Read/Write; String
    • classificationMethod—Read/Write; String
    • colorRamp—Read/Write; ColorRamp
    • deviationInterval—Read/Write; Double
    • intervalSize—Read/Write; Double
    • normalizationField—Read/Write; String
    • normalizationType—Read/Write; String
    • type—Read-only; String

GraduatedSymbolsRenderer

  • Methods
    • updateSymbolTemplate(symbol_template)
  • Properties
    • backgroundSymbol—Read/Write; Symbol
    • breakCount—Read/Write; Integer
    • classBreaks—Read/Write; List of ClassBreak objects
    • classificationField—Read/Write; String
    • classificationMethod—Read/Write; String
    • colorRamp—Read/Write; ColorRamp
    • deviationInterval—Read/Write; Double
    • intervalSize—Read/Write; Double
    • maximumSymbolSize—Read/Write; Double
    • minimumSymbolSize—Read/Write; Double
    • normalizationField—Read/Write; String
    • normalizationType—Read/Write; String
    • symbolTemplate—Read-only; Symbol
    • type—Read-only; String

GraphicElement

  • Methods
    • clone({suffix})
    • delete()
  • Properties
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • isGroup—Read-only; Boolean
    • name—Read/Write; String
    • type—Read-only; String
    • visible—Read/Write; Boolean

Item

  • Properties
    • description—Read/Write; String
    • label—Read/Write; String
    • symbol—Read/Write; Symbol
    • values—Read-only; List of values

ItemGroup

  • Properties
    • heading—Read/Write; String
    • items—Read/Write; List of Item or RasterItem objects

LabelClass

  • Properties
    • expression—Read/Write; String
    • name—Read/Write; String
    • SQLQuery—Read/Write; String
    • visible—Read/Write; Boolean

Layer

  • Methods
    • extrusion({extrusion_type}, {expression})
    • getSelectionSet()
    • listLabelClasses({wildcard})
    • listLayers({wildcard})
    • saveACopy(file_name)
    • setSelectionSet({oidList}, {method})
    • supports(layer_property)
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate})
    • updateLayerFromJSON(json_layer)
  • Properties
    • brightness—Read/Write; Long
    • connectionProperties—Read-only; Dictionary
    • contrast—Read/Write; Long
    • dataSource—Read-only; String
    • definitionQuery—Read/Write; String
    • is3DLayer—Read-only; Boolean
    • isBasemapLayer—Read-only; Boolean
    • isBroken—Read-only; Boolean
    • isFeatureLayer—Read-only; Boolean
    • isGroupLayer—Read-only; Boolean
    • isNetworkAnalystLayer—Read-only; Boolean
    • isNetworkDatasetLayer—Read-only; Boolean
    • isRasterLayer—Read-only; Boolean
    • isWebLayer—Read-only; Boolean
    • longName—Read-only; String
    • maxThreshold—Read/Write; Double
    • minTheshold—Read/Write; Double
    • name—Read/Write; String
    • showLabels—Read/Write; Boolean
    • symbology—Read/Write; Renderer object
    • transparency—Read/Write; Long
    • visible—Read/Write; Boolean

LayerFile

  • Methods
    • addLayer(add_layer_or_layerfile, {add_position})
    • addLayerToGroup(target_group_layer, add_layer_or_layerfile, {add_position})
    • insertLayer(reference_layer, insert_layer_or_layerfile, {insert_position})
    • listBrokenDataSources()
    • listLayers({wildcard})
    • moveLayer(reference_layer, move_layer, {insert_position})
    • removeLayer(remove_layer)
    • save()
    • saveACopy(file_name)
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate})
  • Properties
    • filePath—Read-only; String
    • version—Read-only; String

Layout

  • Methods
    • exportToBMP(out_bmp, {resolution})
    • exportToEMF(out_emf, {resolution})
    • exportToEPS(out_eps, {resolution})
    • exportToGIF(out_gif, {resolution})
    • exportToJPEG(out_jpg, {resolution}, {jpeg_color_mode}, {jpeg_quality})
    • exportToPDF(out_pdf, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality}, {clip_to_elements})
    • exportToPNG(out_png, {resolution}, {color_mode})
    • exportToSVG(out_svg, {resolution}, {compress_to_svgz})
    • exportToTGA(out_tga, {resolution})
    • exportToTIFF(out_tif, {resolution}, {color_mode}, {tiff_compression})
    • listElements({element_type}, {wildcard})
  • Properties
    • mapSeries—Read-only; MapSeries
    • name—Read/Write; String
    • pageHeight—Read/Write; Double
    • pageUnits—Read/Write; String
    • pageWidth—Read/Write; Double

LegendElement

  • Properties
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • mapFrame—Read/Write; MapFrame object
    • name—Read/Write; String
    • showTitle—Read/Write; Boolean
    • syncLayerOrder—Read/Write; Boolean
    • syncLayerVisbility—Read/Write; Boolean
    • syncNewLayer—Read/Write; Boolean
    • syncReferenceScale—Read/Write; Boolean
    • title—Read/Write; String
    • type—Read-only; String
    • visible—Read/Write; Boolean

Map

  • Methods
    • addBasemap(basemap_name)
    • addDataFromPath(data_path)
    • addLayer(add_layer_or_layerfile, {add_position})
    • addLayerToGroup(target_group_layer, add_layer_or_layerfile, {add_position})
    • addTable(add_table)
    • clearSelection()
    • insertLayer(reference_layer, insert_layer_or_layerfile, {insert_position})
    • listBookmarks({wildcard})
    • listBrokenDataSources()
    • listLayers({wildcard})
    • listTables({wildcard})
    • moveLayer(reference_layer, move_layer, {insert_position})
    • removeLayer(remove_layer)
    • removeTable(remove_table)
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate})
  • Properties
    • defaultCamera—Read/Write; Camera object
    • defaultView—Read-Only; MapView object
    • mapType—Read-only; String
    • mapUnits—Read/Write; String
    • name—Read/Write; String
    • referenceScale—Read/Write; Double

MapFrame

  • Methods
    • exportToBMP(out_bmp, {resolution})
    • exportToEMF(out_emf, {resolution})
    • exportToEPS(out_eps, {resolution})
    • exportToGIF(out_gif, {resolution})
    • exportToJPEG(out_jpg, {resolution}, {world_file}, {jpeg_color_mode}, {jpeg_quality})
    • exportToPDF(out_pdf, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality})
    • exportToPNG(out_png, {resolution}, {world_file}, {color_mode})
    • exportToSVG(out_svg, {resolution}, {compress_to_svgz})
    • exportToTGA(out_tga, {resolution})
    • exportToTIFF(out_tif, {resolution}, {world_file}, {color_mode}, {tiff_compression}, {geoTIFF_tags})
    • getLayerExtent(layer, {selection_only}, {symbolized_extent})
    • panToExtent(extent)
    • zoomToAllLayers({selection_only}, {symbolized_extent})
    • zoomToBookmark(bookmark)
  • Properties
    • camera—Read/Write; camera object
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • map—Read/Write; Map object
    • name—Read/Write; String
    • type—Read-only; String
    • visible—Read/Write; Boolean

MapSeries

  • Methods
    • exportToPDF(out_pdf, {page_range_type}, {page_range_string}, {multiple_files}, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality}, {clip_to_elements}, {show_selection_symbology})
    • getPageNumberFromName(page_name)
    • refresh()
  • Properties
    • currentPageNumber—Read/Write; Long
    • enabled—Read/Write; Boolean
    • indexLayer—Read-only; Layer object
    • MapFrame—Read-only; MapFrame object
    • pageCount—Read-only; Long
    • pageNameField—Read-only; GP Field object
    • selectedIndexFeatures—Read-only; Python list of corresponding page numbers

MapsurroundElement

  • Properties
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementWidth—Read/Write; Double
    • mapFrame—Read/Write; MapFrame object
    • name—Read/Write; String
    • type—Read-only; String
    • visible—Read/Write; Boolean

MapView

  • Methods
    • exportToEPS(out_eps, width, height, {resolution})
    • exportToGIF(out_gif, width, height, {resolution})
    • exportToJPEG(out_jpg, width, height, {resolution}, {world_file}, {jpeg_color_mode}, {jpeg_quality})
    • exportToPDF(out_pdf, width, height, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {embed_fonts}, {layers_attributes}, {georef_info}, {jpeg_compression_quality})
    • exportToPNG(out_png, width, height, {resolution}, {world_file}, {color_mode})
    • exportToSVG(out_svg, width, height, {resolution}, {compress_to_svgz})
    • exportToTIFF(out_tif, width, height, {resolution}, {world_file}, {color_mode}, {tiff_compression}, {geoTIFF_tags})
  • Properties
    • camera—Read/Write; camera object

PDFDocument

  • Methods
    • appendPages(pdf_path, {input_pdf_password})
    • deletePages(page_range)
    • insertPages(pdf_path, {before_page_number}, {input_pdf_password})
    • saveAndClose()
    • updateDocProperties({pdf_title}, {pdf_author}, {pdf_subject}, {pdf_keywords}, {pdf_open_view}, {pdf_layout})
    • updateDocSecurity(new_master_password, {new_user_password}, {encryption})
  • Properties
    • pageCount—Read-only; Long

PictureElement

  • Properties
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • name—Read/Write; String
    • sourceImage—Read/Write; String
    • type—Read-only; String
    • visible—Read/Write; Boolean

RasterClassBreak

  • Properties
    • color—Read/Write; Dictionary
    • description—Read/Write; String
    • label—Read/Write; String
    • upperBound—Read/Write; Double

RasterClassifyColorizer

  • Properties
    • breakCount—Read/Write; Long
    • classBreaks—Read/Write; List of RasterClassBreak objects
    • classificationField—Read/Write; String
    • classificationMethod—Read/Write; String
    • colorRamp—Read/Write; ColorRamp
    • noDataColor—Read/Write; Dictionary
    • type—Read-only; String

RasterItem

  • Properties
    • color—Read/Write; Dictionary
    • description—Read/Write; String
    • label—Read/Write; String
    • values—Read-only; List of values

RasterUniqueValueColorizer

  • Properties
    • colorRamp—Read/Write; ColorRamp
    • field—Read/Write; String
    • groups—Read/Write; List of ItemGroup objects
    • noDataColor—Read/Write; Dictionary
    • type—Read-only; String
    • useDefaultColor—Read/Write; Boolean

SimpleRenderer

  • Properties
    • description—Read/Write; String
    • label—Read/Write; String
    • symbol—Read/Write; Symbol
    • type—Read-only; String

Symbol

  • Methods
    • applySymbolFromGallery(wildcard, {index})
    • listSymbolsFromGallery({wildcard})
  • Properties
    • angle—Read/Write; Double
    • color—Read/Write; Dictionary
    • name—Read-only; String
    • outlineColor—Read/Write; Dictionary
    • size—Read/Write; Double
    • useRealWorldUnits—Read/Write; Boolean

Symbology

Table

  • Methods:
    • getSelectionSet()
    • setSelectionSet({oidList}, {method})
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate})
  • Properties
    • connectionProperties—Read-only; Dictionary
    • dataSource—Read-only; String
    • definitionQuery—Read/Write; String
    • isBroken—Read-only; Boolean
    • name—Read/Write; String

TextElement

  • Methods
    • clone({suffix})
    • delete()
  • Properties
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • name—Read/Write; String
    • text—Read/Write; String
    • textAngle—Read/Write; Double
    • textSize—Read/Write; Double
    • type—Read-only; String
    • visible—Read/Write; Boolean

UniqueValueRenderer

  • Methods
    • addValues(values_or_items)
    • listMissingValues()
    • removeValues(values_or_items)
  • Properties
    • colorRamp—Read/Write; ColorRamp
    • defaultSymbol—Read/Write; Symbol
    • fields—Read/Write; List of 1 or more Field objects
    • groups—Read/Write; List of ItemGroup objects
    • type—Read-only; String
    • useDefaultSymbol—Read/Write; Boolean

In this topic
  1. arcpy.mp classes