按字母顺序排序的 arcpy.mp 类列表

arcpy.mp 类可访问 ArcGIS Pro 工程或图层文件中不同对象类型的各种方法和属性。此文档可专门用作快速参考。有关详细信息，请使用链接跳转至各帮助页面。

arcpy.mp 类

ArcGISProject

• 方法
  • importDocument(document_path, {include_layout}, {reuse_existing_maps})
  • listBrokenDataSources()
  • listColorRamps({wildcard})
  • listLayouts({wildcard})
  • listMaps({wildcard})
  • listReports({wildcard})
  • save()
  • saveACopy(file_name)
  • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})
• 属性
  • activeMap- 只读、Map 对象
  • activeView - 只读；MapView、Layout 或 None 对象
  • dateSaved - 只读、Python 日期时间对象
  • defaultGeodatabase - 读/写、字符串型
  • defaultToolbox - 读/写、字符串型
  • documentVersion - 只读、字符串型
  • filePath - 只读、字符串型
  • homeFolder - 读/写、字符串型
  • metadata - 读/写、元数据

Bookmark

• 方法
  • updateThumbnail()
• 属性
  • hasThumbnail - 只读、布尔型
  • map- 只读、Map 对象
  • name - 读/写、字符串型

Camera

• 方法
  • getExtent()
  • setExtent(extent)
• 属性
  • heading - 读/写、双精度型
  • mode - 读/写、字符串型
  • pitch - 读/写、双精度型
  • roll - 读/写、双精度型
  • scale - 读/写、双精度型
  • X - 读/写、双精度型
  • Y - 读/写、双精度型
  • Z - 读/写、双精度型

ClassBreak

• 属性
  • description - 读/写、字符串型
  • label - 读/写、字符串型
  • symbol - 读/写、Symbol
  • upperBound - 读/写、双精度型

ColorRamp

• 属性
  • name - 只读、字符串型

GraduatedColorsRenderer

• 属性
  • breakCount - 读/写、整型
  • classBreaks - 读/写、ClassBreak 对象列表
  • classificationField - 读/写、字符串型
  • classificationMethod - 读/写、字符串型
  • colorRamp - 读/写、ColorRamp
  • deviationInterval - 读/写、双精度型
  • intervalSize - 读/写、双精度型
  • normalizationField - 读/写、字符串型
  • normalizationType - 读/写、字符串型
  • type - 只读、字符串型

GraduatedSymbolsRenderer

• 方法
  • updateSymbolTemplate(symbol_template)
• 属性
  • backgroundSymbol - 读/写、Symbol
  • breakCount - 读/写、整型
  • classBreaks - 读/写、ClassBreak 对象列表
  • classificationField - 读/写、字符串型
  • classificationMethod - 读/写、字符串型
  • colorRamp - 读/写、ColorRamp
  • deviationInterval - 读/写、双精度型
  • intervalSize - 读/写、双精度型
  • maximumSymbolSize - 读/写、双精度型
  • minimumSymbolSize - 读/写、双精度型
  • normalizationField - 读/写、字符串型
  • normalizationType - 读/写、字符串型
  • symbolTemplate - 只读、Symbol
  • type - 只读、字符串型

GraphicElement

• 方法
  • clone({suffix})
  • delete()
• 属性
  • elementHeight - 读/写、双精度型
  • elementPositionX - 读/写、双精度型
  • elementPositionY - 读/写、双精度型
  • elementRotation - 读/写、双精度型
  • elementWidth - 读/写、双精度型
  • isGroup - 只读、布尔型
  • name - 读/写、字符串型
  • type - 只读、字符串型
  • visible- 读/写、布尔型

Item

• 属性
  • description - 读/写、字符串型
  • label - 读/写、字符串型
  • symbol - 读/写、Symbol
  • values - 只读；值列表

ItemGroup

• 属性
  • heading - 读/写、字符串型
  • items - 读/写、Item 或 RasterItem 对象列表

LabelClass

• 属性
  • expression - 读/写、字符串型
  • name - 读/写、字符串型
  • SQLQuery - 读/写、字符串型
  • visible- 读/写、布尔型

