Back to Top

Alphabetical list of arcpy.mp classes

In this topic

  1. arcpy.mp classes

The arcpy.mp classes provide access to various methods and properties for the different object types found within an ArcGIS AllSource 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

AIXFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • convertMarkers—Read/Write; Boolean, Default : False
    • embedColorProfile—Read/Write; Boolean, Default : True
    • embedFonts—Read/Write; Boolean, Default : True
    • filePath—Read/Write; String
    • height—Read/Write; Double, Default : 960
    • imageCompression—Read/Write; String, Default : ADAPTIVE
    • imageCompressionQuality—Read/Write; Long, Default : 80
    • imageQuality—Read/Write; String, Default : BEST
    • removeLayoutBackground—Read/Write; Boolean, Default : False
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • width—Read/Write; Double, Default : 960
  • Methods
    • setImageCompression(image_compression)
    • setImageQuality(image_quality)

ArcGISProject

  • Properties
    • activeMap—Read-only; Map object
    • activeView—Read-only; MapView, Layout, Report object
    • databases—Read-only; List of Python dictionaries
    • dateSaved—Read-only; Datetime
    • defaultGeodatabase—Read/Write; String
    • defaultToolbox—Read/Write; String
    • documentVersion—Read-only; String
    • filePath—Read-only; String
    • folderConnections—Read-only; List of Python dictionaries
    • homeFolder—Read/Write; String
    • isReadOnly—Read-only; Boolean
    • metadata—Read/Write; Metadata
    • styles—Read-only; List of Python strings
    • toolboxes—Read-only; List of Python dictionaries
  • Methods
    • closeViews({view_type})
    • copyItem(project_item, {new_name})
    • createGraphicElement(container, geometry, {style_item}, {name}, {lock_aspect_ratio})
    • createGroupElement(container, element_list, {name})
    • createLayout(page_width, page_height, page_units, {name})
    • createMap({name}, {map_type})
    • createPictureElement(container, geometry, path, {name}, {lock_aspect_ratio})
    • createPreDefinedGraphicElement(container, geometry, shape_type, {style_item}, {name}, {lock_aspect_ratio})
    • createReport(page_info, data_source, {fields}, {statistics}, {name})
    • createTextElement(container, geometry, text_type, text, {text_size}, {font_family_name}, {font_style_name}, {style_item}, {name}, {lock_aspect_ratio})
    • deleteItem(project_item)
    • importDocument(document_path, {include_layout}, {reuse_existing_maps}, {log_files})
    • listBasemaps({wildcard})
    • listBrokenDataSources()
    • listColorRamps({wildcard})
    • listLayouts({wildcard})
    • listMaps({wildcard})
    • listReports({wildcard})
    • listStyleItems(style, {style_class}, {wildcard})
    • save()
    • saveACopy(file_name)
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})
    • updateDatabases(databases, {validate})
    • updateFolderConnections(folder_connections, {validate})
    • updateStyles(styles)
    • updateToolboxes(toolboxes, {validate})

BMPFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • colorMode—Read/Write; String, Default : 24-BIT_TRUE_COLOR
    • filePath—Read/Write; String
    • georeferenceMapFrame—Read/Write; MapFrame object, Default : None
    • height—Read/Write; Double, Default : 960
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • threshold—Read/Write; Long, Default : 128
    • width—Read/Write; Double, Default : 960
    • worldFile—Read/Write; Boolean, Default : False
  • Methods
    • setColorMode(color_mode)

Bookmark

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

BookmarkMapSeries

  • Methods
    • export(export_format, {mapseries_export_options})
    • 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}, {output_as_image}, {embed_color_profile}, {pdf_accessibility}, {show_export_count}, {keep_layout_background}, {convert_markers}, {simulate_overprint})
    • getDefinition(cim_version)
    • getPageNumberFromName(page_name)
    • refresh()
    • setDefinition(definition_object)
  • Properties
    • bookmarks—Read/Write; List of Bookmark objects
    • currentBookmark—Read-only; Bookmark object
    • currentPageNumber—Read/Write; Long
    • enabled—Read/Write; Boolean
    • mapFrame—Read/Write; MapFrame object
    • pageCount—Read-only; Long

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

