【282】◀▶ arcpy.mapping 常用函数说明

01 mapping.ListDataFrames 返回单个地图文档中存在的 DataFrame 对象的列表。

02 mapping.AddLayer 将图层添加到地图文档 (.mxd) 内的数据框中。

03 mapping.RemoveLayer 可用于移除地图文档 (.mxd) 中数据框内的图层。

04 mapping.InsertLayer 用于将图层插入到地图文档 (.mxd) 的特定位置处。

05 mapping.MoveLayer 用于将图层移动到地图文档 (.mxd) 的特定位置处。

06 mapping.ListLayers 返回一个 Python 列表，地图文档 (.mxd) 中的层。

07 mapping.UpdateLayers 更新地图文档 (.mxd) 中所有图层属性或仅更新图层的符号系统。(可以引用目标图层的样式)

08 mapping.AddLayerToGroup 将图层添加到 group layer 中。

09 mapping.ListLayoutElements 返回地图文档 (.mxd) 布局中布局元素的 Python 列表。

10 mapping.ExportToJPEG 将地图文档 (.mxd) 的页面布局导出到 (JPEG) 格式。

1	`---------------`

序号

函数名称

功能说明

语法 & 举例

mapping.ListDataFrames

====<<<< Description >>>>====

返回单个地图文档 (.mxd) 中存在的 DataFrame 对象的 Python 列表。
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.ListDataFrames (map_document, {wildcard})

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈ map_document：一个引用 MapDocument 对象的变量。
◈ wildcard：可以使用星号 (*) 和字符的组合来限制结果。(默认值为无)

====<<<< Returns >>>>====

◈ DataFrame (数据类型)：DataFrame 对象的 Python 列表。

mapping.AddLayer

====<<<< Description >>>>====

用于使用简易放置选项将图层添加到地图文档 (.mxd) 内的数据框中。
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.AddLayer (data_frame, add_layer, {add_position})

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈ data_frame：一个包含现有地图文档 (.mxd) 的完整路径和文件名的字符串，或者包含关键字 CURRENT 的字符串。
◈ add_layer：对表示要添加的层的层对象的引用。这个引用可以指向磁盘上的一个层文件或者地图文档中的一个层。
◈ add_position：一个常量，它决定了数据框架中添加的图层的位置。AUTO_ARRANGE/BOTTOM/TOP

import arcpy
mxd = arcpy.mapping.MapDocument(r"C:\Project\Project.mxd")
df = arcpy.mapping.ListDataFrames(mxd, "New Data Frame")[0]
addLayer = arcpy.mapping.Layer(r"C:\Project\Data\Orthophoto.lyr")
arcpy.mapping.AddLayer(df, addLayer, "BOTTOM")
mxd.saveACopy(r"C:\Project\Project2.mxd")
del mxd, addLayer

mapping.RemoveLayer

====<<<< Description >>>>====

可用于移除地图文档 (.mxd) 中数据框内的图层。
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.RemoveLayer (data_frame, remove_layer)

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈ data_frame：一个包含现有地图文档 (.mxd) 的完整路径和文件名的字符串，或者包含关键字 CURRENT 的字符串。
◈ remove_layer：需要移除的图层。

mapping.InsertLayer

====<<<< Description >>>>====

可用于将图层插入到数据框或地图文档 (.mxd) 中的图层组内的特定位置处。（原图层不变）
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.InsertLayer (data_frame, reference_layer, insert_layer, {insert_position})

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈ reference_layer：参考图层。
◈ insert_layer：欲插入的图层。
◈ insert_position：插入的位置，BEFORE 为之前、AFTER 为之后。（默认值为 BEFORE）

mapping.MoveLayer

====<<<< Description >>>>====