图层

• 方法
  • extrusion({extrusion_type}, {expression})
  • getDefinition(cim_version)
  • getSelectionSet()
  • listLabelClasses({wildcard})
  • listLayers({wildcard})
  • saveACopy(file_name)
  • setDefinition(definition_object)
  • setSelectionSet({oidList}, {method})
  • supports(layer_property)
  • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})
  • updateLayerFromJSON(json_data)
• 属性
  • brightness- 读/写、长整型
  • connectionProperties - 只读、字典
  • contrast- 读/写、长整型
  • dataSource - 只读、字符串型
  • definitionQuery - 读/写、字符串型
  • is3DLayer - 只读、布尔型
  • isBasemapLayer - 只读、布尔型
  • isBroken - 只读、布尔型
  • isFeatureLayer - 只读、布尔型
  • isGroupLayer - 只读、布尔型
  • isNetworkAnalystLayer - 只读、布尔型
  • isNetworkDatasetLayer - 只读、布尔型
  • isRasterLayer - 只读、布尔型
  • isSceneLayer - 只读、布尔型
  • isWebLayer - 只读、布尔型
  • longName - 只读、字符串型
  • maxThreshold - 读/写、双精度型
  • metadata - 读/写、元数据
  • minTheshold - 读/写、双精度型
  • name - 读/写、字符串型
  • showLabels- 读/写、布尔型
  • symbology - 读/写、Renderer 对象
  • transparency- 读/写、长整型
  • visible- 读/写、布尔型

LayerFile

• 方法
  • 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}, {ignore_case})
• 属性
  • filePath - 只读、字符串型
  • metadata - 读/写、元数据
  • version - 只读、字符串型

Layout

• 方法
  • 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}, )
  • 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})
  • exportToEPS(out_eps, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image}, {clip_to_elements})
  • 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})
  • 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})
  • 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})
  • setDefinition(definition_object)
• 属性
  • mapSeries - 只读、MapSeries
  • metadata - 读/写、元数据
  • name - 读/写、字符串型
  • pageHeight - 读/写、双精度型
  • pageUnits - 读/写、字符串型
  • pageWidth - 读/写、双精度型

LegendElement

• 方法
  • addItem(layer, {add_position})
  • moveLayer(reference_item, move_item, {move_position})
  • removeLayer(remove_item)
• 属性
  • columnCount- 读/写、长整型
  • elementHeight - 读/写、双精度型
  • elementPositionX - 读/写、双精度型
  • elementPositionY - 读/写、双精度型
  • elementRotation - 读/写、双精度型
  • elementWidth - 读/写、双精度型
  • fittingStrategy - 读/写、字符串型
  • items - 只读、LegendItem 对象列表
  • mapFrame - 读/写、MapFrame 对象
  • name - 读/写、字符串型
  • showTitle- 读/写、布尔型
  • syncLayerOrder- 读/写、布尔型
  • syncLayerVisbility- 读/写、布尔型
  • syncNewLayer- 读/写、布尔型
  • syncReferenceScale- 读/写、布尔型
  • title - 读/写、字符串型
  • type - 只读、字符串型
  • visible- 读/写、布尔型

LegendItem

• 属性
  • arrangement - 读/写、字符串型
  • column- 读/写、长整型
  • name - 只读、字符串型
  • patchHeight - 读/写、双精度型
  • patchWidth - 读/写、双精度型
  • showFeatureCount- 读/写、布尔型
  • showVisibleFeatures- 读/写、布尔型
  • type - 只读、字符串型
  • visible- 读/写、布尔型

Map

• 方法
  • 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()
  • exportToMAPX(out_mapx)
  • getDefinition(cim_version)
  • getWebLayerSharingDraft(server_type, service_type, service_name, {layers_and_tables})
  • 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)
  • setDefinition(definition_object)
  • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})