ElevationSource

  • Properties
    • dataSource—Read-only; String
    • name—Read/Write; String
    • visible—Read/Write; Boolean

ElevationSurface

  • Methods
    • listElevationSources({wildcard})
  • Properties
    • name—Read/Write; String
    • verticalExaggeration—Read/Write; Double

EMFFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • convertMarkers—Read/Write; Boolean, Default : False
    • filePath—Read/Write; String
    • height—Read/Write; Double, Default : 960
    • imageQuality—Read/Write; String, Default : BEST
    • outputAsImage—Read/Write; Boolean, Default : False
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • width—Read/Write; Double, Default : 960
  • Methods
    • setImageQuality(image_quality)

EPSFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • convertMarkers—Read/Write; Boolean, Default : False
    • embedFonts—Read/Write; Boolean, Default : True
    • filePath—Read/Write; String
    • height—Read/Write; Double, Default : 960
    • imageCompression—Read/Write; String, Default : ADAPTIVE
    • imageQuality—Read/Write; String, Default : BEST
    • outputAsImage—Read/Write; Boolean, Default : False
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • width—Read/Write; Double, Default : 960
  • Methods
    • setImageCompression(image_compression)
    • setImageQuality(image_quality)

GIFFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • colorMode—Read/Write; String, Default : 8-BIT_ADAPTIVE_PALETTE
    • filePath—Read/Write; String
    • georeferenceMapFrame—Read/Write; MapFrame object, Default : None
    • height—Read/Write; Double, Default : 960
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • threshold—Read/Write; Long, Default : 128
    • width—Read/Write; Double, Default : 960
    • worldFile—Read/Write; Boolean, Default : False
  • Methods
    • setColorMode(color_mode)

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
    • lowerBound—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
    • lowerBound—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
    • applyStyleItem(style_item)
    • clone({suffix})
    • delete()
    • getDefinition(cim_version)
    • setAnchor(anchor)
    • setDefinition(definition_object)
  • Properties
    • anchor—Read-only; String
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • isGroup—Read-only; Boolean
    • locked—Read/Write; Boolean
    • longName—Read/Write; String
    • name—Read/Write; String
    • parentGroupElement—Read-only; GroupElement
    • type—Read-only; String
    • visible—Read/Write; Boolean

GroupElement

  • Methods
    • getDefinition(cim_version)
    • setAnchor(anchor)
    • setDefinition(definition_object)
    • ungroupElements()
  • Properties
    • anchor—Read-only; String
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elements—Read-only; List of elements
    • elementWidth—Read/Write; Double
    • isGroup—Read-only; Boolean
    • locked—Read/Write; Boolean
    • longName—Read/Write; String
    • name—Read/Write; String
    • parentGroupElement—Read-only; GroupElement
    • 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

JPEGFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • colorMode—Read/Write; String, Default : 8-BIT_ADAPTIVE_PALETTE
    • filePath—Read/Write; String
    • georeferenceMapFrame—Read/Write; MapFrame object, Default : None
    • height—Read/Write; Double, Default : 960
    • imageCompressionQuality
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • threshold—Read/Write; Long, Default : 128
    • width—Read/Write; Double, Default : 960
    • worldFile—Read/Write; Boolean, Default : False
  • Methods
    • setColorMode(color_mode)

LabelClass

  • Methods
    • getDefinition(cim_version)
    • setDefinition(definition_object)
  • Properties
    • expression—Read/Write; String
    • name—Read/Write; String
    • SQLQuery—Read/Write; String
    • visible—Read/Write; Boolean