可用于将图层移动到数据框或地图文档 (.mxd) 中的图层组内的特定位置处。（原图层移动）
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.MoveLayer (data_frame, reference_layer, insert_layer, {insert_position})

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈ reference_layer：参考图层。
◈ insert_layer：欲插入的涂层。
◈ insert_position：插入的位置，BEFORE 为之前、AFTER 为之后。（默认值为 BEFORE）

mapping.ListLayers

====<<<< Description >>>>====

返回一个 Python 列表，其中存在于地图文档 (.mxd) 中的层。
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.ListLayers (map_document_or_layer, {wildcard}, {data_frame})

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈ map_document_or_layer：一个引用 MapDocument 对象的变量或者 Layer 对象。
◈ wildcard：可以使用星号 (*) 和字符的组合来限制结果。(默认值为无)
◈ data_frame：一个引用 DataFrame 对象的变量。(默认值为无)

mapping.UpdateLayer

====<<<< Description >>>>====

通过从源图层提取信息，更新地图文档 (.mxd) 中所有图层属性或仅更新图层的符号系统。(可以引用目标图层的样式 symbology)
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.UpdateLayers (data_frame, update_layer, source_layer, {symbology_only})

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈ data_frame：一个引用 DataFrame 对象的变量。(默认值为无)
◈ update_layer：一个表示现有层的层对象，该层将被更新。
◈ source_layer：对包含要应用到updatelayer的信息的层对象的引用。
◈ symbology_only：如果设置为 True，则仅更新当前图层的 symbology。默认为 True，若为 False，则更新全部。

说明：将 lys[41] 的样式引用给 lys[20]

mapping.
AddLayerToGroup

====<<<< Description>>>>====

将图层添加到 group layer 中。（原始图层不变）
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.AddToGroup (data_frame, target_group_layer, add_layer, {add_position})
----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈ data_frame：一个引用 DataFrame 对象的变量。
◈ target_group_layer：group layer 对应的图层。
◈ add_layer：增加的图层。
◈ add_position：一个常量，它决定了数据框架中添加的图层的位置。AUTO_ARRANGE/BOTTOM/TOP

>>> lyrs = arcpy.mapping.ListLayers(df)
# 预增加的图层
>>> lyrs[3]
<map layer u'China'>
# group layer 对应的图层
>>> lyrs[0]
<map group layer u'New Group Layer'>
# 将 China 添加到 group layer 中
>>> arcpy.mapping.AddLayerToGroup(df, lyrs[0], lyrs[3])
>>> arcpy.RefreshTOC()

mapping.
ListLayoutElements

====<<<< Description >>>>====

返回地图文档 (.mxd) 布局中布局元素的 Python 列表。
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.ListLayoutElements (map_document, {element_type}, {wildcard})

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====

◈   element_type：一个表示元素类型的字符串，它将用于筛选元素的返回列表。(默认值为无)
    DATAFRAME_ELEMENT：数据框元素，DataFrame
    GRAPHIC_ELEMENT：图形元素，GraphicElement
    LEGEND_ELEMENT：图例元素，LegendElement
    MAPSURROUND_ELEMENT：地图整饰要素元素，MapsurroundElement
    PICTURE_ELEMENT：图片元素，PictureElement
    TEXT_ELEMENT：文本元素，TextElement

----------------------------------------------------------------------------------

====<<<< Returns >>>>====

◈ Object (数据类型)：页面布局元素的 Python 列表。可返回的对象类型是：DataFrame、GraphicElement、LegendElement、MapsurroundElement、PictureElement 和 TextElement。

mapping.ExportToJPEG

====<<<< Description >>>>====

将地图文档 (.mxd) 的页面布局或数据框导出到 (JPEG) 格式。（其他格式类似）
----------------------------------------------------------------------------------

====<<<< Syntax >>>>====

mapping.ExportToJPEG (map_document, out_jpeg, {data_frame}, {df_export_width}, {df_export_height}, {resolution}, {world_file}, {color_mode}, {jpeg_quality}, {progressive})

----------------------------------------------------------------------------------

====<<<< Parameters >>>>====