• 属性
  • defaultCamera - 读/写、Camera 对象
  • defaultView - 只读、MapView 对象
  • mapType - 只读、字符串型
  • mapUnits - 读/写、字符串型
  • metadata - 读/写、元数据
  • name - 读/写、字符串型
  • referenceScale - 读/写、双精度型
  • spatialReference - 读/写、SpatialReference 对象

MapFrame

• 方法
  • exportToAIX(out_aix, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {jpeg_compression_quality}, {embed_fonts}, {embed_color_profile})
  • exportToBMP(out_bmp, {resolution}, {world_file}, {bmp_color_mode}, {bmp_image_compression}, {embed_color_profile})
  • exportToEMF(out_emf, {resolution}, {image_quality}, {output_as_image})
  • exportToEPS(out_eps, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image})
  • 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})
  • 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})
  • 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})
  • getLayerExtent(layer, {selection_only}, {symbolized_extent})
  • panToExtent(extent)
  • zoomToAllLayers({selection_only}, {symbolized_extent})
  • zoomToBookmark(bookmark)
• 属性
  • camera - 读/写、camera 对象
  • elementHeight - 读/写、双精度型
  • elementPositionX - 读/写、双精度型
  • elementPositionY - 读/写、双精度型
  • elementRotation - 读/写、双精度型
  • elementWidth - 读/写、双精度型
  • map - 读/写、Map 对象
  • name - 读/写、字符串型
  • type - 只读、字符串型
  • visible- 读/写、布尔型

MapSeries

• 方法
  • 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})
  • getPageNumberFromName(page_name)
  • refresh()
• 属性
  • currentPageNumber - 读/写、长整型
  • enabled- 读/写、布尔型
  • indexLayer - 只读、Layer 对象
  • mapFrame - 只读；MapFrame 对象
  • pageCount - 只读、长整型
  • pageNameField - 只读、GP Field 对象
  • pageRow - 只读；行
  • selectedIndexFeatures - 只读、Python 相应的页码列表

MapsurroundElement

• 属性
  • elementHeight - 读/写、双精度型
  • elementPositionX - 读/写、双精度型
  • elementPositionY - 读/写、双精度型
  • elementWidth - 读/写、双精度型
  • mapFrame - 读/写、MapFrame 对象
  • name - 读/写、字符串型
  • type - 只读、字符串型
  • visible- 读/写、布尔型

MapView

• 方法
  • exportToAIX(out_aix, width, height, {resolution}, {image_quality}, {compress_vector_graphics}, {image_compression}, {jpeg_compression_quality}, {embed_fonts}, {embed_color_profile})
  • 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})
  • exportToEPS(out_eps, width, height, {resolution}, {image_compression}, {image_quality}, {embed_fonts}, {output_as_image})
  • 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})
  • exportToPNG(out_png, width, height, {resolution}, {world_file}, {color_mode}, {embed_color_profile})
  • exportToSVG(out_svg, width, height, {resolution}, {compress_to_svgz}, {image_quality}, {embed_fonts}, {output_as_image})
  • 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)
• 属性
  • camera - 读/写、camera 对象
  • map- 只读、Map 对象

PDFDocument

• 方法
  • 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})
• 属性
  • pageCount- 只读、长整型

PictureElement

• 属性
  • elementHeight - 读/写、双精度型
  • elementPositionX - 读/写、双精度型
  • elementPositionY - 读/写、双精度型
  • elementRotation - 读/写、双精度型
  • elementWidth - 读/写、双精度型
  • name - 读/写、字符串型
  • sourceImage - 读/写、字符串型
  • type - 只读、字符串型
  • visible- 读/写、布尔型

RasterClassBreak

• 属性
  • color- 读/写、字典
  • description - 读/写、字符串型
  • label - 读/写、字符串型
  • upperBound - 读/写、双精度型

RasterClassifyColorizer

• 属性
  • breakCount- 读/写、长整型
  • classBreaks - 读/写、RasterClassBreak 对象列表
  • classificationField - 读/写、字符串型
  • classificationMethod - 读/写、字符串型
  • colorRamp - 读/写、ColorRamp
  • noDataColor- 读/写、字典
  • type - 只读、字符串型

RasterItem