Layer

  • Methods
    • createLabelClass(name, expression, {sql_query}, {labelclass_language})
    • disableTime()
    • enableTime({startTimeField}, {endTimeField}, {autoCalculateTimeRange}, {timeDimension})
    • extrusion({extrusion_type}, {expression})
    • getDefinition(cim_version)
    • getSelectionSet()
    • listDefinitionQueries({wildcard})
    • listLabelClasses({wildcard})
    • listLayers({wildcard})
    • listTables({wildcard})
    • openTableView({show_selected})
    • pasteProperties(source_layer, {layer_paste_properties})
    • saveACopy(file_name)
    • setDefinition(definition_object)
    • setGroupType(group_type)
    • setPageQuery({field_name}, {match})
    • setSelectionSet({oidList}, {method})
    • supports(layer_property)
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})
    • updateDefinitionQueries(definitionQueries)
    • updateLayerFromJSON(json_data)
  • Properties
    • brightness—Read/Write; Long
    • connectionProperties—Read-only; Dictionary
    • contrast—Read/Write; Long
    • dataSource—Read-only; String
    • definitionQuery—Read/Write; String
    • groupType—Read-only; String
    • is3DLayer—Read-only; Boolean
    • isBasemapLayer—Read-only; Boolean
    • isBroken—Read-only; Boolean
    • isFeatureLayer—Read-only; Boolean
    • isGraphicsLayer—Read-only; Boolean
    • isGroupLayer—Read-only; Boolean
    • isNetworkAnalystLayer—Read-only; Boolean
    • isNetworkDatasetLayer—Read-only; Boolean
    • isPacelFabricLayer—Read-only; Boolean
    • isRasterLayer—Read-only; Boolean
    • isSceneLayer—Read-only; Boolean
    • isTimeEnabled—Read-only; Boolean
    • isWebLayer—Read-only; Boolean
    • longName—Read-only; String
    • maxThreshold—Read/Write; Double
    • metadata—Read/Write; Metadata
    • minTheshold—Read/Write; Double
    • name—Read/Write; String
    • pageQuery—Read-only; named Tuple
    • showLabels—Read/Write; Boolean
    • symbology—Read/Write; Renderer object
    • time—Read-only; LayerTime object
    • transparency—Read/Write; Long
    • URI—Read-only; Boolean
    • 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})
    • listTables({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}, {ignore_case})
  • Properties
    • filePath—Read-only; String
    • metadata—Read/Write; Metadata
    • version—Read-only; String

LayerTime

  • Properties
    • daylightSavings—Read/Write; Boolean
    • endTime—Read/Write; DateTime
    • endTimeField—Read/Write; String
    • startTime—Read/Write; DateTime
    • startTimeField—Read/Write; String
    • timeDimension—Read/Write; String
    • timeFormat—Read/Write; String
    • timeOffset—Read/Write; Double
    • timeOffsetUnits—Read/Write; String
    • timeStepInterval—Read/Write; Double
    • timeStepIntervalUnits—Read/Write; String
    • timeZone—Read/Write; String
    • timeZoneIANA—Read/Write; String

Layout

  • Methods
    • changePageSize(page_width, page_height, {resize_elements})
    • createBookmarkMapSeries(mapframe, {bookmarks})
    • createMapFrame(geometry, {map}, {name})
    • createMapSurroundElement(geometry, {map_surround_type}, {mapframe}, {style_Item}, {name})
    • createSpatialMapSeries(mapframe, index_layer, name_field, {sort_field})
    • createTableFrameElement(geometry, {mapframe}, {table}, {fields}, {style_item}, {name})
    • deleteElement(element)
    • export(export_format)
    • 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}, {convert_markers})
    • exportToBMP(out_bmp, {resolution}, {bmp_color_mode}, {bmp_image_compression}, {embed_color_profile}, {clip_to_elements})
    • exportToEMF(out_emf, {resolution}, {image_quality}, {output_as_image}, {clip_to_elements}, {convert_markers})
    • exportToEPS(out_eps, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image}, {clip_to_elements}, {convert_markers})
    • exportToGIF(out_gif, {resolution}, {gif_color_mode}, {clip_to_elements})
    • exportToJPEG(out_jpg, {resolution}, {jpeg_color_mode}, {jpeg_quality}, {embed_color_profile}, {clip_to_elements})
    • 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}, {pdf_accessibility}, {keep_layout_background}, {convert_markers}, {simulate_overprint})
    • exportToPNG(out_png, {resolution}, {color_mode}, {transparent_background}, {embed_color_profile}, {clip_to_elements})
    • exportToSVG(out_svg, {resolution}, {compress_to_svgz}, {image_quality}, {embed_fonts}, {output_as_image}, {clip_to_elements}, {convert_markers})
    • exportToTGA(out_tga, {resolution}, {color_mode}, {transparent_background}, {clip_to_elements})
    • 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})
    • getDefinition(cim_version)
    • listElements({element_type}, {wildcard})
    • openView()
    • setDefinition(definition_object)
  • Properties
    • mapSeries—Read-only; MapSeries or BookmarkMapSeries
    • metadata—Read/Write; Metadata
    • name—Read/Write; String
    • pageHeight—Read/Write; Double
    • pageUnits—Read/Write; String
    • pageWidth—Read/Write; Double
    • URI—Read-only; Boolean

LegendElement

  • Methods
    • addItem(layer, {add_position})
    • applyStyleItem(style_item)
    • getDefinition(cim_version)
    • moveItem(reference_item, move_item, {move_position})
    • removeItem(remove_item)
    • setAnchor(anchor)
    • setDefinition(definition_object)
  • Properties
    • anchor—Read-only; String
    • columnCount—Read/Write; Long
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • fittingStrategy—Read/Write; String
    • items—Read-only; List of LegendItem objects
    • locked—Read/Write; Boolean
    • longName—Read/Write; String
    • mapFrame—Read/Write; MapFrame object
    • name—Read/Write; String
    • parentGroupElement—Read-only; GroupElement
    • 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

LegendItem

  • Methods
    • applyStyleItem(style_item)
  • Properties
    • arrangement—Read/Write; String
    • column—Read/Write; Long
    • name—Read-only; String
    • patchHeight—Read/Write; Double
    • patchWidth—Read/Write; Double
    • showFeatureCount—Read/Write; Boolean
    • showVisibleFeatures—Read/Write; Boolean
    • type—Read-only; String
    • visible—Read/Write; Boolean

Map

  • Methods
    • addBasemap(basemap_name)
    • addDataFromPath(data_path, {web_service_type}, {custom_parameters})
    • addLayer(add_layer_or_layerfile, {add_position})
    • addLayerToGroup(target_group_layer, add_layer_or_layerfile, {add_position})
    • addTable(add_table)
    • addTableToGroup(target_group_layer, add_table)
    • clearSelection()
    • clipLayers(clip_object, {selection})
    • copyBookmark(bookmark, {name})
    • createGraphicsLayer({name})
    • createGroupLayer(name, {group_layer})
    • exportBookmarks(out_bkmx)
    • exportToMAPX(out_mapx)
    • getDefinition(cim_version)
    • getWebLayerSharingDraft(server_type, service_type, service_name, {layers_and_tables})
    • importBookmarks(bkmx_path)
    • insertLayer(reference_layer, insert_layer_or_layerfile, {insert_position})
    • listBookmarks({wildcard})
    • listBrokenDataSources()
    • listElevationSources({wildcard})
    • listLayers({wildcard})
    • listTables({wildcard})
    • moveLayer(reference_layer, move_layer, {insert_position})
    • openView()
    • removeBookmark(remove_bookmark)
    • removeLayer(remove_layer)
    • removeTable(remove_table)
    • setDefinition(definition_object)
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})
    • updateTransformations(transformations)
  • Properties
    • defaultCamera—Read/Write; Camera object
    • defaultView—Read-Only; MapView object
    • excludedLayersFromClipping—Read/Write; List
    • mapType—Read-only; String
    • mapUnits—Read/Write; String
    • metadata—Read/Write; Metadata
    • name—Read/Write; String
    • referenceScale—Read/Write; Double
    • spatialReference—Read/Write; SpatialReference object
    • transformations—Read-Only; Dictionary
    • URI—Read-only; Boolean