• 属性
  • color- 读/写、字典
  • description - 读/写、字符串型
  • label - 读/写、字符串型
  • values - 只读；值列表

RasterStretchColorizer

• 属性
  • band- 读/写、长整型
  • colorRamp - 读/写、ColorRamp
  • gamma - 读/写、双精度型
  • invertColorRamp- 读/写、布尔型
  • maxLabel - 读/写、字符串型
  • maxPercent - 读/写、双精度型
  • minLabel - 读/写、字符串型
  • minPercent - 读/写、双精度型
  • standardDeviation - 读/写、双精度型
  • stretchType - 读/写、字符串型
  • type - 只读、字符串型

RasterUniqueValueColorizer

• 属性
  • colorRamp - 读/写、ColorRamp
  • field - 读/写、字符串型
  • groups - 读/写、ItemGroup 对象列表
  • noDataColor- 读/写、字典
  • type - 只读、字符串型
  • useDefaultColor- 读/写、布尔型

Report

• 方法
  • 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})
  • setReferenceDataSource(data_source)
• 属性
  • definitionQuery - 读/写、字符串型
  • metadata - 读/写、元数据
  • name - 读/写、字符串型
  • referenceDataSource - 只读、字典

SimpleRenderer

• 属性
  • description - 读/写、字符串型
  • label - 读/写、字符串型
  • symbol - 读/写、Symbol
  • type - 只读、字符串型

Symbol

• 方法
  • applySymbolFromGallery(wildcard, {index})
  • listSymbolsFromGallery({wildcard})
• 属性
  • angle - 读/写、双精度型
  • color- 读/写、字典
  • name - 只读、字符串型
  • outlineColor- 读/写、字典
  • size - 读/写、双精度型
  • useRealWorldUnits- 读/写、布尔型

Symbology

• 方法
  • updateColorizer(colorizer_name)
  • updateRenderer(renderer_name)
• 属性
  • colorizer - 只读、RasterClassifyColorizer、RasterUniqueValueColorizer
  • renderer - 只读、GraduatedColorsRenderer、GraduatedSymbolsRenderer、SimpleRenderer 或 UniqueValueRenderer

表

• 方法：
  • getDefinition(cim_version)
  • getSelectionSet()
  • setDefinition(definition_object)
  • setSelectionSet({oidList}, {method})
  • updateConnectionProperties(current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})

• 属性
  • connectionProperties - 只读、字典
  • dataSource - 只读、字符串型
  • definitionQuery - 读/写、字符串型
  • isBroken - 只读、布尔型
  • metadata - 读/写、元数据
  • name - 读/写、字符串型

TextElement

• 方法
  • clone({suffix})
  • delete()
• 属性
  • elementHeight - 读/写、双精度型
  • elementPositionX - 读/写、双精度型
  • elementPositionY - 读/写、双精度型
  • elementRotation - 读/写、双精度型
  • elementWidth - 读/写、双精度型
  • name - 读/写、字符串型
  • text - 读/写、字符串型
  • textAngle - 读/写、双精度型
  • textSize - 读/写、双精度型
  • type - 只读、字符串型
  • visible- 读/写、布尔型

UnclassedColorsRenderer

• 方法
  • updateSymbolTemplate(symbol_template)
• 属性
  • colorRamp - 读/写、ColorRamp
  • expression - 读/写、字符串型
  • field - 读/写、字符串型
  • lowerLabel - 读/写、字符串型
  • normalizationField - 读/写、字符串型
  • symbolTemplate - 只读、Symbol
  • type - 只读、字符串型
  • upperLabel - 读/写、字符串型

UniqueValueRenderer

• 方法
  • addValues(values_or_items)
  • listMissingValues()
  • removeValues(values_or_items)
• 属性
  • colorRamp - 读/写、ColorRamp
  • defaultSymbol - 读/写、Symbol
  • fields - 读/写、1 个或多个 Field 对象列表
  • groups - 读/写、ItemGroup 对象列表
  • type - 只读、字符串型
  • useDefaultSymbol- 读/写、布尔型