MapFrame

  • Methods
    • addGrid(style_item)
    • convertGridToFeatures(grid_name, output_geodatabase, {new_grid_name})
    • createBookmark({name}, {description})
    • export(export_format)
    • exportToAIX(out_aix, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {jpeg_compression_quality}, {embed_fonts}, {embed_color_profile}, {convert_markers})
    • exportToBMP(out_bmp, {resolution}, {world_file}, {bmp_color_mode}, {bmp_image_compression}, {embed_color_profile})
    • exportToEMF(out_emf, {resolution}, {image_quality}, {output_as_image}, {convert_markers})
    • exportToEPS(out_eps, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image}, {convert_markers})
    • exportToGIF(out_gif, {resolution}, {world_file}, {gif_color_mode})
    • exportToJPEG(out_jpg, {resolution}, {world_file}, {jpeg_color_mode}, {jpeg_quality}, {embed_color_profile})
    • 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})
    • exportToPNG(out_png, {resolution}, {world_file}, {color_mode}, {embed_color_profile})
    • exportToSVG(out_svg, {resolution}, {compress_to_svgz}, {image_quality}, {embed_fonts}, {output_as_image}, {convert_markers})
    • exportToTGA(out_tga, {resolution}, {world_file}, {color_mode})
    • exportToTIFF(out_tif, {resolution}, {world_file}, {color_mode}, {tiff_compression}, {geoTIFF_tags}, {jpeg_compression_quality}, {embed_color_profile})
    • getDefinition(cim_version)
    • getLayerExtent(layer, {selection_only}, {symbolized_extent})
    • panToExtent(extent)
    • removeGrids({wildcard})
    • setAnchor(anchor)
    • setDefinition(definition_object)
    • zoomToAllLayers({selection_only}, {symbolized_extent})
    • zoomToBookmark(bookmark)
  • Properties
    • anchor—Read-only; String
    • 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
    • locked—Read/Write; Boolean
    • longName—Read/Write; String
    • map—Read/Write; Map object
    • name—Read/Write; String
    • parentGroupElement—Read-only; GroupElement
    • time—Read-only; MapTime object
    • type—Read-only; String
    • visible—Read/Write; Boolean

MapSeries

  • Methods
    • export(export_format, {mapseries_export_options})
    • 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}, {output_as_image}, {embed_color_profile}, {pdf_accessibility}, {show_export_count}, {convert_markers})
    • getDefinition(cim_version)
    • getPageNumberFromName(page_name)
    • refresh()
    • setDefinition(definition_object)
  • Properties
    • clipToIndexFeature—Read/Write; Boolean
    • 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
    • pageRow—Read-only; Row
    • selectedIndexFeatures—Read-only; Python list of corresponding page numbers

MapSeriesExportOptions

  • Methods
    • setExportFileOptions(export_file_options)
    • setExportPages(export_pages)
  • Properties
    • customPages—Read/Write; String
    • exportFileOptions—Read-only; String
    • exportPages—Read-only; String
    • showExportCount—Read/Write; Boolean

MapsurroundElement

  • Methods
    • applyStyleItem(style_item)
    • getDefinition(cim_version)
    • setAnchor(anchor)
    • setDefinition(definition_object)
  • Properties
    • anchor—Read-only; String
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • locked—Read/Write; Boolean
    • longName—Read/Write; String
    • mapFrame—Read/Write; MapFrame object
    • name—Read/Write; String
    • parentGroupElement—Read-only; GroupElement
    • type—Read-only; String
    • visible—Read/Write; Boolean

MapTime

  • Methods
    • setTimeInclusion(time_inclusion)
    • timeStep(reference_time, interval, interval_units)
  • Properties
    • currentTimeEnd—Read/Write; DateTime
    • currentTimeSpan—Read-only; Double
    • currentTimeSpanUnits—Read-only; String
    • currentTimeStart—Read/Write; DateTime
    • isTimeEnabled—Read/Write; Boolean
    • timeIncludsion—Read-only; String
    • timeStepInterval—Read-only; Double
    • timeStepIntervalUnits—Read-only; String

MapView

  • Methods
    • createBookmark({name}, {description})
    • export(export_format)
    • exportToAIX(out_aix, width, height, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {jpeg_compression_quality}, {embed_fonts}, {embed_color_profile}, {convert_markers})
    • exportToBMP(out_bmp, width, height, {resolution}, {world_file}, {bmp_color_mode}, {bmp_image_compression}, {embed_color_profile})
    • exportToEMF(out_emf, width, height, {resolution}, {image_quality}, {output_as_image}, {convert_markers})
    • exportToEPS(out_eps, width, height, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image}, {convert_markers})
    • exportToGIF(out_gif, width, height, {resolution}, {world_file}, {gif_color_mode})
    • exportToJPEG(out_jpg, width, height, {resolution}, {world_file}, {jpeg_color_mode}, {jpeg_quality}, {embed_color_profile})
    • exportToPDF(out_pdf, width, height, {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})
    • exportToPNG(out_png, width, height, {resolution}, {world_file}, {color_mode}, {embed_color_profile}, {transparent_background})
    • exportToSVG(out_svg, width, height, {resolution}, {compress_to_svgz}, {image_quality}, {embed_fonts}, {output_as_image}, {convert_markers})
    • exportToTIFF(out_tif, width, height, {resolution}, {world_file}, {color_mode}, {tiff_compression}, {geoTIFF_tags}, {jpeg_compression_quality}, {embed_color_profile})
    • exportToTGA(out_tga, width, height, {resolution}, {world_file}, {color_mode})
    • getLayerExtent(layer, {selection_only}, {symbolized_extent})
    • panToExtent(extent)
    • zoomToAllLayers({selection_only}, {symbolized_extent})
    • zoomToBookmark(bookmark)
  • Properties
    • camera—Read/Write; camera object
    • map—Read-only; Map 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}, {permissions})
  • Properties
    • pageCount—Read-only; Long

PDFFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • compressVectorGraphics—Read/Write; Boolean, Default : True
    • convertMarkers—Read/Write; Boolean, Default : False
    • embedColorProfile—Read/Write; Boolean, Default : True
    • embedFonts—Read/Write; Boolean, Default : True
    • filePath—Read/Write; String
    • georefInfo—Read/Write; Boolean, Default : True
    • height—Read/Write; Double, Default : 960
    • imageCompression—Read/Write; String, Default : ADAPTIVE
    • imageCompressionQuality—Read/Write; Long, Default : 80
    • imageQuality—Read/Write; String, Default : BEST
    • includeAccessibilityTags—Read/Write; Boolean, Default : False
    • includeNonVisibleMapLayers—Read/Write; Boolean, Default : False
    • layersAndAttributes—Read/Write; String, Default : LAYERS_ONLY
    • outputAsImage—Read/Write; Boolean, Default : False
    • removeLayoutBackground—Read/Write; Boolean, Default : False
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • simulateOverprint—Read/Write; Boolean, Default : False
    • width—Read/Write; Double, Default : 960
  • Methods
    • setImageCompression(image_compression)
    • setImageQuality(image_quality)
    • setLayersAndAttributes(layers_attributes)

PictureElement

  • Methods
    • getDefinition(cim_version)
    • setAnchor(anchor)
    • setDefinition(definition_object)
  • Properties
    • anchor—Read-only; String
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • locked—Read/Write; Boolean
    • longName—Read/Write; String
    • name—Read/Write; String
    • parentGroupElement—Read-only; GroupElement
    • sourceImage—Read/Write; String
    • type—Read-only; String
    • visible—Read/Write; Boolean

PNGFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • colorMode—Read/Write; String, Default : 24-BIT_TRUE_COLOR
    • filePath—Read/Write; String
    • georeferenceMapFrame—Read/Write; MapFrame object, Default : None
    • height—Read/Write; Double, Default : 960
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • threshold—Read/Write; Long, Default : 128
    • transparentBackground—Read/Write; Boolean, Default : False
    • width—Read/Write; Double, Default : 960
    • worldFile—Read/Write; Boolean, Default : False
  • Methods
    • setColorMode(color_mode)

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

RasterStretchColorizer

  • Properties
    • band—Read/Write; Long
    • colorRamp—Read/Write; ColorRamp
    • gamma—Read/Write; Double
    • invertColorRamp—Read/Write; Boolean
    • maxLabel—Read/Write; String
    • maxPercent—Read/Write; Double
    • minLabel—Read/Write; String
    • minPercent—Read/Write; Double
    • standardDeviation—Read/Write; Double
    • stretchType—Read/Write; String
    • type—Read-only; String

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

Report

  • Methods
    • export(export_format, {report_export_options})
    • exportToPDF(out_pdf, {page_range_type}, {page_range}, {starting_page_number}, {total_page_number}, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression},{embed_fonts}, {jpeg_compression_quality}, {embed_color_profile}, {pdf_accessibility}, {convert_markers}, {simulate_overprint})
    • getDefinition(cim_version)
    • listSections({wildcard})
    • openView()
    • setDefinition(definition_object)
    • setReferenceDataSource(data_source)
  • Properties
    • definitionQuery—Read/Write; String
    • metadata—Read/Write; Metadata
    • name—Read/Write; String
    • referenceDataSource—Read-only; Dictionary

ReportExportOptions

  • Methods
    • setExportPages(export_pages)
  • Properties
    • customPages—Read/Write; String
    • exportPages—Read-only; String
    • startingPageNumberLabelOffset—Read/Write; Integer
    • totalPageNumberOverride—Read/Write; Integer

ReportLayoutSection

  • Properties
    • name—Read/Write; String
    • type—Read-only; String
    • visible—Read/Write; Boolean
    • URI—Read/Write; String

ReportSection

  • Methods
    • setReferenceDataSource(data_source)
    • setRelatedReportSource (related_report_data_source, related_report_section_name, relate_or_relationship_class_name)
  • Properties
    • definitionQuery—Read/Write; String
    • fields—Read/Write; List
    • name—Read-only; String
    • referenceDataSource—Read-only; Dictionary
    • statistics—Read/Write; List
    • type—Read-only; String
    • visible—Read/Write; Boolean

SimpleRenderer

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

StyleItem

  • Properties
    • category—Read-only; String
    • name—Read-only; String
    • style—Read-only; String
    • styleClass—Read-only; String
    • tags—Read-only; String

SVGFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • compressToSVGZ—Read/Write; Boolean, Default : False
    • convertMarkers—Read/Write; Boolean, Default : False
    • embedFonts—Read/Write; Boolean, Default : True
    • filePath—Read/Write; String
    • height—Read/Write; Double, Default : 960
    • imageQuality—Read/Write; String, Default : BEST
    • includeNonVisibleMapLayers—Read/Write; Boolean, Default : False
    • outputAsImage—Read/Write; Boolean, Default : False
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • width—Read/Write; Double, Default : 960
  • Methods
    • setImageQuality(image_quality)

Symbol

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

Symbology

  • Methods
    • updateColorizer(colorizer_name)
    • updateRenderer(renderer_name)
  • Properties
    • colorizer—Read-only; RasterClassifyColorizer, RasterUniqueValueColorizer
    • renderer—Read-only; GraduatedColorsRenderer, GraduatedSymbolsRenderer, SimpleRenderer, or UniqueValueRenderer

Table

  • Methods:
    • disableTime()
    • enableTime({startTimeField}, {endTimeField}, {autoCalculateTimeRange}, {timeDimension})
    • getDefinition(cim_version)
    • getSelectionSet()
    • listDefinitionQueries({wildcard})
    • openTableView({show_selected})
    • pasteProperties(source_table, {table_paste_properties})
    • saveACopy(file_name)
    • setDefinition(definition_object)
    • setSelectionSet({oidList}, {method})
    • time—Read-only; LayerTime object
    • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})
    • updateDefinitionQueries(definitionQueries)
  • Properties
    • connectionProperties—Read-only; Dictionary
    • dataSource—Read-only; String
    • definitionQuery—Read/Write; String
    • isBroken—Read-only; Boolean
    • isTimeEnabled—Read-only; Boolean
    • longName—Read-only; String
    • metadata—Read/Write; Metadata
    • name—Read/Write; String
    • time—Read-only; LayerTime
    • URI—Read-only; Boolean

TableFrameElement

  • Methods
    • applyStyleItem(style_item)
    • getDefinition(cim_version)
    • setAnchor(anchor)
    • setDefinition(definition_object)
    • setQuery(query_rows)
    • sortFields(field_info)
  • Properties
    • anchor—Read-only; String
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementWidth—Read/Write; Double
    • fields—Read/Write; List of field names
    • locked—Read/Write; Boolean
    • longName—Read/Write; String
    • mapFrame—Read/Write; MapFrame object
    • name—Read/Write; String
    • parentGroupElement—Read-only; GroupElement
    • query—Read-only; String
    • table—Read/Write; Layer or Table object
    • type—Read-only; String
    • visible—Read/Write; Boolean

TextElement

  • Methods
    • applyStyleItem(style_item)
    • clone({suffix})
    • delete()
    • getDefinition(cim_version)
    • setAnchor(anchor)
    • setDefinition(definition_object)
  • Properties
    • anchor—Read-only; String
    • elementHeight—Read/Write; Double
    • elementPositionX—Read/Write; Double
    • elementPositionY—Read/Write; Double
    • elementRotation—Read/Write; Double
    • elementWidth—Read/Write; Double
    • fontFamilyName—Read/Write; String
    • fontStyleName—Read/Write; String
    • isOverflowing—Read-only; Boolean
    • locked—Read/Write; Boolean
    • longName—Read/Write; String
    • name—Read/Write; String
    • parentGroupElement—Read-only; GroupElement
    • text—Read/Write; String
    • textAngle—Read/Write; Double
    • textSize—Read/Write; Double
    • type—Read-only; String
    • visible—Read/Write; Boolean

TGAFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • colorMode—Read/Write; String, Default : 32-BIT_WITH_ALPHA
    • filePath—Read/Write; String
    • height—Read/Write; Double, Default : 960
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • transparentBackground—Read/Write; Boolean, Default : False
    • width—Read/Write; Double, Default : 960
  • Methods
    • setColorMode(color_mode)

TIFFFormat

  • Properties
    • clipToElements—Read/Write; Boolean, Default : False
    • colorMode—Read/Write; String, Default : 24-BIT_TRUE_COLOR
    • embedColorProfile—Read/Write; Boolean, Default : True
    • filePath—Read/Write; String
    • georeferenceMapFrame—Read/Write; MapFrame object, Default : None
    • geoTIFFTags—Read/Write; Boolean, Default : False
    • height—Read/Write; Double, Default : 960
    • imageCompression—Read/Write; String, Default : LZW
    • imageCompressionQuality—Read/Write; Long, Default : 100
    • resolution—Read/Write; Boolean, Double : 96
    • showSelectionSymbology—Read/Write; Boolean, Default : False
    • threshold—Read/Write; Long, Default : 128
    • transparentBackground—Read/Write; Boolean, Default : False
    • width—Read/Write; Double, Default : 960
    • worldFile—Read/Write; Boolean, Default : False
  • Methods
    • setColorMode(color_mode)
    • setImageCompression(image_compression)

UnclassedColorsRenderer

  • Methods
    • updateSymbolTemplate(symbol_template)
  • Properties
    • colorRamp—Read/Write; ColorRamp
    • expression—Read/Write; String
    • field—Read/Write; String
    • lowerLabel—Read/Write; String
    • normalizationField—Read/Write; String
    • symbolTemplate—Read-only; Symbol
    • type—Read-only; String
    • upperLabel—Read/Write; String

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

Feedback on this topic?

In this topic
  1. arcpy.mp classes